git-interpret-trailers - Online in der Cloud

PROGRAMM:

NAME/FUNKTION

git-interpret-trailers - hilft beim Hinzufügen strukturierter Informationen zu Commit-Nachrichten

ZUSAMMENFASSUNG

git Dolmetscher-Trailer [--trim-leer] [(--trailer [(=|:) ])...] [ ...]

BESCHREIBUNG

Hilfe beim Hinzufügen Anhänger Zeilen, die ähnlich aussehen wie RFC 822 E-Mail-Header, am Ende des
ansonsten Freiformteil einer Commit-Nachricht.

Dieser Befehl liest einige Patches oder Commit-Meldungen von einem der Argumente oder die
Standardeingabe wenn nein angegeben. Dann wendet dieser Befehl die übergebenen Argumente an
Verwenden Sie die Option --trailer, falls vorhanden, für den Commit-Nachrichtenteil jeder Eingabedatei. Die
Ergebnis wird auf der Standardausgabe ausgegeben.

Einige Konfigurationsvariablen steuern, wie die --trailer-Argumente auf jede angewendet werden
Commit-Nachricht und die Art und Weise, wie ein vorhandener Trailer in der Commit-Nachricht geändert wird. Sie
ermöglichen es auch, einige Trailer automatisch hinzuzufügen.

Standardmäßig a = or : Argument, das mit --trailer angegeben wird, ist
nur nach den bestehenden Trailern angehängt, wenn der letzte Trailer ein anderes ( ,
) Paar (oder wenn kein Trailer vorhanden ist). Die und Teile werden
getrimmt, um beginnende und nachfolgende Leerzeichen zu entfernen, und das resultierende Trimmen und
wird in der Nachricht wie folgt angezeigt:

Token: Wert

Dies bedeutet, dass die getrimmten und wird durch ': ' (ein Doppelpunkt
gefolgt von einem Leerzeichen).

Standardmäßig erscheint der neue Trailer am Ende aller bestehenden Trailer. Wenn da
kein vorhandener Trailer ist, erscheint der neue Trailer nach der Commit-Nachricht im Teil des
Ausgabe, und wenn am Ende des Commit-Nachrichtenteils keine Zeile mit nur Leerzeichen vorhanden ist,
vor dem neuen Trailer wird eine Leerzeile eingefügt.

Vorhandene Trailer werden aus der Eingabenachricht extrahiert, indem nach einer Gruppe von einem oder gesucht wird
mehrere Zeilen, die einen Doppelpunkt enthalten (standardmäßig), wobei der Gruppe ein oder mehrere vorangestellt sind
leere (oder nur Leerzeichen) Zeilen. Die Gruppe muss entweder am Ende der Nachricht stehen oder
die letzten Zeilen ohne Leerzeichen vor einer Zeile, die mit beginnt ---. Solche drei Minuszeichen
Starten Sie den Patch-Teil der Nachricht.

Beim Lesen von Trailern kann es Leerzeichen vor und nach dem Token geben, dem Trennzeichen
und der Wert. Es können auch Leerzeichen innerhalb des Tokens und des Werts vorhanden sein.

Beachten Sie, dass Anhänger viele Regeln für RFC 822 nicht befolgen und nicht befolgen sollen
Kopfzeilen. Sie befolgen beispielsweise nicht die Linienfaltungsregeln, die Kodierungsregeln und
wahrscheinlich viele andere Regeln.

OPTIONAL

--trim-leer
Wenn die Ein Teil eines Trailers enthält nur Leerzeichen, der gesamte Trailer wird
aus der resultierenden Nachricht entfernt. Dies gilt sowohl für bestehende Trailer als auch für neue
Anhänger.

--Anhänger [(=|:) ]
Geben Sie ein ( , ) Paar, das als Trailer an den Eingang angelegt werden soll
Mitteilungen. Siehe die Beschreibung dieses Befehls.

CONFIGURATION VARIABLEN

Anhänger.Abscheider
Diese Option gibt an, welche Zeichen als Trailer-Trennzeichen erkannt werden. Standardmäßig
einzige : wird als Anhängertrenner erkannt, außer dass = wird immer am . akzeptiert
Befehlszeile für die Kompatibilität mit anderen Git-Befehlen.

Das erste von dieser Option angegebene Zeichen ist das Standardzeichen, das verwendet wird, wenn
ein anderes Trennzeichen ist in der Konfiguration für diesen Trailer nicht angegeben.

Wenn der Wert für diese Option beispielsweise "%=$" lautet, dann nur Zeilen mit dem Format
mit enthält %, = or $ und dann werden Leerzeichen berücksichtigt
Anhänger. Und % wird als Standardtrennzeichen verwendet, daher werden standardmäßig Trailer angezeigt
mögen: % (ein Prozentzeichen und ein Leerzeichen erscheinen zwischen dem Token
und der Wert).

Anhänger.wo
Diese Option gibt an, wo ein neuer Trailer hinzugefügt wird.

Dies kann end sein, was die Standardeinstellung ist, start, after oder before.

Wenn es Ende ist, wird jeder neue Trailer am Ende der bestehenden Trailer erscheinen.

Wenn es start ist, erscheint jeder neue Trailer am Anfang, statt am Ende von
die vorhandenen Anhänger.

Wenn es danach ist, erscheint jeder neue Trailer direkt nach dem letzten Trailer mit dem
gleich .

Wenn es vorher ist, erscheint jeder neue Trailer kurz vor dem ersten Trailer mit
das gleiche .

Trailer.falls vorhanden
Mit dieser Option können Sie auswählen, welche Aktion ausgeführt werden soll, wenn
schon mindestens ein Trailer mit dem gleichen in der Nachricht.

Die gültigen Werte für diese Option sind: addIfDifferentNeighbor (dies ist die Standardeinstellung),
addIfDifferent, add, overwrite oder doNothing.

Mit addIfDifferentNeighbor wird nur dann ein neuer Trailer hinzugefügt, wenn kein Trailer mit dem
gleich ( , ) Paar ist über oder unter der Linie, wo der neue Trailer sein wird
zugegeben.

Mit addIfDifferent wird nur dann ein neuer Trailer hinzugefügt, wenn kein Trailer mit dem gleichen
( , ) Paar ist bereits in der Nachricht.

Mit add wird ein neuer Trailer hinzugefügt, auch wenn einige Trailer mit dem gleichen ( ,
) Paar sind bereits in der Nachricht.

Mit ersetzen, einen vorhandenen Anhänger mit dem gleichen wird gelöscht und das neue
Trailer wird hinzugefügt. Der gelöschte Trailer ist der nächste (mit dem gleichen
) an die Stelle, an der das neue hinzugefügt wird.

Mit doNothing wird nichts getan; das heißt kein neuer Trailer wird hinzugefügt, wenn es einen gibt
schon eins mit dem gleichen in der Nachricht.

Trailer.ifmissing
Mit dieser Option können Sie auswählen, welche Aktion ausgeführt werden soll, wenn
noch kein Trailer mit dem gleichen in der Nachricht.

Die gültigen Werte für diese Option sind: add (dies ist die Standardeinstellung) und doNothing.

Mit add wird ein neuer Trailer hinzugefügt.

Mit doNothing wird nichts getan.

Anhänger. .Schlüssel
Dieser Schlüssel wird anstelle von verwendet im Anhänger. Am Ende dieses Schlüssels a
Trennzeichen erscheinen und dann einige Leerzeichen. Standardmäßig das einzig gültige
Trennzeichen ist :, aber dies kann mit der Konfigurationsvariablen trailer.separators geändert werden.

Wenn ein Trennzeichen vorhanden ist, wird der Schlüssel anstelle der beiden verwendet und der
Standardtrennzeichen beim Hinzufügen des Trailers.

Anhänger. .wo
Diese Option nimmt die gleichen Werte an wie die Anhänger.wo Konfigurationsvariable und es
überschreibt das, was durch diese Option für Anhänger mit dem angegebenen . angegeben wird .

Anhänger. .ifexist
Diese Option nimmt die gleichen Werte an wie die Trailer.falls vorhanden Konfigurationsvariable und es
überschreibt das, was durch diese Option für Anhänger mit dem angegebenen . angegeben wird .

Anhänger. .wenn fehlt
Diese Option nimmt die gleichen Werte an wie die Trailer.ifmissing Konfigurationsvariable und
es überschreibt, was durch diese Option für Anhänger mit dem angegebenen . angegeben wird .

Anhänger. .Befehl
Diese Option kann verwendet werden, um einen Shell-Befehl anzugeben, der aufgerufen wird an
Automatisches Hinzufügen oder Ändern eines Anhängers mit den angegebenen .

Wenn diese Option angegeben ist, verhält sich das Verhalten wie bei einem Spezial =
-Argument wurden am Anfang der Befehlszeile hinzugefügt, wobei wird angenommen
die Standardausgabe des angegebenen Befehls mit allen führenden und abschließenden Leerzeichen
abgeschnitten.

Wenn der Befehl den $ARG-String enthält, wird dieser String durch den . ersetzt
Teil eines bestehenden Trailers mit demselben , falls vorhanden, bevor der Befehl lautet
ins Leben gerufen.

Wenn einige = Argumente werden auch auf der Kommandozeile übergeben, wenn a
Anhänger. .Befehl konfiguriert ist, wird der Befehl auch für jeden von
diese Argumente. Und der ein Teil dieser Argumente, falls vorhanden, wird verwendet, um
Ersetzen Sie die Zeichenfolge $ARG im Befehl.

Beispiele:

· Konfigurieren Sie Schild Anhänger mit a Abgemeldet von key und fügen Sie dann zwei dieser Trailer hinzu
zu einer Nachricht:

$ git config trailer.sign.key "Abgemeldet von"
$ cat msg.txt
Fach

Nachricht
$ cat msg.txt | git interpret-trailers --trailer 'sign: Alice[E-Mail geschützt] >' --trailer 'Zeichen: Bob[E-Mail geschützt] >'
Fach

Nachricht

Abgezeichnet von: Alice[E-Mail geschützt] >
Abgezeichnet von: Bob[E-Mail geschützt] >

· Den letzten Commit als Patch extrahieren und a . hinzufügen Cc und einem Rezensiert von Trailer dazu:

$ git format-patch -1
0001-foo.patch
$ git interpret-trailers --trailer 'Cc: Alice[E-Mail geschützt] >' --trailer 'Bewertet von: Bob[E-Mail geschützt] >' 0001-foo.patch >0001-bar.patch

· Konfigurieren Sie Schild Trailer mit einem Befehl zum automatischen Hinzufügen eines 'Abgemeldet-von:' mit
die Autoreninformationen nur, wenn es noch kein "Signed-off-by:" gibt, und zeigen Sie, wie es geht
funktioniert:

$ git config trailer.sign.key "Abgemeldet von: "
$ git config trailer.sign.ifmissing hinzufügen
$ git config Trailer.sign.ifexists doNothing
$ git config trailer.sign.command 'echo "$(git config user.name) <$(git config user.email)>"'
$ git interpret-trailer <
> EOF

Abgezeichnet von: Bob[E-Mail geschützt] >
$ git interpret-trailer <
> Abgemeldet von: Alice[E-Mail geschützt] >
> EOF

Abgezeichnet von: Alice[E-Mail geschützt] >

· Konfigurieren Sie fixieren Anhänger mit einem Schlüssel, der a . enthält # und danach kein platz
Charakter und zeigen, wie es funktioniert:

$ git config trailer.separators ":#"
$ git config trailer.fix.key "Fix #"
$ echo "Betreff" | git interpret-trailers --trailer fix=42
Fach

Fix #42

· Konfigurieren Sie sehen Trailer mit einem Befehl zum Anzeigen des Betreffs eines Commits, das ist
verwandt, und zeigen Sie, wie es funktioniert:

$ git config trailer.see.key "Siehe auch: "
$ git config trailer.see.ifExists "ersetzen"
$ git config trailer.see.ifMissing "doNothing"
$ git config trailer.see.command "git log -1 --oneline --format=\"%h (%s)\" --abbrev-commit --abbrev=14 \$ARG"
$ git interpret-trailer <
> Thema
>
> Nachricht
>
> siehe: KOPF ~ 2
> EOF
Fach

Nachricht

Siehe auch: fe3187489d69c4 (Gegenstand des entsprechenden Commits)

· Konfigurieren Sie eine Commit-Vorlage mit einigen Trailern mit leeren Werten (mit sed zum Anzeigen
und behalten Sie die abschließenden Leerzeichen am Ende der Trailer bei), dann konfigurieren Sie eine commit-msg
Haken, der verwendet git Dolmetscher-Trailer Trailer mit leeren Werten entfernen und hinzufügen
a Git-Version Anhänger:

$ sed -e 's/ Z$/ /' >commit_template.txt <
> ***Thema***
>
> ***Nachricht***
>
> Fixes: Z
> CC: Z
> Bewertet von: Z
> Abgemeldet von: Z
> EOF
$ git config commit.template commit_template.txt
$ cat >.git/hooks/commit-msg <
> #!/ Bin / sh
> git interpret-trailers --trim-empty --trailer "git-version: \$(git describe)" "\$1" > "\$1.new"
> mv "\$1.neu" "\$1"
> EOF
$ chmod +x .git/hooks/commit-msg

Verwenden Sie git-interpret-trailer online mit den onworks.net-Diensten