doc: enforce placeholders in documentation
Any string that is not meant to be used verbatim in the documentation should be marked as a placeholder. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
Dec 25, 2023 at 21:21 UTC
51e846e673ca749273534d063082627a561f7622
5 files changed
+9
-9
Documentation/diff-options.txt
+1
-1
@@ -299,7 +299,7 @@ and accumulating child directory counts in the parent directories:
299
Synonym for --dirstat=cumulative
300
301
--dirstat-by-file[=<param1,param2>...]::
302
- Synonym for --dirstat=files,param1,param2...
302
+ Synonym for --dirstat=files,<param1>,<param2>...
303
304
--summary::
305
Output a condensed summary of extended header information
Documentation/git-config.txt
+4
-4
@@ -103,11 +103,11 @@ OPTIONS
103
names are not.
104
105
--get-urlmatch <name> <URL>::
106
- When given a two-part name section.key, the value for
107
- section.<URL>.key whose <URL> part matches the best to the
106
+ When given a two-part <name> as <section>.<key>, the value for
107
+ <section>.<URL>.<key> whose <URL> part matches the best to the
108
given URL is returned (if no such key exists, the value for
109
- section.key is used as a fallback). When given just the
110
- section as name, do so for all the keys in the section and
109
+ <section>.<key> is used as a fallback). When given just the
110
+ <section> as name, do so for all the keys in the section and
111
list them. Returns error code 1 if no value is found.
112
113
--global::
Documentation/git-daemon.txt
+2
-2
@@ -141,8 +141,8 @@ otherwise `stderr`.
141
specified with no parameter, a request to
142
git://host/{tilde}alice/foo is taken as a request to access
143
'foo' repository in the home directory of user `alice`.
144
- If `--user-path=path` is specified, the same request is
145
- taken as a request to access `path/foo` repository in
144
+ If `--user-path=<path>` is specified, the same request is
145
+ taken as a request to access `<path>/foo` repository in
146
the home directory of user `alice`.
147
148
--verbose::
Documentation/git-difftool.txt
+1
-1
@@ -90,7 +90,7 @@ instead. `--no-symlinks` is the default on Windows.
90
--extcmd=<command>::
91
Specify a custom command for viewing diffs.
92
'git-difftool' ignores the configured defaults and runs
93
- `$command $LOCAL $REMOTE` when this option is specified.
93
+ `<command> $LOCAL $REMOTE` when this option is specified.
94
Additionally, `$BASE` is set in the environment.
95
96
-g::
Documentation/git.txt
+1
-1
@@ -202,7 +202,7 @@ If you just want to run git as if it was started in `<path>` then use
202
Do not perform optional operations that require locks. This is
203
equivalent to setting the `GIT_OPTIONAL_LOCKS` to `0`.
204
205
---list-cmds=group[,group...]::
205
+--list-cmds=<group>[,<group>...]::
206
List commands by group. This is an internal/experimental
207
option and may change or be removed in the future. Supported
208
groups are: builtins, parseopt (builtin commands that use