]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: fix some placeholders formating
authorJean-Noël Avila <jn.avila@free.fr>
Sat, 16 Mar 2024 15:21:41 +0000 (15:21 +0000)
committerJunio C Hamano <gitster@pobox.com>
Sat, 16 Mar 2024 17:04:53 +0000 (10:04 -0700)
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>
Documentation/git-interpret-trailers.txt
Documentation/git.txt
Documentation/rev-list-options.txt
builtin/interpret-trailers.c

index 418265f044d65000e9ae22235b9801644f9c2170..d9dfb75fef525f4a8379e0c52a78e2642e843858 100644 (file)
@@ -9,7 +9,7 @@ SYNOPSIS
 --------
 [verse]
 'git interpret-trailers' [--in-place] [--trim-empty]
-                       [(--trailer (<key>|<keyAlias>)[(=|:)<value>])...]
+                       [(--trailer (<key>|<key-alias>)[(=|:)<value>])...]
                        [--parse] [<file>...]
 
 DESCRIPTION
@@ -67,9 +67,9 @@ key: value
 This means that the trimmed <key> and <value> will be separated by
 `': '` (one colon followed by one space).
 
-For convenience, a <keyAlias> can be configured to make using `--trailer`
+For convenience, a <key-alias> can be configured to make using `--trailer`
 shorter to type on the command line. This can be configured using the
-'trailer.<keyAlias>.key' configuration variable. The <keyAlias> must be a prefix
+'trailer.<key-alias>.key' configuration variable. The <keyAlias> must be a prefix
 of the full <key> string, although case sensitivity does not matter. For
 example, if you have
 
index 0d25224c9696942b797d64895d98bbcdd80db62a..b0c05bbd0d2d143ce4682a3bdac21756c0e63315 100644 (file)
@@ -942,7 +942,7 @@ will never be returned from the commit-graph at the cost of performance.
 `GIT_PROTOCOL`::
        For internal use only.  Used in handshaking the wire protocol.
        Contains a colon ':' separated list of keys with optional values
-       'key[=value]'.  Presence of unknown keys and values must be
+       '<key>[=<value>]'.  Presence of unknown keys and values must be
        ignored.
 +
 Note that servers may need to be configured to allow this variable to
index a583b52c612aece1f7d1fd24086c0f7961eecceb..1bfc9270f75957023b5a313842904c53cb1200d8 100644 (file)
@@ -316,12 +316,12 @@ list.
 With `--pretty` format other than `oneline` and `reference` (for obvious reasons),
 this causes the output to have two extra lines of information
 taken from the reflog.  The reflog designator in the output may be shown
-as `ref@{Nth}` (where `Nth` is the reverse-chronological index in the
-reflog) or as `ref@{timestamp}` (with the timestamp for that entry),
+as `ref@{<Nth>}` (where _<Nth>_ is the reverse-chronological index in the
+reflog) or as `ref@{<timestamp>}` (with the _<timestamp>_ for that entry),
 depending on a few rules:
 +
 --
-1. If the starting point is specified as `ref@{Nth}`, show the index
+1. If the starting point is specified as `ref@{<Nth>}`, show the index
    format.
 +
 2. If the starting point was specified as `ref@{now}`, show the
index 033bd1556cf9f8d6e56c2730a3e868500388144e..582ace8966b03423b5a99d8fe0739d6e307a9278 100644 (file)
@@ -14,7 +14,7 @@
 
 static const char * const git_interpret_trailers_usage[] = {
        N_("git interpret-trailers [--in-place] [--trim-empty]\n"
-          "                       [(--trailer (<key>|<keyAlias>)[(=|:)<value>])...]\n"
+          "                       [(--trailer (<key>|<key-alias>)[(=|:)<value>])...]\n"
           "                       [--parse] [<file>...]"),
        NULL
 };