git-interpret-trailers - En ligne dans le Cloud

PROGRAMME:

Nom

git-interpret-trailers - aide à ajouter des informations structurées dans les messages de validation

SYNOPSIS

jet interprète-remorques [--trim-vide] [(--remorque [(=|:) ])...] [ ...]

DESCRIPTION

Aide à l'ajout remorques lignes, qui ressemblent aux en-têtes de courrier électronique RFC 822, à la fin de la
sinon forme libre partie d'un message de validation.

Cette commande lit des correctifs ou des messages de validation à partir du arguments ou le
entrée standard si non est spécifié. Ensuite, cette commande applique les arguments passés
en utilisant l'option --trailer, le cas échéant, à la partie message de validation de chaque fichier d'entrée. Les
résultat est émis sur la sortie standard.

Certaines variables de configuration contrôlent la manière dont les arguments --trailer sont appliqués à chaque
le message de validation et la façon dont toute bande-annonce existante dans le message de validation est modifiée. Ils
permettent également d'ajouter automatiquement des bandes-annonces.

Par défaut, un = or : l'argument donné en utilisant --trailer sera
ajouté après les remorques existantes uniquement si la dernière remorque a un autre ( ,
) paire (ou s'il n'y a pas de remorque existante). Les et les pièces seront
rogné pour supprimer les espaces blancs de début et de fin, et le résultat rogné et
apparaîtra dans le message comme ceci :

jeton : valeur

Cela signifie que la coupe et seront séparés par ': ' (un deux-points
suivi d'un espace).

Par défaut, la nouvelle bande-annonce apparaîtra à la fin de toutes les bandes-annonces existantes. S'il y a
n'existe pas de bande-annonce existante, la nouvelle bande-annonce apparaîtra après la partie du message de validation du
sortie, et, s'il n'y a pas de ligne avec uniquement des espaces à la fin de la partie du message de validation,
une ligne vierge sera ajoutée avant la nouvelle bande-annonce.

Les bandes-annonces existantes sont extraites du message d'entrée en recherchant un groupe d'un ou
plusieurs lignes contenant un deux-points (par défaut), où le groupe est précédé d'un ou plusieurs
lignes vides (ou avec des espaces uniquement). Le groupe doit soit être à la fin du message, soit être
les dernières lignes sans espace avant une ligne commençant par ---. Ces trois signes moins
démarrer la partie patch du message.

Lors de la lecture des bandes-annonces, il peut y avoir des espaces avant et après le jeton, le séparateur
et la valeur. Il peut également y avoir des espaces à l'intérieur du jeton et de la valeur.

Notez que remorques ne suivent pas et ne sont pas destinés à suivre de nombreuses règles de la RFC 822
en-têtes. Par exemple, ils ne suivent pas les règles de pliage des lignes, les règles d'encodage et
probablement beaucoup d'autres règles.

OPTIONS

--trim-vide
Si la une partie d'une bande-annonce ne contient que des espaces, toute la bande-annonce sera
supprimé du message résultant. Ceci s'applique aux remorques existantes ainsi qu'aux nouvelles
bandes annonces.

--bande annonce [(=|:) ]
Spécifiez un ( , ) paire qui devrait être appliquée comme remorque à l'entrée
messages. Voir la description de cette commande.

CONFIGURATION VARIABLES

séparateurs.de.remorque
Cette option indique quels caractères sont reconnus comme séparateurs de fin. Par défaut
uniquement : est reconnu comme un séparateur de remorque, sauf que = est toujours accepté sur le
ligne de commande pour la compatibilité avec d'autres commandes git.

Le premier caractère donné par cette option sera le caractère par défaut utilisé lorsque
un autre séparateur n'est pas spécifié dans la configuration de cette bande-annonce.

Par exemple, si la valeur de cette option est "%=$", alors seules les lignes utilisant le format
avec contenant %, = or $ puis les espaces seront pris en compte
bandes annonces. Et % sera le séparateur par défaut utilisé, donc par défaut les bandes-annonces apparaîtront
comme: % (un signe pour cent et un espace apparaîtront entre le jeton
et la valeur).

remorque.où
Cette option indique où une nouvelle bande-annonce sera ajoutée.

Cela peut être fin, qui est la valeur par défaut, début, après ou avant.

Si c'est la fin, alors chaque nouvelle bande-annonce apparaîtra à la fin des bandes-annonces existantes.

Si c'est le début, alors chaque nouvelle bande-annonce apparaîtra au début, au lieu de la fin, de
les remorques existantes.

Si c'est après, alors chaque nouvelle bande-annonce apparaîtra juste après la dernière bande-annonce avec le
même .

Si c'est avant, alors chaque nouvelle bande-annonce apparaîtra juste avant la première bande-annonce avec
le même .

bande-annonce.ifexiste
Cette option permet de choisir quelle action sera effectuée lorsqu'il y a
déjà au moins une remorque avec le même dans le message.

Les valeurs valides pour cette option sont : addIfDifferentNeighbor (c'est la valeur par défaut),
addIfDifferent, ajouter, écraser ou doNothing.

Avec addIfDifferentNeighbor, une nouvelle bande-annonce sera ajoutée uniquement si aucune bande-annonce avec le
même ( , ) la paire est au-dessus ou au-dessous de la ligne où la nouvelle bande-annonce sera
ajouté.

Avec addIfDifferent, une nouvelle bande-annonce sera ajoutée uniquement si aucune bande-annonce avec le même
( , ) la paire est déjà dans le message.

Avec add, une nouvelle bande-annonce sera ajoutée, même si certaines bandes-annonces avec le même ( ,
) sont déjà dans le message.

Avec remplacement, une remorque existante avec le même sera supprimé et le nouveau
une bande-annonce sera ajoutée. La bande-annonce supprimée sera la plus proche (avec le même
) à l'endroit où le nouveau sera ajouté.

Avec doNothing, rien ne sera fait ; c'est-à-dire qu'aucune nouvelle bande-annonce ne sera ajoutée s'il y a
déjà un avec le même dans le message.

bande-annonce.ifmissing
Cette option permet de choisir quelle action sera effectuée lorsqu'il y a
pas encore de remorque avec le même dans le message.

Les valeurs valides pour cette option sont : add (il s'agit de la valeur par défaut) et doNothing.

Avec add, une nouvelle bande-annonce sera ajoutée.

Avec doNothing, rien ne sera fait.

bande annonce. .clé
Cette clé sera utilisée à la place de dans la remorque. A la fin de cette clé, un
un séparateur peut apparaître suivi de quelques espaces. Par défaut le seul valide
le séparateur est :, mais cela peut être modifié à l'aide de la variable de configuration trailer.separators.

S'il y a un séparateur, la clé sera utilisée à la place des deux et le
séparateur par défaut lors de l'ajout de la bande-annonce.

bande annonce. .où
Cette option prend les mêmes valeurs que le remorque.où variable de configuration et il
remplace ce qui est spécifié par cette option pour les remorques avec le .

bande annonce. .ifexiste
Cette option prend les mêmes valeurs que le bande-annonce.ifexist variable de configuration et il
remplace ce qui est spécifié par cette option pour les remorques avec le .

bande annonce. .ifmissing
Cette option prend les mêmes valeurs que le bande-annonce.ifmissing variable de configuration et
il remplace ce qui est spécifié par cette option pour les remorques avec le spécifié .

bande annonce. .commander
Cette option peut être utilisée pour spécifier une commande shell qui sera appelée pour
ajouter ou modifier automatiquement une bande-annonce avec le .

Lorsque cette option est spécifiée, le comportement est comme si un =
argument ont été ajoutés au début de la ligne de commande, où est pris pour être
la sortie standard de la commande spécifiée avec tout espace blanc de début et de fin
coupé.

Si la commande contient la chaîne $ARG, cette chaîne sera remplacée par le
partie d'une remorque existante avec le même , le cas échéant, avant que la commande ne soit
lancé.

Si quelques = les arguments sont également passés sur la ligne de commande, lorsqu'un
bande annonce. .commander est configuré, la commande sera également exécutée pour chacun des
ces arguments. Et le une partie de ces arguments, le cas échéant, sera utilisée pour
remplacez la chaîne $ARG dans la commande.

EXEMPLES

· Configurer un signer remorque avec un Signé par clé, puis ajoutez deux de ces remorques
à un message :

$ git config trailer.sign.key "Signé par"
$ chat msg.txt
sujet

message
$ cat msg.txt | git interpret-trailers --trailer 'sign: Alice[email protected]>' --trailer ' signe : Bob[email protected]>'
sujet

message

Signé par : Alice[email protected]>
Signé par : Bob[email protected]>

· Extrayez le dernier commit en tant que patch et ajoutez un Cc et Revu par bande-annonce :

$ git format-correctif -1
0001-foo.patch
$ git interpret-trailers --trailer 'Cc: Alice[email protected]>' --trailer 'Commentaire par : Bob[email protected]>' 0001-foo.patch >0001-bar.patch

· Configurer un signer bande-annonce avec une commande pour ajouter automatiquement un « Signé par : » avec
les informations sur l'auteur uniquement s'il n'y a pas déjà de « Signé par : » et montrez comment cela
travaux:

$ git config trailer.sign.key « Signé par : »
$ git config trailer.sign.ifmissing ajouter
$ git config trailer.sign.ifexists ne fait rien
$ git config trailer.sign.command 'echo "$(git config user.name) <$(git config user.email)>"'
$ git interpret-trailers <
> EOF

Signé par : Bob[email protected]>
$ git interpret-trailers <
> Signé par : Alice[email protected]>
> EOF

Signé par : Alice[email protected]>

· Configurer un fixer remorque avec une clé qui contient un # et pas d'espace après ça
personnage, et montrez comment cela fonctionne :

$ git config trailer.separators ":#"
$ git config trailer.fix.key "Réparer #"
$ echo "sujet" | git interpret-trailers --trailer fix=42
sujet

Correction #42

· Configurer un sur le lien bande-annonce avec une commande pour afficher le sujet d'un commit qui est
liés, et montrez comment cela fonctionne :

$ git config trailer.see.key « Voir aussi : »
$ git config trailer.see.ifExists "remplacer"
$ 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-trailers <
> sujet
>
> message
>
> voir : TÊTE~2
> EOF
sujet

message

Voir aussi : fe3187489d69c4 (sujet du commit associé)

· Configurez un modèle de validation avec des bandes-annonces avec des valeurs vides (en utilisant sed pour afficher
et gardez les espaces de fin à la fin des bandes-annonces), puis configurez un commit-msg
crochet qui utilise jet interprète-remorques supprimer les remorques avec des valeurs vides et ajouter
a version git bande annonce:

$ sed -e 's/ Z$/ /' >commit_template.txt <
> ***sujet***
>
> ***message***
>
> Corrections : Z
> Cc : Z
> Révisé par : Z
> Signé par : 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.nouveau" "\$1"
> EOF
$ chmod +x .git/hooks/commit-msg

Utilisez git-interpret-trailers en ligne en utilisant les services onworks.net