Skip to content

Commit 51e846e

Browse files
jnavilagitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 2162f9f commit 51e846e

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

Documentation/diff-options.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ and accumulating child directory counts in the parent directories:
299299
Synonym for --dirstat=cumulative
300300

301301
--dirstat-by-file[=<param1,param2>...]::
302-
Synonym for --dirstat=files,param1,param2...
302+
Synonym for --dirstat=files,<param1>,<param2>...
303303

304304
--summary::
305305
Output a condensed summary of extended header information

Documentation/git-config.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,11 @@ OPTIONS
103103
names are not.
104104

105105
--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
108108
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
111111
list them. Returns error code 1 if no value is found.
112112

113113
--global::

Documentation/git-daemon.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ otherwise `stderr`.
141141
specified with no parameter, a request to
142142
git://host/{tilde}alice/foo is taken as a request to access
143143
'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
146146
the home directory of user `alice`.
147147

148148
--verbose::

Documentation/git-difftool.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ instead. `--no-symlinks` is the default on Windows.
9090
--extcmd=<command>::
9191
Specify a custom command for viewing diffs.
9292
'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.
9494
Additionally, `$BASE` is set in the environment.
9595

9696
-g::

Documentation/git.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ If you just want to run git as if it was started in `<path>` then use
202202
Do not perform optional operations that require locks. This is
203203
equivalent to setting the `GIT_OPTIONAL_LOCKS` to `0`.
204204

205-
--list-cmds=group[,group...]::
205+
--list-cmds=<group>[,<group>...]::
206206
List commands by group. This is an internal/experimental
207207
option and may change or be removed in the future. Supported
208208
groups are: builtins, parseopt (builtin commands that use

0 commit comments

Comments
 (0)