Merge branch 'jk/asciidoc-markup-fix'
authorJunio C Hamano <gitster@pobox.com>
Fri, 22 May 2015 19:41:50 +0000 (12:41 -0700)
committerJunio C Hamano <gitster@pobox.com>
Fri, 22 May 2015 19:41:50 +0000 (12:41 -0700)
Various documentation mark-up fixes to make the output more
consistent in general and also make AsciiDoctor (an alternative
formatter) happier.

* jk/asciidoc-markup-fix:
doc: convert AsciiDoc {?foo} to ifdef::foo[]
doc: put example URLs and emails inside literal backticks
doc: drop backslash quoting of some curly braces
doc: convert \--option to --option
doc/add: reformat `--edit` option
doc: fix length of underlined section-title
doc: fix hanging "+"-continuation
doc: fix unquoted use of "{type}"
doc: fix misrendering due to `single quote'

19 files changed:
Documentation/config.txt
Documentation/diff-generate-patch.txt
Documentation/diff-options.txt
Documentation/git-add.txt
Documentation/git-fast-export.txt
Documentation/git-fast-import.txt
Documentation/git-fetch-pack.txt
Documentation/git-http-backend.txt
Documentation/git-pack-objects.txt
Documentation/git-push.txt
Documentation/git-rebase.txt
Documentation/git-rev-list.txt
Documentation/git-rev-parse.txt
Documentation/git-send-pack.txt
Documentation/git-show.txt
Documentation/git-svn.txt
Documentation/git-tag.txt
Documentation/gitdiffcore.txt
Documentation/gitremote-helpers.txt
index efea933561bc42015773f5b8a855b4b77d7966b2..54cbf6b7ea8c6e21a4ffc5c767fc15c630ccd33c 100644 (file)
@@ -2292,18 +2292,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 843a20bac2bb50916210fa8b055201bfcd1aabd9..bcf54da82a8c11367354a86efd8c802f58a6e502 100644 (file)
@@ -77,7 +77,7 @@ combined diff format
 Any diff-generating command can take the `-c` or `--cc` option to
 produce a 'combined diff' when showing a merge. This is the default
 format when showing merges with linkgit:git-diff[1] or
-linkgit:git-show[1]. Note also that you can give the `-m' option to any
+linkgit:git-show[1]. Note also that you can give the `-m` option to any
 of these commands to force generation of diffs with individual parents
 of a merge.
 
index ccd499867b64d0609df66196f833fff173dd60da..b7c3afeb3a0ce871d426de6912a6a875f37620fa 100644 (file)
@@ -23,7 +23,9 @@ ifndef::git-format-patch[]
 -u::
 --patch::
        Generate patch (see section on generating patches).
-       {git-diff? This is the default.}
+ifdef::git-diff[]
+       This is the default.
+endif::git-diff[]
 endif::git-format-patch[]
 
 -s::
@@ -42,7 +44,9 @@ endif::git-format-patch[]
 ifndef::git-format-patch[]
 --raw::
        Generate the raw format.
-       {git-diff-core? This is the default.}
+ifdef::git-diff-core[]
+       This is the default.
+endif::git-diff-core[]
 endif::git-format-patch[]
 
 ifndef::git-format-patch[]
index f2eb9076d73d830c19dc70bf2175e55a46ae1111..fe5282f1305902545eaff585ced432d296dd64f4 100644 (file)
@@ -93,7 +93,8 @@ This effectively runs `add --interactive`, but bypasses the
 initial command menu and directly jumps to the `patch` subcommand.
 See ``Interactive mode'' for details.
 
--e, \--edit::
+-e::
+--edit::
        Open the diff vs. the index in an editor and let the user
        edit it.  After the editor was closed, adjust the hunk headers
        and apply the patch to the index.
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 690fed3ea40d3de73a2b6f1c194216b72738da8f..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.
 
@@ -600,7 +600,7 @@ be removed from the branch.
 See `filemodify` above for a detailed description of `<path>`.
 
 `filecopy`
-^^^^^^^^^^^^
+^^^^^^^^^^
 Recursively copies an existing file or subdirectory to a different
 location within the branch.  The existing file or directory must
 exist.  If the destination exists it will be completely replaced
@@ -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 d422ba4b59acf31151f149c8067c18e541e5bdb2..3ca18c4de519ebdf0a2af6509d0d6bed3e6e492c 100644 (file)
@@ -65,8 +65,8 @@ automatically by the web server.
 
 EXAMPLES
 --------
-All of the following examples map 'http://$hostname/git/foo/bar.git'
-to '/var/www/git/foo/bar.git'.
+All of the following examples map `http://$hostname/git/foo/bar.git`
+to `/var/www/git/foo/bar.git`.
 
 Apache 2.x::
        Ensure mod_cgi, mod_alias, and mod_env are enabled, set
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 863c30c4c2d0fd78ee81d219ed221cb248ce1994..135d810b7a9b7e36d1cb06ca49c185655a655bee 100644 (file)
@@ -265,8 +265,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 47984e84ed2f994ec48c1d659e47c1ecd6a17f23..1d01baa5fcfd03370953e8311b9c7bf3b49e2f4e 100644 (file)
@@ -80,7 +80,7 @@ remain the checked-out branch.
 If the upstream branch already contains a change you have made (e.g.,
 because you mailed a patch which was applied upstream), then that commit
 will be skipped. For example, running `git rebase master` on the
-following history (in which A' and A introduce the same set of changes,
+following history (in which `A'` and `A` introduce the same set of changes,
 but have different committer information):
 
 ------------
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 97fc703f4c0db968151b39de537fc641e5a19c32..c483100e75886e7326cecabcd66f1449e640365a 100644 (file)
@@ -102,7 +102,7 @@ eval "set -- $(git rev-parse --sq --prefix "$prefix" "$@")"
 +
 If you want to make sure that the output actually names an object in
 your object database and/or can be used as a specific type of object
-you require, you can add "\^{type}" peeling operator to the parameter.
+you require, you can add the `^{type}` peeling operator to the parameter.
 For example, `git rev-parse "$VAR^{commit}"` will make sure `$VAR`
 names an existing object that is a commit-ish (i.e. a commit, or an
 annotated tag that points at a commit).  To make sure that `$VAR`
@@ -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 45c7725dc303eed198fc0ed370f603a71d1fa8c1..b5d09f79ee686d20b6e99196202546eac1ce2635 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 39e9a181cce8e58c4dfd0e3fb62e15cedecb30b7..11d1e2fc66bb6e92eb0c0f5a85f86fb38eca865a 100644 (file)
@@ -70,8 +70,8 @@ COMMANDS
 --username=<user>;;
        For transports that SVN handles authentication for (http,
        https, and plain svn), specify the username.  For other
-       transports (e.g. svn+ssh://), you must include the username in
-       the URL, e.g. svn+ssh://foo@svn.bar.com/project
+       transports (e.g. `svn+ssh://`), you must include the username in
+       the URL, e.g. `svn+ssh://foo@svn.bar.com/project`
 --prefix=<prefix>;;
        This allows one to specify a prefix which is prepended
        to the names of remotes if trunk/branches/tags are
@@ -279,9 +279,9 @@ first have already been pushed into SVN.
        Ask the user to confirm that a patch set should actually be sent to SVN.
        For each patch, one may answer "yes" (accept this patch), "no" (discard this
        patch), "all" (accept all patches), or "quit".
-       +
-       'git svn dcommit' returns immediately if answer is "no" or "quit", without
-       committing anything to SVN.
++
+'git svn dcommit' returns immediately if answer is "no" or "quit", without
+committing anything to SVN.
 
 'branch'::
        Create a branch in the SVN repository.
index f5b267e1e300c965704ab3918fe16163351fd1cf..034d10d633c343b17a83879b00aae3ba2a98a388 100644 (file)
@@ -158,7 +158,7 @@ This option is only applicable when listing tags without annotation lines.
 CONFIGURATION
 -------------
 By default, 'git tag' in sign-with-default mode (-s) will use your
-committer identity (of the form "Your Name <\your@email.address>") to
+committer identity (of the form `Your Name <your@email.address>`) to
 find a key.  If you want to use a different default key, you can specify
 it in the repository configuration as follows:
 
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:
index 8edf72cf5398f3a13002e8e08774f75b4cc7180d..82e2d154359de5dba6694ac7a844b34984e09300 100644 (file)
@@ -408,14 +408,14 @@ set by Git if the remote helper has the 'option' capability.
        of <n> correspond to the number of -v flags passed on the
        command line.
 
-'option progress' \{'true'|'false'\}::
+'option progress' {'true'|'false'}::
        Enables (or disables) progress messages displayed by the
        transport helper during a command.
 
 'option depth' <depth>::
        Deepens the history of a shallow repository.
 
-'option followtags' \{'true'|'false'\}::
+'option followtags' {'true'|'false'}::
        If enabled the helper should automatically fetch annotated
        tag objects if the object the tag points at was transferred
        during the fetch command.  If the tag is not fetched by
@@ -423,7 +423,7 @@ set by Git if the remote helper has the 'option' capability.
        ask for the tag specifically.  Some helpers may be able to
        use this option to avoid a second network connection.
 
-'option dry-run' \{'true'|'false'\}:
+'option dry-run' {'true'|'false'}:
        If true, pretend the operation completed successfully,
        but don't actually change any repository data.  For most
        helpers this only applies to the 'push', if supported.
@@ -434,18 +434,18 @@ set by Git if the remote helper has the 'option' capability.
        must not rely on this option being set before
        connect request occurs.
 
-'option check-connectivity' \{'true'|'false'\}::
+'option check-connectivity' {'true'|'false'}::
        Request the helper to check connectivity of a clone.
 
-'option force' \{'true'|'false'\}::
+'option force' {'true'|'false'}::
        Request the helper to perform a force update.  Defaults to
        'false'.
 
-'option cloning \{'true'|'false'\}::
+'option cloning {'true'|'false'}::
        Notify the helper this is a clone request (i.e. the current
        repository is guaranteed empty).
 
-'option update-shallow \{'true'|'false'\}::
+'option update-shallow {'true'|'false'}::
        Allow to extend .git/shallow if the new refs require it.
 
 SEE ALSO