WebTools Git/de



Anmerkung: Beginnend mit FreeCAD v0.17 wurde dieses Werkzeug aus dem Arch-Arbeitsbereich entfernt und ist nun Teil des externen Webtools-Arbeitsbereichs, der über das Menü Werkzeuge → Addon-Manager installiert werden kann.

Beschreibung
Dieser Befehl erlaubt die Verwaltung des aktuellen Dokuments mit Git. Git ist ein mächtiges System zur Dateiversionskontrolle, welches verschiedene Versionen von Dateien verwalten kann und den Überblick über die Änderungen behält.

Git ist ein komplexes Werkzeug, so dass es sinnvoll ist, die Grundlagen vor der Benutzung zu erlernen, um falsche Operationen zu vermieden, die zu Datenverlust führen können. Reichlich Literatur über Git ist verfügbar und einfach im Internet zu finden.

Aktuelle Einschränkungen:


 * Das Werkzeug kann bisher keine neuen Repositories anlegen. Ein existierendes lokales Repository muss bereits verfügbar sein (FreeCAD wird prüfen, ob die aktuelle Dokumentendatei in einem Repository ist)
 * Das Werkzeug kann kein Branches ändern oder anlegen. Das muss manuell mit den Standard-Git-Werkzeugen getan werden.

Anmerkung: Um diesen Befehl nutzen zu können, muss das gitpython-Paket auf Deinem System installiert sein. In den meisten Linux-Distributionen ist gitpython in den Standard-Software-Repositories als gitpython oder python-git verfügbar.

Anwendung

 * 1) Speichere das aktuelle aktive Dokument
 * 2) Stelle sicher, dass sich die gespeicherte Datei in einem existierenden Git-Repository befindet
 * 3) Wähle aus den Menü Arch → Dienstprogramme →

Optionen



 * Stelle sicher, dass das Ausgabefenster geöffnet ist, denn Git-Meldungen werden dort ausgegeben
 * Das Git-Werkzeug wird nur geöffnet, wenn die aktuelle Datei in einem Git-Repository gespeichert ist. Die Datei kann in einem Unterverzeichnis sein.
 * Der Log-Button wird einen Dialog öffnen, in dem die aktuellsten Log-Einträge angezeigt werden
 * Der Refresh-Button wird das Repository auf geänderte Dateien durchsuchen
 * Der Diff-Button wird die Unterschiede zwischen der aktuellen Version einer ausgewählten Datei und der im Repository gespeicherten Vorversion anzeigen
 * Der Select all-Button wird alle Dateien auswählen, um sie an das Repository zu übergeben (commit)
 * Der Commit-Button wird die ausgewählten Dateien an das Repository übergeben (commit). Stelle sicher, eine Commit-Meldung zu erfassen, die die zu übergebenden Änderungen beschreiben
 * Der Pull-Button wird jegliche neuen Änderungen aus dem ausgewählten entfernten (remote) Repository in das lokale herunterladen. Wenn die aktuell in FreeCAD geöffnete Datei durch einen Pull verändert wird, informiert eine Warnmeldung darüber, so dass die Datei entweder erneut gespeichert oder an einer anderen Stelle gespeichert werden kann
 * Der Push-Button wird den/die letzten Commit/s in das entfernte Repository hochladen.

Aktivieren eines 'lesbaren' Diffs für FCStd-Dateien
FreeCADs Fcstd-Dateiformat ist ein Zip-basiertes Binärformat, für das Git keine sauber lesbaren Diffs (Unterschiede) erstellen kann. Das bedeutet, dass Du nicht sehen kannst, was sich zwischen der einen und der anderen Version geändert hat und dass jede neue im Git-Repository gespeicherte Version eine vollständige Kopie der Datei ist.

Auch wenn es für das zweite Problem bisher keine Lösung gibt, kann das erste mit einem kleinen Werkzeug aus dem FreeCAD-Quellcode gelöst werden, das fcinfo heißt. Git kann angewiesen werden, mit dem fcinfo-Dienstprogramm einen menschlich-lesbaren Bericht einer FCStd-Datei zu drucken und beim Vergleich (diff) von zwei FCStd-Dateien stattdessen einen Vergleich der beiden fcinfo-Berichte zu erzeugen. Bitte beachte, dass dies lediglich eine visuelle 'Rückmeldung' ist, denn intern wird eine vollständige Version der Datei gespeichert.

Beispiel eines mit fcinfo erstellten diff:

Jede FreeCAD-Datei enthält eine SHA1-Prüfsumme, die sich jedes Mal beim Speichern der Datei ändert, selbst wenn der Inhalt nicht verändert wurde. Deshalb wird fcinfo immer etwas ausgeben, unabhängig davon, ob sich der Inhalt ändert.

Zur Aktivierung der Nutzung von fcinfo (nur Linux und Mac - ToDo: Windows-Anweisungen hinzufügen)

*.FCStd diff=fcinfo
 * 1) Speichere die fcinfo-Datei irgendwo im System-Pfad
 * 2) Mache sie ausführbar
 * 3) Erstelle eine .gitattributes-Datei in Deinem Git-Repository
 * 4) Füge die folgende Zeile hinzu: