Versionsverwaltung mit CVS

Transkript

1 Versionsverwaltung mit CVS Steffen Schäfer Michael Velten 27. Juni 2004 Reihe Berichte zur Softwaretechnik Herausgeber: Prof. Dr. Ulrich Eisenecker, Fachhochschule Kaiserslautern, Standort Zweibrücken, Institut für Componentware und Window-Oberflächen

2 Copyright-Vermerk Das Copyright für diesen Bericht liegt bei den Autoren und dem Herausgeber. Der Bericht darf ganz oder in Teilen nur mit schriftlicher Zustimmung der Autoren und des Herausgebers verwendet werden. Jede kommerzielle Nutzung ist ausgeschlossen. Die Autoren und der Herausgeber, Zweibrücken, den 23. Juni 2004 Haftungsausschluss Weder die Autoren noch der Herausgeber haften für die Richtigkeit der in diesem Bericht gemachten Angaben oder für Folgen oder Schäden, die aus der Verwendung dieses Berichts resultieren. Auch falls in diesem Bericht Warenzeichen nicht als solche gekennzeichnet sind, kann nicht davon ausgegangen werden, dass die entsprechenden Begriffe und Bezeichnungen frei von Rechten Dritter sind.

3 Vorwort des Herausgebers Die Berichte zur Softwaretechnik behandeln Themen, die in der Vorlesung Software-Technik aus Zeitgründen nur gestreift oder nicht vermittelt werden konnten, aber für die Praxis der Softwareentwicklung dennoch von Bedeutung sind. Sie richten sich an Studierende der Informatik oder der Wirtschaftsinformatik, die sich beispielsweise im Rahmen ihres Praxissemesters oder ihrer Diplomarbeit mit den betreffenden Themen auseinander setzen müssen, oder an sonstige interessierte Personen, die sich auf diesen Gebieten autodidaktisch weiter bilden wollen. Wir freuen uns über Ihre Korrekturvorschläge, Verbesserungshinweise und auch Anregungen für Themen, die im Rahmen dieser Reihe aufgegriffen werden können. Diese richten Sie bitte an den Herausgeber, dessen -Adresse Sie auf der Homepage eisenecker finden. Ulrich W. Eisenecker, Zweibrücken, den 23. Juni 2004

4 Inhaltsverzeichnis 1 Einleitung 1 2 Installation Allgemein Linux-Installation Windows/Cygwin-Installation Repository Erstellen eines Repositories Projekt zum Repository hinzufügen Kommandos Lokale Kopie erzeugen Lokale Kopie aktualisieren Dateien modifizieren Änderungen anzeigen Dateien hinzufügen Dateien löschen Historie Ältere Versionen beziehen Literatur 7

5 CVS 1 1 Einleitung Dateien wie Quellcode und Dokumentationen werden in Software-Projekten in der Regel von mehreren Personen bearbeitet. Dadurch kommt es leicht zu Konflikten, da oftmals Änderungen an der selben Datei vorgenommen werden. Infolgedessen existieren mehrere Versionen dieser Datei, deren Modifikationen nicht mehr eindeutig nachvollziehbar sind. Ebenfalls können leicht Änderungen verloren gehen. Abhilfe bietet hier der Einsatz eines Versionsmanagementsystems wie zum Beispiel CVS. CVS steht für Concurrent Versions System und bezeichnet ein Versionsmanagementsystem. Es kann sowohl für kleinere als auch für größere Projekte zur komfortablen Verwaltung der verschiedenen Dateiversionen benutzt werden. Dies ist nicht auf Quelltext beschränkt, sondern es können auch z.b. in L A TEX verfasste Dateien oder allgemein Textdateien jeder Art verwaltet werden. Mit einigen Abstrichen gilt dies sogar für Binärdateien, wobei sich die Beschreibung im Folgenden auf Textdateien beschränkt. 2 Installation 2.1 Allgemein CVS wurde ursprünglich von Dick Grune als eine Ansammlung von Shell-Skripten veröffentlicht und im Jahre 1989 von Brian Berliner und Jeff Polk zu der heute bekannten Form weiterentwickelt. CVS kann kostenlos von der Homepage unter der GPL (siehe [4]) bezogen werden. 2.2 Linux-Installation Für das Kompilieren des Quellcodes wird die Datei cvs tar.bz2 benötigt. Das Archiv muss vor dem Installieren entpackt werden, dies geschieht mit dem folgenden Befehl: $ tar -xvjf cvs tar.bz2 Nach dem Entpacken liegt das Verzeichnis cvs vor. In dieses Verzeichnis wird jetzt mit dem Befehl cd cvs gewechselt. Anschließend muss der Quellcode noch übersetzt werden. Hierbei können./configure diverse Parameter übergeben werden um z.b. CVS nur für den clientseitigen Betrieb zu erstellen. Eine Erläuterung dieser Parameter befindet sich in der Datei INSTALL im Quellcodeverzeichnis. $./configure $ make $ make install

6 CVS 2 Wenn Probleme beim Compilieren auftreten, sollte man die Dateien INSTALL und README konsultieren. Unter Debian kann CVS mit dem Befehl $ apt-get install cvs installiert werden. 2.3 Windows/Cygwin-Installation Unter Windows kann das Tool WinCvs (siehe [2]) benutzt werden. WinCvs selbst bringt eine lauffähige Version von CVS mit, die bei den Standardeinstellungen mitinstalliert wird. Die durch die GUI ausgeführten Kommandos können in einer Konsole am unteren Bildrand von WinCvs mitverfolgt werden. Eine hervorragende Einleitung zu WinCvs bietet der Daily Use Guide (siehe [3]). Abbildung 1: WinCvs-Hauptfenster Unter Cygwin kann CVS über die Setup-Routine oder mittels Quelltext analog zu Linux installiert werden. 3 Repository Das CVS-Repository unterhält eine komplette Kopie aller Dateien und Verzeichnisse, die durch CVS verwaltet werden. Auf diese Dateien wird normalerweise niemals direkt zugegriffen, sondern es kann durch spezielle Befehle eine lokale Kopie der gewünschten Dateien bzw. Verzeichnisse erstellt werden. Das Repository kann entweder lokal oder auf einem entfernten Rechner gepflegt werden.

7 CVS Erstellen eines Repositories Anmerkung: Die folgende Beschreibung bezieht sich auf Linux bzw. ein Unixartiges Betriebssystem und die Verwendung von Cygwin. Zunächst sollte man ein neues Verzeichnis erstellen, in dem das Repository abgelegt wird und die Umgebungsvariable CVSROOT auf dieses Verzeichnis setzen. Anschließend müssen die von CVS benötigten internen Verwaltungsdateien angelegt werden. $ mkdir cvshome $ export CVSROOT=$(pwd)/cvshome $ cvs init Im neu erstellten Verzeichnis wird ein Unterverzeichnis mit dem Namen CVS- ROOT erstellt. Dieses Verzeichnis enthält interne Verwaltungsdateien von CVS, die nicht manuell geändert werden sollten. 3.2 Projekt zum Repository hinzufügen Im Folgenden wird das vorhandene Projekt produkt bestehend aus lediglich einer Datei main.cpp CVS zur Verwaltung übergeben. #include <iostream > void main ( ) { int produkt ; produkt = 7 8 / 2 ; // Summe von 1 b i s 7 std : : cout << produkt << std : : endl ; } Listing 1: Erste Version von main.cpp $ cvs import -m "Erste Version unseres Programms" produkt swt start N produkt/main.cpp No conflicts created by this import Hier eine kurze Erläuterung der verwendeten Parameter: import: Veranlasst CVS dazu, die Dateien im Ordner produkt in das Repository mit aufzunehmen.

8 CVS 4 -m... : Beim Importieren kann zu den geänderten Dateien ein Vermerk angegeben werden, der zum Nachvollziehen der Änderungen dient. Fehlt dieser Parameter, wird der Standardeditor aus der Umgebungsvariablen EDITOR ausgelesen und zur interaktiven Eingabe des Vermerks aufgerufen. produkt: gibt den Namen des zu benutzenden Moduls an. Jedes Projekt wird als einzelnes Modul im Repository in einem separaten Ordner gespeichert. swt: Das sogenannte Vendor-Tag, welches anzeigt, von wem die Dateien erstellt wurden. Hier könnte etwa FH-ZW oder einfach der Name des Benutzers stehen. start: Das sogenannte Revision-Tag. Wird ein neues Modul angelegt, kann dies mit dem Revision-Tag start geschehen, da das Modul meistens in einem sehr frühen Entwicklungsstadium ist. Im Verzeichnis cvshome wurde ein neues Unterverzeichnis produkt erstellt. Es enthält die importierte Datei main.cpp mit dem Suffix,v. Dies kann mit folgendem Befehl verifiziert werden: $ ls $CVSROOT main.cpp,v 4 Kommandos 4.1 Lokale Kopie erzeugen Bevor man sich eine lokale Kopie des gewünschten Moduls lädt, sollte das ursprüngliche Verzeichnis gelöscht werden, um ein versehentliches Arbeiten im alten Verzeichnis zu vermeiden. Erst danach sollten die Dateien vom CVS-System bezogen werden. $ cd.. $ rm -rf produkt $ cvs checkout produkt cvs checkout: Updating produkt U produkt/main.cpp Mit cvs checkout wird das aktuelle Modul produkt zur Bearbeitung als lokale Kopie gespeichert.

9 CVS Lokale Kopie aktualisieren Falls mehrere Benutzer auf das gleiche Repository zugreifen und Änderungen an Dateien vornehmen, kann es vorkommen, dass eine lokale Kopie nicht mehr auf dem aktuellsten Stand ist, da Dateien im Repository durch andere Benutzer in der Zwischenzeit modifiziert wurden. Von daher sollte man in kleineren Intervallen seine Dateien auf den aktuellsten Stand bringen. Dies geschieht mit folgender Anweisung: $ cvs update 4.3 Dateien modifizieren An der erzeugten Kopie können nun beliebige Änderungen vorgenommen werden. Diese Änderungen wirken sich noch nicht direkt auf die Dateien im CVS- Repository aus. Angenommen die Datei main.cpp wurde wie folgt geändert: #include <iostream > int main ( ) { // void durch i n t e r s e t z t int produkt ; produkt = ; std : : cout << produkt << std : : endl ; } return 0 ; Listing 2: Zweite Version von main.cpp Die neue Version von main.cpp wird nun dem CVS-System übergeben. Hierbei ist hervorzuheben, dass die alte Datei nicht einfach überschrieben wird, sondern vielmehr die Änderungen zur vorherigen Version festgehalten werden. Somit ist auch zu einem späteren Zeitpunkt klar ersichtlich, welche Änderungen zu welcher Zeit getätigt wurden. $ cvs commit -m "Diverse Fehler korrigiert" main.cpp Checking in main.cpp; /home/cvshome/produkt/main.cpp,v <-- main.cpp new revision: 1.2; previous revision: 1.1 done Erst jetzt wurden die Änderungen auch tatsächlich in das Repository übernommen. Wie an der Ausgabe zu erkennen ist, ordnet CVS der neuen Dateiversion

10 CVS 6 automatisch eine sogenannte Revisionsnummer zu. Dadurch kann zu einem späteren Zeitpunkt auf eine bestimmte Revision gezielt zugegriffen werden. Dies wird im Abschnitt 4.8 beschrieben. 4.4 Änderungen anzeigen Oft ist es praktisch, sich die Änderungen anzeigen zu lassen, die man seit der letzten Aktualisierung der lokalen Kopie vorgenommen hat. Dies geschieht folgendermaßen: $ cvs diff Durch diesen Befehl werden alle Änderungen aller Dateien im aktuellen Verzeichnis angezeigt. Möchte man nur die Änderungen einer bestimmten Datei angezeigt bekommen, kann man zusätzlich den Dateinamen angeben: $ cvs diff main.cpp 4.5 Dateien hinzufügen Falls man dem Projekt eine völlig neue Datei hinzugefügt hat, kann man diese mit folgendem Befehl CVS bekannt machen: $ cvs add dateiname.cpp Dadurch wird beim nächsten Ausführen von cvs checkout die neue Datei in das Repository mit aufgenommen. 4.6 Dateien löschen Eine Datei kann mit den üblichen Kommandos gelöscht werden. Allerdings wirkt sich auch diese Aktion nicht unmittelbar auf das Repository aus. Damit auch von CVS das Entfernen der Datei übernommen wird, muss die Datei entsprechend markiert werden. Dies geschieht folgendermaßen: $ rm dateiname.cpp $ cvs remove dateiname.cpp Beim nächsten Aufruf von cvs checkout wird die Datei dann auch aus dem Repository entfernt.

11 CVS Historie Mit dem Befehl cvs log kann man sich Informationen über alle Revisionen einschließlich. der Kommentare, die mit der Option -m festgelegt wurden, anzeigen lassen. Eine etwas kompaktere Ausgabe über den Status der Dateien liefert der Befehl cvs status. Beide Befehle können alternativ auch explizit auf eine bestimmte Datei angewendet werden, also cvs log dateiname.cpp bzw. cvs status dateiname.cpp. 4.8 Ältere Versionen beziehen Wie bereits weiter oben beschrieben, ordnet CVS allen Dateien automatisch eine eindeutige Revisionsnummer zu, die bei jeder Änderung im Repository aktualisiert wird. Somit können bequem ältere Versionen mit folgender Anweisung bezogen werden: $ cvs checkout -r 1.2 produkt Hierdurch wird im aktuellen Verzeichnis ein neues Unterverzeichnis produkt erstellt, das alle Dateien mit der Revisionsnummer 1.2 enthält. Es gibt noch weitere Kritierien, nach denen ältere Versionen bezogen werden können. Diese können mit dem Befehl man cvs in der Manual-Page von CVS nachgeschlagen werden.

12 CVS 8 Literatur [1] Homepage von CVS, [2] Homepage von WinCvs, [3] Daily Use Guide, [4] GPL, [5] Buch Open Source Development with CVS, [6] CVS FAQ, molli/cvs/cvs-faq/cvsfaq0.html