|
|
| Zeile 43: |
Zeile 43: |
| Wir beschreiben hier kurz und sehr abstrakt die einzelnen Funktionen, die ein [[Subversion]]-Client generell zur Verfügung stellt. Die genaue Funktionsweise kann von Client zu Client abweichen. | | Wir beschreiben hier kurz und sehr abstrakt die einzelnen Funktionen, die ein [[Subversion]]-Client generell zur Verfügung stellt. Die genaue Funktionsweise kann von Client zu Client abweichen. |
|
| |
|
| = Repository erstellen = | | == Repository erstellen == |
| Git init | | Git init |
|
| |
|
| = Repository clonen = | | == Repository clonen == |
| Git clone | | Git clone |
|
| |
|
| = Am Repository Arbeiten = | | == Am Repository Arbeiten == |
| Alle Dateien und Ordner in der [[#Working Copy|Working Copy]] können nahezu genauso bearbeitet werden, als wäre die [[#Working Copy|Working Copy]] ein normales Verzeichnis. Man kann Dateien und Verzeichnisse
| | === Remote Änderungen synchronisieren === |
| * neu anlegen
| | === Eigene Änderungen hinzufügen === |
| * löschen
| | === Änderungen Rückgängig machen === |
| * ändern
| | === Dateien Ignorieren === |
| * verschieben
| | Man kann in Git mittels einer <code>.gitignore</code> Datei andere Dateien ignorieren, d.h. sie explizit nicht unter Versionskontrolle stellen. |
| * umbenennen
| |
| Manche Veränderungen der [[#Working Copy|Working Copy]] erfordern jedoch vor dem [[#Working Copy commiten|Commit]] eine explizite Mitteilung an die [[Versionsverwaltung]]. Wenn Dateien oder Verzeichnisse neu angelegt (<tt>Add...</tt>) oder gelöscht (<tt>Delete...</tt>) werden, kann das [[#Repository|Repository]] nicht entscheiden, wie es darauf reagieren soll. Neue Dateien müssen nicht zwangsweise unter [[Versionsverwaltung]] gestellt werden, auch wenn sie in einer [[#Working Copy|Working Copy]] liegen. Man könnte sie auch [[#Ignore|ignorieren]]. Gelöschte Dateien sollen nicht zwangsweise auch im [[#Repository|Repository]] gelöscht werden, sie könnten auch von dort wiederhergestellt (z.B. mit [[#Working Copy updaten|Update]]) werden.
| |
| | |
| Noch größeren Aufwand benötigt das Umbenennen (<tt>Rename...</tt>) und das Verschieben von Dateien oder Verzeichnissen. Da zusätzliche Informationen mit einzelnen Dateien verknüpft sind, müssen diese Operationen vollständig durch den [[#Clients|Client]] getätigt werden.
| |
| | |
| [[#AnkhSVN|AnkhSVN]] übernimmt diese Arbeiten (zu einem Großteil) für den Benutzer, während man in [[#TortoiseSVN|TortoiseSVN]] diese Mitteilungen manuell vor einem [[#Working Copy commiten|Commit]] machen muss. Das Verschieben mit [[#TortoiseSVN|TortoiseSVN]] ist etwas versteckt, da dieser Befehl nur im Rechtsklick-Drag-and-Drop-Kontextmenü sichtbar ist.
| |
| | |
| === Working Copy updaten === | |
| [[Image:update_messages.png|thumb|right|400px|Ein Update-Log mit typischen Status-Meldungen ([[Subversion#TortoiseSVN|TortoiseSVN]]).]]
| |
| | |
| Mit dem ''Update'' der [[#Working Copy|Working Copy]] (<tt>SVN Update</tt>) holt man sich die Änderungen der anderen Benutzer auf seinen Rechner. Dabei werden dem Benutzer die einzelnen Änderungen, die durch das Update an seiner [[#Working Copy|Working Copy]] vorgenommen wurden, in einem Update-Log angezeigt. Je nach [[#Clients|Client]] sieht das natürlich verschieden aus, aber die folgenden Aktionen wird man oft zu sehen bekommen<ref>Für eine vollständige Liste siehe http://knaddison.com/technology/svn-status-code-cheat-sheet</ref>:
| |
| | |
| <table class="default">
| |
| <tr><th>Deleted</th><td>Die Datei wurde von einem anderen Benutzer in der Zwischenzeit gelöscht.</td></tr>
| |
| <tr><th>Conflicted</th><td>Die Datei ist in einem [[#Conflicts|Conflict]]-Zustand, d.h. seit dem letzen [[#Projekt auschecken|Checkout]] hat ein anderer Benutzer diese Datei geändert und sie wurde außerdem lokal geändert. [[Subversion]] kann diese Änderung nicht automatisch zusammenführen (da z.B. die selbe Zeile geändert wurde). Ein [[#Conflicts|Conflict]] benötigt IMMER Benutzer-Interaktion um aufgelöst zu werden. </td></tr>
| |
| <tr><th>Updated</th><td>Die Datei wurde seit dem letzten [[#Projekt auschecken|Checkout]] nicht lokal verändert, aber ein anderer Benutzer hat Veränderungen daran vorgenommen.</td></tr>
| |
| <tr><th>Added</th><td>Ein anderer Benutzer hat diese Datei neu hinzugefügt.</td></tr>
| |
| <tr><th>Merged</th><td>Seit dem letzen [[#Projekt auschecken|Checkout]] hat ein anderer Benutzer diese Datei geändert und sie wurde außerdem lokal geändert. In diesem Fall konnte [[Subversion]] die Änderungen automatisch zusammenführen (da z.B. der eine Benutzer nur den Anfang der Datei geändert hat, lokal aber nur das Ende geändert wurde)</td></tr>
| |
| </table>
| |
| <br clear="all">
| |
| | |
| === Working Copy commiten === | |
| Wenn die [[#Working Copy bearbeiten|lokalen Änderungen]] (für den Moment) abgeschlossen sind, können sie ''commited'' werden. Dadurch werden sie in das [[#Repository|Repository]] eingefügt und den anderen Benutzern zur Verfügung gestellt.
| |
| | |
| Bei einem Commit sollte man auch immer eine Log-Message schreiben, sodass der Rest des Teams nachvollziehen kann, was (oder warum) man geändert hat. Sie sollten sich auf ein einheitliches Format (oder wenigstens eine Sprache) für diese Nachrichten einigen.
| |
| | |
| Sollte man beim Commit einen Fehler erhalten, kann dies mehrere Ursachen haben:
| |
| * Die [[#Working Copy|Working Copy]] hat eine ältere [[#Revision|Revision]] als das [[#Repository|Repository]]. Man sollte immer ein [[#Working Copy updaten|Update]] vor dem Commit ausführen.
| |
| * Die [[#Working Copy|Working Copy]] enthält unaufgelöste [[#Conflicts|Conflicts]].
| |
| | |
| Sollte der Commit durch ein unerwartetes Ereignis unterbrochen werden, z.B. durch einen Stromausfall oder den Verlust der Verbindung zum [[#Repository|Repository]], sperrt [[Subversion]] die [[#Working Copy|Working Copy]] und ignoriert diesen Commit im [[#Repository|Repository]], um inkonsistente Zustände zu vermeiden. In diesem Fall sollte vor einem erneuten Commit ein [[#Cleanup|Cleanup]] der [[#Working Copy|Working Copy]] durchgeführt werden.
| |
| | |
| '''Achtung''': NIEMALS [[#Working Copy bearbeiten|Änderungen]] einchecken, die das [[#Repository|Repository]] ''breaken''! Das sind [[#Working Copy bearbeiten|Änderungen]], die dazu führen, das das Projekt nicht mehr [[Compiler|kompiliert]]. Die anderen Team-Mitglieder können dann ohne ihre Hilfe nicht mehr weiterarbeiten (und werden entsprechend dankbar sein)!
| |
| | |
| === Revert === | |
| Mit <code>svn revert</code> macht man alle lokalen Änderungen rückgängig. Dabei werden sowohl die Änderungen des Inhaltes wie auch an den Metadaten (Zeit, Rechte etc.) rückgängig gemacht. Mit <code>svn revert</code> kann auch die Markierung um neue Dateien oder Verzeichnisse Hinzufügen/Löschen wieder entfernt werden. Die Auswirkungen von <code>svn revert</code> sind dabei auf die Arbeitskopie beschränkt (Das Projekt-Archiv bleibt unberührt).
| |
| | |
| === Ignore ===
| |
| Man kann die meisten [[Subversion]]-[[#Client|Clients]] anweisen, bestimmte Dateien in allen folgenden Operationen zu ignorieren, d.h. sie explizit nicht unter Versionskontrolle stellen.
| |
| Das ist insbesondere für temporäre Dateien (die z.B. bei jedem [[Build]] neu erzeugt werden) oder Benutzer-spezifische Einstellungen sinnvoll und muss von jedem verwendet werden. | | Das ist insbesondere für temporäre Dateien (die z.B. bei jedem [[Build]] neu erzeugt werden) oder Benutzer-spezifische Einstellungen sinnvoll und muss von jedem verwendet werden. |
| Die folgenden Dateien und Verzeichnisse müssen auf jedenfall auf die Ignore-Liste und dürfen nicht mit eingecheckt werden: | | Die folgenden Dateien und Verzeichnisse müssen auf jedenfall auf die Ignore-Liste und dürfen nicht mit eingecheckt werden: |
| Zeile 108: |
Zeile 69: |
| <tr><th><tt>.vs</tt></th><td>Von Visual Studio generiertes Verzeichnis für interne Einstellungen.</td></tr> | | <tr><th><tt>.vs</tt></th><td>Von Visual Studio generiertes Verzeichnis für interne Einstellungen.</td></tr> |
| </table> | | </table> |
| '''Hinweis:''' Bei Nutzung von [[Downloads#Subversion | TortoiseSVN]] als SVN Client müssen zuerst die Umgebenden Ordner eingecheckt werden damit die Ignore-Regeln gesetzt werden können! Also als erstes einfach das gesamte Projekt mit Ausnahme der zu ignorierenden Ordner und Dateien committen. Dann zu den zu ignorierenden Daten gehen und per Rechtsklick und Tortoise Menü auf die Ignore-Liste setzen (Das geht alternativ auch im Commit-Fenster). Sobald alle Ignore-Regeln gesetzt sind nocheinmal Committen damit die Ignore Regeln im SVN gespeichert sind.
| |
|
| |
| Über die Kommandozeile fügt man Ordner/Dateien mittels <code>svn propset svn:ignore <Datei/Ordnername> .</code> hinzu. Oder man editiert die ignore Datei direkt mittels <code>svn propedit svn:ignore .</code> hier kann man durch newlines getrennt [http://pubs.opengroup.org/onlinepubs/009695399/utilities/xcu_chap02.html#tag_02_13 pattern] für auszuschließende Objekte angeben
| |
|
| |
|
| === Diff === | | === Diff === |
| Mit ''Diff'' (in [[Subversion#TortoiseSVN|TortoiseSVN]] ''Show Modifications'') kann man sich die [[#Working Copy bearbeiten|Änderungen]], die man seit dem letzten [[#Projekt auschecken|Checkout]] gemacht hat, anzeigen lassen. Das ist insbesondere für das Erstellen der [[#Working Copy commiten|Commit]]-Log-Message nützlich (man weiss wieder, was man eigentlich gemacht hat).
| |
|
| |
|
| === Conflicts === | | === Conflicts === |
| [[Image:TortoiseSVN_commit_failed.png|thumb|right|300px|[[Subversion#TortoiseSVN|TortoiseSVN]] Dialog: Commit schlägt fehl, da <code>foo.cpp</code> in neuerer Revision vorliegt]]
| |
|
| |
| Konflikte treten auf, wenn eine geänderte Datei committed wird, die in der Zwischenzeit in einer neueren Revision im Projekt-Archiv vorliegt. Konflikte bemerkt man entweder beim Committen <code>svn: Out of date</code> oder nach einem Update an der Markierung der Datei mit einem <code>C</code>.
| |
|
| |
| Öffnet man die Datei sieht man die Konflikt behafteten Stellen:
| |
|
| |
| <<<<<<< .mine
| |
| Das habe ich geschrieben
| |
| =======
| |
| Das steht in der letzten Revision im Projekt-Archiv (Hier Revision 42)
| |
| >>>>>>> .r42
| |
|
| |
| Nach dem <code>svn update</code> sieht man jetzt 4 Versionen der betroffenen Datei <code>foo.cpp</code>
| |
|
| |
| foo.cpp -> Die Datei mit den Markierungen wie oben.
| |
| foo.cpp.mine -> Die Datei mit nur meinen Änderungen.
| |
| foo.cpp.r41 -> Die Datei vor meinen Änderungen. (Also Revision 41 der Datei).
| |
| foo.cpp.r42 -> Die Datei mit nur den Änderungen aus dem Projekt-archiv. (Also Revision 42 der Datei).
| |
|
| |
| Jetzt kann mann sich entscheiden
| |
| ==== Letzte Revision im Projektarchiv verwenden ====
| |
| Hier werden meine Änderungen verworfen (das bedeutet '''alles was ich an der conflicted Datei geändert habe ist verloren''' und wird auch in keiner History gespeichert) und es wird die Letzte Revision aus dem Projekt-Archiv verwendet.
| |
|
| |
| <code>svn resolve --accept theirs-full foo.cpp</code>.
| |
|
| |
| ==== Meine Änderungen verwenden und die Änderungen an der Letzten Revision(en) wegschmeißen ====
| |
| Eine Möglichkeit wäre: Man löscht die Datei <code>foo.cpp</code> nennt <code>foo.cpp.mine</code> in <code>foo.cpp</code> um. Jetzt muss man SVN mitteilen, dass der Konflikt behoben ist indem man <code>svn resolve foo.cpp</code> ausführt. SVN kümmert sich um die <code>foo.cpp.r<id></code> dateien. Das ganze geht auch mit einem Befehl: <code>svn resolve --accept mine-full foo.cpp</code>.
| |
|
| |
| Jetzt sind in der aktuellen Revision nur meine Änderungen an der Datei. Alle Änderungen die in der Zwischenzeit vorgenommen wurden sind entfernt (allerdings noch in der History einsehbar).
| |
|
| |
| ==== Das beste aus Beiden Versionen behalten ====
| |
| [[Image:TortoiseMerge.png|thumb|right|300px|[[Subversion#TortoiseSVN|TortoiseSVN]] Merge tool]]
| |
|
| |
| Hier muss man die datei <code>foo.cpp</code> öffnen und alle Markierten Stellen von Hand bearbeiten, so dass am Ende das gewünschte übrig bleibt. Nach dem Speichern teilt man SVN mittels
| |
| <code>svn resolve foo.cpp</code> mit das nun alles in Ordnung ist. SVN kümmert sich (löscht) die verbleibenden Dateien und man kann jetzt committen. Um sich den Prozess der Bearbeitung zu erleichtern gibt es auch eine ganze reihe Tools und Plugins für fast alle gängigen Editoren.
| |
|
| |
| [[Subversion#TortoiseSVN|TortoiseSVN]] bietet einen Merge-Editor an. Diesen startet man für eine conflicted Datei mittels Rechtsklick auf diese wählt dann ''"Edit conflicts"'' dies öffnet den Editor (siehe rechts). Hier ist die obere linke Hälfte die aktuelle Revision im Projekt-Archiv (Mit "Theirs" betitelt). Die rechte Hälfte (mit "Mine" betitelt) öffnet die <code>foo.cpp.mine</code> datei. In Orange ist jeweils die Differenz markiert (die Zeile dient zur Orientierung wie sie vor dem Konflikt war). Im unteren Editor kann man nun unter jeder orangen Zeile entscheiden, welchen Teil man übernehmen möchte. Mit Rechtsklick auf die Zeile wählt man für jede Differenz <code>Use text block from "theirs"</code> für den Code aus der aktuellen Revision im Projekt-Archiv oder <code>Use text block from "mine"</code> um den Code aus meinen Änderungen zu benutzen. Man kann auch etwas komplett anderes direkt in die Zeilen Schreiben.
| |
|
| |
| Ist man mit der Bearbeitung fertig, klickt man oben links aus "Save". Jetzt sollte man schauen, ob die Datei auch wirklich so ist wie man sie möchte und ob das Projekt noch kompiliert etc. Dann kann man die Datei mit ''Rechtsklick -> TurtoiseSVN -> Resolve'' (Dies ist auch in der Taskleiste im MergeEditor möglich) als "resolved" markieren und committen.
| |
|
| |
|
| === History === | | === History === |
| [[Image:log_messages.png|thumb|right|400px|Die ''Show Log'' Ansicht von [[Subversion#TortoiseSVN|TortoiseSVN]]]]
| |
|
| |
| Unter dieser Funktion versteht man die Überprüfung der Revisionsgeschichte (daher History) des [[#Repository|Repository]]. Dazu stehen verschiedene Werkzeuge zur Verfügung:
| |
| * ''List'' liefert eine Liste von Dateien/Verzeichnissen einer spezifischen [[#Revision|Revision]] des [[#Repository|Repositorys]] (in [[Subversion#TortoiseSVN|TortoiseSVN]] der ''Repo-Browser'', der über das Kontextmenü erreicht wird.)
| |
| * ''Log'' liefert alle Log-Messages einer Datei oder eines Verzeichnisses (''Show Log'' in [[Subversion#TortoiseSVN|TortoiseSVN]] (ebenfalls über das Kontextmenü) liefert alle Log-Messages von allen [[#Revision|Revisionen]])
| |
| * ''Cat'' gibt eine bestimmte Revision einer Datei auf den Bildschirm aus (in [[Subversion#TortoiseSVN|TortoiseSVN]] im Repo-Browser integriert)
| |
| * ''Blame'' zeigt eine Datei an und ordnet jede Zeile einem Benutzer zu, sodass man sehen kann, wer wann welche Änderungen vorgenommen hat.
| |
| <br clear="all">
| |
|
| |
| === Cleanup ===
| |
| Das ''Cleanup''-Kommando säubert [[Rekursion|rekursiv]] die [[#Working Copy|Working Copy]] indem es Locks<ref>Locks werden in diesem Artikel nicht behandelt, da wir glauben, das dieses Konzept überholt und - für uns - unnötig ist.</ref> entfernt und unterbrochene Operationen weiterführt (genauer: den Zustand so ändert, das er wieder konsistent ist).
| |
|
| |
| == Clients ==
| |
| Für die Entwicklung unter [[Windows]] haben wir gute Erfahrungen mit den zwei nachfolgenden Clients<ref>für eine vollständigere Liste siehe Wikipedias [[wikipedia:en:Comparison_of_Subversion_clients|Vergleich verschiedener SVN-Clients]]</ref> gemacht. Wir empfehlen den Einsatz von beiden Clients gleichzeitg, da sie beide je nach aktueller Aufgabe gewisse, substantielle Vor- bzw. Nachteile aufweisen.
| |
|
| |
| === TortoiseSVN ===
| |
| {{:TortoiseSVN}}
| |
| === AnkhSVN ===
| |
| {{:AnkhSVN}}
| |
| === Web-Access ===
| |
| Unsere [[#Repository|Repositorys]] können auch ohne [[#Clients|Client]] über den Browser erreicht werden. Einfach den Pfad des [[#Repository|Repositorys]] (siehe [[Gruppeneinteilung]] oder [[#Sopra Repository|Abschnitt "Sopra Repository"]] für den eigenen Pfad) im Browser eingeben und mit den eigenen Zugangsdaten authentifizieren. Allerdings ist hierbei nur lesender Zugriff möglich.
| |
|
| |
| == Sopra Repository ==
| |
| Um auf das [[Gruppeneinteilung|Gruppen]]-[[#Repository|Repository]] zuzugreifen, braucht man:
| |
| * einen IIF-Account (''Poolaccount'')
| |
| <!--* ein WWW-Passwort (das man [https://support.informatik.uni-freiburg.de/cgi/support/fawmgr.cgi?wpassword:de hier] einrichten kann)-->
| |
|
| |
| Der Pfad für das [[#Repository|Repository]] ist https://sotec.informatik.uni-freiburg.de/svn/sopraXX wobei das XX für die [[Gruppeneinteilung|Gruppennummer]] (01 bis 10) steht.
| |
|
| |
| == Trac und SVN ==
| |
| Das Projektmanagement-Werkzeug Trac ist im Softwarepraktikum auch mit dem Versionskontrollsystem [[Subversion]] verbunden. Dies erlaubt nicht nur, das [[Subversion#History|Changelog]] über die Trac Weboberfläche einzusehen, sondern auch, Tickets über die [[Subversion#Working Copy commiten|Commit-Log-Messages]] zu referenzieren und zu schließen. Dabei wird die gesamte Log-Message eines Commits automatisch als Kommentar zu einem oder mehreren angegebenen Tickets hinzugefügt. Zusätzlich kann das entsprechende Ticket dabei auch geschlossen werden.
| |
| Dies ermöglicht eine bessere Nachvollziehbarkeit (Traceability) der Projektentwicklung durch die Zuordnung von Änderungen des Projekts zu einzelnen [[Item]]s im [[Product Backlog|Product-]] bzw. [[Sprint Backlog]].
| |
|
| |
| === Verwendung ===
| |
| Die Commit-Log-Messages werden nach Kommandos der Form <tt> [<Kommando> <Ticket> (<Konnektor> <Ticket>)*] </tt> durchsucht. Dabei stehen folgende Kommandos und Konnektoren zur Verfügung:
| |
| * Ticket schließen (dabei wird immer die in Trac eingestellte Default-Resolution verwendet) und referenzieren: <tt>close, closed, closes, fix, fixed, fixes</tt>
| |
| * Nur referenzieren: <tt>references, refs, addresses, re, see </tt>
| |
| * Remaining Time ändern: <tt>remaining <ticketid>:<hours></tt>
| |
| * Konnektoren: <tt>, & and</tt>
| |
| * Ticket-Schreibweise: <tt>ticket:<ticketid>, ticket<ticketid>, issue:<ticketid>, issue<ticketid>, bug:<ticketid>, bug<ticketid>, #<ticketid>, </tt>
| |
|
| |
| === Beispiele ===
| |
| Folgende Beispiele sind mögliche Commit-Log Messages:
| |
| Changed blah and foo to do this or that. [Fixes #10 and #12], and [refs #12].
| |
|
| |
| This will [close #10 and #12].
| |
|
| |
| Das betrifft [see #10, #12].
| |
|
| |
| Ich habe an Ticket [see #13] weitergearbeitet. Die verbleibende Zeit ist nun [remaining #13:2h].
| |
|
| |
| Die Kombination von Kommandos innerhalb einer Klammer ist allerdings nicht möglich. Folgendes Beispiel '''funktioniert nicht''':
| |
| Ich muss sowieso mal das zumachen: [close #30, #51 and refs #50]
| |
|
| |
| Im Moment '''funktioniert nicht''', dass man die verbrauchte Zeit per Commit Message ändert. Bitte tragen Sie diese von Hand im Trac für Ihre Tasks nach, z.B. immer an einem festen Zeitpunkt in der Woche.
| |
|
| |
| == siehe auch ==
| |
| === Referenzen ===
| |
| <references/>
| |
| === Links ===
| |
| * [[wikipedia:de:Subversion_(Software)|Subversion]] auf Wikipedia
| |
| * [http://svnbook.red-bean.com/ Version Control with Subversion] - das große [[Subversion]]-Buch online
| |
| * [http://www.cs.put.poznan.pl/csobaniec/Papers/svn-refcard.pdf Cheat-Sheet für Subversion]
| |
|
| |
| [[Kategorie:Begriffe]]
| |
| [[Kategorie:Tutorials]]
| |
| [[Kategorie:Entwurf]]
| |
| [[Kategorie:MS01]]
| |
|
| |
|
| |
|
| |
|
| | = Git Installieren = |
| | Es gibt unzählige Git Clients. Empfehlenswert ist vor allem für den Einstieg [https://git-scm.com/downloads Der offizielle Git client]. Wer gerne ein graphisches Interface hat kann [https://tortoisegit.org/ tortoisegit] oder einen der [https://git-scm.com/downloads/guis zahlreichen Alternativen] verwenden. |
| [[Kategorie:Begriffe]] | | [[Kategorie:Begriffe]] |
| [[Kategorie:Tutorials]] | | [[Kategorie:Tutorials]] |
| [[Kategorie:Entwurf]] | | [[Kategorie:Entwurf]] |
| [[Kategorie:MS01]] | | [[Kategorie:MS01]] |
Git ist ein Versionsverwaltungssystem. Es wird verwendet um
- Änderungen am Projekt zu protokollieren und dieses zu archivieren.
- Ältere Versionen wiederherzustellen.
- Gemeinsames Arbeiten auf der selben Datenbasis zu ermöglichen.
Wir verwenden Git im Sopra um genau diese Punkte zu ermöglichen. Jede Gruppe erhält ihr eigenes Repository auf Gitea (einer Plattform ähnlich zu GitHub), um ihr Projekt zu verwalten.
Git in einer Nussschale
Um mit Git arbeiten zu können, ist es wichtig die Prinzipielle Arbeitsweise von Git zu verstehen. Hat man die technische Umsetzung im Hinterkopf, werden die Befehle und Arbeitsweisen um git zu bedienen klarer.
Git protokolliert und verwaltet ein Dateiverzeichnis und alle Änderungen die an den verwalteten Dateien gemacht werden. Jede Änderung produziert dabei einen neuen "Schnappschuß" - den aktuellen Zustand des Verzeichnisses und der Dateien denen ein HASH (SHA-1) zugeordnet wird. Git kümmert sich darum, dass dies speichereffizient abläuft und verwendet dazu ein speziellen Verzeichniss das .git heißt und in dem verwalteten Dateiverzeichnis liegt. Dieses die gesammte Historie beinhaltende .git Verzeichnis ist ein Git Repository. Meistens wird aber das verwaltete Verzeichnis synonym als Repository bezeichnet, was wir ab jetzt auch tun. Ein einfaches Repository mit nur einer Datei "README.md" sieht demnach so aus:
.
├── .git
└── README.md
Die gesammte Historie des Repository ist also (meistens) lokal vorhanden. Um mit mehreren Personen an dem Repository zu arbeiten, müssen die Teilnehmer es mit einem "remote" Repository synchronisieren.
Git arbeitet mit 3 Zuständen. Jede versionierte Datei kann in einem der Zustände sein wobei es nicht sein muss, dass zu einem Zeitpunkt alle Dateien den gleichen Zustand haben.
Die 3 Zustände sind:
- committed -> Die Datei ist so wie sie ist im repository gespeichert.
- modified -> Die Datei ist zum letzten gespeicherten Zustand verändert.
- staged -> Die Datei (vorher im "Modified" Zustand oder eine neue Datei) wurde von dem git Benutzer markiert, sodass die Änderungen gespeichert werden sollen.
Daneben gibt es auch noch `untracked files` dies sind Dateien, die noch nicht in die Versionskontrolle aufgenommen wurden.
Zentrale Begriffe
Commit
Ein Commit repräsentiert einen Schnappschuss des Reposity und impliziert eine Menge an Änderungen an einer Datei (oder mehreren Dateien). Jedes mal wenn der git commit Befehl ausgeführt wird, wird dem Commit eine eindeutige ID (dem SHA-1 Hash) zugeordnet. Eine Serie an Commits erzeugt eine verkettete Liste an Commits wobei ein Commit immer seinen Vorgänger kennt.
Branch
Ein Branch ist ein unabhängiger Abzweig des Repository. Ausgehend von einem Commit kann mittels des git branch befehls ein neuer Branch erzeugt werden. Ein branch funktioniert wie ein eigenes Repository mit der Besonderheit, dass der Branch ausgehend von einem Commit (Schnappschuss) des Repository erstellt wurde und mit anderen Branches des Repository wieder vereinigt werden kann (#Merging).
Branch: A branch is an independent line of development. You can think of it as a brand new working directory.
Clone
Ein Clone ist eine Kopie eines schon bestehenden Git Repository. Dabei möchte man meistens die Quelle als #Remote behalten um Änderungen mit dieser Synchronisieren zu können.
Arbeiten mit Git
Wir beschreiben hier kurz und sehr abstrakt die einzelnen Funktionen, die ein Subversion-Client generell zur Verfügung stellt. Die genaue Funktionsweise kann von Client zu Client abweichen.
Repository erstellen
Git init
Repository clonen
Git clone
Am Repository Arbeiten
Remote Änderungen synchronisieren
Eigene Änderungen hinzufügen
Änderungen Rückgängig machen
Dateien Ignorieren
Man kann in Git mittels einer .gitignore Datei andere Dateien ignorieren, d.h. sie explizit nicht unter Versionskontrolle stellen.
Das ist insbesondere für temporäre Dateien (die z.B. bei jedem Build neu erzeugt werden) oder Benutzer-spezifische Einstellungen sinnvoll und muss von jedem verwendet werden.
Die folgenden Dateien und Verzeichnisse müssen auf jedenfall auf die Ignore-Liste und dürfen nicht mit eingecheckt werden:
| Warum? |
|---|
| bin | Die Dateien in diesem Ordner werden automatisch beim Kompillieren erstellt, sie hochzuladen ist also unnötig. Zudem sind auch binäre Dateien dabei die sich beim kompilieren häufig ändern. Da binäre Dateien nicht gemerged werden können wird das zu häufigen Konflikten mit den Commits anderer Teammitglieder führen. |
|---|
| obj | Siehe bin. |
|---|
| _ReSharper.#PROJEKTNAME# | Dieses Verzeichnis wird vom Resharper automatisch generiert. Automatisch generierte Ordner sollen nicht ins SVN, siehe bin. |
|---|
| *.suo | Die Dateien mit der Endung .suo (Solution User Options[1]) beinhalten eine Reihe von Benutzer-spezifischen Einstellungen für Visual Studio, die niemanden außer den Benutzer selber interessieren. Sie enthalten außerdem eine Reihe von absoluten Pfadangaben, die bei anderen Benutzern massive Probleme auslösen können. Sie sollen auf keinen Fall zum Repository hinzugefügt werden. |
|---|
| *.cachefile | Siehe bin. Auch merkt sich MonoGame hier, welche Dateien es schon in ein ihm genehmes Format konvertiert hat. Wenn ein anderes Teammitglied eine neue Datei hinzufügt und diese Datei im .cachefile als bereits konvertiert markiert ist, kann es passieren daß sich XNA denkt "Hey die Datei hab ich doch schon" und sie nicht neu konvertiert. |
|---|
| *.DotSettings.user | Diese Datei enthält Benutzerspezifische Resharper Einstellungen und soll entsprechend auch nicht eingecheckt werden. |
|---|
| *.thumb | Von Windows generierte Datei, die Vorschaubilder für die Miniaturansicht im Explorer enthält. |
|---|
| thumbs.db | Siehe .thumb |
|---|
| .vs | Von Visual Studio generiertes Verzeichnis für interne Einstellungen. |
|---|
Diff
Conflicts
History
Git Installieren
Es gibt unzählige Git Clients. Empfehlenswert ist vor allem für den Einstieg Der offizielle Git client. Wer gerne ein graphisches Interface hat kann tortoisegit oder einen der zahlreichen Alternativen verwenden.
