doc: use only hyphens as word separators in placeholders
According to CodingGuidelines, multi-word placeholders should use hyphens as word separators. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com> Reviewed-by: Eli Schwartz <eschwartz@archlinux.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jean-Noël Avila committed
Nov 6, 2021 at 19:48 UTC
133db54dabd2174960d4a7449a1a7ed574ea0ad3
14 files changed
+76
-76
Documentation/date-formats.txt
+3
-3
@@ -5,9 +5,9 @@ The `GIT_AUTHOR_DATE` and `GIT_COMMITTER_DATE` environment variables
5
support the following date formats:
6
7
Git internal format::
8
- It is `<unix timestamp> <time zone offset>`, where `<unix
9
- timestamp>` is the number of seconds since the UNIX epoch.
10
- `<time zone offset>` is a positive or negative offset from UTC.
8
+ It is `<unix-timestamp> <time-zone-offset>`, where
9
+ `<unix-timestamp>` is the number of seconds since the UNIX epoch.
10
+ `<time-zone-offset>` is a positive or negative offset from UTC.
11
For example CET (which is 1 hour ahead of UTC) is `+0100`.
12
13
RFC 2822::
Documentation/git-checkout.txt
+18
-18
@@ -11,7 +11,7 @@ SYNOPSIS
11
'git checkout' [-q] [-f] [-m] [<branch>]
12
'git checkout' [-q] [-f] [-m] --detach [<branch>]
13
'git checkout' [-q] [-f] [-m] [--detach] <commit>
14
-'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>]
14
+'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new-branch>] [<start-point>]
15
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...
16
'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]
17
'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]
@@ -43,7 +43,7 @@ You could omit `<branch>`, in which case the command degenerates to
43
rather expensive side-effects to show only the tracking information,
44
if exists, for the current branch.
45
46
-'git checkout' -b|-B <new_branch> [<start point>]::
46
+'git checkout' -b|-B <new-branch> [<start-point>]::
47
48
Specifying `-b` causes a new branch to be created as if
49
linkgit:git-branch[1] were called and then checked out. In
@@ -52,11 +52,11 @@ if exists, for the current branch.
52
`--track` without `-b` implies branch creation; see the
53
description of `--track` below.
54
+
55
-If `-B` is given, `<new_branch>` is created if it doesn't exist; otherwise, it
55
+If `-B` is given, `<new-branch>` is created if it doesn't exist; otherwise, it
56
is reset. This is the transactional equivalent of
57
+
58
------------
59
-$ git branch -f <branch> [<start point>]
59
+$ git branch -f <branch> [<start-point>]
60
$ git checkout <branch>
61
------------
62
+
@@ -144,13 +144,13 @@ as `ours` (i.e. "our shared canonical history"), while what you did
144
on your side branch as `theirs` (i.e. "one contributor's work on top
145
of it").
146
147
--b <new_branch>::
148
- Create a new branch named `<new_branch>` and start it at
149
- `<start_point>`; see linkgit:git-branch[1] for details.
147
+-b <new-branch>::
148
+ Create a new branch named `<new-branch>` and start it at
149
+ `<start-point>`; see linkgit:git-branch[1] for details.
150
151
--B <new_branch>::
152
- Creates the branch `<new_branch>` and start it at `<start_point>`;
153
- if it already exists, then reset it to `<start_point>`. This is
151
+-B <new-branch>::
152
+ Creates the branch `<new-branch>` and start it at `<start-point>`;
153
+ if it already exists, then reset it to `<start-point>`. This is
154
equivalent to running "git branch" with "-f"; see
155
linkgit:git-branch[1] for details.
156
@@ -209,16 +209,16 @@ variable.
209
`<commit>` is not a branch name. See the "DETACHED HEAD" section
210
below for details.
211
212
---orphan <new_branch>::
213
- Create a new 'orphan' branch, named `<new_branch>`, started from
214
- `<start_point>` and switch to it. The first commit made on this
212
+--orphan <new-branch>::
213
+ Create a new 'orphan' branch, named `<new-branch>`, started from
214
+ `<start-point>` and switch to it. The first commit made on this
215
new branch will have no parents and it will be the root of a new
216
history totally disconnected from all the other branches and
217
commits.
218
+
219
The index and the working tree are adjusted as if you had previously run
220
-`git checkout <start_point>`. This allows you to start a new history
221
-that records a set of paths similar to `<start_point>` by easily running
220
+`git checkout <start-point>`. This allows you to start a new history
221
+that records a set of paths similar to `<start-point>` by easily running
222
`git commit -a` to make the root commit.
223
+
224
This can be useful when you want to publish the tree from a commit
@@ -228,7 +228,7 @@ whose full history contains proprietary or otherwise encumbered bits of
228
code.
229
+
230
If you want to start a disconnected history that records a set of paths
231
-that is totally different from the one of `<start_point>`, then you should
231
+that is totally different from the one of `<start-point>`, then you should
232
clear the index and the working tree right after creating the orphan
233
branch by running `git rm -rf .` from the top level of the working tree.
234
Afterwards you will be ready to prepare your new files, repopulating the
@@ -340,10 +340,10 @@ As a special case, you may use `A...B` as a shortcut for the
340
merge base of `A` and `B` if there is exactly one merge base. You can
341
leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
342
343
-<new_branch>::
343
+<new-branch>::
344
Name for the new branch.
345
346
-<start_point>::
346
+<start-point>::
347
The name of a commit at which to start the new branch; see
348
linkgit:git-branch[1] for details. Defaults to `HEAD`.
349
+
Documentation/git-clone.txt
+4
-4
@@ -9,10 +9,10 @@ git-clone - Clone a repository into a new directory
9
SYNOPSIS
10
--------
11
[verse]
12
-'git clone' [--template=<template_directory>]
12
+'git clone' [--template=<template-directory>]
13
[-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
14
[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
15
- [--dissociate] [--separate-git-dir <git dir>]
15
+ [--dissociate] [--separate-git-dir <git-dir>]
16
[--depth <depth>] [--[no-]single-branch] [--no-tags]
17
[--recurse-submodules[=<pathspec>]] [--[no-]shallow-submodules]
18
[--[no-]remote-submodules] [--jobs <n>] [--sparse] [--[no-]reject-shallow]
@@ -211,7 +211,7 @@ objects from the source repository into a pack in the cloned repository.
211
via ssh, this specifies a non-default path for the command
212
run on the other end.
213
214
---template=<template_directory>::
214
+--template=<template-directory>::
215
Specify the directory from which templates will be used;
216
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
217
@@ -294,7 +294,7 @@ or `--mirror` is given)
294
superproject's recorded SHA-1. Equivalent to passing `--remote` to
295
`git submodule update`.
296
297
---separate-git-dir=<git dir>::
297
+--separate-git-dir=<git-dir>::
298
Instead of placing the cloned repository where it is supposed
299
to be, place the cloned repository at the specified directory,
300
then make a filesystem-agnostic Git symbolic link to there.
Documentation/git-cvsimport.txt
+4
-4
@@ -11,9 +11,9 @@ SYNOPSIS
11
[verse]
12
'git cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>]
13
[-A <author-conv-file>] [-p <options-for-cvsps>] [-P <file>]
14
- [-C <git_repository>] [-z <fuzz>] [-i] [-k] [-u] [-s <subst>]
15
- [-a] [-m] [-M <regex>] [-S <regex>] [-L <commitlimit>]
16
- [-r <remote>] [-R] [<CVS_module>]
14
+ [-C <git-repository>] [-z <fuzz>] [-i] [-k] [-u] [-s <subst>]
15
+ [-a] [-m] [-M <regex>] [-S <regex>] [-L <commit-limit>]
16
+ [-r <remote>] [-R] [<CVS-module>]
17
18
19
DESCRIPTION
@@ -59,7 +59,7 @@ OPTIONS
59
from `CVS/Root`. If no such file exists, it checks for the
60
`CVSROOT` environment variable.
61
62
-<CVS_module>::
62
+<CVS-module>::
63
The CVS module you want to import. Relative to <CVSROOT>.
64
If not given, 'git cvsimport' tries to read it from
65
`CVS/Repository`.
Documentation/git-diff-files.txt
+1
-1
@@ -9,7 +9,7 @@ git-diff-files - Compares files in the working tree and the index
9
SYNOPSIS
10
--------
11
[verse]
12
-'git diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>...]
12
+'git diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common-diff-options>] [<path>...]
13
14
DESCRIPTION
15
-----------
Documentation/git-diff-index.txt
+1
-1
@@ -9,7 +9,7 @@ git-diff-index - Compare a tree to the working tree or index
9
SYNOPSIS
10
--------
11
[verse]
12
-'git diff-index' [-m] [--cached] [--merge-base] [<common diff options>] <tree-ish> [<path>...]
12
+'git diff-index' [-m] [--cached] [--merge-base] [<common-diff-options>] <tree-ish> [<path>...]
13
14
DESCRIPTION
15
-----------
Documentation/git-diff-tree.txt
+1
-1
@@ -11,7 +11,7 @@ SYNOPSIS
11
[verse]
12
'git diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty]
13
[-t] [-r] [-c | --cc] [--combined-all-paths] [--root] [--merge-base]
14
- [<common diff options>] <tree-ish> [<tree-ish>] [<path>...]
14
+ [<common-diff-options>] <tree-ish> [<tree-ish>] [<path>...]
15
16
DESCRIPTION
17
-----------
Documentation/git-init-db.txt
+1
-1
@@ -9,7 +9,7 @@ git-init-db - Creates an empty Git repository
9
SYNOPSIS
10
--------
11
[verse]
12
-'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>] [--separate-git-dir <git dir>] [--shared[=<permissions>]]
12
+'git init-db' [-q | --quiet] [--bare] [--template=<template-directory>] [--separate-git-dir <git-dir>] [--shared[=<permissions>]]
13
14
15
DESCRIPTION
Documentation/git-init.txt
+4
-4
@@ -9,8 +9,8 @@ git-init - Create an empty Git repository or reinitialize an existing one
9
SYNOPSIS
10
--------
11
[verse]
12
-'git init' [-q | --quiet] [--bare] [--template=<template_directory>]
13
- [--separate-git-dir <git dir>] [--object-format=<format>]
12
+'git init' [-q | --quiet] [--bare] [--template=<template-directory>]
13
+ [--separate-git-dir <git-dir>] [--object-format=<format>]
14
[-b <branch-name> | --initial-branch=<branch-name>]
15
[--shared[=<permissions>]] [<directory>]
16
@@ -57,12 +57,12 @@ values are 'sha1' and (if enabled) 'sha256'. 'sha1' is the default.
57
+
58
include::object-format-disclaimer.txt[]
59
60
---template=<template_directory>::
60
+--template=<template-directory>::
61
62
Specify the directory from which templates will be used. (See the "TEMPLATE
63
DIRECTORY" section below.)
64
65
---separate-git-dir=<git dir>::
65
+--separate-git-dir=<git-dir>::
66
67
Instead of initializing the repository as a directory to either `$GIT_DIR` or
68
`./.git/`, create a text file there containing the path to the actual
Documentation/git-log.txt
+4
-4
@@ -9,7 +9,7 @@ git-log - Show commit logs
9
SYNOPSIS
10
--------
11
[verse]
12
-'git log' [<options>] [<revision range>] [[--] <path>...]
12
+'git log' [<options>] [<revision-range>] [[--] <path>...]
13
14
DESCRIPTION
15
-----------
@@ -81,13 +81,13 @@ produced by `--stat`, etc.
81
82
include::line-range-options.txt[]
83
84
-<revision range>::
84
+<revision-range>::
85
Show only commits in the specified revision range. When no
86
- <revision range> is specified, it defaults to `HEAD` (i.e. the
86
+ <revision-range> is specified, it defaults to `HEAD` (i.e. the
87
whole history leading to the current commit). `origin..HEAD`
88
specifies all the commits reachable from the current commit
89
(i.e. `HEAD`), but not from `origin`. For a complete list of
90
- ways to spell <revision range>, see the 'Specifying Ranges'
90
+ ways to spell <revision-range>, see the 'Specifying Ranges'
91
section of linkgit:gitrevisions[7].
92
93
[--] <path>...::
Documentation/git-p4.txt
+3
-3
@@ -9,10 +9,10 @@ git-p4 - Import from and submit to Perforce repositories
9
SYNOPSIS
10
--------
11
[verse]
12
-'git p4 clone' [<sync options>] [<clone options>] <p4 depot path>...
13
-'git p4 sync' [<sync options>] [<p4 depot path>...]
12
+'git p4 clone' [<sync-options>] [<clone-options>] <p4-depot-path>...
13
+'git p4 sync' [<sync-options>] [<p4-depot-path>...]
14
'git p4 rebase'
15
-'git p4 submit' [<submit options>] [<master branch name>]
15
+'git p4 submit' [<submit-options>] [<master-branch-name>]
16
17
18
DESCRIPTION
Documentation/git-shortlog.txt
+4
-4
@@ -8,7 +8,7 @@ git-shortlog - Summarize 'git log' output
8
SYNOPSIS
9
--------
10
[verse]
11
-'git shortlog' [<options>] [<revision range>] [[--] <path>...]
11
+'git shortlog' [<options>] [<revision-range>] [[--] <path>...]
12
git log --pretty=short | 'git shortlog' [<options>]
13
14
DESCRIPTION
@@ -89,13 +89,13 @@ counts both authors and co-authors.
89
If width is `0` (zero) then indent the lines of the output without wrapping
90
them.
91
92
-<revision range>::
92
+<revision-range>::
93
Show only commits in the specified revision range. When no
94
- <revision range> is specified, it defaults to `HEAD` (i.e. the
94
+ <revision-range> is specified, it defaults to `HEAD` (i.e. the
95
whole history leading to the current commit). `origin..HEAD`
96
specifies all the commits reachable from the current commit
97
(i.e. `HEAD`), but not from `origin`. For a complete list of
98
- ways to spell <revision range>, see the "Specifying Ranges"
98
+ ways to spell <revision-range>, see the "Specifying Ranges"
99
section of linkgit:gitrevisions[7].
100
101
[--] <path>...::
Documentation/git-svn.txt
+1
-1
@@ -575,7 +575,7 @@ OPTIONS
575
-------
576
577
--shared[=(false|true|umask|group|all|world|everybody)]::
578
---template=<template_directory>::
578
+--template=<template-directory>::
579
Only used with the 'init' command.
580
These are passed directly to 'git init'.
581
Documentation/pretty-formats.txt
+27
-27
@@ -20,7 +20,7 @@ built-in formats:
20
21
* 'oneline'
22
23
- <hash> <title line>
23
+ <hash> <title-line>
24
+
25
This is designed to be as compact as possible.
26
@@ -29,17 +29,17 @@ This is designed to be as compact as possible.
29
commit <hash>
30
Author: <author>
31
32
- <title line>
32
+ <title-line>
33
34
* 'medium'
35
36
commit <hash>
37
Author: <author>
38
- Date: <author date>
38
+ Date: <author-date>
39
40
- <title line>
40
+ <title-line>
41
42
- <full commit message>
42
+ <full-commit-message>
43
44
* 'full'
45
@@ -47,25 +47,25 @@ This is designed to be as compact as possible.
47
Author: <author>
48
Commit: <committer>
49
50
- <title line>
50
+ <title-line>
51
52
- <full commit message>
52
+ <full-commit-message>
53
54
* 'fuller'
55
56
commit <hash>
57
Author: <author>
58
- AuthorDate: <author date>
58
+ AuthorDate: <author-date>
59
Commit: <committer>
60
- CommitDate: <committer date>
60
+ CommitDate: <committer-date>
61
62
- <title line>
62
+ <title-line>
63
64
- <full commit message>
64
+ <full-commit-message>
65
66
* 'reference'
67
68
- <abbrev hash> (<title line>, <short author date>)
68
+ <abbrev-hash> (<title-line>, <short-author-date>)
69
+
70
This format is used to refer to another commit in a commit message and
71
is the same as `--pretty='format:%C(auto)%h (%s, %ad)'`. By default,
@@ -78,10 +78,10 @@ placeholders, its output is not affected by other options like
78
79
From <hash> <date>
80
From: <author>
81
- Date: <author date>
82
- Subject: [PATCH] <title line>
81
+ Date: <author-date>
82
+ Subject: [PATCH] <title-line>
83
84
- <full commit message>
84
+ <full-commit-message>
85
86
* 'mboxrd'
87
+
@@ -101,9 +101,9 @@ commits are displayed, but not the way the diff is shown e.g. with
101
`git log --raw`. To get full object names in a raw diff format,
102
use `--no-abbrev`.
103
104
-* 'format:<string>'
104
+* 'format:<format-string>'
105
+
106
-The 'format:<string>' format allows you to specify which information
106
+The 'format:<format-string>' format allows you to specify which information
107
you want to show. It works a little bit like printf format,
108
with the notable exception that you get a newline with '%n'
109
instead of '\n'.
@@ -273,12 +273,12 @@ endif::git-rev-list[]
273
If any option is provided multiple times the
274
last occurrence wins.
275
+
276
-The boolean options accept an optional value `[=<BOOL>]`. The values
276
+The boolean options accept an optional value `[=<value>]`. The values
277
`true`, `false`, `on`, `off` etc. are all accepted. See the "boolean"
278
sub-section in "EXAMPLES" in linkgit:git-config[1]. If a boolean
279
option is given with no value, it's enabled.
280
+
281
-** 'key=<K>': only show trailers with specified key. Matching is done
281
+** 'key=<key>': only show trailers with specified <key>. Matching is done
282
case-insensitively and trailing colon is optional. If option is
283
given multiple times trailer lines matching any of the keys are
284
shown. This option automatically enables the `only` option so that
@@ -286,25 +286,25 @@ option is given with no value, it's enabled.
286
desired it can be disabled with `only=false`. E.g.,
287
`%(trailers:key=Reviewed-by)` shows trailer lines with key
288
`Reviewed-by`.
289
-** 'only[=<BOOL>]': select whether non-trailer lines from the trailer
289
+** 'only[=<bool>]': select whether non-trailer lines from the trailer
290
block should be included.
291
-** 'separator=<SEP>': specify a separator inserted between trailer
291
+** 'separator=<sep>': specify a separator inserted between trailer
292
lines. When this option is not given each trailer line is
293
- terminated with a line feed character. The string SEP may contain
293
+ terminated with a line feed character. The string <sep> may contain
294
the literal formatting codes described above. To use comma as
295
separator one must use `%x2C` as it would otherwise be parsed as
296
next option. E.g., `%(trailers:key=Ticket,separator=%x2C )`
297
shows all trailer lines whose key is "Ticket" separated by a comma
298
and a space.
299
-** 'unfold[=<BOOL>]': make it behave as if interpret-trailer's `--unfold`
299
+** 'unfold[=<bool>]': make it behave as if interpret-trailer's `--unfold`
300
option was given. E.g.,
301
`%(trailers:only,unfold=true)` unfolds and shows all trailer lines.
302
-** 'keyonly[=<BOOL>]': only show the key part of the trailer.
303
-** 'valueonly[=<BOOL>]': only show the value part of the trailer.
304
-** 'key_value_separator=<SEP>': specify a separator inserted between
302
+** 'keyonly[=<bool>]': only show the key part of the trailer.
303
+** 'valueonly[=<bool>]': only show the value part of the trailer.
304
+** 'key_value_separator=<sep>': specify a separator inserted between
305
trailer lines. When this option is not given each trailer key-value
306
pair is separated by ": ". Otherwise it shares the same semantics
307
- as 'separator=<SEP>' above.
307
+ as 'separator=<sep>' above.
308
309
NOTE: Some placeholders may depend on other options given to the
310
revision traversal engine. For example, the `%g*` reflog options will