diff options
author | Junio C Hamano <gitster@pobox.com> | 2021-04-07 16:54:08 -0700 |
---|---|---|
committer | Junio C Hamano <gitster@pobox.com> | 2021-04-07 16:54:08 -0700 |
commit | 68e15e0c231bfa50e254fc87d054649161a7e301 (patch) | |
tree | 0706474cce507f7bb5fcce4f9a8f612a095f35c8 /Documentation | |
parent | Merge branch 'js/cmake-vsbuild' (diff) | |
parent | commit: add --trailer option (diff) | |
download | tgif-68e15e0c231bfa50e254fc87d054649161a7e301.tar.xz |
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')
-rw-r--r-- | Documentation/git-commit.txt | 14 |
1 files changed, 13 insertions, 1 deletions
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt index 3c69f461c9..340c5fbb48 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. |