.gitattributes: Zeilenenden, Diff-Treiber, Merge-Treiber und export-ignore

Worum es geht

.gitattributes bildet Pfadmuster auf Attribute ab, in derselben Mustersyntax wie .gitignore, und wird mit dem Code versioniert. Die am häufigsten verwendeten Attribute, wie in der Dokumentation beschrieben:

• text / text=auto / -text: ob Git Zeilenenden beim Check-in umwandelt (zu LF im Repository). Mit text=auto entscheidet Git pro Datei, ob es sich um Text handelt.
• eol=lf / eol=crlf: das Zeilenende im Arbeitsverzeichnis beim Checkout; das Setzen von eol setzt auch text.
• binary: ein eingebautes Makro gleichbedeutend mit -diff -merge -text.
• diff=<driver>: wählt einen unter [diff "<driver>"] konfigurierten Diff-Treiber, zum Beispiel xfuncname, um die Hunk-Header-Zeile zu bestimmen, oder textconv, um ein Binärformat zur Anzeige in Text umzuwandeln.
• merge=<driver>: text (normaler Drei-Wege-Merge), binary (eigene Version behalten, als Konflikt belassen), union (Zeilen aus beiden übernehmen, Reihenfolge nicht garantiert) oder ein eigener Treiber aus .git/config.
• export-ignore: der Pfad wird bei git archive ausgelassen; export-subst expandiert $Format:...$-Platzhalter in archivierten Dateien.

Warum es wichtig ist

Ohne eingecheckte Vorgabe entscheidet das core.autocrlf jeder einzelnen Person, und gemischte Zeilenenden machen aus Einzeiler-Fixes Diffs über die ganze Datei. Diff- und Merge-Treiber machen generierte oder strukturierte Dateien überprüfbar und verringern falsche Konflikte. export-ignore hält Tests und CI-Konfiguration aus Release-Tarballs heraus.

So wird es angewendet

• Mit * text=auto beginnen, dann Ausnahmen festlegen: *.sh text eol=lf, *.bat text eol=crlf, *.png binary.
• Nach dem Hinzufügen oder Ändern von Zeilenenden-Regeln git add --renormalize . aus einem sauberen Baum ausführen und die Normalisierung allein committen, wie das Beispiel der Dokumentation zeigt.
• Lock-Dateien oder Changelogs nur dann merge=union geben, wenn die Zeilenreihenfolge wirklich keine Rolle spielt; die Dokumentation warnt, dass das Ergebnis überprüft werden muss.
• Die von der Dokumentation aufgeführten eingebauten Hunk-Header-Muster aktivieren (*.py diff=python, *.tex diff=tex), damit Reviews die umschliessende Funktion zeigen, und einen xfuncname-Treiber nur für Sprachen ohne einen solchen definieren.
• tests/ export-ignore und .github/ export-ignore markieren, wenn git archive die Quell-Releases erzeugt.

Stolpersteine

Git zieht zuerst $GIT_DIR/info/attributes heran, dann die .gitattributes-Dateien vom Verzeichnis des Pfads bis zur obersten Ebene; ein Klon wendet neue Regeln erst an, sobald er den Commit hat, der sie hinzufügt, und bereits ausgecheckte Dateien behalten ihre alten Zeilenenden, bis renormalisiert wird. Makros wie binary lassen sich nur in Attributdateien der obersten Ebene definieren. Die Ausgabe von textconv ist einseitig und kann nicht als Patch angewendet werden. Eigene Treiber liegen in der Konfiguration jeder einzelnen Person, sodass das Attribut allein auf einer Maschine ohne diesen Treiber nichts bewirkt.