Signed-off-by: Christian Couder <chrisc...@tuxfamily.org> --- Documentation/git-interpret-trailers.txt | 98 +++++++++++++++++++++++++++++++- 1 file changed, 97 insertions(+), 1 deletion(-)
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt index 450ec54..42c2f71 100644 --- a/Documentation/git-interpret-trailers.txt +++ b/Documentation/git-interpret-trailers.txt @@ -134,9 +134,105 @@ If the command contains the `$ARG` string, this string will be replaced with the <value> part of an existing trailer with the same <token>, if any, before the command is launched. +EXAMPLES +-------- + +* Configure a 'sign' trailer with a 'Signed-off-by: ' key, and then + add two of these trailers to a message: ++ +------------ +$ git config trailer.sign.key "Signed-off-by: " +$ cat msg.txt +subject + +message +$ cat msg.txt | git interpret-trailers --trailer 'sign: Alice <al...@example.com>' --trailer 'sign: Bob <b...@example.com>' +subject + +message + +Signed-off-by: Alice <al...@example.com> +Signed-off-by: Bob <b...@example.com> +------------ + +* Extract the last commit as a patch, and add a 'Cc' and a + 'Reviewed-by' trailer to it: ++ +------------ +$ git format-patch -1 +0001-foo.patch +$ git interpret-trailers --trailer 'Cc: Alice <al...@example.com>' --trailer 'Reviewed-by: Bob <b...@example.com>' 0001-foo.patch >0001-bar.patch +------------ + +* Configure a 'sign' trailer with a command to automatically add a + 'Signed-off-by: ' with the author information only if there is no + 'Signed-off-by: ' already, and show how it works: ++ +------------ +$ git config trailer.sign.key "Signed-off-by: " +$ git config trailer.sign.ifmissing add +$ git config trailer.sign.ifexists doNothing +$ git config trailer.sign.command 'echo "$(git config user.name) <$(git config user.email)>"' +$ git interpret-trailers <<EOF +> EOF + +Signed-off-by: Bob <b...@example.com> +$ git interpret-trailers <<EOF +> Signed-off-by: Alice <al...@example.com> +> EOF + +Signed-off-by: Alice <al...@example.com> +------------ + +* Configure a 'fix' trailer with a command to show the subject of a + commit that is fixed, and show how it works: ++ +------------ +$ git config trailer.fix.key "Fixes #" +$ git config trailer.fix.ifExists "overwrite" +$ git config trailer.fix.command "git log -1 --oneline --format=\"%h (%s)\" --abbrev-commit --abbrev=14 \$ARG" +$ git interpret-trailers <<EOF +> subject +> +> message +> +> fix: HEAD~2 +> EOF +subject + +message + +Fixes #fe3187489d69c4 (subject of fixed commit) +------------ + +* Configure a commit template with some trailers with empty values, + then configure a commit-msg hook that uses git interpret-trailers to + remove trailers with empty values and to add a 'git-version' + trailer: ++ +------------ +$ cat >commit_template.txt <<EOF +> ***subject*** +> +> ***message*** +> +> Fixes: +> Cc: +> Reviewed-by: +> Signed-off-by: +> EOF +$ git config commit.template commit_template.txt +$ cat >.git/hooks/commit-msg <<EOF +#!/bin/sh +git interpret-trailers --trim-empty --trailer "git-version: \$(git describe)" "\$1" > "\$1.new" +mv "\$1.new" "\$1" +EOF +$ chmod +x .git/hooks/commit-msg +------------ + SEE ALSO -------- -linkgit:git-commit[1] +linkgit:git-commit[1], linkgit:git-format-patch[1], linkgit:git-config[1] GIT --- -- 1.9.rc0.17.g651113e -- To unsubscribe from this list: send the line "unsubscribe git" in the body of a message to majord...@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html
