Skip to content

Commit 1c262bb

Browse files
peffgitster
authored andcommitted
doc: convert \--option to --option
Older versions of AsciiDoc would convert the "--" in "--option" into an emdash. According to 565e135 (Documentation: quote double-dash for AsciiDoc, 2011-06-29), this is fixed in AsciiDoc 8.3.0. According to bf17126, we don't support anything older than 8.4.1 anyway, so we no longer need to worry about quoting. Even though this does not change the output at all, there are a few good reasons to drop the quoting: 1. It makes the source prettier to read. 2. We don't quote consistently, which may be confusing when reading the source. 3. Asciidoctor does not like the quoting, and renders a literal backslash. Signed-off-by: Jeff King <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 0a3ca9c commit 1c262bb

11 files changed

+80
-80
lines changed

Documentation/config.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2256,18 +2256,18 @@ remote.<name>.skipFetchAll::
22562256

22572257
remote.<name>.receivepack::
22582258
The default program to execute on the remote side when pushing. See
2259-
option \--receive-pack of linkgit:git-push[1].
2259+
option --receive-pack of linkgit:git-push[1].
22602260

22612261
remote.<name>.uploadpack::
22622262
The default program to execute on the remote side when fetching. See
2263-
option \--upload-pack of linkgit:git-fetch-pack[1].
2263+
option --upload-pack of linkgit:git-fetch-pack[1].
22642264

22652265
remote.<name>.tagopt::
2266-
Setting this value to \--no-tags disables automatic tag following when
2267-
fetching from remote <name>. Setting it to \--tags will fetch every
2266+
Setting this value to --no-tags disables automatic tag following when
2267+
fetching from remote <name>. Setting it to --tags will fetch every
22682268
tag from remote <name>, even if they are not reachable from remote
22692269
branch heads. Passing these flags directly to linkgit:git-fetch[1] can
2270-
override this setting. See options \--tags and \--no-tags of
2270+
override this setting. See options --tags and --no-tags of
22712271
linkgit:git-fetch[1].
22722272

22732273
remote.<name>.vcs::

Documentation/git-fast-export.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,17 +67,17 @@ produced incorrect results if you gave these options.
6767
have been completed, or to save the marks table across
6868
incremental runs. As <file> is only opened and truncated
6969
at completion, the same path can also be safely given to
70-
\--import-marks.
70+
--import-marks.
7171
The file will not be written if no new object has been
7272
marked/exported.
7373

7474
--import-marks=<file>::
7575
Before processing any input, load the marks specified in
7676
<file>. The input file must exist, must be readable, and
77-
must use the same format as produced by \--export-marks.
77+
must use the same format as produced by --export-marks.
7878
+
7979
Any commits that have already been marked will not be exported again.
80-
If the backend uses a similar \--import-marks file, this allows for
80+
If the backend uses a similar --import-marks file, this allows for
8181
incremental bidirectional exporting of the repository by keeping the
8282
marks the same across runs.
8383

Documentation/git-fast-import.txt

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,13 @@ OPTIONS
4242
--quiet::
4343
Disable all non-fatal output, making fast-import silent when it
4444
is successful. This option disables the output shown by
45-
\--stats.
45+
--stats.
4646

4747
--stats::
4848
Display some basic statistics about the objects fast-import has
4949
created, the packfiles they were stored into, and the
5050
memory used by fast-import during this run. Showing this output
51-
is currently the default, but can be disabled with \--quiet.
51+
is currently the default, but can be disabled with --quiet.
5252

5353
Options for Frontends
5454
~~~~~~~~~~~~~~~~~~~~~
@@ -81,12 +81,12 @@ Locations of Marks Files
8181
have been completed, or to save the marks table across
8282
incremental runs. As <file> is only opened and truncated
8383
at checkpoint (or completion) the same path can also be
84-
safely given to \--import-marks.
84+
safely given to --import-marks.
8585

8686
--import-marks=<file>::
8787
Before processing any input, load the marks specified in
8888
<file>. The input file must exist, must be readable, and
89-
must use the same format as produced by \--export-marks.
89+
must use the same format as produced by --export-marks.
9090
Multiple options may be supplied to import more than one
9191
set of marks. If a mark is defined to different values,
9292
the last file wins.
@@ -179,8 +179,8 @@ fast-forward update, fast-import will skip updating that ref and instead
179179
prints a warning message. fast-import will always attempt to update all
180180
branch refs, and does not stop on the first failure.
181181

182-
Branch updates can be forced with \--force, but it's recommended that
183-
this only be used on an otherwise quiet repository. Using \--force
182+
Branch updates can be forced with --force, but it's recommended that
183+
this only be used on an otherwise quiet repository. Using --force
184184
is not necessary for an initial import into an empty repository.
185185

186186

@@ -231,11 +231,11 @@ Date Formats
231231
~~~~~~~~~~~~
232232
The following date formats are supported. A frontend should select
233233
the format it will use for this import by passing the format name
234-
in the \--date-format=<fmt> command-line option.
234+
in the --date-format=<fmt> command-line option.
235235

236236
`raw`::
237237
This is the Git native format and is `<time> SP <offutc>`.
238-
It is also fast-import's default format, if \--date-format was
238+
It is also fast-import's default format, if --date-format was
239239
not specified.
240240
+
241241
The time of the event is specified by `<time>` as the number of
@@ -437,7 +437,7 @@ the email address from the other fields in the line. Note that
437437
of bytes, except `LT`, `GT` and `LF`. `<name>` is typically UTF-8 encoded.
438438

439439
The time of the change is specified by `<when>` using the date format
440-
that was selected by the \--date-format=<fmt> command-line option.
440+
that was selected by the --date-format=<fmt> command-line option.
441441
See ``Date Formats'' above for the set of supported formats, and
442442
their syntax.
443443

@@ -888,7 +888,7 @@ save out all current branch refs, tags and marks.
888888
....
889889

890890
Note that fast-import automatically switches packfiles when the current
891-
packfile reaches \--max-pack-size, or 4 GiB, whichever limit is
891+
packfile reaches --max-pack-size, or 4 GiB, whichever limit is
892892
smaller. During an automatic packfile switch fast-import does not update
893893
the branch refs, tags or marks.
894894

@@ -1226,7 +1226,7 @@ users of fast-import, and are offered here as suggestions.
12261226
Use One Mark Per Commit
12271227
~~~~~~~~~~~~~~~~~~~~~~~
12281228
When doing a repository conversion, use a unique mark per commit
1229-
(`mark :<n>`) and supply the \--export-marks option on the command
1229+
(`mark :<n>`) and supply the --export-marks option on the command
12301230
line. fast-import will dump a file which lists every mark and the Git
12311231
object SHA-1 that corresponds to it. If the frontend can tie
12321232
the marks back to the source repository, it is easy to verify the
@@ -1291,7 +1291,7 @@ even for considerably large projects (100,000+ commits).
12911291

12921292
However repacking the repository is necessary to improve data
12931293
locality and access performance. It can also take hours on extremely
1294-
large projects (especially if -f and a large \--window parameter is
1294+
large projects (especially if -f and a large --window parameter is
12951295
used). Since repacking is safe to run alongside readers and writers,
12961296
run the repack in the background and let it finish when it finishes.
12971297
There is no reason to wait to explore your new Git project!
@@ -1305,7 +1305,7 @@ Repacking Historical Data
13051305
~~~~~~~~~~~~~~~~~~~~~~~~~
13061306
If you are repacking very old imported data (e.g. older than the
13071307
last year), consider expending some extra CPU time and supplying
1308-
\--window=50 (or higher) when you run 'git repack'.
1308+
--window=50 (or higher) when you run 'git repack'.
13091309
This will take longer, but will also produce a smaller packfile.
13101310
You only need to expend the effort once, and everyone using your
13111311
project will benefit from the smaller repository.
@@ -1407,7 +1407,7 @@ branch, their in-memory storage size can grow to a considerable size
14071407
fast-import automatically moves active branches to inactive status based on
14081408
a simple least-recently-used algorithm. The LRU chain is updated on
14091409
each `commit` command. The maximum number of active branches can be
1410-
increased or decreased on the command line with \--active-branches=.
1410+
increased or decreased on the command line with --active-branches=.
14111411

14121412
per active tree
14131413
~~~~~~~~~~~~~~~

Documentation/git-fetch-pack.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ be in a separate packet, and the list must end with a flush packet.
8080
the things up in .bash_profile).
8181

8282
--exec=<git-upload-pack>::
83-
Same as \--upload-pack=<git-upload-pack>.
83+
Same as --upload-pack=<git-upload-pack>.
8484

8585
--depth=<n>::
8686
Limit fetching to ancestor-chains not longer than n.

Documentation/git-pack-objects.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ self-contained. Use `git index-pack --fix-thin`
192192

193193
--shallow::
194194
Optimize a pack that will be provided to a client with a shallow
195-
repository. This option, combined with \--thin, can result in a
195+
repository. This option, combined with --thin, can result in a
196196
smaller pack at the cost of speed.
197197

198198
--delta-base-offset::

Documentation/git-push.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -257,8 +257,8 @@ origin +master` to force a push to the `master` branch). See the
257257

258258
--[no-]verify::
259259
Toggle the pre-push hook (see linkgit:githooks[5]). The
260-
default is \--verify, giving the hook a chance to prevent the
261-
push. With \--no-verify, the hook is bypassed completely.
260+
default is --verify, giving the hook a chance to prevent the
261+
push. With --no-verify, the hook is bypassed completely.
262262

263263

264264
include::urls-remotes.txt[]

Documentation/git-rev-list.txt

Lines changed: 48 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -9,54 +9,54 @@ git-rev-list - Lists commit objects in reverse chronological order
99
SYNOPSIS
1010
--------
1111
[verse]
12-
'git rev-list' [ \--max-count=<number> ]
13-
[ \--skip=<number> ]
14-
[ \--max-age=<timestamp> ]
15-
[ \--min-age=<timestamp> ]
16-
[ \--sparse ]
17-
[ \--merges ]
18-
[ \--no-merges ]
19-
[ \--min-parents=<number> ]
20-
[ \--no-min-parents ]
21-
[ \--max-parents=<number> ]
22-
[ \--no-max-parents ]
23-
[ \--first-parent ]
24-
[ \--remove-empty ]
25-
[ \--full-history ]
26-
[ \--not ]
27-
[ \--all ]
28-
[ \--branches[=<pattern>] ]
29-
[ \--tags[=<pattern>] ]
30-
[ \--remotes[=<pattern>] ]
31-
[ \--glob=<glob-pattern> ]
32-
[ \--ignore-missing ]
33-
[ \--stdin ]
34-
[ \--quiet ]
35-
[ \--topo-order ]
36-
[ \--parents ]
37-
[ \--timestamp ]
38-
[ \--left-right ]
39-
[ \--left-only ]
40-
[ \--right-only ]
41-
[ \--cherry-mark ]
42-
[ \--cherry-pick ]
43-
[ \--encoding=<encoding> ]
44-
[ \--(author|committer|grep)=<pattern> ]
45-
[ \--regexp-ignore-case | -i ]
46-
[ \--extended-regexp | -E ]
47-
[ \--fixed-strings | -F ]
48-
[ \--date=(local|relative|default|iso|iso-strict|rfc|short) ]
49-
[ [ \--objects | \--objects-edge | \--objects-edge-aggressive ]
50-
[ \--unpacked ] ]
51-
[ \--pretty | \--header ]
52-
[ \--bisect ]
53-
[ \--bisect-vars ]
54-
[ \--bisect-all ]
55-
[ \--merge ]
56-
[ \--reverse ]
57-
[ \--walk-reflogs ]
58-
[ \--no-walk ] [ \--do-walk ]
59-
[ \--use-bitmap-index ]
12+
'git rev-list' [ --max-count=<number> ]
13+
[ --skip=<number> ]
14+
[ --max-age=<timestamp> ]
15+
[ --min-age=<timestamp> ]
16+
[ --sparse ]
17+
[ --merges ]
18+
[ --no-merges ]
19+
[ --min-parents=<number> ]
20+
[ --no-min-parents ]
21+
[ --max-parents=<number> ]
22+
[ --no-max-parents ]
23+
[ --first-parent ]
24+
[ --remove-empty ]
25+
[ --full-history ]
26+
[ --not ]
27+
[ --all ]
28+
[ --branches[=<pattern>] ]
29+
[ --tags[=<pattern>] ]
30+
[ --remotes[=<pattern>] ]
31+
[ --glob=<glob-pattern> ]
32+
[ --ignore-missing ]
33+
[ --stdin ]
34+
[ --quiet ]
35+
[ --topo-order ]
36+
[ --parents ]
37+
[ --timestamp ]
38+
[ --left-right ]
39+
[ --left-only ]
40+
[ --right-only ]
41+
[ --cherry-mark ]
42+
[ --cherry-pick ]
43+
[ --encoding=<encoding> ]
44+
[ --(author|committer|grep)=<pattern> ]
45+
[ --regexp-ignore-case | -i ]
46+
[ --extended-regexp | -E ]
47+
[ --fixed-strings | -F ]
48+
[ --date=(local|relative|default|iso|iso-strict|rfc|short) ]
49+
[ [ --objects | --objects-edge | --objects-edge-aggressive ]
50+
[ --unpacked ] ]
51+
[ --pretty | --header ]
52+
[ --bisect ]
53+
[ --bisect-vars ]
54+
[ --bisect-all ]
55+
[ --merge ]
56+
[ --reverse ]
57+
[ --walk-reflogs ]
58+
[ --no-walk ] [ --do-walk ]
59+
[ --use-bitmap-index ]
6060
<commit>... [ \-- <paths>... ]
6161

6262
DESCRIPTION

Documentation/git-rev-parse.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ can be used.
147147
form as close to the original input as possible.
148148

149149
--symbolic-full-name::
150-
This is similar to \--symbolic, but it omits input that
150+
This is similar to --symbolic, but it omits input that
151151
are not refs (i.e. branch or tag names; or more
152152
explicitly disambiguating "heads/master" form, when you
153153
want to name the "master" branch when there is an

Documentation/git-send-pack.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ OPTIONS
2929
a directory on the default $PATH.
3030

3131
--exec=<git-receive-pack>::
32-
Same as \--receive-pack=<git-receive-pack>.
32+
Same as --receive-pack=<git-receive-pack>.
3333

3434
--all::
3535
Instead of explicitly specifying which refs to update,

Documentation/git-show.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ presents the merge commit in a special format as produced by
2222
For tags, it shows the tag message and the referenced objects.
2323

2424
For trees, it shows the names (equivalent to 'git ls-tree'
25-
with \--name-only).
25+
with --name-only).
2626

2727
For plain blobs, it shows the plain contents.
2828

0 commit comments

Comments
 (0)