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>
Felipe Contreras committed
May 8, 2013 at 20:16 UTC
0460ed2c93d78c753242f835c441f320f792ac54
20 files changed
+37
-47
Documentation/git-am.txt
+3
-4
@@ -9,12 +9,12 @@ git-am - Apply a series of patches from a mailbox
9
SYNOPSIS
10
--------
11
[verse]
12
-'git am' [--signoff] [--keep] [--keep-cr | --no-keep-cr] [--utf8 | --no-utf8]
12
+'git am' [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8]
13
[--3way] [--interactive] [--committer-date-is-author-date]
14
[--ignore-date] [--ignore-space-change | --ignore-whitespace]
15
[--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>]
16
[--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet]
17
- [--scissors | --no-scissors]
17
+ [--[no-]scissors]
18
[(<mbox> | <Maildir>)...]
19
'git am' (--continue | --skip | --abort)
20
@@ -43,8 +43,7 @@ OPTIONS
43
--keep-non-patch::
44
Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
45
46
---keep-cr::
47
---no-keep-cr::
46
+--[no-]keep-cr::
47
With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
48
with the same option, to prevent it from stripping CR at the end of
49
lines. `am.keepcr` configuration variable can be used to specify the
Documentation/git-archive.txt
+1
-1
@@ -10,7 +10,7 @@ SYNOPSIS
10
--------
11
[verse]
12
'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
13
- [-o | --output=<file>] [--worktree-attributes]
13
+ [-o <file> | --output=<file>] [--worktree-attributes]
14
[--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
15
[<path>...]
16
Documentation/git-check-ref-format.txt
+1
-2
@@ -83,8 +83,7 @@ typed the branch name.
83
84
OPTIONS
85
-------
86
---allow-onelevel::
87
---no-allow-onelevel::
86
+--[no-]allow-onelevel::
87
Controls whether one-level refnames are accepted (i.e.,
88
refnames that do not contain multiple `/`-separated
89
components). The default is `--no-allow-onelevel`.
Documentation/git-clone.txt
+2
-2
@@ -14,7 +14,7 @@ SYNOPSIS
14
[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
15
[--separate-git-dir <git dir>]
16
[--depth <depth>] [--[no-]single-branch]
17
- [--recursive|--recurse-submodules] [--] <repository>
17
+ [--recursive | --recurse-submodules] [--] <repository>
18
[<directory>]
19
20
DESCRIPTION
@@ -188,7 +188,7 @@ objects from the source repository into a pack in the cloned repository.
188
with a long history, and would want to send in fixes
189
as patches.
190
191
---single-branch::
191
+--[no-]single-branch::
192
Clone only the history leading to the tip of a single branch,
193
either specified by the `--branch` option or the primary
194
branch remote's `HEAD` points at. When creating a shallow
Documentation/git-commit.txt
+1
-1
@@ -12,7 +12,7 @@ SYNOPSIS
12
[--dry-run] [(-c | -C | --fixup | --squash) <commit>]
13
[-F <file> | -m <msg>] [--reset-author] [--allow-empty]
14
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
15
- [--date=<date>] [--cleanup=<mode>] [--status | --no-status]
15
+ [--date=<date>] [--cleanup=<mode>] [--[no-]status]
16
[-i | -o] [-S[<keyid>]] [--] [<file>...]
17
18
DESCRIPTION
Documentation/git-config.txt
+1
-2
@@ -186,8 +186,7 @@ See also <<FILES>>.
186
Opens an editor to modify the specified config file; either
187
'--system', '--global', or repository (default).
188
189
---includes::
190
---no-includes::
189
+--[no-]includes::
190
Respect `include.*` directives in config files when looking up
191
values. Defaults to on.
192
Documentation/git-daemon.txt
+5
-4
@@ -16,8 +16,10 @@ SYNOPSIS
16
[--reuseaddr] [--detach] [--pid-file=<file>]
17
[--enable=<service>] [--disable=<service>]
18
[--allow-override=<service>] [--forbid-override=<service>]
19
- [--access-hook=<path>]
20
- [--inetd | [--listen=<host_or_ipaddr>] [--port=<n>] [--user=<user> [--group=<group>]]
19
+ [--access-hook=<path>] [--[no-]informative-errors]
20
+ [--inetd |
21
+ [--listen=<host_or_ipaddr>] [--port=<n>]
22
+ [--user=<user> [--group=<group>]]]
23
[<directory>...]
24
25
DESCRIPTION
@@ -169,8 +171,7 @@ Git configuration files in that directory are readable by `<user>`.
171
repository configuration. By default, all the services
172
are overridable.
173
172
---informative-errors::
173
---no-informative-errors::
174
+--[no-]informative-errors::
175
When informative errors are turned on, git-daemon will report
176
more verbose errors to the client, differentiating conditions
177
like "no such repository" from "repository not exported". This
Documentation/git-difftool.txt
+1
-2
@@ -69,8 +69,7 @@ with custom merge tool commands and has the same value as `$MERGED`.
69
--tool-help::
70
Print a list of diff tools that may be used with `--tool`.
71
72
---symlinks::
73
---no-symlinks::
72
+--[no-]symlinks::
73
'git difftool''s default behavior is create symlinks to the
74
working tree when run in `--dir-diff` mode and the right-hand
75
side of the comparison yields the same content as the file in
Documentation/git-fast-export.txt
+5
-5
@@ -106,11 +106,11 @@ marks the same across runs.
106
different from the commit's first parent).
107
108
[<git-rev-list-args>...]::
109
- A list of arguments, acceptable to 'git rev-parse' and
110
- 'git rev-list', that specifies the specific objects and references
111
- to export. For example, `master~10..master` causes the
112
- current master reference to be exported along with all objects
113
- added since its 10th ancestor commit.
109
+ A list of arguments, acceptable to 'git rev-parse' and
110
+ 'git rev-list', that specifies the specific objects and references
111
+ to export. For example, `master~10..master` causes the
112
+ current master reference to be exported along with all objects
113
+ added since its 10th ancestor commit.
114
115
EXAMPLES
116
--------
Documentation/git-fetch-pack.txt
+3
-3
@@ -10,9 +10,9 @@ SYNOPSIS
10
--------
11
[verse]
12
'git fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag]
13
- [--upload-pack=<git-upload-pack>]
14
- [--depth=<n>] [--no-progress]
15
- [-v] [<host>:]<directory> [<refs>...]
13
+ [--upload-pack=<git-upload-pack>]
14
+ [--depth=<n>] [--no-progress]
15
+ [-v] [<host>:]<directory> [<refs>...]
16
17
DESCRIPTION
18
-----------
Documentation/git-fmt-merge-msg.txt
+1
-2
@@ -35,8 +35,7 @@ OPTIONS
35
Do not list one-line descriptions from the actual commits being
36
merged.
37
38
---summary::
39
---no-summary::
38
+--[no-]summary::
39
Synonyms to --log and --no-log; these are deprecated and will be
40
removed in the future.
41
Documentation/git-fsck.txt
+2
-4
@@ -30,8 +30,7 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs
30
Print out objects that exist but that aren't reachable from any
31
of the reference nodes.
32
33
---dangling::
34
---no-dangling::
33
+--[no-]dangling::
34
Print objects that exist but that are never 'directly' used (default).
35
`--no-dangling` can be used to omit this information from the output.
36
@@ -78,8 +77,7 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs
77
a blob, the contents are written into the file, rather than
78
its object name.
79
81
---progress::
82
---no-progress::
80
+--[no-]progress::
81
Progress status is reported on the standard error stream by
82
default when it is attached to a terminal, unless
83
--no-progress or --verbose is specified. --progress forces
Documentation/git-grep.txt
+1
-1
@@ -25,7 +25,7 @@ SYNOPSIS
25
[-W | --function-context]
26
[-f <file>] [-e] <pattern>
27
[--and|--or|--not|(|)|-e <pattern>...]
28
- [ [--exclude-standard] [--cached | --no-index | --untracked] | <tree>...]
28
+ [ [--[no-]exclude-standard] [--cached | --no-index | --untracked] | <tree>...]
29
[--] [<pathspec>...]
30
31
DESCRIPTION
Documentation/git-mailinfo.txt
+1
-1
@@ -9,7 +9,7 @@ git-mailinfo - Extracts patch and authorship from a single e-mail message
9
SYNOPSIS
10
--------
11
[verse]
12
-'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--scissors] <msg> <patch>
12
+'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--[no-]scissors] <msg> <patch>
13
14
15
DESCRIPTION
Documentation/git-merge.txt
+1
-2
@@ -76,8 +76,7 @@ The 'git fmt-merge-msg' command can be
76
used to give a good default for automated 'git merge'
77
invocations.
78
79
---rerere-autoupdate::
80
---no-rerere-autoupdate::
79
+--[no-]rerere-autoupdate::
80
Allow the rerere mechanism to update the index with the
81
result of auto-conflict resolution if possible.
82
Documentation/git-mergetool.txt
+1
-1
@@ -8,7 +8,7 @@ git-mergetool - Run merge conflict resolution tools to resolve merge conflicts
8
SYNOPSIS
9
--------
10
[verse]
11
-'git mergetool' [--tool=<tool>] [-y|--no-prompt|--prompt] [<file>...]
11
+'git mergetool' [--tool=<tool>] [-y | --[no-]prompt] [<file>...]
12
13
DESCRIPTION
14
-----------
Documentation/git-push.txt
+1
-2
@@ -162,8 +162,7 @@ useful if you write an alias or script around 'git push'.
162
linkgit:git-pull[1] and other commands. For more information,
163
see 'branch.<name>.merge' in linkgit:git-config[1].
164
165
---thin::
166
---no-thin::
165
+--[no-]thin::
166
These options are passed to linkgit:git-send-pack[1]. A thin transfer
167
significantly reduces the amount of sent data when the sender and
168
receiver share many of the same objects in common. The default is
Documentation/git-remote.txt
+1
-1
@@ -10,7 +10,7 @@ SYNOPSIS
10
--------
11
[verse]
12
'git remote' [-v | --verbose]
13
-'git remote add' [-t <branch>] [-m <master>] [-f] [--tags|--no-tags] [--mirror=<fetch|push>] <name> <url>
13
+'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=<fetch|push>] <name> <url>
14
'git remote rename' <old> <new>
15
'git remote remove' <name>
16
'git remote set-head' <name> (-a | -d | <branch>)
Documentation/git-revert.txt
+1
-1
@@ -8,7 +8,7 @@ git-revert - Revert some existing commits
8
SYNOPSIS
9
--------
10
[verse]
11
-'git revert' [--edit | --no-edit] [-n] [-m parent-number] [-s] <commit>...
11
+'git revert' [--[no-]edit] [-n] [-m parent-number] [-s] <commit>...
12
'git revert' --continue
13
'git revert' --quit
14
'git revert' --abort
Documentation/git-update-index.txt
+4
-6
@@ -14,8 +14,8 @@ SYNOPSIS
14
[--refresh] [-q] [--unmerged] [--ignore-missing]
15
[(--cacheinfo <mode> <object> <file>)...]
16
[--chmod=(+|-)x]
17
- [--assume-unchanged | --no-assume-unchanged]
18
- [--skip-worktree | --no-skip-worktree]
17
+ [--[no-]assume-unchanged]
18
+ [--[no-]skip-worktree]
19
[--ignore-submodules]
20
[--really-refresh] [--unresolve] [--again | -g]
21
[--info-only] [--index-info]
@@ -77,8 +77,7 @@ OPTIONS
77
--chmod=(+|-)x::
78
Set the execute permissions on the updated files.
79
80
---assume-unchanged::
81
---no-assume-unchanged::
80
+--[no-]assume-unchanged::
81
When these flags are specified, the object names recorded
82
for the paths are not updated. Instead, these options
83
set and unset the "assume unchanged" bit for the
@@ -102,8 +101,7 @@ you will need to handle the situation manually.
101
Like '--refresh', but checks stat information unconditionally,
102
without regard to the "assume unchanged" setting.
103
105
---skip-worktree::
106
---no-skip-worktree::
104
+--[no-]skip-worktree::
105
When one of these flags is specified, the object name recorded
106
for the paths are not updated. Instead, these options
107
set and unset the "skip-worktree" bit for the paths. See