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>

diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 4656a97e6012796f182a725e14c13dc03f71bba2..fae730397cbc6c36c2b2376d4c85cef51385f936 100644 (file)
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -48,9 +48,9 @@ endif::git-format-patch[]
 --patience::
        Generate a diff using the "patience diff" algorithm.
 
 --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
        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.
 
        The width of the filename part can be controlled by
        giving another width to it separated by a comma.
 


@@ -66,14 +66,14 @@ endif::git-format-patch[]
        number of modified files, as well as number of added and deleted
        lines.
 
        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
        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.
 
        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::
        Same as `--dirstat`, but counts changed files instead of lines.
 
 --summary::

diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
index 4a74b23d403d970643fcb8e0438ab6649f54e54c..08bf6e7fb79311396c03429fdeb4542383abca7f 100644 (file)
--- a/Documentation/git-apply.txt
+++ b/Documentation/git-apply.txt
@@ -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]
 '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>]
          [--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
          [--verbose] [<patch>...]
 
 DESCRIPTION

diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index 8d3e66626f7561b0ba7f8140288cfc15167bdc14..4163a1bcb1643e7f05b6a79034ac9f63135d6ac9 100644 (file)
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -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>
 'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
              [-o | --output=<file>] [--worktree-attributes]
              [--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>

-             [path...]
+             [<path>...]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -73,7 +73,7 @@ OPTIONS
 <tree-ish>::
        The tree or commit to produce an archive for.
 
 <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.
        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.

diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index 38e59afb34effd84da6d8a79da67e5ad3ae45c5a..6266a3a6020db72c8629ad521dfedccc9d790a03 100644 (file)
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -11,8 +11,8 @@ SYNOPSIS
 [verse]
 'git bundle' create <file> <git-rev-list-args>
 'git bundle' verify <file>
 [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
 -----------
 
 DESCRIPTION
 -----------


@@ -68,7 +68,7 @@ unbundle <file>::
        packaged.
 
 
        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
        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

diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index 01c9f8eb9eff634fe8ab99908c62207ebecd5e31..2f0ddf6fe817ab7b59fb5f5276ba688447661ee3 100644 (file)
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -9,15 +9,15 @@ SYNOPSIS
 --------
 [verse]
 'git daemon' [--verbose] [--syslog] [--export-all]
 --------
 [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
 -----------
 
 DESCRIPTION
 -----------


@@ -48,7 +48,7 @@ OPTIONS
        'git daemon' will refuse to start when this option is enabled and no
        whitelist is specified.
 
        '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
        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


@@ -61,7 +61,7 @@ OPTIONS
        This is useful for switching to --base-path usage, while still
        allowing the old paths.
 
        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
        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


@@ -80,27 +80,27 @@ OPTIONS
        Have the server run as an inetd service. Implies --syslog.
        Incompatible with --port, --listen, --user and --group 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.
 
        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.
 
        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 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.
 
        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.
 
        Maximum number of concurrent clients, defaults to 32.  Set it to
        zero for no limit.
 


@@ -109,7 +109,7 @@ OPTIONS
        --verbose, thus by default only error conditions will be logged.
 
 --user-path::
        --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
        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


@@ -129,12 +129,12 @@ OPTIONS
 --detach::
        Detach from the shell. Implies --syslog.
 
 --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`.
 
        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
        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


@@ -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.
 
 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.
 
        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.
        Allow/forbid overriding the site-wide default with per
        repository configuration.  By default, all the services
        are overridable.

diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt
index fcad1132767021a03a88cf084d5eaf4ae8780792..e05b686b1e4784290e40993469a2c5fab9b4ce5d 100644 (file)
--- a/Documentation/git-fast-export.txt
+++ b/Documentation/git-fast-export.txt
@@ -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).
 
        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
        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

diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt
index f3ccc72f0d68f03cd7b3fb6a36aabc8d7c7772a1..c2bb81042c80dbf93b7a651c47fc177358132f97 100644 (file)
--- a/Documentation/git-index-pack.txt
+++ b/Documentation/git-index-pack.txt
@@ -59,10 +59,10 @@ OPTIONS
        the newly constructed pack and index before refs can be
        updated to use objects contained in the pack.
 
        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
        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.
 
        message can later be searched for within all .keep files to
        locate any which have outlived their usefulness.
 

diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
index 1f89d3680043cc98ad39facb1f43ae770ff66e14..76ed625e7b2fe503d3fb2262371ecd4de006411f 100644 (file)
--- a/Documentation/git-ls-tree.txt
+++ b/Documentation/git-ls-tree.txt
@@ -10,8 +10,8 @@ SYNOPSIS
 --------
 [verse]
 'git ls-tree' [-d] [-r] [-t] [-l] [-z]
 --------
 [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
 -----------
 
 DESCRIPTION
 -----------


@@ -19,11 +19,11 @@ 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
 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.
 
    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
    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


@@ -72,7 +72,7 @@ OPTIONS
        Do not limit the listing to the current working directory.
        Implies --full-name.
 
        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.
        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.

diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index 8ed09c0b3cfc0fff2dbb8907fdc00e027c2c6d33..a1dd3e9d969a5c4b8d6dbc47efa36169fcd47eaf 100644 (file)
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -11,7 +11,7 @@ SYNOPSIS
 [verse]
 'git pack-objects' [-q | --progress | --all-progress] [--all-progress-implied]
        [--no-reuse-delta] [--delta-base-offset] [--non-empty]
 [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
 
        [--revs [--unpacked | --all]*] [--stdout | base-name]
        [--keep-true-parents] < object-list
 


@@ -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.
 
        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
        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


@@ -95,10 +95,10 @@ base-name::
        times to get to the necessary object.
        The default value for --window is 10 and --depth is 50.
 
        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
        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
        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


@@ -106,7 +106,7 @@ base-name::
        `--window-memory=0` makes memory usage unlimited, which is the
        default.
 
        `--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.
        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.


@@ -171,7 +171,7 @@ base-name::
        wholesale enforcement of a different compression level on the
        packed data is desired.
 
        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,
        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,

diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index aa021b0cb803a9cd9f08566f6a6fe407eb025e4b..b3170868939d36a5b9ad2fefea089b50f050f17c 100644 (file)
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -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 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
 -----------
 
 DESCRIPTION
 -----------

diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt
index 8c67d1724f705c94fb8faf6801ee2bc7cd459629..af79b86516764617163b020ec3c4d9bbeda9fe9b 100644 (file)
--- a/Documentation/git-repack.txt
+++ b/Documentation/git-repack.txt
@@ -8,7 +8,7 @@ git-repack - Pack unpacked objects in a repository
 
 SYNOPSIS
 --------
 
 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
 -----------
 
 DESCRIPTION
 -----------


@@ -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].
 
        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
        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


@@ -87,10 +87,10 @@ 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.
 
        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
        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
        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


@@ -98,7 +98,7 @@ other objects in that pack they already have locally.
        `--window-memory=0` makes memory usage unlimited, which is the
        default.
 
        `--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.
        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.

diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt
index 173f3fc78599f268c1e483c4d1abe51e95ad0e59..cfb1d2122a86e266c31fad9f6e7ba052d90cd807 100644 (file)
--- a/Documentation/git-rev-list.txt
+++ b/Documentation/git-rev-list.txt
@@ -9,10 +9,10 @@ git-rev-list - Lists commit objects in reverse chronological order
 SYNOPSIS
 --------
 [verse]
 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 ]
             [ \--sparse ]
             [ \--merges ]
             [ \--no-merges ]


@@ -21,10 +21,10 @@ SYNOPSIS
             [ \--full-history ]
             [ \--not ]
             [ \--all ]
             [ \--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 ]
             [ \--stdin ]
             [ \--quiet ]
             [ \--topo-order ]

diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt
index e1586c78c3d271c78bcf26827cf10ff234fcba62..51e8e0af1e7ff37ce4abfe53b6d52e9935b536a8 100644 (file)
--- a/Documentation/git-web--browse.txt
+++ b/Documentation/git-web--browse.txt
@@ -32,19 +32,19 @@ Custom commands may also be specified.
 
 OPTIONS
 -------
 
 OPTIONS
 -------

--b BROWSER::
---browser=BROWSER::
-       Use the specified BROWSER. It must be in the list of supported
+-b <browser>::
+--browser=<browser>::
+       Use the specified browser. It must be in the list of supported

        browsers.
 
        browsers.
 

--t BROWSER::
---tool=BROWSER::
+-t <browser>::
+--tool=<browser>::

        Same as above.
 
        Same as above.
 

--c CONF.VAR::
---config=CONF.VAR::
+-c <conf.var>::
+--config=<conf.var>::

        CONF.VAR is looked up in the git config files. If it's set,
        CONF.VAR is looked up in the git config files. If it's set,

-       then its value specify the browser that should be used.
+       then its value specifies the browser that should be used.

 
 CONFIGURATION VARIABLES
 -----------------------
 
 CONFIGURATION VARIABLES
 -----------------------

diff --git a/Documentation/git.txt b/Documentation/git.txt
index dd57bdc436788e56c3b3cd1a8481b191c0a62d67..8de86174e4e8d4670c09001d81448f8993bd0eed 100644 (file)
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -9,11 +9,11 @@ git - the stupid content tracker
 SYNOPSIS
 --------
 [verse]
 SYNOPSIS
 --------
 [verse]

-'git' [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]
+'git' [--version] [--exec-path[=<path>]] [--html-path]

     [-p|--paginate|--no-pager] [--no-replace-objects]
     [-p|--paginate|--no-pager] [--no-replace-objects]

-    [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]
-    [-c name=value]
-    [--help] COMMAND [ARGS]
+    [--bare] [--git-dir=<path>] [--work-tree=<path>]
+    [-c <name>=<value>]
+    [--help] <command> [<args>]

 
 DESCRIPTION
 -----------
 
 DESCRIPTION
 -----------


@@ -28,7 +28,7 @@ also want to read linkgit:gitcvs-migration[7].  See
 the link:user-manual.html[Git User's Manual] for a more in-depth
 introduction.
 
 the link:user-manual.html[Git User's Manual] for a more in-depth
 introduction.
 

-The COMMAND is either a name of a Git command (see below) or an alias
+The '<command>' is either a name of a Git command (see below) or an alias

 as defined in the configuration file (see linkgit:git-config[1]).
 
 Formatted and hyperlinked version of the latest git
 as defined in the configuration file (see linkgit:git-config[1]).
 
 Formatted and hyperlinked version of the latest git


@@ -252,7 +252,7 @@ help ...`.
        The <name> is expected in the same format as listed by
        'git config' (subkeys separated by dots).
 
        The <name> is expected in the same format as listed by
        'git config' (subkeys separated by dots).
 

---exec-path::
+--exec-path[=<path>]::

        Path to wherever your core git programs are installed.
        This can also be controlled by setting the GIT_EXEC_PATH
        environment variable. If no path is given, 'git' will print
        Path to wherever your core git programs are installed.
        This can also be controlled by setting the GIT_EXEC_PATH
        environment variable. If no path is given, 'git' will print

diff --git a/Documentation/merge-strategies.txt b/Documentation/merge-strategies.txt
index 049313d6015758fb3e95c21fecc40e021e8aa4bd..8676e26ca20311196d069ab28c08c913271c7631 100644 (file)
--- a/Documentation/merge-strategies.txt
+++ b/Documentation/merge-strategies.txt
@@ -52,7 +52,7 @@ no-renormalize;;
        Disables the `renormalize` option.  This overrides the
        `merge.renormalize` configuration variable.
 
        Disables the `renormalize` option.  This overrides the
        `merge.renormalize` configuration variable.
 

-subtree[=path];;
+subtree[=<path>];;

        This option is a more advanced form of 'subtree' strategy, where
        the strategy makes a guess on how two trees must be shifted to
        match with each other when merging.  Instead, the specified path
        This option is a more advanced form of 'subtree' strategy, where
        the strategy makes a guess on how two trees must be shifted to
        match with each other when merging.  Instead, the specified path

diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index ebc0108731dffd2dde1ec8917a93e15c9003baf3..1b13c1f909082bee427e0a9505aab6a017e78674 100644 (file)
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -246,29 +246,29 @@ endif::git-rev-list[]
        Pretend as if all the refs in `refs/` are listed on the
        command line as '<commit>'.
 
        Pretend as if all the refs in `refs/` are listed on the
        command line as '<commit>'.
 

---branches[=pattern]::
+--branches[=<pattern>]::

 
        Pretend as if all the refs in `refs/heads` are listed
 
        Pretend as if all the refs in `refs/heads` are listed

-       on the command line as '<commit>'. If `pattern` is given, limit
+       on the command line as '<commit>'. If '<pattern>' is given, limit

        branches to ones matching given shell glob. If pattern lacks '?',
        '*', or '[', '/*' at the end is implied.
 
        branches to ones matching given shell glob. If pattern lacks '?',
        '*', or '[', '/*' at the end is implied.
 

---tags[=pattern]::
+--tags[=<pattern>]::

 
        Pretend as if all the refs in `refs/tags` are listed
 
        Pretend as if all the refs in `refs/tags` are listed

-       on the command line as '<commit>'. If `pattern` is given, limit
+       on the command line as '<commit>'. If '<pattern>' is given, limit

        tags to ones matching given shell glob. If pattern lacks '?', '*',
        or '[', '/*' at the end is implied.
 
        tags to ones matching given shell glob. If pattern lacks '?', '*',
        or '[', '/*' at the end is implied.
 

---remotes[=pattern]::
+--remotes[=<pattern>]::

 
        Pretend as if all the refs in `refs/remotes` are listed
 
        Pretend as if all the refs in `refs/remotes` are listed

-       on the command line as '<commit>'. If `pattern`is given, limit
+       on the command line as '<commit>'. If '<pattern>' is given, limit

        remote tracking branches to ones matching given shell glob.
        If pattern lacks '?', '*', or '[', '/*' at the end is implied.
 
        remote tracking branches to ones matching given shell glob.
        If pattern lacks '?', '*', or '[', '/*' at the end is implied.
 

---glob=glob-pattern::
-       Pretend as if all the refs matching shell glob `glob-pattern`
+--glob=<glob-pattern>::
+       Pretend as if all the refs matching shell glob '<glob-pattern>'

        are listed on the command line as '<commit>'. Leading 'refs/',
        is automatically prepended if missing. If pattern lacks '?', '*',
        or '[', '/*' at the end is implied.
        are listed on the command line as '<commit>'. Leading 'refs/',
        is automatically prepended if missing. If pattern lacks '?', '*',
        or '[', '/*' at the end is implied.

diff --git a/archive.c b/archive.c
index edd68534fa847ad839fe8554e6864b39de4fcde0..f59afda6ffda02920a50cabe1eb3e764221199ba 100644 (file)
--- a/archive.c
+++ b/archive.c
@@ -7,9 +7,9 @@
 #include "unpack-trees.h"
 
 static char const * const archive_usage[] = {
 #include "unpack-trees.h"
 
 static char const * const archive_usage[] = {

-       "git archive [options] <tree-ish> [path...]",
+       "git archive [options] <tree-ish> [<path>...]",

        "git archive --list",
        "git archive --list",

-       "git archive --remote <repo> [--exec <cmd>] [options] <tree-ish> [path...]",
+       "git archive --remote <repo> [--exec <cmd>] [options] <tree-ish> [<path>...]",

        "git archive --remote <repo> [--exec <cmd>] --list",
        NULL
 };
        "git archive --remote <repo> [--exec <cmd>] --list",
        NULL
 };

diff --git a/builtin/bundle.c b/builtin/bundle.c
index 80649ba0b28846d09b49a791dd25af9a2907f75f..9b87fb9ac2505e746ae34db34740cdfb3cfde127 100644 (file)
--- a/builtin/bundle.c
+++ b/builtin/bundle.c
@@ -12,8 +12,8 @@
 static const char builtin_bundle_usage[] =
   "git bundle create <file> <git-rev-list args>\n"
   "   or: git bundle verify <file>\n"
 static const char builtin_bundle_usage[] =
   "git bundle create <file> <git-rev-list args>\n"
   "   or: git bundle verify <file>\n"

-  "   or: git bundle list-heads <file> [refname...]\n"
-  "   or: git bundle unbundle <file> [refname...]";
+  "   or: git bundle list-heads <file> [<refname>...]\n"
+  "   or: git bundle unbundle <file> [<refname>...]";

 
 int cmd_bundle(int argc, const char **argv, const char *prefix)
 {
 
 int cmd_bundle(int argc, const char **argv, const char *prefix)
 {

diff --git a/builtin/grep.c b/builtin/grep.c
index da32f3df34da7af3cdcb0a9dd6aa66061bdfe927..3d5f6ace97b806fd7dba9f8c5d62abcdbd903681 100644 (file)
--- a/builtin/grep.c
+++ b/builtin/grep.c
@@ -24,7 +24,7 @@
 #endif
 
 static char const * const grep_usage[] = {
 #endif
 
 static char const * const grep_usage[] = {

-       "git grep [options] [-e] <pattern> [<rev>...] [[--] path...]",
+       "git grep [options] [-e] <pattern> [<rev>...] [[--] <path>...]",

        NULL
 };
 
        NULL
 };
 

diff --git a/builtin/ls-tree.c b/builtin/ls-tree.c
index a8187568bf99872e717c389b031331838544fe04..f73e6bd9626a0e929a513fed1fd1227c28732ec7 100644 (file)
--- a/builtin/ls-tree.c
+++ b/builtin/ls-tree.c
@@ -24,7 +24,7 @@ static int chomp_prefix;
 static const char *ls_tree_prefix;
 
 static const  char * const ls_tree_usage[] = {
 static const char *ls_tree_prefix;
 
 static const  char * const ls_tree_usage[] = {

-       "git ls-tree [<options>] <tree-ish> [path...]",
+       "git ls-tree [<options>] <tree-ish> [<path>...]",

        NULL
 };
 
        NULL
 };
 

diff --git a/builtin/pack-objects.c b/builtin/pack-objects.c
index d5a8db1bb6c14b02db9f7f534fcbaf4dc46994ba..1e4c386048625f6d411b9a49dfdcb4b1884c0a2c 100644 (file)
--- a/builtin/pack-objects.c
+++ b/builtin/pack-objects.c
@@ -25,10 +25,10 @@
 static const char pack_usage[] =
   "git pack-objects [{ -q | --progress | --all-progress }]\n"
   "        [--all-progress-implied]\n"
 static const char pack_usage[] =
   "git pack-objects [{ -q | --progress | --all-progress }]\n"
   "        [--all-progress-implied]\n"

-  "        [--max-pack-size=N] [--local] [--incremental]\n"
-  "        [--window=N] [--window-memory=N] [--depth=N]\n"
+  "        [--max-pack-size=<n>] [--local] [--incremental]\n"
+  "        [--window=<n>] [--window-memory=<n>] [--depth=<n>]\n"

   "        [--no-reuse-delta] [--no-reuse-object] [--delta-base-offset]\n"
   "        [--no-reuse-delta] [--no-reuse-object] [--delta-base-offset]\n"

-  "        [--threads=N] [--non-empty] [--revs [--unpacked | --all]*]\n"
+  "        [--threads=<n>] [--non-empty] [--revs [--unpacked | --all]]\n"

   "        [--reflog] [--stdout | base-name] [--include-tag]\n"
   "        [--keep-unreachable | --unpack-unreachable]\n"
   "        [<ref-list | <object-list]";
   "        [--reflog] [--stdout | base-name] [--include-tag]\n"
   "        [--keep-unreachable | --unpack-unreachable]\n"
   "        [<ref-list | <object-list]";

diff --git a/builtin/remote.c b/builtin/remote.c
index 48e0a6bf260cab18d44058ade554e3a9d5946b93..c0198fc7b635fe932bc1410de01fe6ca24bd4dd3 100644 (file)
--- a/builtin/remote.c
+++ b/builtin/remote.c
@@ -15,7 +15,7 @@ static const char * const builtin_remote_usage[] = {
        "git remote set-head <name> (-a | -d | <branch>)",
        "git remote [-v | --verbose] show [-n] <name>",
        "git remote prune [-n | --dry-run] <name>",
        "git remote set-head <name> (-a | -d | <branch>)",
        "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>]",

        "git remote set-branches <name> [--add] <branch>...",
        "git remote set-url <name> <newurl> [<oldurl>]",
        "git remote set-url --add <name> <newurl>",
        "git remote set-branches <name> [--add] <branch>...",
        "git remote set-url <name> <newurl> [<oldurl>]",
        "git remote set-url --add <name> <newurl>",

diff --git a/builtin/rev-list.c b/builtin/rev-list.c
index efe9360e2fdb9aac3bae0c61c85531041f24708a..158ce1111af12db1445d82cfa5728bc19837570d 100644 (file)
--- a/builtin/rev-list.c
+++ b/builtin/rev-list.c
@@ -11,9 +11,9 @@
 static const char rev_list_usage[] =
 "git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
 "  limiting output:\n"
 static const char rev_list_usage[] =
 "git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
 "  limiting output:\n"

-"    --max-count=nr\n"
-"    --max-age=epoch\n"
-"    --min-age=epoch\n"
+"    --max-count=<n>\n"
+"    --max-age=<epoch>\n"
+"    --min-age=<epoch>\n"

 "    --sparse\n"
 "    --no-merges\n"
 "    --remove-empty\n"
 "    --sparse\n"
 "    --no-merges\n"
 "    --remove-empty\n"


@@ -33,7 +33,7 @@ static const char rev_list_usage[] =
 "    --objects | --objects-edge\n"
 "    --unpacked\n"
 "    --header | --pretty\n"
 "    --objects | --objects-edge\n"
 "    --unpacked\n"
 "    --header | --pretty\n"

-"    --abbrev=nr | --no-abbrev\n"
+"    --abbrev=<n> | --no-abbrev\n"

 "    --abbrev-commit\n"
 "    --left-right\n"
 "  special purpose:\n"
 "    --abbrev-commit\n"
 "    --left-right\n"
 "  special purpose:\n"

diff --git a/daemon.c b/daemon.c
index e22a2b7fa5f6fcfc5b26541a21c10d3c8b7eda81..9326d3a1fa05f4878a21b58a623d07428f7230fe 100644 (file)
--- a/daemon.c
+++ b/daemon.c
@@ -20,15 +20,15 @@ static int reuseaddr;
 
 static const char daemon_usage[] =
 "git daemon [--verbose] [--syslog] [--export-all]\n"
 
 static const char daemon_usage[] =
 "git daemon [--verbose] [--syslog] [--export-all]\n"

-"           [--timeout=n] [--init-timeout=n] [--max-connections=n]\n"
-"           [--strict-paths] [--base-path=path] [--base-path-relaxed]\n"
-"           [--user-path | --user-path=path]\n"
-"           [--interpolated-path=path]\n"
-"           [--reuseaddr] [--detach] [--pid-file=file]\n"
-"           [--[enable|disable|allow-override|forbid-override]=service]\n"
-"           [--inetd | [--listen=host_or_ipaddr] [--port=n]\n"
-"                      [--user=user [--group=group]]\n"
-"           [directory...]";
+"           [--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]\n"
+"           [--strict-paths] [--base-path=<path>] [--base-path-relaxed]\n"
+"           [--user-path | --user-path=<path>]\n"
+"           [--interpolated-path=<path>]\n"
+"           [--reuseaddr] [--detach] [--pid-file=<file>]\n"
+"           [--(enable|disable|allow-override|forbid-override)=<service>]\n"
+"           [--inetd | [--listen=<host_or_ipaddr>] [--port=<n>]\n"
+"                      [--user=<user> [--group=<group>]]\n"
+"           [<directory>...]";

 
 /* List of acceptable pathname prefixes */
 static char **ok_paths;
 
 /* List of acceptable pathname prefixes */
 static char **ok_paths;

diff --git a/fast-import.c b/fast-import.c
index 2317b0fe7509b957577234890135509143c0872b..eab68d58c394a67f4805d77b0007b583e79e24b9 100644 (file)
--- a/fast-import.c
+++ b/fast-import.c
@@ -2884,7 +2884,7 @@ static int git_pack_config(const char *k, const char *v, void *cb)
 }
 
 static const char fast_import_usage[] =
 }
 
 static const char fast_import_usage[] =

-"git fast-import [--date-format=f] [--max-pack-size=n] [--big-file-threshold=n] [--depth=n] [--active-branches=n] [--export-marks=marks.file]";
+"git fast-import [--date-format=<f>] [--max-pack-size=<n>] [--big-file-threshold=<n>] [--depth=<n>] [--active-branches=<n>] [--export-marks=<marks.file>]";

 
 static void parse_argv(void)
 {
 
 static void parse_argv(void)
 {

diff --git a/git.c b/git.c
index 50a14013c5a87fed200df0a5a4ec6db0f1e2c223..0409ac9fd3f1ea36680189e07116e58b2630ccad 100644 (file)
--- a/git.c
+++ b/git.c
@@ -6,14 +6,14 @@
 #include "run-command.h"
 
 const char git_usage_string[] =
 #include "run-command.h"
 
 const char git_usage_string[] =

-       "git [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path]\n"
+       "git [--version] [--exec-path[=<path>]] [--html-path]\n"

        "           [-p|--paginate|--no-pager] [--no-replace-objects]\n"
        "           [-p|--paginate|--no-pager] [--no-replace-objects]\n"

-       "           [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]\n"
+       "           [--bare] [--git-dir=<path>] [--work-tree=<path>]\n"

        "           [-c name=value] [--help]\n"
        "           [-c name=value] [--help]\n"

-       "           COMMAND [ARGS]";
+       "           <command> [<args>]";

 
 const char git_more_info_string[] =
 
 const char git_more_info_string[] =

-       "See 'git help COMMAND' for more information on a specific command.";
+       "See 'git help <command>' for more information on a specific command.";

 
 static struct startup_info git_startup_info;
 static int use_pager = -1;
 
 static struct startup_info git_startup_info;
 static int use_pager = -1;

diff --git a/upload-pack.c b/upload-pack.c
index 92f9530c6572a212c12ac917d774736286325e52..f05e4229d0d3a3ed34b4bba6636f4d333c74dc22 100644 (file)
--- a/upload-pack.c
+++ b/upload-pack.c
@@ -11,7 +11,7 @@
 #include "list-objects.h"
 #include "run-command.h"
 
 #include "list-objects.h"
 #include "run-command.h"
 

-static const char upload_pack_usage[] = "git upload-pack [--strict] [--timeout=nn] <dir>";
+static const char upload_pack_usage[] = "git upload-pack [--strict] [--timeout=<n>] <dir>";

 
 /* bits #0..7 in revision.h, #8..10 in commit.c */
 #define THEY_HAVE      (1u << 11)
 
 /* bits #0..7 in revision.h, #8..10 in commit.c */
 #define THEY_HAVE      (1u << 11)