summaryrefslogtreecommitdiff
path: root/Documentation/git-commit.txt
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2021-04-07 23:54:08 (GMT)
committerJunio C Hamano <gitster@pobox.com>2021-04-07 23:54:08 (GMT)
commit68e15e0c231bfa50e254fc87d054649161a7e301 (patch)
tree0706474cce507f7bb5fcce4f9a8f612a095f35c8 /Documentation/git-commit.txt
parenta548f3e0adb55ecee0517f5ebdc109074c0c1d5c (diff)
parent2daae3d1d1bf513f1e1c00f1e4df75e1cb500e0f (diff)
downloadgit-68e15e0c231bfa50e254fc87d054649161a7e301.zip
git-68e15e0c231bfa50e254fc87d054649161a7e301.tar.gz
git-68e15e0c231bfa50e254fc87d054649161a7e301.tar.bz2
Merge branch 'zh/commit-trailer'
"git commit" learned "--trailer <key>[=<value>]" option; together with the interpret-trailers command, this will make it easier to support custom trailers. * zh/commit-trailer: commit: add --trailer option
Diffstat (limited to 'Documentation/git-commit.txt')
-rw-r--r--Documentation/git-commit.txt14
1 files changed, 13 insertions, 1 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 3c69f46..340c5fb 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -14,7 +14,8 @@ SYNOPSIS
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
[--date=<date>] [--cleanup=<mode>] [--[no-]status]
[-i | -o] [--pathspec-from-file=<file> [--pathspec-file-nul]]
- [-S[<keyid>]] [--] [<pathspec>...]
+ [(--trailer <token>[(=|:)<value>])...] [-S[<keyid>]]
+ [--] [<pathspec>...]
DESCRIPTION
-----------
@@ -199,6 +200,17 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.
include::signoff-option.txt[]
+--trailer <token>[(=|:)<value>]::
+ Specify a (<token>, <value>) pair that should be applied as a
+ trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \
+ <committer@example.com>" --trailer "Helped-by:C O Mitter \
+ <committer@example.com>"` will add the "Signed-off-by" trailer
+ and the "Helped-by" trailer to the commit message.)
+ The `trailer.*` configuration variables
+ (linkgit:git-interpret-trailers[1]) can be used to define if
+ a duplicated trailer is omitted, where in the run of trailers
+ each trailer would appear, and other details.
+
-n::
--no-verify::
This option bypasses the pre-commit and commit-msg hooks.