mirror of
https://github.com/git/git
synced 2024-07-04 16:48:40 +00:00
documentation: trivial style cleanups
White-spaces, missing braces, standardize --[no-]foo. Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Felipe Contreras
Junio C Hamano
parent
9b795193a6
commit
0460ed2c93
|
|
@ -9,12 +9,12 @@ git-am - Apply a series of patches from a mailbox
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git am' [--signoff] [--keep] [--keep-cr | --no-keep-cr] [--utf8 | --no-utf8]
|
||||
'git am' [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8]
|
||||
[--3way] [--interactive] [--committer-date-is-author-date]
|
||||
[--ignore-date] [--ignore-space-change | --ignore-whitespace]
|
||||
[--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>]
|
||||
[--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet]
|
||||
[--scissors | --no-scissors]
|
||||
[--[no-]scissors]
|
||||
[(<mbox> | <Maildir>)...]
|
||||
'git am' (--continue | --skip | --abort)
|
||||
|
||||
|
|
@ -43,8 +43,7 @@ OPTIONS
|
|||
--keep-non-patch::
|
||||
Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
|
||||
|
||||
--keep-cr::
|
||||
--no-keep-cr::
|
||||
--[no-]keep-cr::
|
||||
With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
|
||||
with the same option, to prevent it from stripping CR at the end of
|
||||
lines. `am.keepcr` configuration variable can be used to specify the
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ SYNOPSIS
|
|||
--------
|
||||
[verse]
|
||||
'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
|
||||
[-o | --output=<file>] [--worktree-attributes]
|
||||
[-o <file> | --output=<file>] [--worktree-attributes]
|
||||
[--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
|
||||
[<path>...]
|
||||
|
||||
|
|
|
|||
|
|
@ -83,8 +83,7 @@ typed the branch name.
|
|||
|
||||
OPTIONS
|
||||
-------
|
||||
--allow-onelevel::
|
||||
--no-allow-onelevel::
|
||||
--[no-]allow-onelevel::
|
||||
Controls whether one-level refnames are accepted (i.e.,
|
||||
refnames that do not contain multiple `/`-separated
|
||||
components). The default is `--no-allow-onelevel`.
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ SYNOPSIS
|
|||
[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
|
||||
[--separate-git-dir <git dir>]
|
||||
[--depth <depth>] [--[no-]single-branch]
|
||||
[--recursive|--recurse-submodules] [--] <repository>
|
||||
[--recursive | --recurse-submodules] [--] <repository>
|
||||
[<directory>]
|
||||
|
||||
DESCRIPTION
|
||||
|
|
@ -188,7 +188,7 @@ objects from the source repository into a pack in the cloned repository.
|
|||
with a long history, and would want to send in fixes
|
||||
as patches.
|
||||
|
||||
--single-branch::
|
||||
--[no-]single-branch::
|
||||
Clone only the history leading to the tip of a single branch,
|
||||
either specified by the `--branch` option or the primary
|
||||
branch remote's `HEAD` points at. When creating a shallow
|
||||
|
|
|
|||
|
|
@ -12,7 +12,7 @@ SYNOPSIS
|
|||
[--dry-run] [(-c | -C | --fixup | --squash) <commit>]
|
||||
[-F <file> | -m <msg>] [--reset-author] [--allow-empty]
|
||||
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
|
||||
[--date=<date>] [--cleanup=<mode>] [--status | --no-status]
|
||||
[--date=<date>] [--cleanup=<mode>] [--[no-]status]
|
||||
[-i | -o] [-S[<keyid>]] [--] [<file>...]
|
||||
|
||||
DESCRIPTION
|
||||
|
|
|
|||
|
|
@ -186,8 +186,7 @@ See also <<FILES>>.
|
|||
Opens an editor to modify the specified config file; either
|
||||
'--system', '--global', or repository (default).
|
||||
|
||||
--includes::
|
||||
--no-includes::
|
||||
--[no-]includes::
|
||||
Respect `include.*` directives in config files when looking up
|
||||
values. Defaults to on.
|
||||
|
||||
|
|
|
|||
|
|
@ -16,8 +16,10 @@ SYNOPSIS
|
|||
[--reuseaddr] [--detach] [--pid-file=<file>]
|
||||
[--enable=<service>] [--disable=<service>]
|
||||
[--allow-override=<service>] [--forbid-override=<service>]
|
||||
[--access-hook=<path>]
|
||||
[--inetd | [--listen=<host_or_ipaddr>] [--port=<n>] [--user=<user> [--group=<group>]]
|
||||
[--access-hook=<path>] [--[no-]informative-errors]
|
||||
[--inetd |
|
||||
[--listen=<host_or_ipaddr>] [--port=<n>]
|
||||
[--user=<user> [--group=<group>]]]
|
||||
[<directory>...]
|
||||
|
||||
DESCRIPTION
|
||||
|
|
@ -169,8 +171,7 @@ Git configuration files in that directory are readable by `<user>`.
|
|||
repository configuration. By default, all the services
|
||||
are overridable.
|
||||
|
||||
--informative-errors::
|
||||
--no-informative-errors::
|
||||
--[no-]informative-errors::
|
||||
When informative errors are turned on, git-daemon will report
|
||||
more verbose errors to the client, differentiating conditions
|
||||
like "no such repository" from "repository not exported". This
|
||||
|
|
|
|||
|
|
@ -69,8 +69,7 @@ with custom merge tool commands and has the same value as `$MERGED`.
|
|||
--tool-help::
|
||||
Print a list of diff tools that may be used with `--tool`.
|
||||
|
||||
--symlinks::
|
||||
--no-symlinks::
|
||||
--[no-]symlinks::
|
||||
'git difftool''s default behavior is create symlinks to the
|
||||
working tree when run in `--dir-diff` mode and the right-hand
|
||||
side of the comparison yields the same content as the file in
|
||||
|
|
|
|||
|
|
@ -106,11 +106,11 @@ marks the same across runs.
|
|||
different from the commit's first parent).
|
||||
|
||||
[<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~10..master` causes the
|
||||
current master reference to be exported along with all objects
|
||||
added since its 10th ancestor commit.
|
||||
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~10..master` causes the
|
||||
current master reference to be exported along with all objects
|
||||
added since its 10th ancestor commit.
|
||||
|
||||
EXAMPLES
|
||||
--------
|
||||
|
|
|
|||
|
|
@ -10,9 +10,9 @@ SYNOPSIS
|
|||
--------
|
||||
[verse]
|
||||
'git fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag]
|
||||
[--upload-pack=<git-upload-pack>]
|
||||
[--depth=<n>] [--no-progress]
|
||||
[-v] [<host>:]<directory> [<refs>...]
|
||||
[--upload-pack=<git-upload-pack>]
|
||||
[--depth=<n>] [--no-progress]
|
||||
[-v] [<host>:]<directory> [<refs>...]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
|
|
|||
|
|
@ -35,8 +35,7 @@ OPTIONS
|
|||
Do not list one-line descriptions from the actual commits being
|
||||
merged.
|
||||
|
||||
--summary::
|
||||
--no-summary::
|
||||
--[no-]summary::
|
||||
Synonyms to --log and --no-log; these are deprecated and will be
|
||||
removed in the future.
|
||||
|
||||
|
|
|
|||
|
|
@ -30,8 +30,7 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs
|
|||
Print out objects that exist but that aren't reachable from any
|
||||
of the reference nodes.
|
||||
|
||||
--dangling::
|
||||
--no-dangling::
|
||||
--[no-]dangling::
|
||||
Print objects that exist but that are never 'directly' used (default).
|
||||
`--no-dangling` can be used to omit this information from the output.
|
||||
|
||||
|
|
@ -78,8 +77,7 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs
|
|||
a blob, the contents are written into the file, rather than
|
||||
its object name.
|
||||
|
||||
--progress::
|
||||
--no-progress::
|
||||
--[no-]progress::
|
||||
Progress status is reported on the standard error stream by
|
||||
default when it is attached to a terminal, unless
|
||||
--no-progress or --verbose is specified. --progress forces
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ SYNOPSIS
|
|||
[-W | --function-context]
|
||||
[-f <file>] [-e] <pattern>
|
||||
[--and|--or|--not|(|)|-e <pattern>...]
|
||||
[ [--exclude-standard] [--cached | --no-index | --untracked] | <tree>...]
|
||||
[ [--[no-]exclude-standard] [--cached | --no-index | --untracked] | <tree>...]
|
||||
[--] [<pathspec>...]
|
||||
|
||||
DESCRIPTION
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ git-mailinfo - Extracts patch and authorship from a single e-mail message
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch>
|
||||
'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--[no-]scissors] <msg> <patch>
|
||||
|
||||
|
||||
DESCRIPTION
|
||||
|
|
|
|||
|
|
@ -76,8 +76,7 @@ The 'git fmt-merge-msg' command can be
|
|||
used to give a good default for automated 'git merge'
|
||||
invocations.
|
||||
|
||||
--rerere-autoupdate::
|
||||
--no-rerere-autoupdate::
|
||||
--[no-]rerere-autoupdate::
|
||||
Allow the rerere mechanism to update the index with the
|
||||
result of auto-conflict resolution if possible.
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ git-mergetool - Run merge conflict resolution tools to resolve merge conflicts
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git mergetool' [--tool=<tool>] [-y|--no-prompt|--prompt] [<file>...]
|
||||
'git mergetool' [--tool=<tool>] [-y | --[no-]prompt] [<file>...]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
|
|
|
|||
|
|
@ -162,8 +162,7 @@ useful if you write an alias or script around 'git push'.
|
|||
linkgit:git-pull[1] and other commands. For more information,
|
||||
see 'branch.<name>.merge' in linkgit:git-config[1].
|
||||
|
||||
--thin::
|
||||
--no-thin::
|
||||
--[no-]thin::
|
||||
These options are passed to linkgit:git-send-pack[1]. A thin transfer
|
||||
significantly reduces the amount of sent data when the sender and
|
||||
receiver share many of the same objects in common. The default is
|
||||
|
|
|
|||
|
|
@ -10,7 +10,7 @@ SYNOPSIS
|
|||
--------
|
||||
[verse]
|
||||
'git remote' [-v | --verbose]
|
||||
'git remote add' [-t <branch>] [-m <master>] [-f] [--tags|--no-tags] [--mirror=<fetch|push>] <name> <url>
|
||||
'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=<fetch|push>] <name> <url>
|
||||
'git remote rename' <old> <new>
|
||||
'git remote remove' <name>
|
||||
'git remote set-head' <name> (-a | -d | <branch>)
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ git-revert - Revert some existing commits
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit>...
|
||||
'git revert' [--[no-]edit] [-n] [-m parent-number] [-s] <commit>...
|
||||
'git revert' --continue
|
||||
'git revert' --quit
|
||||
'git revert' --abort
|
||||
|
|
|
|||
|
|
@ -14,8 +14,8 @@ SYNOPSIS
|
|||
[--refresh] [-q] [--unmerged] [--ignore-missing]
|
||||
[(--cacheinfo <mode> <object> <file>)...]
|
||||
[--chmod=(+|-)x]
|
||||
[--assume-unchanged | --no-assume-unchanged]
|
||||
[--skip-worktree | --no-skip-worktree]
|
||||
[--[no-]assume-unchanged]
|
||||
[--[no-]skip-worktree]
|
||||
[--ignore-submodules]
|
||||
[--really-refresh] [--unresolve] [--again | -g]
|
||||
[--info-only] [--index-info]
|
||||
|
|
@ -77,8 +77,7 @@ OPTIONS
|
|||
--chmod=(+|-)x::
|
||||
Set the execute permissions on the updated files.
|
||||
|
||||
--assume-unchanged::
|
||||
--no-assume-unchanged::
|
||||
--[no-]assume-unchanged::
|
||||
When these flags are specified, the object names recorded
|
||||
for the paths are not updated. Instead, these options
|
||||
set and unset the "assume unchanged" bit for the
|
||||
|
|
@ -102,8 +101,7 @@ you will need to handle the situation manually.
|
|||
Like '--refresh', but checks stat information unconditionally,
|
||||
without regard to the "assume unchanged" setting.
|
||||
|
||||
--skip-worktree::
|
||||
--no-skip-worktree::
|
||||
--[no-]skip-worktree::
|
||||
When one of these flags is specified, the object name recorded
|
||||
for the paths are not updated. Instead, these options
|
||||
set and unset the "skip-worktree" bit for the paths. See
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user