]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: convert \--option to --option
authorJeff King <peff@peff.net>
Wed, 13 May 2015 05:01:38 +0000 (01:01 -0400)
committerJunio C Hamano <gitster@pobox.com>
Wed, 13 May 2015 05:14:46 +0000 (22:14 -0700)
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>
Documentation/config.txt
Documentation/git-fast-export.txt
Documentation/git-fast-import.txt
Documentation/git-fetch-pack.txt
Documentation/git-pack-objects.txt
Documentation/git-push.txt
Documentation/git-rev-list.txt
Documentation/git-rev-parse.txt
Documentation/git-send-pack.txt
Documentation/git-show.txt
Documentation/gitdiffcore.txt

index 1a8ddb41c7fff8cce5d2c0a51a9d642e3bf0fd42..7714798ffe76812f11f71e128a14091495f12776 100644 (file)
@@ -2256,18 +2256,18 @@ remote.<name>.skipFetchAll::
 
 remote.<name>.receivepack::
        The default program to execute on the remote side when pushing.  See
-       option \--receive-pack of linkgit:git-push[1].
+       option --receive-pack of linkgit:git-push[1].
 
 remote.<name>.uploadpack::
        The default program to execute on the remote side when fetching.  See
-       option \--upload-pack of linkgit:git-fetch-pack[1].
+       option --upload-pack of linkgit:git-fetch-pack[1].
 
 remote.<name>.tagopt::
-       Setting this value to \--no-tags disables automatic tag following when
-       fetching from remote <name>. Setting it to \--tags will fetch every
+       Setting this value to --no-tags disables automatic tag following when
+       fetching from remote <name>. Setting it to --tags will fetch every
        tag from remote <name>, even if they are not reachable from remote
        branch heads. Passing these flags directly to linkgit:git-fetch[1] can
-       override this setting. See options \--tags and \--no-tags of
+       override this setting. See options --tags and --no-tags of
        linkgit:git-fetch[1].
 
 remote.<name>.vcs::
index 929e496af8d6b93904cb91d2148272516dd92033..ed57c684dbc82c587ca1cf6b66ae46f3760ecfba 100644 (file)
@@ -67,17 +67,17 @@ produced incorrect results if you gave these options.
        have been completed, or to save the marks table across
        incremental runs.  As <file> is only opened and truncated
        at completion, the same path can also be safely given to
-       \--import-marks.
+       --import-marks.
        The file will not be written if no new object has been
        marked/exported.
 
 --import-marks=<file>::
        Before processing any input, load the marks specified in
        <file>.  The input file must exist, must be readable, and
-       must use the same format as produced by \--export-marks.
+       must use the same format as produced by --export-marks.
 +
 Any commits that have already been marked will not be exported again.
-If the backend uses a similar \--import-marks file, this allows for
+If the backend uses a similar --import-marks file, this allows for
 incremental bidirectional exporting of the repository by keeping the
 marks the same across runs.
 
index bf7fbd45de28dc3534d105b5bcf54ed10bf7664c..fd328952556fc8a28db72e6537595067aadbd946 100644 (file)
@@ -42,13 +42,13 @@ OPTIONS
 --quiet::
        Disable all non-fatal output, making fast-import silent when it
        is successful.  This option disables the output shown by
-       \--stats.
+       --stats.
 
 --stats::
        Display some basic statistics about the objects fast-import has
        created, the packfiles they were stored into, and the
        memory used by fast-import during this run.  Showing this output
-       is currently the default, but can be disabled with \--quiet.
+       is currently the default, but can be disabled with --quiet.
 
 Options for Frontends
 ~~~~~~~~~~~~~~~~~~~~~
@@ -81,12 +81,12 @@ Locations of Marks Files
        have been completed, or to save the marks table across
        incremental runs.  As <file> is only opened and truncated
        at checkpoint (or completion) the same path can also be
-       safely given to \--import-marks.
+       safely given to --import-marks.
 
 --import-marks=<file>::
        Before processing any input, load the marks specified in
        <file>.  The input file must exist, must be readable, and
-       must use the same format as produced by \--export-marks.
+       must use the same format as produced by --export-marks.
        Multiple options may be supplied to import more than one
        set of marks.  If a mark is defined to different values,
        the last file wins.
@@ -179,8 +179,8 @@ fast-forward update, fast-import will skip updating that ref and instead
 prints a warning message.  fast-import will always attempt to update all
 branch refs, and does not stop on the first failure.
 
-Branch updates can be forced with \--force, but it's recommended that
-this only be used on an otherwise quiet repository.  Using \--force
+Branch updates can be forced with --force, but it's recommended that
+this only be used on an otherwise quiet repository.  Using --force
 is not necessary for an initial import into an empty repository.
 
 
@@ -231,11 +231,11 @@ Date Formats
 ~~~~~~~~~~~~
 The following date formats are supported.  A frontend should select
 the format it will use for this import by passing the format name
-in the \--date-format=<fmt> command-line option.
+in the --date-format=<fmt> command-line option.
 
 `raw`::
        This is the Git native format and is `<time> SP <offutc>`.
-       It is also fast-import's default format, if \--date-format was
+       It is also fast-import's default format, if --date-format was
        not specified.
 +
 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
 of bytes, except `LT`, `GT` and `LF`.  `<name>` is typically UTF-8 encoded.
 
 The time of the change is specified by `<when>` using the date format
-that was selected by the \--date-format=<fmt> command-line option.
+that was selected by the --date-format=<fmt> command-line option.
 See ``Date Formats'' above for the set of supported formats, and
 their syntax.
 
@@ -888,7 +888,7 @@ save out all current branch refs, tags and marks.
 ....
 
 Note that fast-import automatically switches packfiles when the current
-packfile reaches \--max-pack-size, or 4 GiB, whichever limit is
+packfile reaches --max-pack-size, or 4 GiB, whichever limit is
 smaller.  During an automatic packfile switch fast-import does not update
 the branch refs, tags or marks.
 
@@ -1226,7 +1226,7 @@ users of fast-import, and are offered here as suggestions.
 Use One Mark Per Commit
 ~~~~~~~~~~~~~~~~~~~~~~~
 When doing a repository conversion, use a unique mark per commit
-(`mark :<n>`) and supply the \--export-marks option on the command
+(`mark :<n>`) and supply the --export-marks option on the command
 line.  fast-import will dump a file which lists every mark and the Git
 object SHA-1 that corresponds to it.  If the frontend can tie
 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).
 
 However repacking the repository is necessary to improve data
 locality and access performance.  It can also take hours on extremely
-large projects (especially if -f and a large \--window parameter is
+large projects (especially if -f and a large --window parameter is
 used).  Since repacking is safe to run alongside readers and writers,
 run the repack in the background and let it finish when it finishes.
 There is no reason to wait to explore your new Git project!
@@ -1305,7 +1305,7 @@ Repacking Historical Data
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 If you are repacking very old imported data (e.g. older than the
 last year), consider expending some extra CPU time and supplying
-\--window=50 (or higher) when you run 'git repack'.
+--window=50 (or higher) when you run 'git repack'.
 This will take longer, but will also produce a smaller packfile.
 You only need to expend the effort once, and everyone using your
 project will benefit from the smaller repository.
@@ -1407,7 +1407,7 @@ branch, their in-memory storage size can grow to a considerable size
 fast-import automatically moves active branches to inactive status based on
 a simple least-recently-used algorithm.  The LRU chain is updated on
 each `commit` command.  The maximum number of active branches can be
-increased or decreased on the command line with \--active-branches=.
+increased or decreased on the command line with --active-branches=.
 
 per active tree
 ~~~~~~~~~~~~~~~
index 93b50679461a201badf62afe5ed3931bbdfa88e5..8680f45f8d635253576499453588308618afdc5f 100644 (file)
@@ -80,7 +80,7 @@ be in a separate packet, and the list must end with a flush packet.
        the things up in .bash_profile).
 
 --exec=<git-upload-pack>::
-       Same as \--upload-pack=<git-upload-pack>.
+       Same as --upload-pack=<git-upload-pack>.
 
 --depth=<n>::
        Limit fetching to ancestor-chains not longer than n.
index c2f76fb1ea476aa551963349ee976ad8745f10e2..bbea5294ca9680dd7efee9caeea861711dafc3a5 100644 (file)
@@ -192,7 +192,7 @@ self-contained. Use `git index-pack --fix-thin`
 
 --shallow::
        Optimize a pack that will be provided to a client with a shallow
-       repository.  This option, combined with \--thin, can result in a
+       repository.  This option, combined with --thin, can result in a
        smaller pack at the cost of speed.
 
 --delta-base-offset::
index 35937744957982f105774846fb806d10f0024402..bf6569f6666c33864130f65f0fe865d98dc402f5 100644 (file)
@@ -257,8 +257,8 @@ origin +master` to force a push to the `master` branch). See the
 
 --[no-]verify::
        Toggle the pre-push hook (see linkgit:githooks[5]).  The
-       default is \--verify, giving the hook a chance to prevent the
-       push.  With \--no-verify, the hook is bypassed completely.
+       default is --verify, giving the hook a chance to prevent the
+       push.  With --no-verify, the hook is bypassed completely.
 
 
 include::urls-remotes.txt[]
index 5b119220bf168153d63bf2051a065e40b68c1ed3..b10ea60833ca67ca1d3c5bd413958980405575d4 100644 (file)
@@ -9,54 +9,54 @@ git-rev-list - Lists commit objects in reverse chronological order
 SYNOPSIS
 --------
 [verse]
-'git rev-list' [ \--max-count=<number> ]
-            [ \--skip=<number> ]
-            [ \--max-age=<timestamp> ]
-            [ \--min-age=<timestamp> ]
-            [ \--sparse ]
-            [ \--merges ]
-            [ \--no-merges ]
-            [ \--min-parents=<number> ]
-            [ \--no-min-parents ]
-            [ \--max-parents=<number> ]
-            [ \--no-max-parents ]
-            [ \--first-parent ]
-            [ \--remove-empty ]
-            [ \--full-history ]
-            [ \--not ]
-            [ \--all ]
-            [ \--branches[=<pattern>] ]
-            [ \--tags[=<pattern>] ]
-            [ \--remotes[=<pattern>] ]
-            [ \--glob=<glob-pattern> ]
-            [ \--ignore-missing ]
-            [ \--stdin ]
-            [ \--quiet ]
-            [ \--topo-order ]
-            [ \--parents ]
-            [ \--timestamp ]
-            [ \--left-right ]
-            [ \--left-only ]
-            [ \--right-only ]
-            [ \--cherry-mark ]
-            [ \--cherry-pick ]
-            [ \--encoding=<encoding> ]
-            [ \--(author|committer|grep)=<pattern> ]
-            [ \--regexp-ignore-case | -i ]
-            [ \--extended-regexp | -E ]
-            [ \--fixed-strings | -F ]
-            [ \--date=(local|relative|default|iso|iso-strict|rfc|short) ]
-            [ [ \--objects | \--objects-edge | \--objects-edge-aggressive ]
-              [ \--unpacked ] ]
-            [ \--pretty | \--header ]
-            [ \--bisect ]
-            [ \--bisect-vars ]
-            [ \--bisect-all ]
-            [ \--merge ]
-            [ \--reverse ]
-            [ \--walk-reflogs ]
-            [ \--no-walk ] [ \--do-walk ]
-            [ \--use-bitmap-index ]
+'git rev-list' [ --max-count=<number> ]
+            [ --skip=<number> ]
+            [ --max-age=<timestamp> ]
+            [ --min-age=<timestamp> ]
+            [ --sparse ]
+            [ --merges ]
+            [ --no-merges ]
+            [ --min-parents=<number> ]
+            [ --no-min-parents ]
+            [ --max-parents=<number> ]
+            [ --no-max-parents ]
+            [ --first-parent ]
+            [ --remove-empty ]
+            [ --full-history ]
+            [ --not ]
+            [ --all ]
+            [ --branches[=<pattern>] ]
+            [ --tags[=<pattern>] ]
+            [ --remotes[=<pattern>] ]
+            [ --glob=<glob-pattern> ]
+            [ --ignore-missing ]
+            [ --stdin ]
+            [ --quiet ]
+            [ --topo-order ]
+            [ --parents ]
+            [ --timestamp ]
+            [ --left-right ]
+            [ --left-only ]
+            [ --right-only ]
+            [ --cherry-mark ]
+            [ --cherry-pick ]
+            [ --encoding=<encoding> ]
+            [ --(author|committer|grep)=<pattern> ]
+            [ --regexp-ignore-case | -i ]
+            [ --extended-regexp | -E ]
+            [ --fixed-strings | -F ]
+            [ --date=(local|relative|default|iso|iso-strict|rfc|short) ]
+            [ [ --objects | --objects-edge | --objects-edge-aggressive ]
+              [ --unpacked ] ]
+            [ --pretty | --header ]
+            [ --bisect ]
+            [ --bisect-vars ]
+            [ --bisect-all ]
+            [ --merge ]
+            [ --reverse ]
+            [ --walk-reflogs ]
+            [ --no-walk ] [ --do-walk ]
+            [ --use-bitmap-index ]
             <commit>... [ \-- <paths>... ]
 
 DESCRIPTION
index 11e032e2425a4aea8e908ae8b1a98b73befa398f..bf81b9734ee0360f632686af9b241a1eeadaf493 100644 (file)
@@ -147,7 +147,7 @@ can be used.
        form as close to the original input as possible.
 
 --symbolic-full-name::
-       This is similar to \--symbolic, but it omits input that
+       This is similar to --symbolic, but it omits input that
        are not refs (i.e. branch or tag names; or more
        explicitly disambiguating "heads/master" form, when you
        want to name the "master" branch when there is an
index 2a0de42a75d482a4bbafefd19991dad25b3e67f9..1b5ba442fde58079a70479b72ae82404d620541c 100644 (file)
@@ -29,7 +29,7 @@ OPTIONS
        a directory on the default $PATH.
 
 --exec=<git-receive-pack>::
-       Same as \--receive-pack=<git-receive-pack>.
+       Same as --receive-pack=<git-receive-pack>.
 
 --all::
        Instead of explicitly specifying which refs to update,
index 4e617e6979dda86138e14cb93d84016d304de07a..82a4125a2da805e0b3c21e4e827bf203d5ac4532 100644 (file)
@@ -22,7 +22,7 @@ presents the merge commit in a special format as produced by
 For tags, it shows the tag message and the referenced objects.
 
 For trees, it shows the names (equivalent to 'git ls-tree'
-with \--name-only).
+with --name-only).
 
 For plain blobs, it shows the plain contents.
 
index c8b3e51c84a58d6f9e4a0ba324f9071cc125881f..c579593e55008b09ca1914270fb8b52a08476f72 100644 (file)
@@ -28,8 +28,8 @@ The 'git diff-{asterisk}' family works by first comparing two sets of
 files:
 
  - 'git diff-index' compares contents of a "tree" object and the
-   working directory (when '\--cached' flag is not used) or a
-   "tree" object and the index file (when '\--cached' flag is
+   working directory (when '--cached' flag is not used) or a
+   "tree" object and the index file (when '--cached' flag is
    used);
 
  - 'git diff-files' compares contents of the index file and the
@@ -142,7 +142,7 @@ merges these filepairs and creates:
 
 When the "-C" option is used, the original contents of modified files,
 and deleted files (and also unmodified files, if the
-"\--find-copies-harder" option is used) are considered as candidates
+"--find-copies-harder" option is used) are considered as candidates
 of the source files in rename/copy operation.  If the input were like
 these filepairs, that talk about a modified file fileY and a newly
 created file file0: