Skip to content

Commit

Permalink
Use angles for placeholders consistently
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Štěpán Němec authored and Junio C Hamano committed Oct 8, 2010
1 parent 7c6eafa commit 62b4698
Show file tree
Hide file tree
Showing 27 changed files with 118 additions and 118 deletions.
10 changes: 5 additions & 5 deletions Documentation/diff-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ endif::git-format-patch[]
--patience::
Generate a diff using the "patience diff" algorithm.

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

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

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

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

--summary::
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-apply.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ SYNOPSIS
'git apply' [--stat] [--numstat] [--summary] [--check] [--index]
[--apply] [--no-add] [--build-fake-ancestor=<file>] [-R | --reverse]
[--allow-binary-replacement | --binary] [--reject] [-z]
[-pNUM] [-CNUM] [--inaccurate-eof] [--recount] [--cached]
[-p<n>] [-C<n>] [--inaccurate-eof] [--recount] [--cached]
[--ignore-space-change | --ignore-whitespace ]
[--whitespace=<nowarn|warn|fix|error|error-all>]
[--exclude=PATH] [--include=PATH] [--directory=<root>]
[--exclude=<path>] [--include=<path>] [--directory=<root>]
[--verbose] [<patch>...]

DESCRIPTION
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-archive.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ SYNOPSIS
'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
[-o | --output=<file>] [--worktree-attributes]
[--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
[path...]
[<path>...]

DESCRIPTION
-----------
Expand Down Expand Up @@ -73,7 +73,7 @@ OPTIONS
<tree-ish>::
The tree or commit to produce an archive for.

path::
<path>::
Without an optional path parameter, all files and subdirectories
of the current working directory are included in the archive.
If one or more paths are specified, only these are included.
Expand Down
6 changes: 3 additions & 3 deletions Documentation/git-bundle.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ SYNOPSIS
[verse]
'git bundle' create <file> <git-rev-list-args>
'git bundle' verify <file>
'git bundle' list-heads <file> [refname...]
'git bundle' unbundle <file> [refname...]
'git bundle' list-heads <file> [<refname>...]
'git bundle' unbundle <file> [<refname>...]

DESCRIPTION
-----------
Expand Down Expand Up @@ -68,7 +68,7 @@ unbundle <file>::
packaged.


[refname...]::
[<refname>...]::
A list of references used to limit the references reported as
available. This is principally of use to 'git fetch', which
expects to receive only those references asked for and not
Expand Down
48 changes: 24 additions & 24 deletions Documentation/git-daemon.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ SYNOPSIS
--------
[verse]
'git daemon' [--verbose] [--syslog] [--export-all]
[--timeout=n] [--init-timeout=n] [--max-connections=n]
[--strict-paths] [--base-path=path] [--base-path-relaxed]
[--user-path | --user-path=path]
[--interpolated-path=pathtemplate]
[--reuseaddr] [--detach] [--pid-file=file]
[--enable=service] [--disable=service]
[--allow-override=service] [--forbid-override=service]
[--inetd | [--listen=host_or_ipaddr] [--port=n] [--user=user [--group=group]]
[directory...]
[--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]
[--strict-paths] [--base-path=<path>] [--base-path-relaxed]
[--user-path | --user-path=<path>]
[--interpolated-path=<pathtemplate>]
[--reuseaddr] [--detach] [--pid-file=<file>]
[--enable=<service>] [--disable=<service>]
[--allow-override=<service>] [--forbid-override=<service>]
[--inetd | [--listen=<host_or_ipaddr>] [--port=<n>] [--user=<user> [--group=<group>]]
[<directory>...]

DESCRIPTION
-----------
Expand Down Expand Up @@ -48,7 +48,7 @@ OPTIONS
'git daemon' will refuse to start when this option is enabled and no
whitelist is specified.

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

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

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

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

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

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

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

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

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

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

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

--enable=service::
--disable=service::
--enable=<service>::
--disable=<service>::
Enable/disable the service site-wide per default. Note
that a service disabled site-wide can still be enabled
per repository if it is marked overridable and the
repository enables the service with a configuration
item.

--allow-override=service::
--forbid-override=service::
--allow-override=<service>::
--forbid-override=<service>::
Allow/forbid overriding the site-wide default with per
repository configuration. By default, all the services
are overridable.
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-fast-export.txt
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ marks the same across runs.
in the commit (as opposed to just listing the files which are
different from the commit's first parent).

[git-rev-list-args...]::
[<git-rev-list-args>...]::
A list of arguments, acceptable to 'git rev-parse' and
'git rev-list', that specifies the specific objects and references
to export. For example, `master{tilde}10..master` causes the
Expand Down
4 changes: 2 additions & 2 deletions Documentation/git-index-pack.txt
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,10 @@ OPTIONS
the newly constructed pack and index before refs can be
updated to use objects contained in the pack.

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

Expand Down
10 changes: 5 additions & 5 deletions Documentation/git-ls-tree.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ SYNOPSIS
--------
[verse]
'git ls-tree' [-d] [-r] [-t] [-l] [-z]
[--name-only] [--name-status] [--full-name] [--full-tree] [--abbrev=[<n>]]
<tree-ish> [paths...]
[--name-only] [--name-status] [--full-name] [--full-tree] [--abbrev[=<n>]]
<tree-ish> [<path>...]

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

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

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

paths::
[<path>...]::
When paths are given, show them (note that this isn't really raw
pathnames, but rather a list of patterns to match). Otherwise
implicitly uses the root level of the tree as the sole path argument.
Expand Down
14 changes: 7 additions & 7 deletions Documentation/git-pack-objects.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ SYNOPSIS
[verse]
'git pack-objects' [-q | --progress | --all-progress] [--all-progress-implied]
[--no-reuse-delta] [--delta-base-offset] [--non-empty]
[--local] [--incremental] [--window=N] [--depth=N]
[--local] [--incremental] [--window=<n>] [--depth=<n>]
[--revs [--unpacked | --all]*] [--stdout | base-name]
[--keep-true-parents] < object-list

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

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

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

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

--compression=[N]::
--compression=<n>::
Specifies compression level for newly-compressed data in the
generated pack. If not specified, pack compression level is
determined first by pack.compression, then by core.compression,
Expand Down
2 changes: 1 addition & 1 deletion Documentation/git-remote.txt
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ SYNOPSIS
'git remote set-url --delete' [--push] <name> <url>
'git remote' [-v | --verbose] 'show' [-n] <name>
'git remote prune' [-n | --dry-run] <name>
'git remote' [-v | --verbose] 'update' [-p | --prune] [group | remote]...
'git remote' [-v | --verbose] 'update' [-p | --prune] [<group> | <remote>]...

DESCRIPTION
-----------
Expand Down
12 changes: 6 additions & 6 deletions Documentation/git-repack.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ git-repack - Pack unpacked objects in a repository

SYNOPSIS
--------
'git repack' [-a] [-A] [-d] [-f] [-l] [-n] [-q] [--window=N] [--depth=N]
'git repack' [-a] [-A] [-d] [-f] [-l] [-n] [-q] [--window=<n>] [--depth=<n>]

DESCRIPTION
-----------
Expand Down Expand Up @@ -76,8 +76,8 @@ other objects in that pack they already have locally.
this repository (or a direct copy of it)
over HTTP or FTP. See linkgit:git-update-server-info[1].

--window=[N]::
--depth=[N]::
--window=<n>::
--depth=<n>::
These two options affect how the objects contained in the pack are
stored using delta compression. The objects are first internally
sorted by type, size and optionally names and compared against the
Expand All @@ -87,18 +87,18 @@ other objects in that pack they already have locally.
to be applied that many times to get to the necessary object.
The default value for --window is 10 and --depth is 50.

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

--max-pack-size=[N]::
--max-pack-size=<n>::
Maximum size of each output pack file. The size can be suffixed with
"k", "m", or "g". The minimum size allowed is limited to 1 MiB.
If specified, multiple packfiles may be created.
Expand Down
16 changes: 8 additions & 8 deletions Documentation/git-rev-list.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ git-rev-list - Lists commit objects in reverse chronological order
SYNOPSIS
--------
[verse]
'git rev-list' [ \--max-count=number ]
[ \--skip=number ]
[ \--max-age=timestamp ]
[ \--min-age=timestamp ]
'git rev-list' [ \--max-count=<number> ]
[ \--skip=<number> ]
[ \--max-age=<timestamp> ]
[ \--min-age=<timestamp> ]
[ \--sparse ]
[ \--merges ]
[ \--no-merges ]
Expand All @@ -21,10 +21,10 @@ SYNOPSIS
[ \--full-history ]
[ \--not ]
[ \--all ]
[ \--branches[=pattern] ]
[ \--tags[=pattern] ]
[ \--remotes[=pattern] ]
[ \--glob=glob-pattern ]
[ \--branches[=<pattern>] ]
[ \--tags[=<pattern>] ]
[ \--remotes[=<pattern>] ]
[ \--glob=<glob-pattern> ]
[ \--stdin ]
[ \--quiet ]
[ \--topo-order ]
Expand Down
Loading

0 comments on commit 62b4698

Please sign in to comment.