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 <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jeff King committed
May 13, 2015 at 01:01 UTC
1c262bb7b2968a8eecca3fed366638e0779184bb
11 files changed
+80
-80
Documentation/config.txt
+5
-5
@@ -2256,18 +2256,18 @@ remote.<name>.skipFetchAll::
2256
2257
remote.<name>.receivepack::
2258
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].
2260
2261
remote.<name>.uploadpack::
2262
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].
2264
2265
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
2268
tag from remote <name>, even if they are not reachable from remote
2269
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
2271
linkgit:git-fetch[1].
2272
2273
remote.<name>.vcs::
Documentation/git-fast-export.txt
+3
-3
@@ -67,17 +67,17 @@ produced incorrect results if you gave these options.
67
have been completed, or to save the marks table across
68
incremental runs. As <file> is only opened and truncated
69
at completion, the same path can also be safely given to
70
- \--import-marks.
70
+ --import-marks.
71
The file will not be written if no new object has been
72
marked/exported.
73
74
--import-marks=<file>::
75
Before processing any input, load the marks specified in
76
<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.
78
+
79
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
81
incremental bidirectional exporting of the repository by keeping the
82
marks the same across runs.
83
Documentation/git-fast-import.txt
+14
-14
@@ -42,13 +42,13 @@ OPTIONS
42
--quiet::
43
Disable all non-fatal output, making fast-import silent when it
44
is successful. This option disables the output shown by
45
- \--stats.
45
+ --stats.
46
47
--stats::
48
Display some basic statistics about the objects fast-import has
49
created, the packfiles they were stored into, and the
50
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.
52
53
Options for Frontends
54
~~~~~~~~~~~~~~~~~~~~~
@@ -81,12 +81,12 @@ Locations of Marks Files
81
have been completed, or to save the marks table across
82
incremental runs. As <file> is only opened and truncated
83
at checkpoint (or completion) the same path can also be
84
- safely given to \--import-marks.
84
+ safely given to --import-marks.
85
86
--import-marks=<file>::
87
Before processing any input, load the marks specified in
88
<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.
90
Multiple options may be supplied to import more than one
91
set of marks. If a mark is defined to different values,
92
the last file wins.
@@ -179,8 +179,8 @@ fast-forward update, fast-import will skip updating that ref and instead
179
prints a warning message. fast-import will always attempt to update all
180
branch refs, and does not stop on the first failure.
181
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
184
is not necessary for an initial import into an empty repository.
185
186
@@ -231,11 +231,11 @@ Date Formats
231
~~~~~~~~~~~~
232
The following date formats are supported. A frontend should select
233
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.
235
236
`raw`::
237
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
239
not specified.
240
+
241
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
437
of bytes, except `LT`, `GT` and `LF`. `<name>` is typically UTF-8 encoded.
438
439
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.
441
See ``Date Formats'' above for the set of supported formats, and
442
their syntax.
443
@@ -888,7 +888,7 @@ save out all current branch refs, tags and marks.
888
....
889
890
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
892
smaller. During an automatic packfile switch fast-import does not update
893
the branch refs, tags or marks.
894
@@ -1226,7 +1226,7 @@ users of fast-import, and are offered here as suggestions.
1226
Use One Mark Per Commit
1227
~~~~~~~~~~~~~~~~~~~~~~~
1228
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
1230
line. fast-import will dump a file which lists every mark and the Git
1231
object SHA-1 that corresponds to it. If the frontend can tie
1232
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).
1291
1292
However repacking the repository is necessary to improve data
1293
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
1295
used). Since repacking is safe to run alongside readers and writers,
1296
run the repack in the background and let it finish when it finishes.
1297
There is no reason to wait to explore your new Git project!
@@ -1305,7 +1305,7 @@ Repacking Historical Data
1305
~~~~~~~~~~~~~~~~~~~~~~~~~
1306
If you are repacking very old imported data (e.g. older than the
1307
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'.
1309
This will take longer, but will also produce a smaller packfile.
1310
You only need to expend the effort once, and everyone using your
1311
project will benefit from the smaller repository.
@@ -1407,7 +1407,7 @@ branch, their in-memory storage size can grow to a considerable size
1407
fast-import automatically moves active branches to inactive status based on
1408
a simple least-recently-used algorithm. The LRU chain is updated on
1409
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=.
1411
1412
per active tree
1413
~~~~~~~~~~~~~~~
Documentation/git-fetch-pack.txt
+1
-1
@@ -80,7 +80,7 @@ be in a separate packet, and the list must end with a flush packet.
80
the things up in .bash_profile).
81
82
--exec=<git-upload-pack>::
83
- Same as \--upload-pack=<git-upload-pack>.
83
+ Same as --upload-pack=<git-upload-pack>.
84
85
--depth=<n>::
86
Limit fetching to ancestor-chains not longer than n.
Documentation/git-pack-objects.txt
+1
-1
@@ -192,7 +192,7 @@ self-contained. Use `git index-pack --fix-thin`
192
193
--shallow::
194
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
196
smaller pack at the cost of speed.
197
198
--delta-base-offset::
Documentation/git-push.txt
+2
-2
@@ -257,8 +257,8 @@ origin +master` to force a push to the `master` branch). See the
257
258
--[no-]verify::
259
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.
262
263
264
include::urls-remotes.txt[]
Documentation/git-rev-list.txt
+48
-48
@@ -9,54 +9,54 @@ git-rev-list - Lists commit objects in reverse chronological order
9
SYNOPSIS
10
--------
11
[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 ]
60
<commit>... [ \-- <paths>... ]
61
62
DESCRIPTION
Documentation/git-rev-parse.txt
+1
-1
@@ -147,7 +147,7 @@ can be used.
147
form as close to the original input as possible.
148
149
--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
151
are not refs (i.e. branch or tag names; or more
152
explicitly disambiguating "heads/master" form, when you
153
want to name the "master" branch when there is an
Documentation/git-send-pack.txt
+1
-1
@@ -29,7 +29,7 @@ OPTIONS
29
a directory on the default $PATH.
30
31
--exec=<git-receive-pack>::
32
- Same as \--receive-pack=<git-receive-pack>.
32
+ Same as --receive-pack=<git-receive-pack>.
33
34
--all::
35
Instead of explicitly specifying which refs to update,
Documentation/git-show.txt
+1
-1
@@ -22,7 +22,7 @@ presents the merge commit in a special format as produced by
22
For tags, it shows the tag message and the referenced objects.
23
24
For trees, it shows the names (equivalent to 'git ls-tree'
25
-with \--name-only).
25
+with --name-only).
26
27
For plain blobs, it shows the plain contents.
28
Documentation/gitdiffcore.txt
+3
-3
@@ -28,8 +28,8 @@ The 'git diff-{asterisk}' family works by first comparing two sets of
28
files:
29
30
- 'git diff-index' compares contents of a "tree" object and the
31
- working directory (when '\--cached' flag is not used) or a
32
- "tree" object and the index file (when '\--cached' flag is
31
+ working directory (when '--cached' flag is not used) or a
32
+ "tree" object and the index file (when '--cached' flag is
33
used);
34
35
- 'git diff-files' compares contents of the index file and the
@@ -142,7 +142,7 @@ merges these filepairs and creates:
142
143
When the "-C" option is used, the original contents of modified files,
144
and deleted files (and also unmodified files, if the
145
-"\--find-copies-harder" option is used) are considered as candidates
145
+"--find-copies-harder" option is used) are considered as candidates
146
of the source files in rename/copy operation. If the input were like
147
these filepairs, that talk about a modified file fileY and a newly
148
created file file0: