зеркало из https://github.com/microsoft/git.git
doc: express grammar placeholders between angle brackets
This discerns user inputs from verbatim options in the synopsis. Signed-off-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Родитель
06ebae09f5
Коммит
49cbad0edd
|
@ -8,7 +8,7 @@ git-cherry-pick - Apply the changes introduced by some existing commits
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff]
|
||||
'git cherry-pick' [--edit] [-n] [-m <parent-number>] [-s] [-x] [--ff]
|
||||
[-S[<keyid>]] <commit>...
|
||||
'git cherry-pick' (--continue | --skip | --abort | --quit)
|
||||
|
||||
|
@ -81,8 +81,8 @@ OPTIONS
|
|||
described above, and `-r` was to disable it. Now the
|
||||
default is not to do `-x` so this option is a no-op.
|
||||
|
||||
-m parent-number::
|
||||
--mainline parent-number::
|
||||
-m <parent-number>::
|
||||
--mainline <parent-number>::
|
||||
Usually you cannot cherry-pick a merge because you do not know which
|
||||
side of the merge should be considered the mainline. This
|
||||
option specifies the parent number (starting from 1) of
|
||||
|
|
|
@ -9,20 +9,20 @@ git-config - Get and set repository or global options
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git config' [<file-option>] [--type=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] name [value [value-pattern]]
|
||||
'git config' [<file-option>] [--type=<type>] --add name value
|
||||
'git config' [<file-option>] [--type=<type>] [--fixed-value] --replace-all name value [value-pattern]
|
||||
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get name [value-pattern]
|
||||
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all name [value-pattern]
|
||||
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp name_regex [value-pattern]
|
||||
'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch name URL
|
||||
'git config' [<file-option>] [--fixed-value] --unset name [value-pattern]
|
||||
'git config' [<file-option>] [--fixed-value] --unset-all name [value-pattern]
|
||||
'git config' [<file-option>] --rename-section old_name new_name
|
||||
'git config' [<file-option>] --remove-section name
|
||||
'git config' [<file-option>] [--type=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] <name> [<value> [<value-pattern>]]
|
||||
'git config' [<file-option>] [--type=<type>] --add <name> <value>
|
||||
'git config' [<file-option>] [--type=<type>] [--fixed-value] --replace-all <name> <value> [<value-pattern>]
|
||||
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get <name> [<value-pattern>]
|
||||
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all <name> [<value-pattern>]
|
||||
'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp <name-regex> [<value-pattern>]
|
||||
'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch <name> <URL>
|
||||
'git config' [<file-option>] [--fixed-value] --unset <name> [<value-pattern>]
|
||||
'git config' [<file-option>] [--fixed-value] --unset-all <name> [<value-pattern>]
|
||||
'git config' [<file-option>] --rename-section <old-name> <new-name>
|
||||
'git config' [<file-option>] --remove-section <name>
|
||||
'git config' [<file-option>] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
|
||||
'git config' [<file-option>] --get-color name [default]
|
||||
'git config' [<file-option>] --get-colorbool name [stdout-is-tty]
|
||||
'git config' [<file-option>] --get-color <name> [<default>]
|
||||
'git config' [<file-option>] --get-colorbool <name> [<stdout-is-tty>]
|
||||
'git config' [<file-option>] -e | --edit
|
||||
|
||||
DESCRIPTION
|
||||
|
@ -102,9 +102,9 @@ OPTIONS
|
|||
in which section and variable names are lowercased, but subsection
|
||||
names are not.
|
||||
|
||||
--get-urlmatch name URL::
|
||||
--get-urlmatch <name> <URL>::
|
||||
When given a two-part name section.key, the value for
|
||||
section.<url>.key whose <url> part matches the best to the
|
||||
section.<URL>.key whose <URL> part matches the best to the
|
||||
given URL is returned (if no such key exists, the value for
|
||||
section.key is used as a fallback). When given just the
|
||||
section as name, do so for all the keys in the section and
|
||||
|
@ -145,8 +145,8 @@ See also <<FILES>>.
|
|||
read from or written to if `extensions.worktreeConfig` is
|
||||
present. If not it's the same as `--local`.
|
||||
|
||||
-f config-file::
|
||||
--file config-file::
|
||||
-f <config-file>::
|
||||
--file <config-file>::
|
||||
For writing options: write to the specified file rather than the
|
||||
repository `.git/config`.
|
||||
+
|
||||
|
@ -155,7 +155,7 @@ available files.
|
|||
+
|
||||
See also <<FILES>>.
|
||||
|
||||
--blob blob::
|
||||
--blob <blob>::
|
||||
Similar to `--file` but use the given blob instead of a file. E.g.
|
||||
you can use 'master:.gitmodules' to read values from the file
|
||||
'.gitmodules' in the master branch. See "SPECIFYING REVISIONS"
|
||||
|
@ -246,18 +246,18 @@ Valid `<type>`'s include:
|
|||
all queried config options with the scope of that value
|
||||
(local, global, system, command).
|
||||
|
||||
--get-colorbool name [stdout-is-tty]::
|
||||
--get-colorbool <name> [<stdout-is-tty>]::
|
||||
|
||||
Find the color setting for `name` (e.g. `color.diff`) and output
|
||||
"true" or "false". `stdout-is-tty` should be either "true" or
|
||||
Find the color setting for `<name>` (e.g. `color.diff`) and output
|
||||
"true" or "false". `<stdout-is-tty>` should be either "true" or
|
||||
"false", and is taken into account when configuration says
|
||||
"auto". If `stdout-is-tty` is missing, then checks the standard
|
||||
"auto". If `<stdout-is-tty>` is missing, then checks the standard
|
||||
output of the command itself, and exits with status 0 if color
|
||||
is to be used, or exits with status 1 otherwise.
|
||||
When the color setting for `name` is undefined, the command uses
|
||||
`color.ui` as fallback.
|
||||
|
||||
--get-color name [default]::
|
||||
--get-color <name> [<default>]::
|
||||
|
||||
Find the color configured for `name` (e.g. `color.diff.new`) and
|
||||
output it as the ANSI color escape sequence to the standard
|
||||
|
|
|
@ -9,8 +9,8 @@ git-cvsexportcommit - Export a single commit to a CVS checkout
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot]
|
||||
[-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID
|
||||
'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d <cvsroot>]
|
||||
[-w <cvs-workdir>] [-W] [-f] [-m <msgprefix>] [<parent-commit>] <commit-id>
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
|
|
|
@ -8,7 +8,7 @@ git-gui - A portable graphical interface to Git
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git gui' [<command>] [arguments]
|
||||
'git gui' [<command>] [<arguments>]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
|
|
@ -9,12 +9,12 @@ SYNOPSIS
|
|||
--------
|
||||
[verse]
|
||||
'git help' [-a|--all [--[no-]verbose]] [-g|--guides]
|
||||
[-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]
|
||||
[-i|--info|-m|--man|-w|--web] [<command>|<guide>]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
||||
With no options and no COMMAND or GUIDE given, the synopsis of the 'git'
|
||||
With no options and no '<command>' or '<guide>' given, the synopsis of the 'git'
|
||||
command and a list of the most commonly used Git commands are printed
|
||||
on the standard output.
|
||||
|
||||
|
@ -31,7 +31,7 @@ variables.
|
|||
|
||||
If an alias is given, git shows the definition of the alias on
|
||||
standard output. To get the manual page for the aliased command, use
|
||||
`git COMMAND --help`.
|
||||
`git <command> --help`.
|
||||
|
||||
Note that `git --help ...` is identical to `git help ...` because the
|
||||
former is internally converted into the latter.
|
||||
|
|
|
@ -9,7 +9,7 @@ git-http-fetch - Download from a remote Git repository via HTTP
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [--stdin | --packfile=<hash> | <commit>] <url>
|
||||
'git http-fetch' [-c] [-t] [-a] [-d] [-v] [-w <filename>] [--recover] [--stdin | --packfile=<hash> | <commit>] <url>
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
|
|
@ -12,7 +12,7 @@ SYNOPSIS
|
|||
'git init' [-q | --quiet] [--bare] [--template=<template_directory>]
|
||||
[--separate-git-dir <git dir>] [--object-format=<format>]
|
||||
[-b <branch-name> | --initial-branch=<branch-name>]
|
||||
[--shared[=<permissions>]] [directory]
|
||||
[--shared[=<permissions>]] [<directory>]
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
|
|
|
@ -13,8 +13,8 @@ SYNOPSIS
|
|||
[--no-reuse-delta] [--delta-base-offset] [--non-empty]
|
||||
[--local] [--incremental] [--window=<n>] [--depth=<n>]
|
||||
[--revs [--unpacked | --all]] [--keep-pack=<pack-name>]
|
||||
[--stdout [--filter=<filter-spec>] | base-name]
|
||||
[--shallow] [--keep-true-parents] [--[no-]sparse] < object-list
|
||||
[--stdout [--filter=<filter-spec>] | <base-name>]
|
||||
[--shallow] [--keep-true-parents] [--[no-]sparse] < <object-list>
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
|
|
|
@ -9,7 +9,7 @@ git-pack-redundant - Find redundant pack files
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git pack-redundant' [ --verbose ] [ --alt-odb ] < --all | .pack filename ... >
|
||||
'git pack-redundant' [ --verbose ] [ --alt-odb ] ( --all | <pack-filename>... )
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
|
|
@ -17,12 +17,12 @@ The command takes various subcommands, and different options
|
|||
depending on the subcommand:
|
||||
|
||||
[verse]
|
||||
'git reflog' ['show'] [log-options] [<ref>]
|
||||
'git reflog' ['show'] [<log-options>] [<ref>]
|
||||
'git reflog expire' [--expire=<time>] [--expire-unreachable=<time>]
|
||||
[--rewrite] [--updateref] [--stale-fix]
|
||||
[--dry-run | -n] [--verbose] [--all [--single-worktree] | <refs>...]
|
||||
'git reflog delete' [--rewrite] [--updateref]
|
||||
[--dry-run | -n] [--verbose] ref@\{specifier\}...
|
||||
[--dry-run | -n] [--verbose] <ref>@\{<specifier>\}...
|
||||
'git reflog exists' <ref>
|
||||
|
||||
Reference logs, or "reflogs", record when the tips of branches and
|
||||
|
|
|
@ -11,7 +11,7 @@ given by a list of patterns.
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git sparse-checkout <subcommand> [options]'
|
||||
'git sparse-checkout <subcommand> [<options>]'
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
|
|
|
@ -9,7 +9,7 @@ git-stage - Add file contents to the staging area
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git stage' args...
|
||||
'git stage' <arg>...
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
|
|
Загрузка…
Ссылка в новой задаче