Skip to content

Commit 680ed3e

Browse files
committed
Merge branch 'fc/doc-style'
* fc/doc-style: documentation: trivial style cleanups
2 parents 8639f3e + 0460ed2 commit 680ed3e

20 files changed

+37
-47
lines changed

Documentation/git-am.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ git-am - Apply a series of patches from a mailbox
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git am' [--signoff] [--keep] [--keep-cr | --no-keep-cr] [--utf8 | --no-utf8]
12+
'git am' [--signoff] [--keep] [--[no-]keep-cr] [--[no-]utf8]
1313
[--3way] [--interactive] [--committer-date-is-author-date]
1414
[--ignore-date] [--ignore-space-change | --ignore-whitespace]
1515
[--whitespace=<option>] [-C<n>] [-p<n>] [--directory=<dir>]
1616
[--exclude=<path>] [--include=<path>] [--reject] [-q | --quiet]
17-
[--scissors | --no-scissors]
17+
[--[no-]scissors]
1818
[(<mbox> | <Maildir>)...]
1919
'git am' (--continue | --skip | --abort)
2020

@@ -43,8 +43,7 @@ OPTIONS
4343
--keep-non-patch::
4444
Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
4545

46-
--keep-cr::
47-
--no-keep-cr::
46+
--[no-]keep-cr::
4847
With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
4948
with the same option, to prevent it from stripping CR at the end of
5049
lines. `am.keepcr` configuration variable can be used to specify the

Documentation/git-archive.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ SYNOPSIS
1010
--------
1111
[verse]
1212
'git archive' [--format=<fmt>] [--list] [--prefix=<prefix>/] [<extra>]
13-
[-o | --output=<file>] [--worktree-attributes]
13+
[-o <file> | --output=<file>] [--worktree-attributes]
1414
[--remote=<repo> [--exec=<git-upload-archive>]] <tree-ish>
1515
[<path>...]
1616

Documentation/git-check-ref-format.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,7 @@ typed the branch name.
8383

8484
OPTIONS
8585
-------
86-
--allow-onelevel::
87-
--no-allow-onelevel::
86+
--[no-]allow-onelevel::
8887
Controls whether one-level refnames are accepted (i.e.,
8988
refnames that do not contain multiple `/`-separated
9089
components). The default is `--no-allow-onelevel`.

Documentation/git-clone.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ SYNOPSIS
1414
[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
1515
[--separate-git-dir <git dir>]
1616
[--depth <depth>] [--[no-]single-branch]
17-
[--recursive|--recurse-submodules] [--] <repository>
17+
[--recursive | --recurse-submodules] [--] <repository>
1818
[<directory>]
1919

2020
DESCRIPTION
@@ -188,7 +188,7 @@ objects from the source repository into a pack in the cloned repository.
188188
with a long history, and would want to send in fixes
189189
as patches.
190190

191-
--single-branch::
191+
--[no-]single-branch::
192192
Clone only the history leading to the tip of a single branch,
193193
either specified by the `--branch` option or the primary
194194
branch remote's `HEAD` points at. When creating a shallow

Documentation/git-commit.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ SYNOPSIS
1212
[--dry-run] [(-c | -C | --fixup | --squash) <commit>]
1313
[-F <file> | -m <msg>] [--reset-author] [--allow-empty]
1414
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
15-
[--date=<date>] [--cleanup=<mode>] [--status | --no-status]
15+
[--date=<date>] [--cleanup=<mode>] [--[no-]status]
1616
[-i | -o] [-S[<keyid>]] [--] [<file>...]
1717

1818
DESCRIPTION

Documentation/git-config.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -186,8 +186,7 @@ See also <<FILES>>.
186186
Opens an editor to modify the specified config file; either
187187
'--system', '--global', or repository (default).
188188

189-
--includes::
190-
--no-includes::
189+
--[no-]includes::
191190
Respect `include.*` directives in config files when looking up
192191
values. Defaults to on.
193192

Documentation/git-daemon.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,10 @@ SYNOPSIS
1616
[--reuseaddr] [--detach] [--pid-file=<file>]
1717
[--enable=<service>] [--disable=<service>]
1818
[--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>]]]
2123
[<directory>...]
2224

2325
DESCRIPTION
@@ -169,8 +171,7 @@ Git configuration files in that directory are readable by `<user>`.
169171
repository configuration. By default, all the services
170172
are overridable.
171173

172-
--informative-errors::
173-
--no-informative-errors::
174+
--[no-]informative-errors::
174175
When informative errors are turned on, git-daemon will report
175176
more verbose errors to the client, differentiating conditions
176177
like "no such repository" from "repository not exported". This

Documentation/git-difftool.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,7 @@ with custom merge tool commands and has the same value as `$MERGED`.
6969
--tool-help::
7070
Print a list of diff tools that may be used with `--tool`.
7171

72-
--symlinks::
73-
--no-symlinks::
72+
--[no-]symlinks::
7473
'git difftool''s default behavior is create symlinks to the
7574
working tree when run in `--dir-diff` mode and the right-hand
7675
side of the comparison yields the same content as the file in

Documentation/git-fast-export.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,11 @@ marks the same across runs.
106106
different from the commit's first parent).
107107

108108
[<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.
114114

115115
EXAMPLES
116116
--------

Documentation/git-fetch-pack.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ SYNOPSIS
1010
--------
1111
[verse]
1212
'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>...]
1616

1717
DESCRIPTION
1818
-----------

0 commit comments

Comments
 (0)