aboutsummaryrefslogtreecommitdiff
path: root/builtin
diff options
context:
space:
mode:
authorLinus Arver <linusa@google.com>2023-09-07 22:20:09 +0000
committerJunio C Hamano <gitster@pobox.com>2023-09-07 23:04:44 -0700
commit6ccbc6679426e39720278aedbb8e415dac8db79b (patch)
tree292e858e1b13ccf9c4537491bbfcda0e49bd015a /builtin
parentab76661f221807b0c8d71ed7acb259575205f4e9 (diff)
downloadgit-6ccbc6679426e39720278aedbb8e415dac8db79b.tar.xz
trailer doc: <token> is a <key> or <keyAlias>, not both
The `--trailer` option takes a "<token>=<value>" argument, for example --trailer "Acked-by=Bob" And in this exampple it is understood that "Acked-by" is the <token>. However, the user can use a shorter "ack" string by defining configuration like git config trailer.ack.key "Acked-by" However, in the docs we define the above configuration as trailer.<token>.key so the <token> can mean either the longer "Acked-by" or the shorter "ack". Separate the two meanings of <token> into <key> and <keyAlias>, and update the configuration syntax to say "trailer.<keyAlias>.key". Signed-off-by: Linus Arver <linusa@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'builtin')
-rw-r--r--builtin/interpret-trailers.c2
1 files changed, 1 insertions, 1 deletions
diff --git a/builtin/interpret-trailers.c b/builtin/interpret-trailers.c
index 832f86a770..d2d78fd961 100644
--- a/builtin/interpret-trailers.c
+++ b/builtin/interpret-trailers.c
@@ -14,7 +14,7 @@
static const char * const git_interpret_trailers_usage[] = {
N_("git interpret-trailers [--in-place] [--trim-empty]\n"
- " [(--trailer <token>[(=|:)<value>])...]\n"
+ " [(--trailer (<key>|<keyAlias>)[(=|:)<value>])...]\n"
" [--parse] [<file>...]"),
NULL
};