Skip to content

Commit 62b4698

Browse files
Štěpán Němecgitster
Štěpán Němec
authored and
gitster
committed
Use angles for placeholders consistently
Signed-off-by: Štěpán Němec <stepnem@gmail.com> Acked-by: Jonathan Nieder <jrnieder@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 7c6eafa commit 62b4698

27 files changed

+118
-118
lines changed

‎Documentation/diff-options.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ endif::git-format-patch[]
4848
--patience::
4949
Generate a diff using the "patience diff" algorithm.
5050

51-
--stat[=width[,name-width]]::
51+
--stat[=<width>[,<name-width>]]::
5252
Generate a diffstat. You can override the default
53-
output width for 80-column terminal by `--stat=width`.
53+
output width for 80-column terminal by `--stat=<width>`.
5454
The width of the filename part can be controlled by
5555
giving another width to it separated by a comma.
5656

@@ -66,14 +66,14 @@ endif::git-format-patch[]
6666
number of modified files, as well as number of added and deleted
6767
lines.
6868

69-
--dirstat[=limit]::
69+
--dirstat[=<limit>]::
7070
Output the distribution of relative amount of changes (number of lines added or
7171
removed) for each sub-directory. Directories with changes below
7272
a cut-off percent (3% by default) are not shown. The cut-off percent
73-
can be set with `--dirstat=limit`. Changes in a child directory is not
73+
can be set with `--dirstat=<limit>`. Changes in a child directory are not
7474
counted for the parent directory, unless `--cumulative` is used.
7575

76-
--dirstat-by-file[=limit]::
76+
--dirstat-by-file[=<limit>]::
7777
Same as `--dirstat`, but counts changed files instead of lines.
7878

7979
--summary::

‎Documentation/git-apply.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ SYNOPSIS
1212
'git apply' [--stat] [--numstat] [--summary] [--check] [--index]
1313
[--apply] [--no-add] [--build-fake-ancestor=<file>] [-R | --reverse]
1414
[--allow-binary-replacement | --binary] [--reject] [-z]
15-
[-pNUM] [-CNUM] [--inaccurate-eof] [--recount] [--cached]
15+
[-p<n>] [-C<n>] [--inaccurate-eof] [--recount] [--cached]
1616
[--ignore-space-change | --ignore-whitespace ]
1717
[--whitespace=<nowarn|warn|fix|error|error-all>]
18-
[--exclude=PATH] [--include=PATH] [--directory=<root>]
18+
[--exclude=<path>] [--include=<path>] [--directory=<root>]
1919
[--verbose] [<patch>...]
2020

2121
DESCRIPTION

‎Documentation/git-archive.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ SYNOPSIS
1212
'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
1313
[-o | --output=<file>] [--worktree-attributes]
1414
[--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
15-
[path...]
15+
[<path>...]
1616

1717
DESCRIPTION
1818
-----------
@@ -73,7 +73,7 @@ OPTIONS
7373
<tree-ish>::
7474
The tree or commit to produce an archive for.
7575

76-
path::
76+
<path>::
7777
Without an optional path parameter, all files and subdirectories
7878
of the current working directory are included in the archive.
7979
If one or more paths are specified, only these are included.

‎Documentation/git-bundle.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ SYNOPSIS
1111
[verse]
1212
'git bundle' create <file> <git-rev-list-args>
1313
'git bundle' verify <file>
14-
'git bundle' list-heads <file> [refname...]
15-
'git bundle' unbundle <file> [refname...]
14+
'git bundle' list-heads <file> [<refname>...]
15+
'git bundle' unbundle <file> [<refname>...]
1616

1717
DESCRIPTION
1818
-----------
@@ -68,7 +68,7 @@ unbundle <file>::
6868
packaged.
6969

7070

71-
[refname...]::
71+
[<refname>...]::
7272
A list of references used to limit the references reported as
7373
available. This is principally of use to 'git fetch', which
7474
expects to receive only those references asked for and not

‎Documentation/git-daemon.txt‎

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@ SYNOPSIS
99
--------
1010
[verse]
1111
'git daemon' [--verbose] [--syslog] [--export-all]
12-
[--timeout=n] [--init-timeout=n] [--max-connections=n]
13-
[--strict-paths] [--base-path=path] [--base-path-relaxed]
14-
[--user-path | --user-path=path]
15-
[--interpolated-path=pathtemplate]
16-
[--reuseaddr] [--detach] [--pid-file=file]
17-
[--enable=service] [--disable=service]
18-
[--allow-override=service] [--forbid-override=service]
19-
[--inetd | [--listen=host_or_ipaddr] [--port=n] [--user=user [--group=group]]
20-
[directory...]
12+
[--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]
13+
[--strict-paths] [--base-path=<path>] [--base-path-relaxed]
14+
[--user-path | --user-path=<path>]
15+
[--interpolated-path=<pathtemplate>]
16+
[--reuseaddr] [--detach] [--pid-file=<file>]
17+
[--enable=<service>] [--disable=<service>]
18+
[--allow-override=<service>] [--forbid-override=<service>]
19+
[--inetd | [--listen=<host_or_ipaddr>] [--port=<n>] [--user=<user> [--group=<group>]]
20+
[<directory>...]
2121

2222
DESCRIPTION
2323
-----------
@@ -48,7 +48,7 @@ OPTIONS
4848
'git daemon' will refuse to start when this option is enabled and no
4949
whitelist is specified.
5050

51-
--base-path=path::
51+
--base-path=<path>::
5252
Remap all the path requests as relative to the given path.
5353
This is sort of "GIT root" - if you run 'git daemon' with
5454
'--base-path=/srv/git' on example.com, then if you later try to pull
@@ -61,7 +61,7 @@ OPTIONS
6161
This is useful for switching to --base-path usage, while still
6262
allowing the old paths.
6363

64-
--interpolated-path=pathtemplate::
64+
--interpolated-path=<pathtemplate>::
6565
To support virtual hosting, an interpolated path template can be
6666
used to dynamically construct alternate paths. The template
6767
supports %H for the target hostname as supplied by the client but
@@ -80,27 +80,27 @@ OPTIONS
8080
Have the server run as an inetd service. Implies --syslog.
8181
Incompatible with --port, --listen, --user and --group options.
8282

83-
--listen=host_or_ipaddr::
83+
--listen=<host_or_ipaddr>::
8484
Listen on a specific IP address or hostname. IP addresses can
8585
be either an IPv4 address or an IPv6 address if supported. If IPv6
8686
is not supported, then --listen=hostname is also not supported and
8787
--listen must be given an IPv4 address.
8888
Incompatible with '--inetd' option.
8989

90-
--port=n::
90+
--port=<n>::
9191
Listen on an alternative port. Incompatible with '--inetd' option.
9292

93-
--init-timeout=n::
93+
--init-timeout=<n>::
9494
Timeout between the moment the connection is established and the
9595
client request is received (typically a rather low value, since
9696
that should be basically immediate).
9797

98-
--timeout=n::
98+
--timeout=<n>::
9999
Timeout for specific client sub-requests. This includes the time
100100
it takes for the server to process the sub-request and the time spent
101101
waiting for the next client's request.
102102

103-
--max-connections=n::
103+
--max-connections=<n>::
104104
Maximum number of concurrent clients, defaults to 32. Set it to
105105
zero for no limit.
106106

@@ -109,7 +109,7 @@ OPTIONS
109109
--verbose, thus by default only error conditions will be logged.
110110

111111
--user-path::
112-
--user-path=path::
112+
--user-path=<path>::
113113
Allow {tilde}user notation to be used in requests. When
114114
specified with no parameter, requests to
115115
git://host/{tilde}alice/foo is taken as a request to access
@@ -129,12 +129,12 @@ OPTIONS
129129
--detach::
130130
Detach from the shell. Implies --syslog.
131131

132-
--pid-file=file::
132+
--pid-file=<file>::
133133
Save the process id in 'file'. Ignored when the daemon
134134
is run under `--inetd`.
135135

136-
--user=user::
137-
--group=group::
136+
--user=<user>::
137+
--group=<group>::
138138
Change daemon's uid and gid before entering the service loop.
139139
When only `--user` is given without `--group`, the
140140
primary group ID for the user is used. The values of
@@ -145,16 +145,16 @@ Giving these options is an error when used with `--inetd`; use
145145
the facility of inet daemon to achieve the same before spawning
146146
'git daemon' if needed.
147147

148-
--enable=service::
149-
--disable=service::
148+
--enable=<service>::
149+
--disable=<service>::
150150
Enable/disable the service site-wide per default. Note
151151
that a service disabled site-wide can still be enabled
152152
per repository if it is marked overridable and the
153153
repository enables the service with a configuration
154154
item.
155155

156-
--allow-override=service::
157-
--forbid-override=service::
156+
--allow-override=<service>::
157+
--forbid-override=<service>::
158158
Allow/forbid overriding the site-wide default with per
159159
repository configuration. By default, all the services
160160
are overridable.

‎Documentation/git-fast-export.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ marks the same across runs.
9696
in the commit (as opposed to just listing the files which are
9797
different from the commit's first parent).
9898

99-
[git-rev-list-args...]::
99+
[<git-rev-list-args>...]::
100100
A list of arguments, acceptable to 'git rev-parse' and
101101
'git rev-list', that specifies the specific objects and references
102102
to export. For example, `master{tilde}10..master` causes the

‎Documentation/git-index-pack.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,10 +59,10 @@ OPTIONS
5959
the newly constructed pack and index before refs can be
6060
updated to use objects contained in the pack.
6161

62-
--keep='why'::
62+
--keep=<msg>::
6363
Like --keep create a .keep file before moving the index into
6464
its final destination, but rather than creating an empty file
65-
place 'why' followed by an LF into the .keep file. The 'why'
65+
place '<msg>' followed by an LF into the .keep file. The '<msg>'
6666
message can later be searched for within all .keep files to
6767
locate any which have outlived their usefulness.
6868

‎Documentation/git-ls-tree.txt‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,20 +10,20 @@ SYNOPSIS
1010
--------
1111
[verse]
1212
'git ls-tree' [-d] [-r] [-t] [-l] [-z]
13-
[--name-only] [--name-status] [--full-name] [--full-tree] [--abbrev=[<n>]]
14-
<tree-ish> [paths...]
13+
[--name-only] [--name-status] [--full-name] [--full-tree] [--abbrev[=<n>]]
14+
<tree-ish> [<path>...]
1515

1616
DESCRIPTION
1717
-----------
1818
Lists the contents of a given tree object, like what "/bin/ls -a" does
1919
in the current working directory. Note that:
2020

2121
- the behaviour is slightly different from that of "/bin/ls" in that the
22-
'paths' denote just a list of patterns to match, e.g. so specifying
22+
'<path>' denotes just a list of patterns to match, e.g. so specifying
2323
directory name (without '-r') will behave differently, and order of the
2424
arguments does not matter.
2525

26-
- the behaviour is similar to that of "/bin/ls" in that the 'paths' is
26+
- the behaviour is similar to that of "/bin/ls" in that the '<path>' is
2727
taken as relative to the current working directory. E.g. when you are
2828
in a directory 'sub' that has a directory 'dir', you can run 'git
2929
ls-tree -r HEAD dir' to list the contents of the tree (that is
@@ -72,7 +72,7 @@ OPTIONS
7272
Do not limit the listing to the current working directory.
7373
Implies --full-name.
7474

75-
paths::
75+
[<path>...]::
7676
When paths are given, show them (note that this isn't really raw
7777
pathnames, but rather a list of patterns to match). Otherwise
7878
implicitly uses the root level of the tree as the sole path argument.

‎Documentation/git-pack-objects.txt‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ SYNOPSIS
1111
[verse]
1212
'git pack-objects' [-q | --progress | --all-progress] [--all-progress-implied]
1313
[--no-reuse-delta] [--delta-base-offset] [--non-empty]
14-
[--local] [--incremental] [--window=N] [--depth=N]
14+
[--local] [--incremental] [--window=<n>] [--depth=<n>]
1515
[--revs [--unpacked | --all]*] [--stdout | base-name]
1616
[--keep-true-parents] < object-list
1717

@@ -82,8 +82,8 @@ base-name::
8282
reference was included in the resulting packfile. This
8383
can be useful to send new tags to native git clients.
8484

85-
--window=[N]::
86-
--depth=[N]::
85+
--window=<n>::
86+
--depth=<n>::
8787
These two options affect how the objects contained in
8888
the pack are stored using delta compression. The
8989
objects are first internally sorted by type, size and
@@ -95,18 +95,18 @@ base-name::
9595
times to get to the necessary object.
9696
The default value for --window is 10 and --depth is 50.
9797

98-
--window-memory=[N]::
98+
--window-memory=<n>::
9999
This option provides an additional limit on top of `--window`;
100100
the window size will dynamically scale down so as to not take
101-
up more than N bytes in memory. This is useful in
101+
up more than '<n>' bytes in memory. This is useful in
102102
repositories with a mix of large and small objects to not run
103103
out of memory with a large window, but still be able to take
104104
advantage of the large window for the smaller objects. The
105105
size can be suffixed with "k", "m", or "g".
106106
`--window-memory=0` makes memory usage unlimited, which is the
107107
default.
108108

109-
--max-pack-size=[N]::
109+
--max-pack-size=<n>::
110110
Maximum size of each output pack file. The size can be suffixed with
111111
"k", "m", or "g". The minimum size allowed is limited to 1 MiB.
112112
If specified, multiple packfiles may be created.
@@ -171,7 +171,7 @@ base-name::
171171
wholesale enforcement of a different compression level on the
172172
packed data is desired.
173173

174-
--compression=[N]::
174+
--compression=<n>::
175175
Specifies compression level for newly-compressed data in the
176176
generated pack. If not specified, pack compression level is
177177
determined first by pack.compression, then by core.compression,

‎Documentation/git-remote.txt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ SYNOPSIS
2020
'git remote set-url --delete' [--push] <name> <url>
2121
'git remote' [-v | --verbose] 'show' [-n] <name>
2222
'git remote prune' [-n | --dry-run] <name>
23-
'git remote' [-v | --verbose] 'update' [-p | --prune] [group | remote]...
23+
'git remote' [-v | --verbose] 'update' [-p | --prune] [<group> | <remote>]...
2424

2525
DESCRIPTION
2626
-----------

0 commit comments

Comments
 (0)