doc: fix some placeholders formating
Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Acked-by: Taylor Blau <me@ttaylorr.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
Mar 16, 2024 at 15:21 UTC
67471bc704434412b367b570ad330330354598ed
4 files changed
+8
-8
Documentation/git-interpret-trailers.txt
+3
-3
@@ -9,7 +9,7 @@ SYNOPSIS
9
--------
10
[verse]
11
'git interpret-trailers' [--in-place] [--trim-empty]
12
- [(--trailer (<key>|<keyAlias>)[(=|:)<value>])...]
12
+ [(--trailer (<key>|<key-alias>)[(=|:)<value>])...]
13
[--parse] [<file>...]
14
15
DESCRIPTION
@@ -67,9 +67,9 @@ key: value
67
This means that the trimmed <key> and <value> will be separated by
68
`': '` (one colon followed by one space).
69
70
-For convenience, a <keyAlias> can be configured to make using `--trailer`
70
+For convenience, a <key-alias> can be configured to make using `--trailer`
71
shorter to type on the command line. This can be configured using the
72
-'trailer.<keyAlias>.key' configuration variable. The <keyAlias> must be a prefix
72
+'trailer.<key-alias>.key' configuration variable. The <keyAlias> must be a prefix
73
of the full <key> string, although case sensitivity does not matter. For
74
example, if you have
75
Documentation/git.txt
+1
-1
@@ -942,7 +942,7 @@ will never be returned from the commit-graph at the cost of performance.
942
`GIT_PROTOCOL`::
943
For internal use only. Used in handshaking the wire protocol.
944
Contains a colon ':' separated list of keys with optional values
945
- 'key[=value]'. Presence of unknown keys and values must be
945
+ '<key>[=<value>]'. Presence of unknown keys and values must be
946
ignored.
947
+
948
Note that servers may need to be configured to allow this variable to
Documentation/rev-list-options.txt
+3
-3
@@ -316,12 +316,12 @@ list.
316
With `--pretty` format other than `oneline` and `reference` (for obvious reasons),
317
this causes the output to have two extra lines of information
318
taken from the reflog. The reflog designator in the output may be shown
319
-as `ref@{Nth}` (where `Nth` is the reverse-chronological index in the
320
-reflog) or as `ref@{timestamp}` (with the timestamp for that entry),
319
+as `ref@{<Nth>}` (where _<Nth>_ is the reverse-chronological index in the
320
+reflog) or as `ref@{<timestamp>}` (with the _<timestamp>_ for that entry),
321
depending on a few rules:
322
+
323
--
324
-1. If the starting point is specified as `ref@{Nth}`, show the index
324
+1. If the starting point is specified as `ref@{<Nth>}`, show the index
325
format.
326
+
327
2. If the starting point was specified as `ref@{now}`, show the
builtin/interpret-trailers.c
+1
-1
@@ -14,7 +14,7 @@
14
15
static const char * const git_interpret_trailers_usage[] = {
16
N_("git interpret-trailers [--in-place] [--trim-empty]\n"
17
- " [(--trailer (<key>|<keyAlias>)[(=|:)<value>])...]\n"
17
+ " [(--trailer (<key>|<key-alias>)[(=|:)<value>])...]\n"
18
" [--parse] [<file>...]"),
19
NULL
20
};