Arktur:Doku-SVN-Anleitung
URLs
- http://tortoisesvn.net/downloads
- http://www.jayotee.de/o/webdesign/subversion.shtml (kurze Einführung in das Konzept eines Versionsverwaltungssystems - Pflichtlektüre für Einsteiger!!!)
SVN-Arbeitsumgebung einrichten
TortoiseSVN integriert sich als Erweiterung der normalen Kontextmenüs in den Windows-Explorer.
- Für die Verwendung von SVN unter Linux sind die nötigen Konsolenkommandos angegeben.
Download und Installation
Die benötigten Setup-Dateien zu TortoiseSVN finden sich hier:
- http://tortoisesvn.net/downloads (Hauptprogramm - Languagepacks - Spellchecker)
Die heruntergeladenen Programmpakete sind als MSI-Dateien ausgeführt und lassen sich einfach installieren, indem man sie im Explorer einmal mit der rechten Maustaste anklickt und "Installieren" wählt.
Nach der erfolgreichen Installation ist zwangsweise ein Neustart nötig. Danach sollten in den Kontextmenüs des Explorers einige Erweiterungen auftauchen.
- Da die meisten aktuellen Linux-Distributionen bereits ein vorbereitetes SVN-Paket mitbringen, kann an dieser Stelle keine genau Installationsanweisung gegeben werden. Unter Debian sollte sich das Paket mittels apt-get install subversion installieren lassen, unter SUSE-Distribtionen sollte YaST behilflich sein.
Erzeugen einer lokalen Arbeitskopie
Um an den Daten aus dem zentralen Repositoy arbeiten zu können, muss zunächst eine lokale Kopie des aktuellen Standes auf dem eigenen Rechner erzeugt werden. Dieser Vorgang wird "Checkout" genannt. Dabei geht man so vor, dass man sich zunächst ein leeres Verzeichnis anlegt, dort "rechtsklickt" und "SVN Checkout" aus dem Menü wählt. Es erscheint ein Dialog, in dem man die URL des Repositorys und das lokale Arbeitsverzeichnis einträgt. Die URL ist im Falle der Arktur4-Dokumentation http://fsn.by.schule.de:81/svn/arktur4/Dokumentation. Das Checkout-Directory entspricht dem zuvor angelegten Arbeitsverzeichnis.
Solange man mit der aktuellsten Version aus dem Repository arbeiten will, lässt man die Einstellung unter "Revision" auf "Head Revision" stehen. Alternativ könnte man auch durch Angabe einer Revisionsnummer einen älteren Stand der Dokumentation auschecken.
Nach dem Auschecken finden sich die Dateien mit dem aktuellen Versionsstand im Arbeitsverzeichnis. Zusätzlich wurden zu den eigentlichen Projektdateien Ordner mit dem Namen ".svn" angelegt, die interne Informationen über die aktuelle Arbeitskopie enthalten. Diese dürfen keinesfalls gelöscht oder von Hand verändert werden.
Verzeichnisse, die unter der Versionsverwaltung von SVN stehen werden im Windows Explorer mit einem veränderten Icon im Verzeichnisbaum markiert:
Außerdem ist das Kontextmenü des Explorers innerhalb dieser Verzeichnisse um weitere SVN-Funktionen erweitert.
- Die Linux-Benutzer sollten an dieser Stelle in ein leeres Arbeitsverzeichnis wechseln und den Befehl svn co http://fsn.by.schule.de:81/svn/arktur4/Dokumentation eingeben. Die aktuelle Version wird nun aus dem Repository heruntergeladen
Arbeiten mit der lokalen Arbeitskopie
Update
Sollte der Checkout zeitlich schon einige Zeit zurückliegen, so empfiehlt es sich dringend die lokale Arbeitskopie zunächst auf einen aktuellen Stand zu bringen. Dieser Vorgang, bei dem Änderungen aus dem zentralen Repository in die lokale Kopie übertragen werden, wird "Update" genannt und kann einfach mittels Rechtsklick auf das Arbeitsverzeichnis und die Auswahl von "SVN Update" erledigt werden. Der eigentlichen Arbeit steht nun nichts mehr im Wege. Vorhandene Dateien können einfach mit einem Editor oder einem passenden Programm bearbeitet werden. Die Arbeit unterscheidet sich hier nicht von der Arbeit mit normalen, lokalen Dateien!
- Linux-Benutzer haben es bei der Update-Funktion sehr leicht. Es reicht ein svn update auf der Kommandozeile wenn man sich im Verzeichnis der Arbeitskopie befindet.
Commit
Sind alle Änderungen erfolgt wird als nächstes ein sog. "Commit" durchgeführt. Dabei werden die lokal durchgeführten Veränderungen an das zentrale Repository übertragen und erzeugen dort eine neue Revisionsnummer. Damit stehen die Änderungen ab sofort allen anderen Teilnehmern zur Verfügung. Praktisch erfolgt der Commit wieder durch Rechtsklick auf das Arbeitsverzeichnis im Explorer und dort den Menüpunkt "SVN Commit".
In dem Commit-Dialog sollte nun als erstes eine möglichst aussagekräftige Kurzbeschreibung der vorgenommenen Änderungen eingetragen werden. Weiter bietet der Dialog eine Übersicht zu den geänderten Dateien und der Art der Änderungen (in dem Bild wurde z.B testweise eine Textdatei hinzugefügt).
- Unter Linux wird alles wieder mit einem einzigen Befehl erledigt: svn commit -m "<hier kommt die Beschreibung der Änderung rein>". Das funktioniert natürlich ebenfalls nur, wenn man sich gerade im richtigen Verzeichnis befindet.
Hinzufügen und Löschen von Dateien aus dem Projekt
Wichtig zu merken ist, dass sich neue Dateien nicht durch einfaches Kopieren in die Versionsverwaltung des Projekts übernehmen lassen. Erzeuge ich in meiner Arbeitskopie eine neue Datei, so bleibt diese solange eine einfache lokale Datei, bis ich sie explizit in das Projekt aufnehmen. Das erfolgt mit Hilfe des Befehls "Add" aus dem Untermenü "TotoiseSVN", das erscheint, wenn man einen Rechtsklick auf die hinzuzufügende Datei macht. gemacht werden. Diese Änderungen werden vorgemerkt und beim nächsten Commit wieder an das Repository übertragen.
Analog müssen Lösch- und Umbennenungsvorgänge zusätzlich durch Aufruf von "Delete" oder "Rename" kenntlich gemacht werden. Ein alleiniges Umbennen oder Löschen der Datei würde beim nächsten Update dazu führen, dass die alte Datei wieder auftaucht.
- Die zugehörigen Befehle unter Linux lauten
- svn add <Dateiname>
- svn delete <Dateiname>
- svn move <Quelle> <Ziel>
- weitere Paramter für die Nutzung unter Linux offenbart das Kommand svn --help
Erste Experimente in der Sandbox
Um Einsteigern eine Möglichkeit zu geben, sich mit der Funktions- und Arbeitsweise von SVN vertraut zu machen, wurde unter http://fsn.by.schule.de:81/svn/sandbox ein Experimentier-Repository eingerichtet. Es ist explizit dazu gedacht nach Herzenslust herumzuexperimentieren! Eine rege Nutzung dieser Möglichkeit ist daher sehr erwünscht :-).
Möchte man die obige Anleitung auf die Arbeit mit der Sandbox übertragen, so ist lediglich die unterschiedliche HTTP-Adresse zu beachten. Weiterhin werden für die Nutzung Zugangsdaten benötigt, die jedoch nur dazu dienen einem Missbrauch dieses Repositories vorzubeugen. DerZugang wird sofort und unbürokratisch auf Anfrage per E-Mail an Michael Vistein (vistein@schul-netz.de) oder per Nachricht in die Arktur-Entwickler-Mailinglisten gewährt.
