svn

Für Projekte die von mehreren Usern bearbeitet werden, empfiehlt sich die Verwendung eines Revision Control Systems für eine effektive Teamarbeit. Dabei wird die Entwicklungsgeschichte aller Dateien, die unter Revisions-Kontrolle stehen in einem Repository gespeichert. Jeder User besitzt einen eigenen Workspace, welcher in der Regel eine komplette Kopie aller Dateien des Repositories enthält. Diese Kopie kann jederzeit auf die aktuelle Revision aktualisiert und es können lokale Änderungen in das Repository übertragen werden, um diese den anderen Team-Mitgliedern zur Verfügung zu stellen.

ICPRO nutzt zur Versionskontrolle Subversion (SVN). Wenn man sich in einem Teamprojekt befindet, werden alle durch ICPRO 'prepare'-Targets erzeugten Dateien und Verzeichnisse automatisch zum

Repository hinzugefügt (svn add) und initial eingecheckt (svn commit). Die Idee dahinter ist, den Nutzer dabei zu unterstützen, alles was für die Reproduzierbarkeit eines ICPRO-Flow-Templates notwendig ist, zum Repository hinzuzufügen.

Diese Übung soll dazu dienen, die grundsätzlichen SVN-Befehle und ICPRO-SVN-Integration kennen zu lernen. Bitte bearbeiten Sie dieses Tutorial gemeinsam mit Ihrer Gruppe und nicht jeder einzeln.

2. Auschecken eines Teamprojects - Anlegen eines Workspaces

Das Repository für die Projektarbeit wurde bereits aufgesetzt und eingerichtet. ICPRO übernimmt das Anlegen des Workspaces und das Auschecken des Projektes, beim ersten Projekt Log-In. Bitte loggen Sie sich nun in das Projekt prz08 und das Subprojekt gruppe (einstellige Gruppennummern mit führender 0, z.B. gruppe01) ein:

icpro prz08 gruppeXX

An dieser Stelle werden Sie einmalig aufgefordert, Ihr SVN-Kennwort einzugeben. Bitte geben Sie das Kennwort: Snow7Zmc ein.

Jetzt erfolgt das Anlegen Ihres Workspaces. Dieser enthält initial alle Dateien und Verzeichnisse eines leeren ICPRO-Projektes.

Bitte lassen Sie jedes Gruppenmitglied das Projekt auschecken (Vorgehen s.o. als entsprechender User angemeldet). Wenn Sie sich dabei an einem Arbeitsplatz befinden, öffnen Sie für die anderen User bitte ein Terminal, damit diese sich mit

ssh @eeets1

anmelden können (Unix Passwort).

3. Einloggen in ein Teamproject

Beim Einloggen in ein Teamproject erfolgt automatisch ein Update des Workspaces. Das können Sie mit dem Schalter -nosvn umgehen. Bitte verlassen Sie Ihr Teamproject mit

exit

und loggen Sie sich erneut ein

icpro prz08 gruppeXX -nosvn

4. Anlegen und Editieren einer Unit

Lassen Sie ein Mitglied Ihres Teams eine Unit 'svn_test' anlegen:

icunit -rtl -verilog svn_test

Die erzeugten Verzeichnisse und das Verilog-Template werden automatisch zum Repository hinzugefügt und Commited.

Lassen Sie nun ein anderes Mitglied Ihres Teams ein Update seines Workspaces durchführen (im Projekt)

cdi svn up

Die Unit 'svn_test' wird nun vom Repository in seinen Workspace kopiert (ausgecheckt).

Lassen Sie diesen User das Verilog-Template editieren (beliebig) und sich den Status anzeigen:

cdi

svn status -q

dabei bekommen Sie folgende Ausschrift:

M units/svn_test/source/rtl/verilog/svn_test.v

die Ihnen sagt, dass sich im Workspace eine modifizierte Datei befindet die unter Versionskontrolle steht. Übertragen Sie die Modifikation in das Repository mit folgendem Befehl:

svn ci units/svn_test/source/rtl/verilog/svn_test.v

Sie werden aufgefordert, Ihre Änderungen zu kommentieren. Geben Sie nun einen Kommentar ein und speichern Sie diesen. Schließen Sie den nedit, um den Commit-Befehl auszuführen.

5. Löschen im Repository

cdu

svn rm svn_test svn ci

Dateien und Verzeichnisse können auch wieder vom Repository entfernt werden. Mit folgendem Befehl entfernen Sie die Unit 'svn_test' wieder löschen:

Sie werden wiederum aufgefordert, Ihr Vorgehen zu kommentieren (Ablauf s.o.).

Lassen Sie einen anderen User Ihrer Gruppe seinen Workspace updaten, um zu überprüfen, ob die Unit gelöscht wird.

6. Native SVN Usage

Neben der durch ICPRO unterstützen SVN-Nutzung, ist es auch möglich die SVN-Kommandos beliebig zu verwenden.

Legen Sie (ein Nutzer der Gruppe) im Verzeichnis doc eine Datei 'README.txt' an:

cdi

nedit doc/README.txt

Füllen Sie diese mit beliebigen Inhalt und speichern sie die Änderung. Fügen Sie diese Datei zum Repository hinzu und commiten Sie die Änderungen:

svn add doc/README.txt svn ci doc/README.txt

(Kommentar eingeben)

Lassen Sie einen anderen Nutzer seinen Workspace updaten und die Datei öffnen:

svn up

nedit doc/README.txt

Weitere Informationen zu den Subversion Kommandos bekommen Sie mit:

svn help

bzw.

svn help

oder im Internet.

Sollte es Probleme mit Ihren Workspaces geben (z.B. Konflikte), die Sie nicht selber lösen können, wenden Sie sich bitte an uns.

Bei Abgabe Ihres Belegs müssen sich sämtliche Design-Sourcen im Repository befinden. Alle Flows (Simulationen, Synthese und Place&Route) müssen so aufgesetzt und

eingecheckt werden, dass sie nur mit den Daten aus dem Repository reproduzierbar sind.

Mikrokontroller (ZMC) Spezifkation - Projekt Wiki

Für die Projektarbeit wurde von uns ein Wiki eingerichtet, was sie unter folgender URL erreichen können:

http://hpsn.et.tu-dresden.de/scpm/zmc

Zum Einloggen verwenden sie bitte ihren Unix-Login und das Passwort Snow7Zmc.

Die ZMC-Spezifikation und eine Reihe zusätzliche Tools können dort herunterladen werden. Weiterhin können sie die Wiki-Funktion nutzen, um ihr Projekt darzustellen, aktuelle Probleme zu diskutieren und Tickets im Falle von Fehlern in der Spezifikation oder ähnlichen zu erzeugen. Bei Fragen dazu wenden sie sich bitte an Stephan Hartmann (hartmann@iee.et.tu-dresden.de).