Welche Dokumente sollten zu einem svn Repo hinzugefügt werden?

Question

Ich arbeite an einem persönlichen Projekt, und obwohl ich ein Wiki habe, würde ich gerne verschiedene Dokumentationsdateien zum svn-Repository hinzufügen. Zu diesen Dateien gehören XML (generiert von monodoc) sowie UML-Diagramme (generiert mit dia).

In diesem eine gute Idee, ich habe hören/lesen Kommentare über nicht Hinzufügen von binären Daten zu den svn Repo und versuchen, nur Code zu halten, ist das richtig?

Answer 1

Fügen Sie alles hinzu, was mit dem Projekt zu tun hat. Das Hinzufügen von Binärdateien (z. B. Bibliotheken) ist kein Problem, sondern : Vermeiden Sie das Hinzufügen doppelter Daten, wie z. B. Dateien, die aus der Quelle kompiliert wurden.

Answer 2

Svn kommt mit Binärdateien gut zurecht, aber ich würde keine erstellten Dateien hinzufügen, sondern nur die Quellen. Wenn Ihre Dokumentation aus anderen Dateien generiert wird, checken Sie sie nicht ein, sondern lassen Sie sie von anderen Entwicklern selbst bauen. Nur wenn die Dateien schwer zu erstellen sind, würde ich sie in Subversion einchecken.

Answer 3

Meine persönliche Regel lautet, dass man keine Dinge hinzufügen sollte, die man aus anderen Dingen generieren kann. Ein gutes Beispiel sind Dokumentationsdateien, die aus Codekommentaren erzeugt werden können.

Answer 4

Wenn Sie ein Dokumentationssystem haben, das auf geschickte Art und Weise zusammengeführt und verglichen werden kann, sollte die "Quelle" für die Dokumente im Baum liegen. D.h. die .tex-Datei, nicht die .pdf-Datei.

Wenn Sie eine Version abzweigen, die Änderungen am Code und an der Dokumentation erfordert, werden diese Änderungen an der Dokumentation auch in SVN zu finden sein. Wenn Sie ein Release erstellen, bauen Sie die Binärdatei aus dem Code und die Dokumentation aus der Dokumentationsquelle.

Wenn Sie etwas aus dem Zweig zurückportieren, können Sie auch die entsprechende Dokumentation zurückportieren.

Answer 5

Ich lege Daten, die ich erstelle und möglicherweise ändere, in SVN ab. Ich lege zum Beispiel Quellcode, Lösungs- und Make-Dateien sowie die Dokumentation in SVN ab. Ich versuche zu vermeiden, dass ich generierte Dateien hinzufüge, z. B. aus anderen Formaten generierte PDFs, Binärdateien und Bibliotheken von Drittanbietern. Inhalte, die ich nicht erstelle und ändere, wie z. B. Handbücher von anderen Anbietern, landen in einem gemeinsamen Ordner. Das deckt sich ziemlich genau mit dem, was andere Leute sagen.

Ich füge jedoch generierte Dateien und Binärdateien hinzu, wenn ich (1) eine Veröffentlichung vornehme und die genauen freigegebenen Dateien beibehalten muss oder (2) die Dateien schwierig zu erstellen sind und ich nicht möchte, dass andere Entwickler sich mit dem Erstellungsprozess befassen müssen. Manchmal füge ich auch Bibliotheken von Drittanbietern hinzu, damit neue Entwickler sie nicht erst suchen, herunterladen und installieren müssen - das ist für mich sehr hilfreich, da viele meiner Entwicklungsrechner keine Verbindung zum Internet haben.