{"thread":{"id":"55461","subject":"[RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale","startedAt":"2021-04-09T04:05:41Z","lastAt":"2021-04-19T09:33:07Z","messageCount":20,"participants":["Firmin Martin","Bagas Sanjaya","Jean-Noël Avila"],"isPatch":true,"patchVersion":1,"patchTotal":13},"messages":[{"id":"421326","messageId":"20210409040301.3260358-1-firminmartin24@gmail.com","threadId":"55461","inReplyTo":null,"subject":"[RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale","fromName":"Firmin Martin","fromEmail":"firminmartin24@gmail.com","sentAt":"2021-04-09T04:02:48Z","receivedAt":"2021-04-09T04:05:41Z","isPatch":true,"sender":{"key":"firminmartin24@gmail.com","avatar":"https://avatars.githubusercontent.com/u/20540328?v=4"},"body":"This patch series aims to make the documentation fully compliant to the\nCodingGuidelines regarding monospace font. After it, new contributors\nwho just want to change a little portion of the documention could just\nlook around how it has been done without being confused by the\ninconsistency between the documentation and the CodingGuidelines.\n\nConcretely: unquoted, single-quoted or double-quoted entities detailed\nbelow in the summary are wrapped or converted in backticks.\n\nExcept some easy cases, the methodology consists of using simple regex\nto find relevant files, then interactively substitute targeted entities\nwith progressively smarter regex to exclude false positives. As the\nreview process could be very tedious, I have been very cautious and have\nreviewed myself a couple of times every changes. Consequently, mistakes,\nif there are any, are not due to the regex, but my personal\nmisinterpretation of the context.\n\nBelow is some changes I plan to make in v2 which request\ncomments/approvals of the community.\n\n* Placeholders and option values should be in italic. (Cf. man man) \n - e.g. `--date`='', `--notes`[=''], `branch.`''`.remote`\n - e.g. `--date`='rfc2822'\n - Compare gcc and git-add\n - man gcc vs. man git-add \n - https://linux.die.net/man/1/gcc vs. https://linux.die.net/man/1/git-add\n* The Synopsis section should be formatted based on the current\nCodingGuidelines plus the above suggestion. IOW, for instance, options should\nbe wrapped in backticks. Again, to have an idea, compare gcc and git-add. \n\nBest,\n\nFirmin\n\nFirmin Martin (13):\n doc: typeset command-line options in monospace\n doc: typeset branches and remotes in monospace\n doc: typeset configuration options in monospace\n doc: typeset git-related commands in monospace\n doc: typeset git-svn subcommands in monospace\n doc: typeset dummy URLs and protocols in monospace\n doc: typeset git dotfiles in monospace\n doc: typeset filepath and $variables in monospace\n doc: typeset command/option/value entries in monospace\n doc: typeset more command entries in monospace\n doc: typeset config option entries in monospace\n doc: typeset environment vars without $ in monospace\n doc: typeset common programs in monospace\n\n Documentation/CodingGuidelines | 2 +-\n Documentation/MyFirstContribution.txt | 8 +-\n Documentation/SubmittingPatches | 2 +-\n Documentation/blame-options.txt | 50 +-\n Documentation/config.txt | 38 +-\n Documentation/config/diff.txt | 2 +-\n Documentation/config/gitcvs.txt | 6 +-\n Documentation/diff-format.txt | 12 +-\n Documentation/diff-generate-patch.txt | 8 +-\n Documentation/diff-options.txt | 252 +++----\n Documentation/fetch-options.txt | 136 ++--\n Documentation/git-add.txt | 86 +--\n Documentation/git-am.txt | 116 +--\n Documentation/git-apply.txt | 84 +--\n Documentation/git-archimport.txt | 34 +-\n Documentation/git-archive.txt | 52 +-\n Documentation/git-bisect-lk2009.txt | 188 ++---\n Documentation/git-bisect.txt | 48 +-\n Documentation/git-blame.txt | 32 +-\n Documentation/git-branch.txt | 156 ++--\n Documentation/git-bugreport.txt | 14 +-\n Documentation/git-bundle.txt | 74 +-\n Documentation/git-cat-file.txt | 42 +-\n Documentation/git-check-attr.txt | 18 +-\n Documentation/git-check-ignore.txt | 16 +-\n Documentation/git-check-mailmap.txt | 4 +-\n Documentation/git-check-ref-format.txt | 16 +-\n Documentation/git-checkout-index.txt | 42 +-\n Documentation/git-checkout.txt | 114 +--\n Documentation/git-cherry-pick.txt | 76 +-\n Documentation/git-cherry.txt | 20 +-\n Documentation/git-citool.txt | 6 +-\n Documentation/git-clean.txt | 66 +-\n Documentation/git-clone.txt | 104 +--\n Documentation/git-column.txt | 26 +-\n Documentation/git-commit-graph.txt | 12 +-\n Documentation/git-commit-tree.txt | 22 +-\n Documentation/git-commit.txt | 174 ++---\n Documentation/git-config.txt | 174 ++---\n Documentation/git-count-objects.txt | 16 +-\n .../git-credential-cache--daemon.txt | 2 +-\n Documentation/git-credential-cache.txt | 8 +-\n Documentation/git-credential-store.txt | 12 +-\n Documentation/git-credential.txt | 16 +-\n Documentation/git-cvsexportcommit.txt | 46 +-\n Documentation/git-cvsimport.txt | 84 +--\n Documentation/git-cvsserver.txt | 110 +--\n Documentation/git-daemon.txt | 150 ++--\n Documentation/git-describe.txt | 80 +-\n Documentation/git-diff-files.txt | 18 +-\n Documentation/git-diff-index.txt | 34 +-\n Documentation/git-diff-tree.txt | 46 +-\n Documentation/git-diff.txt | 64 +-\n Documentation/git-difftool.txt | 78 +-\n Documentation/git-fast-export.txt | 84 +--\n Documentation/git-fast-import.txt | 140 ++--\n Documentation/git-fetch-pack.txt | 72 +-\n Documentation/git-fetch.txt | 46 +-\n Documentation/git-filter-branch.txt | 164 ++---\n Documentation/git-fmt-merge-msg.txt | 30 +-\n Documentation/git-for-each-ref.txt | 80 +-\n Documentation/git-for-each-repo.txt | 4 +-\n Documentation/git-format-patch.txt | 132 ++--\n Documentation/git-fsck-objects.txt | 2 +-\n Documentation/git-fsck.txt | 74 +-\n Documentation/git-gc.txt | 36 +-\n Documentation/git-get-tar-commit-id.txt | 8 +-\n Documentation/git-grep.txt | 178 ++---\n Documentation/git-gui.txt | 32 +-\n Documentation/git-hash-object.txt | 20 +-\n Documentation/git-help.txt | 78 +-\n Documentation/git-http-backend.txt | 72 +-\n Documentation/git-http-fetch.txt | 24 +-\n Documentation/git-http-push.txt | 22 +-\n Documentation/git-imap-send.txt | 20 +-\n Documentation/git-index-pack.txt | 48 +-\n Documentation/git-init-db.txt | 2 +-\n Documentation/git-init.txt | 28 +-\n Documentation/git-instaweb.txt | 44 +-\n Documentation/git-interpret-trailers.txt | 80 +-\n Documentation/git-log.txt | 56 +-\n Documentation/git-ls-files.txt | 126 ++--\n Documentation/git-ls-remote.txt | 46 +-\n Documentation/git-ls-tree.txt | 38 +-\n Documentation/git-mailinfo.txt | 36 +-\n Documentation/git-mailsplit.txt | 20 +-\n Documentation/git-maintenance.txt | 32 +-\n Documentation/git-merge-base.txt | 32 +-\n Documentation/git-merge-file.txt | 26 +-\n Documentation/git-merge-index.txt | 16 +-\n Documentation/git-merge-one-file.txt | 6 +-\n Documentation/git-merge-tree.txt | 4 +-\n Documentation/git-merge.txt | 78 +-\n Documentation/git-mergetool--lib.txt | 8 +-\n Documentation/git-mergetool.txt | 40 +-\n Documentation/git-mktag.txt | 4 +-\n Documentation/git-mktree.txt | 8 +-\n Documentation/git-multi-pack-index.txt | 18 +-\n Documentation/git-mv.txt | 28 +-\n Documentation/git-name-rev.txt | 32 +-\n Documentation/git-notes.txt | 170 ++---\n Documentation/git-p4.txt | 318 ++++----\n Documentation/git-pack-objects.txt | 122 ++--\n Documentation/git-pack-redundant.txt | 10 +-\n Documentation/git-pack-refs.txt | 12 +-\n Documentation/git-patch-id.txt | 22 +-\n Documentation/git-prune-packed.txt | 10 +-\n Documentation/git-prune.txt | 30 +-\n Documentation/git-pull.txt | 42 +-\n Documentation/git-push.txt | 136 ++--\n Documentation/git-quiltimport.txt | 18 +-\n Documentation/git-range-diff.txt | 16 +-\n Documentation/git-read-tree.txt | 118 +--\n Documentation/git-rebase.txt | 384 +++++-----\n Documentation/git-receive-pack.txt | 48 +-\n Documentation/git-reflog.txt | 36 +-\n Documentation/git-remote-ext.txt | 40 +-\n Documentation/git-remote-fd.txt | 16 +-\n Documentation/git-remote.txt | 62 +-\n Documentation/git-repack.txt | 64 +-\n Documentation/git-replace.txt | 42 +-\n Documentation/git-request-pull.txt | 12 +-\n Documentation/git-rerere.txt | 80 +-\n Documentation/git-reset.txt | 60 +-\n Documentation/git-restore.txt | 58 +-\n Documentation/git-rev-list.txt | 6 +-\n Documentation/git-rev-parse.txt | 148 ++--\n Documentation/git-revert.txt | 54 +-\n Documentation/git-rm.txt | 32 +-\n Documentation/git-send-email.txt | 192 ++---\n Documentation/git-send-pack.txt | 44 +-\n Documentation/git-sh-i18n--envsubst.txt | 2 +-\n Documentation/git-sh-i18n.txt | 4 +-\n Documentation/git-sh-setup.txt | 10 +-\n Documentation/git-shell.txt | 26 +-\n Documentation/git-shortlog.txt | 32 +-\n Documentation/git-show-branch.txt | 66 +-\n Documentation/git-show-index.txt | 4 +-\n Documentation/git-show-ref.txt | 58 +-\n Documentation/git-show.txt | 12 +-\n Documentation/git-sparse-checkout.txt | 18 +-\n Documentation/git-stage.txt | 2 +-\n Documentation/git-stash.txt | 80 +-\n Documentation/git-status.txt | 78 +-\n Documentation/git-stripspace.txt | 16 +-\n Documentation/git-submodule.txt | 172 ++---\n Documentation/git-svn.txt | 690 +++++++++---------\n Documentation/git-switch.txt | 76 +-\n Documentation/git-symbolic-ref.txt | 22 +-\n Documentation/git-tag.txt | 108 +--\n Documentation/git-unpack-file.txt | 4 +-\n Documentation/git-unpack-objects.txt | 12 +-\n Documentation/git-update-index.txt | 132 ++--\n Documentation/git-update-ref.txt | 40 +-\n Documentation/git-update-server-info.txt | 6 +-\n Documentation/git-upload-archive.txt | 10 +-\n Documentation/git-upload-pack.txt | 20 +-\n Documentation/git-var.txt | 20 +-\n Documentation/git-verify-commit.txt | 10 +-\n Documentation/git-verify-pack.txt | 14 +-\n Documentation/git-verify-tag.txt | 10 +-\n Documentation/git-web--browse.txt | 26 +-\n Documentation/git-whatchanged.txt | 8 +-\n Documentation/git-worktree.txt | 74 +-\n Documentation/git-write-tree.txt | 12 +-\n Documentation/git.txt | 142 ++--\n Documentation/gitattributes.txt | 88 +--\n Documentation/gitcli.txt | 6 +-\n Documentation/gitcore-tutorial.txt | 212 +++---\n Documentation/gitcredentials.txt | 20 +-\n Documentation/gitcvs-migration.txt | 14 +-\n Documentation/gitdiffcore.txt | 60 +-\n Documentation/giteveryday.txt | 24 +-\n Documentation/gitfaq.txt | 6 +-\n Documentation/githooks.txt | 26 +-\n Documentation/gitignore.txt | 16 +-\n Documentation/gitk.txt | 64 +-\n Documentation/gitmailmap.txt | 2 +-\n Documentation/gitmodules.txt | 26 +-\n Documentation/gitnamespaces.txt | 12 +-\n Documentation/gitremote-helpers.txt | 90 +--\n Documentation/gitrepository-layout.txt | 114 +--\n Documentation/gitsubmodules.txt | 2 +-\n Documentation/gittutorial-2.txt | 38 +-\n Documentation/gittutorial.txt | 100 +--\n Documentation/gitweb.conf.txt | 320 ++++----\n Documentation/gitweb.txt | 168 ++---\n Documentation/gitworkflows.txt | 76 +-\n Documentation/glossary-content.txt | 38 +-\n Documentation/howto/revert-branch-rebase.txt | 2 +-\n .../howto/setup-git-server-over-http.txt | 2 +-\n Documentation/i18n.txt | 4 +-\n Documentation/merge-options.txt | 100 +--\n Documentation/merge-strategies.txt | 36 +-\n Documentation/pretty-formats.txt | 16 +-\n Documentation/pretty-options.txt | 52 +-\n Documentation/pull-fetch-param.txt | 18 +-\n Documentation/rev-list-options.txt | 242 +++---\n Documentation/revisions.txt | 76 +-\n Documentation/sequencer.txt | 8 +-\n Documentation/signoff-option.txt | 8 +-\n Documentation/urls-remotes.txt | 12 +-\n Documentation/urls.txt | 40 +-\n Documentation/user-manual.txt | 116 +--\n 204 files changed, 5971 insertions(+), 5971 deletions(-)\n\n-- \n2.31.1.133.g84d06cdc06\n\n"},{"id":"421329","messageId":"20210409040301.3260358-2-firminmartin24@gmail.com","threadId":"55461","inReplyTo":"20210409040301.3260358-1-firminmartin24@gmail.com","subject":"[RFC PATCH v1 01/13] doc: typeset command-line options in monospace","fromName":"Firmin Martin","fromEmail":"firminmartin24@gmail.com","sentAt":"2021-04-09T04:02:49Z","receivedAt":"2021-04-09T04:05:49Z","isPatch":true,"sender":{"key":"firminmartin24@gmail.com","avatar":"https://avatars.githubusercontent.com/u/20540328?v=4"},"body":"Wrap command-line options with backticks as indicated in the\nCodingGuidelines.\n\nThe following command and regex assisted the process.\n\n REGEX=\"^(?![[:blank:]]*[\\$]).*[^-\\`+<[:punct:][:alnum:]]\\-{1,2}[[:alpha:]][a-z0-9-]*(=[\\\"<]?([[:alnum:]])+[>\\\"]?)?[^\\`-]\" &&\n grep -Pn \"$REGEX\" *.txt --exclude-dir=RelNotes\n\nSigned-off-by: Firmin Martin \n---\n Documentation/SubmittingPatches | 2 +-\n Documentation/blame-options.txt | 6 +-\n Documentation/config/diff.txt | 2 +-\n Documentation/config/gitcvs.txt | 6 +-\n Documentation/diff-generate-patch.txt | 4 +-\n Documentation/diff-options.txt | 8 +-\n Documentation/fetch-options.txt | 16 +--\n Documentation/git-add.txt | 2 +-\n Documentation/git-apply.txt | 2 +-\n Documentation/git-archimport.txt | 2 +-\n Documentation/git-archive.txt | 2 +-\n Documentation/git-branch.txt | 2 +-\n Documentation/git-bundle.txt | 10 +-\n Documentation/git-checkout-index.txt | 6 +-\n Documentation/git-checkout.txt | 4 +-\n Documentation/git-cherry-pick.txt | 2 +-\n Documentation/git-clean.txt | 8 +-\n Documentation/git-clone.txt | 4 +-\n Documentation/git-column.txt | 2 +-\n Documentation/git-commit.txt | 16 +--\n Documentation/git-config.txt | 6 +-\n Documentation/git-count-objects.txt | 6 +-\n Documentation/git-cvsexportcommit.txt | 8 +-\n Documentation/git-cvsimport.txt | 12 +-\n Documentation/git-cvsserver.txt | 12 +-\n Documentation/git-daemon.txt | 22 ++--\n Documentation/git-describe.txt | 18 +--\n Documentation/git-diff-tree.txt | 6 +-\n Documentation/git-diff.txt | 6 +-\n Documentation/git-fast-export.txt | 10 +-\n Documentation/git-fast-import.txt | 42 +++----\n Documentation/git-fetch-pack.txt | 4 +-\n Documentation/git-fetch.txt | 6 +-\n Documentation/git-filter-branch.txt | 26 ++---\n Documentation/git-fmt-merge-msg.txt | 2 +-\n Documentation/git-for-each-ref.txt | 4 +-\n Documentation/git-format-patch.txt | 6 +-\n Documentation/git-fsck.txt | 6 +-\n Documentation/git-gc.txt | 4 +-\n Documentation/git-grep.txt | 4 +-\n Documentation/git-help.txt | 8 +-\n Documentation/git-http-fetch.txt | 2 +-\n Documentation/git-http-push.txt | 2 +-\n Documentation/git-index-pack.txt | 12 +-\n Documentation/git-init.txt | 2 +-\n Documentation/git-interpret-trailers.txt | 18 +--\n Documentation/git-ls-files.txt | 24 ++--\n Documentation/git-ls-remote.txt | 2 +-\n Documentation/git-ls-tree.txt | 6 +-\n Documentation/git-mailinfo.txt | 4 +-\n Documentation/git-mailsplit.txt | 2 +-\n Documentation/git-merge-index.txt | 2 +-\n Documentation/git-mv.txt | 2 +-\n Documentation/git-name-rev.txt | 10 +-\n Documentation/git-notes.txt | 4 +-\n Documentation/git-p4.txt | 26 ++---\n Documentation/git-pack-objects.txt | 36 +++---\n Documentation/git-patch-id.txt | 6 +-\n Documentation/git-prune.txt | 2 +-\n Documentation/git-pull.txt | 6 +-\n Documentation/git-push.txt | 10 +-\n Documentation/git-quiltimport.txt | 2 +-\n Documentation/git-read-tree.txt | 6 +-\n Documentation/git-rebase.txt | 108 +++++++++---------\n Documentation/git-repack.txt | 2 +-\n Documentation/git-reset.txt | 4 +-\n Documentation/git-rev-parse.txt | 6 +-\n Documentation/git-rm.txt | 2 +-\n Documentation/git-send-email.txt | 42 +++----\n Documentation/git-send-pack.txt | 2 +-\n Documentation/git-show-branch.txt | 2 +-\n Documentation/git-show-ref.txt | 12 +-\n Documentation/git-status.txt | 10 +-\n Documentation/git-submodule.txt | 2 +-\n Documentation/git-svn.txt | 76 ++++++------\n Documentation/git-tag.txt | 4 +-\n Documentation/git-update-index.txt | 12 +-\n Documentation/git-update-ref.txt | 6 +-\n Documentation/git-verify-pack.txt | 2 +-\n Documentation/git-web--browse.txt | 2 +-\n Documentation/git-whatchanged.txt | 2 +-\n Documentation/git.txt | 4 +-\n Documentation/gitcore-tutorial.txt | 2 +-\n Documentation/gitdiffcore.txt | 30 ++---\n Documentation/gitk.txt | 6 +-\n Documentation/gittutorial-2.txt | 4 +-\n Documentation/gittutorial.txt | 4 +-\n Documentation/gitweb.conf.txt | 6 +-\n Documentation/howto/revert-branch-rebase.txt | 2 +-\n .../howto/setup-git-server-over-http.txt | 2 +-\n Documentation/merge-options.txt | 22 ++--\n Documentation/pretty-formats.txt | 12 +-\n Documentation/pretty-options.txt | 20 ++--\n Documentation/rev-list-options.txt | 28 ++---\n Documentation/signoff-option.txt | 2 +-\n Documentation/urls.txt | 4 +-\n Documentation/user-manual.txt | 4 +-\n 97 files changed, 479 insertions(+), 479 deletions(-)\n\ndiff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches\nindex 0452db2e67..e7623d967b 100644\n--- a/Documentation/SubmittingPatches\n+++ b/Documentation/SubmittingPatches\n@@ -158,7 +158,7 @@ invocation of `git show`:\n \tgit show -s --pretty=reference \n ....\n \n-or, on an older version of Git without support for --pretty=reference:\n+or, on an older version of Git without support for `--pretty=reference`:\n \n ....\n \tgit show -s --date=short --pretty='format:%h (%s, %ad)' \ndiff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt\nindex 117f4cf806..860e8e2f5c 100644\n--- a/Documentation/blame-options.txt\n+++ b/Documentation/blame-options.txt\n@@ -50,7 +50,7 @@ include::line-range-format.txt[]\n --line-porcelain::\n \tShow the porcelain format, but output commit information for\n \teach line, not just the first time a commit is referenced.\n-\tImplies --porcelain.\n+\tImplies `--porcelain`.\n \n --incremental::\n \tShow the result incrementally in a format designed for\n@@ -71,11 +71,11 @@ include::line-range-format.txt[]\n \t`-` to make the command read from the standard input).\n \n --date ::\n-\tSpecifies the format used to output dates. If --date is not\n+\tSpecifies the format used to output dates. If `--date` is not\n \tprovided, the value of the blame.date config variable is\n \tused. If the blame.date config variable is also not set, the\n \tiso format is used. For supported values, see the discussion\n-\tof the --date option at linkgit:git-log[1].\n+\tof the `--date` option at linkgit:git-log[1].\n \n --[no-]progress::\n \tProgress status is reported on the standard error stream\ndiff --git a/Documentation/config/diff.txt b/Documentation/config/diff.txt\nindex 2d3331f55c..7556df330c 100644\n--- a/Documentation/config/diff.txt\n+++ b/Documentation/config/diff.txt\n@@ -113,7 +113,7 @@ diff.relative::\n \n diff.orderFile::\n \tFile indicating how to order files within a diff.\n-\tSee the '-O' option to linkgit:git-diff[1] for details.\n+\tSee the `-O` option to linkgit:git-diff[1] for details.\n \tIf `diff.orderFile` is a relative pathname, it is treated as\n \trelative to the top of the working tree.\n \ndiff --git a/Documentation/config/gitcvs.txt b/Documentation/config/gitcvs.txt\nindex 02da427fd9..a188638340 100644\n--- a/Documentation/config/gitcvs.txt\n+++ b/Documentation/config/gitcvs.txt\n@@ -16,16 +16,16 @@ gitcvs.usecrlfattr::\n \tthe attributes force Git to treat a file as text,\n \tthe `-k` mode will be left blank so CVS clients will\n \ttreat it as text. If they suppress text conversion, the file\n-\twill be set with '-kb' mode, which suppresses any newline munging\n+\twill be set with `-kb` mode, which suppresses any newline munging\n \tthe client might otherwise do. If the attributes do not allow\n \tthe file type to be determined, then `gitcvs.allBinary` is\n \tused. See linkgit:gitattributes[5].\n \n gitcvs.allBinary::\n \tThis is used if `gitcvs.usecrlfattr` does not resolve\n-\tthe correct '-kb' mode to use. If true, all\n+\tthe correct `-kb` mode to use. If true, all\n \tunresolved files are sent to the client in\n-\tmode '-kb'. This causes the client to treat them\n+\tmode `-kb`. This causes the client to treat them\n \tas binary files, which suppresses any newline munging it\n \totherwise might do. Alternatively, if it is set to \"guess\",\n \tthen the contents of the file are examined to decide if\ndiff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt\nindex 2db8eacc3e..2615b29cb0 100644\n--- a/Documentation/diff-generate-patch.txt\n+++ b/Documentation/diff-generate-patch.txt\n@@ -13,7 +13,7 @@ You can customize the creation of patch text via the\n `GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables\n (see linkgit:git[1]).\n \n-What the -p option produces is slightly different from the traditional\n+What the `-p` option produces is slightly different from the traditional\n diff format:\n \n 1. It is preceded with a \"git diff\" header that looks like this:\n@@ -149,7 +149,7 @@ Similar to two-line header for traditional 'unified' diff\n format, `/dev/null` is used to signal created or deleted\n files.\n +\n-However, if the --combined-all-paths option is provided, instead of a\n+However, if the `--combined-all-paths` option is provided, instead of a\n two-line from-file/to-file you get a N+1 line from-file/to-file header,\n where N is the number of parents in the merge commit\n \ndiff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt\nindex aa2b5c11f2..13e0753862 100644\n--- a/Documentation/diff-options.txt\n+++ b/Documentation/diff-options.txt\n@@ -471,7 +471,7 @@ ifndef::git-format-patch[]\n \tthat is immediately followed by a tab character inside the\n \tinitial indent of the line are considered whitespace errors.\n \tExits with non-zero status if problems are found. Not compatible\n-\twith --exit-code.\n+\twith `--exit-code`.\n \n --ws-error-highlight=::\n \tHighlight whitespace errors in the `context`, `old` or `new`\n@@ -522,10 +522,10 @@ original should remain in the result for Git to consider it a total\n rewrite (i.e. otherwise the resulting patch will be a series of\n deletion and insertion mixed together with context lines).\n +\n-When used with -M, a totally-rewritten file is also considered as the\n-source of a rename (usually -M only considers a file that disappeared\n+When used with `-M`, a totally-rewritten file is also considered as the\n+source of a rename (usually `-M` only considers a file that disappeared\n as the source of a rename), and the number `n` controls this aspect of\n-the -B option (defaults to 50%). `-B20%` specifies that a change with\n+the `-B` option (defaults to 50%). `-B20%` specifies that a change with\n addition and deletion compared to 20% or more of the file's size are\n eligible for being picked up as a possible source of a rename to\n another file.\ndiff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt\nindex 07783deee3..4ccd65c166 100644\n--- a/Documentation/fetch-options.txt\n+++ b/Documentation/fetch-options.txt\n@@ -115,10 +115,10 @@ endif::git-pull[]\n \tBefore fetching, remove any remote-tracking references that no\n \tlonger exist on the remote. Tags are not subject to pruning\n \tif they are fetched only because of the default tag\n-\tauto-following or due to a --tags option. However, if tags\n+\tauto-following or due to a `--tags` option. However, if tags\n \tare fetched due to an explicit refspec (either on the command\n \tline or in the remote configuration, for example if the remote\n-\twas cloned with the --mirror option), then they are also\n+\twas cloned with the `--mirror` option), then they are also\n \tsubject to pruning. Supplying `--prune-tags` is a shorthand for\n \tproviding the tag refspec.\n ifndef::git-pull[]\n@@ -164,7 +164,7 @@ endif::git-pull[]\n \tFetch all tags from the remote (i.e., fetch remote tags\n \t`refs/tags/*` into local tags with the same name), in addition\n \tto whatever else would otherwise be fetched. Using this\n-\toption alone does not subject tags to pruning, even if --prune\n+\toption alone does not subject tags to pruning, even if `--prune`\n \tis used (though tags may be pruned anyway if they are also the\n \tdestination of an explicit refspec; see `--prune`).\n \n@@ -215,7 +215,7 @@ ifndef::git-pull[]\n \n --recurse-submodules-default=[yes|on-demand]::\n \tThis option is used internally to temporarily provide a\n-\tnon-negative default value for the --recurse-submodules\n+\tnon-negative default value for the `--recurse-submodules`\n \toption. All other methods of configuring fetch's submodule\n \trecursion (such as settings in linkgit:gitmodules[5] and\n \tlinkgit:git-config[1]) override this option, as does\n@@ -240,7 +240,7 @@ endif::git-pull[]\n ifndef::git-pull[]\n -q::\n --quiet::\n-\tPass --quiet to git-fetch-pack and silence any other internally\n+\tPass `--quiet` to git-fetch-pack and silence any other internally\n \tused git commands. Progress is not reported to the standard error\n \tstream.\n \n@@ -267,14 +267,14 @@ endif::git-pull[]\n --show-forced-updates::\n \tBy default, git checks if a branch is force-updated during\n \tfetch. This can be disabled through fetch.showForcedUpdates, but\n-\tthe --show-forced-updates option guarantees this check occurs.\n+\tthe `--show-forced-updates` option guarantees this check occurs.\n \tSee linkgit:git-config[1].\n \n --no-show-forced-updates::\n \tBy default, git checks if a branch is force-updated during\n-\tfetch. Pass --no-show-forced-updates or set fetch.showForcedUpdates\n+\tfetch. Pass `--no-show-forced-updates` or set fetch.showForcedUpdates\n \tto false to skip this check for performance reasons. If used during\n-\t'git-pull' the --ff-only option will still check for forced updates\n+\t'git-pull' the `--ff-only` option will still check for forced updates\n \tbefore attempting a fast-forward update. See linkgit:git-config[1].\n \n -4::\ndiff --git a/Documentation/git-add.txt b/Documentation/git-add.txt\nindex be5e3ac54b..6a7cb07a8a 100644\n--- a/Documentation/git-add.txt\n+++ b/Documentation/git-add.txt\n@@ -164,7 +164,7 @@ for \"git add --no-all ...\", i.e. ignored removed files.\n \ttrue to make this the default behaviour.\n \n --ignore-missing::\n-\tThis option can only be used together with --dry-run. By using\n+\tThis option can only be used together with `--dry-run`. By using\n \tthis option the user can check if any of the given files would\n \tbe ignored, no matter if they are already present in the work\n \ttree or not.\ndiff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt\nindex 91d9a8601c..f1c8098c0b 100644\n--- a/Documentation/git-apply.txt\n+++ b/Documentation/git-apply.txt\n@@ -233,7 +233,7 @@ behavior:\n \tadjusting the hunk headers appropriately).\n \n --directory=::\n-\tPrepend to all filenames. If a \"-p\" argument was also passed,\n+\tPrepend to all filenames. If a `-p` argument was also passed,\n \tit is applied before prepending the new root.\n +\n For example, a patch that talks about updating `a/git-gui.sh` to `b/git-gui.sh`\ndiff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt\nindex a595a0ffee..b477e3c495 100644\n--- a/Documentation/git-archimport.txt\n+++ b/Documentation/git-archimport.txt\n@@ -98,7 +98,7 @@ OPTIONS\n \n -a::\n \tAttempt to auto-register archives at `http://mirrors.sourcecontrol.net`\n-\tThis is particularly useful with the -D option.\n+\tThis is particularly useful with the `-D` option.\n \n -t ::\n \tOverride the default tempdir.\ndiff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt\nindex 9f8172828d..0af18c9df3 100644\n--- a/Documentation/git-archive.txt\n+++ b/Documentation/git-archive.txt\n@@ -77,7 +77,7 @@ OPTIONS\n \tlinkgit:git-upload-archive[1] for details.\n \n --exec=::\n-\tUsed with --remote to specify the path to the\n+\tUsed with `--remote` to specify the path to the\n \t'git-upload-archive' on the remote side.\n \n ::\ndiff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt\nindex 94dc9a54f2..271b4ee34e 100644\n--- a/Documentation/git-branch.txt\n+++ b/Documentation/git-branch.txt\n@@ -280,7 +280,7 @@ start-point is either a local or remote-tracking branch.\n \n --sort=::\n \tSort based on the key given. Prefix `-` to sort in descending\n-\torder of the value. You may use the --sort= option\n+\torder of the value. You may use the `--sort=` option\n \tmultiple times, in which case the last key becomes the primary\n \tkey. The keys supported are the same as those in `git\n \tfor-each-ref`. Sort order defaults to the value configured for the\ndiff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt\nindex 53804cad4b..4f1e59a3b2 100644\n--- a/Documentation/git-bundle.txt\n+++ b/Documentation/git-bundle.txt\n@@ -88,19 +88,19 @@ unbundle ::\n \tthe standard error stream is not directed to a terminal.\n \n --all-progress::\n-\tWhen --stdout is specified then progress report is\n+\tWhen `--stdout` is specified then progress report is\n \tdisplayed during the object count and compression phases\n \tbut inhibited during the write-out phase. The reason is\n \tthat in some cases the output stream is directly linked\n \tto another command which may wish to display progress\n \tstatus of its own as it processes incoming pack data.\n-\tThis flag is like --progress except that it forces progress\n-\treport for the write-out phase as well even if --stdout is\n+\tThis flag is like `--progress` except that it forces progress\n+\treport for the write-out phase as well even if `--stdout` is\n \tused.\n \n --all-progress-implied::\n-\tThis is used to imply --all-progress whenever progress display\n-\tis activated. Unlike --all-progress this flag doesn't actually\n+\tThis is used to imply `--all-progress` whenever progress display\n+\tis activated. Unlike `--all-progress` this flag doesn't actually\n \tforce any progress display by itself.\n \n --version=::\ndiff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt\nindex 4d33e7be0f..b06d3ae3d9 100644\n--- a/Documentation/git-checkout-index.txt\n+++ b/Documentation/git-checkout-index.txt\n@@ -52,7 +52,7 @@ OPTIONS\n --stage=|all::\n \tInstead of checking out unmerged entries, copy out the\n \tfiles from named stage. must be between 1 and 3.\n-\tNote: --stage=all automatically implies --temp.\n+\tNote: `--stage=all` automatically implies `--temp`.\n \n --temp::\n \tInstead of copying the files to the working directory\n@@ -88,7 +88,7 @@ $ find . -name '*.h' -print0 | xargs -0 git checkout-index -f --\n which will force all existing `*.h` files to be replaced with their\n cached copies. If an empty command line implied \"all\", then this would\n force-refresh everything in the index, which was not the point. But\n-since 'git checkout-index' accepts --stdin it would be faster to use:\n+since 'git checkout-index' accepts `--stdin` it would be faster to use:\n \n ----------------\n $ find . -name '*.h' -print0 | git checkout-index -f -z --stdin\n@@ -128,7 +128,7 @@ or `.` if there is no stage entry. Paths which only have a stage 0\n entry will always be omitted from the output.\n \n In both formats RS (the record separator) is newline by default\n-but will be the null byte if -z was passed on the command line.\n+but will be the null byte if `-z` was passed on the command line.\n The temporary file names are always safe strings; they will never\n contain directory separators or whitespace characters. The path\n field is always relative to the current directory and the temporary\ndiff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt\nindex b1a6fe4499..3336b8dace 100644\n--- a/Documentation/git-checkout.txt\n+++ b/Documentation/git-checkout.txt\n@@ -151,13 +151,13 @@ of it\").\n -B ::\n \tCreates the branch `` and start it at ``;\n \tif it already exists, then reset it to ``. This is\n-\tequivalent to running \"git branch\" with \"-f\"; see\n+\tequivalent to running \"git branch\" with `-f`; see\n \tlinkgit:git-branch[1] for details.\n \n -t::\n --track::\n \tWhen creating a new branch, set up \"upstream\" configuration. See\n-\t\"--track\" in linkgit:git-branch[1] for details.\n+\t`--track` in linkgit:git-branch[1] for details.\n +\n If no `-b` option is given, the name of the new branch will be\n derived from the remote-tracking branch, by looking at the local part of\ndiff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt\nindex 5d750314b2..0127f56204 100644\n--- a/Documentation/git-cherry-pick.txt\n+++ b/Documentation/git-cherry-pick.txt\n@@ -126,7 +126,7 @@ effect to your index in a row.\n \tindicating that an explicit invocation of `git commit\n \t--allow-empty` is required. This option overrides that\n \tbehavior, allowing empty commits to be preserved automatically\n-\tin a cherry-pick. Note that when \"--ff\" is in effect, empty\n+\tin a cherry-pick. Note that when `--ff` is in effect, empty\n \tcommits that meet the \"fast-forward\" requirement will be kept\n \teven without this option. Note also, that use of this option only\n \tkeeps commits that were initially empty (i.e. the commit recorded the\ndiff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt\nindex a7f309dff5..f4246300ae 100644\n--- a/Documentation/git-clean.txt\n+++ b/Documentation/git-clean.txt\n@@ -28,8 +28,8 @@ OPTIONS\n -d::\n \tNormally, when no is specified, git clean will not\n \trecurse into untracked directories to avoid removing too much.\n-\tSpecify -d to have it recurse into such directories as well.\n-\tIf any paths are specified, -d is irrelevant; all untracked\n+\tSpecify `-d` to have it recurse into such directories as well.\n+\tIf any paths are specified, `-d` is irrelevant; all untracked\n \tfiles matching the specified paths (with exceptions for nested\n \tgit directories mentioned under `--force`) will be removed.\n \n@@ -37,9 +37,9 @@ OPTIONS\n --force::\n \tIf the Git configuration variable clean.requireForce is not set\n \tto false, 'git clean' will refuse to delete files or directories\n-\tunless given -f or -i. Git will refuse to modify untracked\n+\tunless given `-f` or `-i`. Git will refuse to modify untracked\n \tnested git repositories (directories with a .git subdirectory)\n-\tunless a second -f is given.\n+\tunless a second `-f` is given.\n \n -i::\n --interactive::\ndiff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt\nindex 3fe3810f1c..22334771d1 100644\n--- a/Documentation/git-clone.txt\n+++ b/Documentation/git-clone.txt\n@@ -31,7 +31,7 @@ currently active branch.\n After the clone, a plain `git fetch` without arguments will update\n all the remote-tracking branches, and a `git pull` without\n arguments will in addition merge the remote master branch into the\n-current master branch, if any (this is untrue when \"--single-branch\"\n+current master branch, if any (this is untrue when `--single-branch`\n is given; see below).\n \n This default configuration is achieved by creating references to\n@@ -52,7 +52,7 @@ OPTIONS\n \tto save space when possible.\n +\n If the repository is specified as a local path (e.g., `/path/to/repo`),\n-this is the default, and --local is essentially a no-op. If the\n+this is the default, and `--local` is essentially a no-op. If the\n repository is specified as a URL, then this flag is ignored (and we\n never use the local optimizations). Specifying `--no-local` will\n override the default when `/path/to/repo` is given, using the regular\ndiff --git a/Documentation/git-column.txt b/Documentation/git-column.txt\nindex f58e9c43e6..84a02ac15c 100644\n--- a/Documentation/git-column.txt\n+++ b/Documentation/git-column.txt\n@@ -29,7 +29,7 @@ OPTIONS\n \tsyntax in linkgit:git-config[1].\n \n --raw-mode=::\n-\tSame as --mode but take mode encoded as a number. This is mainly used\n+\tSame as `--mode` but take mode encoded as a number. This is mainly used\n \tby other commands that have already parsed layout mode.\n \n --width=::\ndiff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt\nindex 340c5fbb48..6d0d663b50 100644\n--- a/Documentation/git-commit.txt\n+++ b/Documentation/git-commit.txt\n@@ -36,18 +36,18 @@ The content to be committed can be specified in several ways:\n and the index, again before using the 'commit' command;\n \n 3. by listing files as arguments to the 'commit' command\n- (without --interactive or --patch switch), in which\n+ (without `--interactive` or `--patch` switch), in which\n case the commit will ignore changes staged in the index, and instead\n record the current content of the listed files (which must already\n be known to Git);\n \n-4. by using the -a switch with the 'commit' command to automatically\n+4. by using the `-a` switch with the 'commit' command to automatically\n \"add\" changes from all known files (i.e. all files that are already\n listed in the index) and to automatically \"rm\" files in the index\n that have been removed from the working tree, and then perform the\n actual commit;\n \n-5. by using the --interactive or --patch switches with the 'commit' command\n+5. by using the `--interactive` or `--patch` switches with the 'commit' command\n to decide one by one which files or hunks should be part of the commit\n in addition to contents in the index,\n before finalizing the operation. See the ``Interactive Mode'' section of\n@@ -84,7 +84,7 @@ OPTIONS\n \n -c ::\n --reedit-message=::\n-\tLike '-C', but with `-c` the editor is invoked, so that\n+\tLike `-C`, but with `-c` the editor is invoked, so that\n \tthe user can further edit the commit message.\n \n --fixup=[(amend|reword):]::\n@@ -134,7 +134,7 @@ See linkgit:git-rebase[1] for details.\n \tlinkgit:git-rebase[1] for details.\n \n --reset-author::\n-\tWhen used with -C/-c/--amend options, or when committing after a\n+\tWhen used with `-C`/`-c`/`--amend` options, or when committing after a\n \tconflicting cherry-pick, declare that the authorship of the\n \tresulting commit now belongs to the committer. This also renews\n \tthe author timestamp.\n@@ -173,7 +173,7 @@ See linkgit:git-rebase[1] for details.\n \tOverride the commit author. Specify an explicit author using the\n \tstandard `A U Thor ` format. Otherwise \n \tis assumed to be a pattern and is used to search for an existing\n-\tcommit by that author (i.e. rev-list --all -i --author=);\n+\tcommit by that author (i.e. `git rev-list --all -i --author=`);\n \tthe commit author is then copied from the first such commit found.\n \n --date=::\n@@ -223,7 +223,7 @@ include::signoff-option.txt[]\n \tis primarily for use by foreign SCM interface scripts.\n \n --allow-empty-message::\n- Like --allow-empty this command is primarily for use by foreign\n+ Like `--allow-empty` this command is primarily for use by foreign\n SCM interface scripts. It allows you to create a commit with an\n empty commit message without using plumbing commands like\n linkgit:git-commit-tree[1].\n@@ -337,7 +337,7 @@ FROM UPSTREAM REBASE\" section in linkgit:git-rebase[1].)\n +\n --\n The mode parameter is optional (defaults to 'all'), and is used to\n-specify the handling of untracked files; when -u is not used, the\n+specify the handling of untracked files; when `-u` is not used, the\n default is 'normal', i.e. show untracked files and directories.\n \n The possible options are:\ndiff --git a/Documentation/git-config.txt b/Documentation/git-config.txt\nindex 4b4cc5c5e8..b93394ea45 100644\n--- a/Documentation/git-config.txt\n+++ b/Documentation/git-config.txt\n@@ -92,7 +92,7 @@ OPTIONS\n \tLike get, but returns all values for a multi-valued key.\n \n --get-regexp::\n-\tLike --get-all, but interprets the name as a regular expression and\n+\tLike `--get-all`, but interprets the name as a regular expression and\n \twrites out the key names. Regular expression matching is currently\n \tcase-sensitive and done against a canonicalized version of the key\n \tin which section and variable names are lowercased, but subsection\n@@ -337,8 +337,8 @@ ENVIRONMENT\n \n GIT_CONFIG::\n \tTake the configuration from the given file instead of .git/config.\n-\tUsing the \"--global\" option forces this to ~/.gitconfig. Using the\n-\t\"--system\" option forces this to $(prefix)/etc/gitconfig.\n+\tUsing the `--global` option forces this to ~/.gitconfig. Using the\n+\t`--system` option forces this to $(prefix)/etc/gitconfig.\n \n GIT_CONFIG_NOSYSTEM::\n \tWhether to skip reading settings from the system-wide\ndiff --git a/Documentation/git-count-objects.txt b/Documentation/git-count-objects.txt\nindex cb9b4d2e46..d12ce08789 100644\n--- a/Documentation/git-count-objects.txt\n+++ b/Documentation/git-count-objects.txt\n@@ -24,11 +24,11 @@ OPTIONS\n +\n count: the number of loose objects\n +\n-size: disk space consumed by loose objects, in KiB (unless -H is specified)\n+size: disk space consumed by loose objects, in KiB (unless `-H` is specified)\n +\n in-pack: the number of in-pack objects\n +\n-size-pack: disk space consumed by the packs, in KiB (unless -H is specified)\n+size-pack: disk space consumed by the packs, in KiB (unless `-H` is specified)\n +\n prune-packable: the number of loose objects that are also present in\n the packs. These objects could be pruned using `git prune-packed`.\n@@ -36,7 +36,7 @@ the packs. These objects could be pruned using `git prune-packed`.\n garbage: the number of files in object database that are neither valid loose\n objects nor valid packs\n +\n-size-garbage: disk space consumed by garbage files, in KiB (unless -H is\n+size-garbage: disk space consumed by garbage files, in KiB (unless `-H` is\n specified)\n +\n alternate: absolute path of alternate object databases; may appear\ndiff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt\nindex 00154b6c85..f08ab508af 100644\n--- a/Documentation/git-cvsexportcommit.txt\n+++ b/Documentation/git-cvsexportcommit.txt\n@@ -18,7 +18,7 @@ DESCRIPTION\n Exports a commit from Git to a CVS checkout, making it easier\n to merge patches from a Git repository into a CVS repository.\n \n-Specify the name of a CVS checkout using the -w switch or execute it\n+Specify the name of a CVS checkout using the `-w` switch or execute it\n from the root of the CVS working copy. In the latter case GIT_DIR must\n be defined. See examples below.\n \n@@ -40,7 +40,7 @@ OPTIONS\n \n -p::\n \tBe pedantic (paranoid) when applying patches. Invokes patch with\n-\t--fuzz=0\n+\t`--fuzz=0`\n \n -a::\n \tAdd authorship information. Adds Author line, and Committer (if\n@@ -48,7 +48,7 @@ OPTIONS\n \n -d::\n \tSet an alternative CVSROOT to use. This corresponds to the CVS\n-\t-d parameter. Usually users will not want to set this, except\n+\t`-d` parameter. Usually users will not want to set this, except\n \tif using CVS in an asymmetric fashion.\n \n -f::\n@@ -99,7 +99,7 @@ $ git cvsexportcommit -v \n $ cvs commit -F .msg \n ------------\n \n-Merge one patch into CVS (-c and -w options). The working directory is within the Git Repo::\n+Merge one patch into CVS (`-c` and `-w` options). The working directory is within the Git Repo::\n +\n ------------\n \t$ git cvsexportcommit -v -c -w ~/project_cvs_checkout \ndiff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt\nindex de1ebed67d..143c726511 100644\n--- a/Documentation/git-cvsimport.txt\n+++ b/Documentation/git-cvsimport.txt\n@@ -38,7 +38,7 @@ created by 'git cvsimport'. By default initial import will create and populate\n \"master\" branch from the CVS repository's main branch which you're free\n to work with; after that, you need to 'git merge' incremental imports, or\n any CVS branches, yourself. It is advisable to specify a named remote via\n--r to separate and protect the incoming branches.\n+`-r` to separate and protect the incoming branches.\n \n If you intend to set up a shared public repository that all developers can\n read/write, or if you want to use linkgit:git-cvsserver[1], then you\n@@ -74,7 +74,7 @@ OPTIONS\n \takin to the way 'git clone' uses 'origin' by default.\n \n -o ::\n-\tWhen no remote is specified (via -r) the `HEAD` branch\n+\tWhen no remote is specified (via `-r`) the `HEAD` branch\n \tfrom CVS is imported to the 'origin' branch within the Git\n \trepository, as `HEAD` already has a special meaning for Git.\n \tWhen a remote is specified the `HEAD` branch is named\n@@ -82,7 +82,7 @@ OPTIONS\n \tUse this option if you want to import into a different\n \tbranch.\n +\n-Use '-o master' for continuing an import that was initially done by\n+Use `-o master` for continuing an import that was initially done by\n the old cvs2git tool.\n \n -i::\n@@ -91,7 +91,7 @@ the old cvs2git tool.\n \tnot create them if they do not exist.\n \n -k::\n-\tKill keywords: will extract files with '-kk' from the CVS archive\n+\tKill keywords: will extract files with `-kk` from the CVS archive\n \tto avoid noisy changesets. Highly recommended, but off by default\n \tto preserve compatibility with early imported trees.\n \n@@ -103,7 +103,7 @@ the old cvs2git tool.\n \n -p ::\n \tAdditional options for cvsps.\n-\tThe options `-u` and '-A' are implicit and should not be used here.\n+\tThe options `-u` and `-A` are implicit and should not be used here.\n +\n If you need to pass multiple options, separate them with a comma.\n \n@@ -158,7 +158,7 @@ all along. If a time zone is specified, GIT_AUTHOR_DATE will\n have the corresponding offset applied.\n +\n For convenience, this data is saved to `$GIT_DIR/cvs-authors`\n-each time the '-A' option is provided and read from that same\n+each time the `-A` option is provided and read from that same\n file each time 'git cvsimport' is run.\n +\n It is not recommended to use this feature if you intend to\ndiff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt\nindex 1b1c71ad9d..955bae46c9 100644\n--- a/Documentation/git-cvsserver.txt\n+++ b/Documentation/git-cvsserver.txt\n@@ -119,7 +119,7 @@ for example:\n ------\n You can use the 'htpasswd' facility that comes with Apache to make these\n files, but Apache's MD5 crypt method differs from the one used by most C\n-library's crypt() function, so don't use the -m option.\n+library's crypt() function, so don't use the `-m` option.\n \n Alternatively you can produce the password with perl's crypt() operator:\n -----\n@@ -312,7 +312,7 @@ ENVIRONMENT\n These variables obviate the need for command-line options in some\n circumstances, allowing easier restricted usage through git-shell.\n \n-GIT_CVSSERVER_BASE_PATH takes the place of the argument to --base-path.\n+GIT_CVSSERVER_BASE_PATH takes the place of the argument to `--base-path`.\n \n GIT_CVSSERVER_ROOT specifies a single-directory whitelist. The\n repository must still be configured to allow access through\n@@ -361,7 +361,7 @@ All the operations required for normal use are supported, including\n checkout, diff, status, update, log, add, remove, commit.\n \n Most CVS command arguments that read CVS tags or revision numbers\n-(typically -r) work, and also support any git refspec\n+(typically `-r`) work, and also support any git refspec\n (tag, branch, commit ID, etc).\n However, CVS revision numbers for non-default branches are not well\n emulated, and cvs log does not show tags or branches at\n@@ -374,7 +374,7 @@ As described elsewhere on this page, the \"module\" parameter\n of cvs checkout is interpreted as a branch name, and it becomes\n the main branch. It remains the main branch for a given sandbox\n even if you temporarily make another branch sticky with\n-cvs update -r. Alternatively, the -r argument can indicate\n+cvs update -r. Alternatively, the `-r` argument can indicate\n some other branch to actually checkout, even though the module\n is still the \"main\" branch. Tradeoffs (as currently\n implemented): Each new \"module\" creates a new database on disk with\n@@ -385,7 +385,7 @@ many operations, like cvs update.\n \n If you want to refer to a git refspec that has characters that are\n not allowed by CVS, you have two options. First, it may just work\n-to supply the git refspec directly to the appropriate CVS -r argument;\n+to supply the git refspec directly to the appropriate CVS `-r` argument;\n some CVS clients don't seem to do much sanity checking of the argument.\n Second, if that fails, you can use a special character escape mechanism\n that only uses characters that are valid in CVS tags. A sequence\n@@ -415,7 +415,7 @@ Alternatively, if `gitcvs.usecrlfattr` config is not enabled\n or the attributes do not allow automatic detection for a filename, then\n the server uses the `gitcvs.allBinary` config for the default setting.\n If `gitcvs.allBinary` is set, then file not otherwise\n-specified will default to '-kb' mode. Otherwise the `-k` mode\n+specified will default to `-kb` mode. Otherwise the `-k` mode\n is left blank. But if `gitcvs.allBinary` is set to \"guess\", then\n the correct `-k` mode will be guessed based on the contents of\n the file.\ndiff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt\nindex fdc28c041c..2794a2d0c1 100644\n--- a/Documentation/git-daemon.txt\n+++ b/Documentation/git-daemon.txt\n@@ -55,14 +55,14 @@ OPTIONS\n --base-path=::\n \tRemap all the path requests as relative to the given path.\n \tThis is sort of \"Git root\" - if you run 'git daemon' with\n-\t'--base-path=/srv/git' on example.com, then if you later try to pull\n+\t`--base-path=/srv/git` on example.com, then if you later try to pull\n \t'git://example.com/hello.git', 'git daemon' will interpret the path\n \tas `/srv/git/hello.git`.\n \n --base-path-relaxed::\n-\tIf --base-path is enabled and repo lookup fails, with this option\n+\tIf `--base-path` is enabled and repo lookup fails, with this option\n \t'git daemon' will attempt to lookup without prefixing the base path.\n-\tThis is useful for switching to --base-path usage, while still\n+\tThis is useful for switching to `--base-path` usage, while still\n \tallowing the old paths.\n \n --interpolated-path=::\n@@ -81,16 +81,16 @@ OPTIONS\n \tdo not have the 'git-daemon-export-ok' file.\n \n --inetd::\n-\tHave the server run as an inetd service. Implies --syslog (may be\n+\tHave the server run as an inetd service. Implies `--syslog` (may be\n \toverridden with `--log-destination=`).\n-\tIncompatible with --detach, --port, --listen, --user and --group\n+\tIncompatible with `--detach`, `--port`, `--listen`, `--user` and `--group`\n \toptions.\n \n --listen=::\n \tListen on a specific IP address or hostname. IP addresses can\n \tbe either an IPv4 address or an IPv6 address if supported. If IPv6\n-\tis not supported, then --listen=hostname is also not supported and\n-\t--listen must be given an IPv4 address.\n+\tis not supported, then `--listen=hostname` is also not supported and\n+\t`--listen` must be given an IPv4 address.\n \tCan be given more than once.\n \tIncompatible with `--inetd` option.\n \n@@ -116,7 +116,7 @@ OPTIONS\n \n --log-destination=::\n \tSend log messages to the specified destination.\n-\tNote that this option does not imply --verbose,\n+\tNote that this option does not imply `--verbose`,\n \tthus by default only error conditions will be logged.\n \tThe must be one of:\n +\n@@ -154,7 +154,7 @@ otherwise `stderr`.\n \told connections to time out.\n \n --detach::\n-\tDetach from the shell. Implies --syslog.\n+\tDetach from the shell. Implies `--syslog`.\n \n --pid-file=::\n \tSave the process id in 'file'. Ignored when the daemon\n@@ -200,7 +200,7 @@ Git configuration files in that directory are readable by ``.\n \tis more convenient for clients, but may leak information about\n \tthe existence of unexported repositories. When informative\n \terrors are not enabled, all errors report \"access denied\" to the\n-\tclient. The default is --no-informative-errors.\n+\tclient. The default is `--no-informative-errors`.\n \n --access-hook=::\n \tEvery time a client connects, first run an external command\n@@ -219,7 +219,7 @@ it declines the service.\n \n ::\n \tA directory to add to the whitelist of allowed directories. Unless\n-\t--strict-paths is specified this will also include subdirectories\n+\t`--strict-paths` is specified this will also include subdirectories\n \tof each named directory.\n \n SERVICES\ndiff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt\nindex a88f6ae2c6..a3f015743b 100644\n--- a/Documentation/git-describe.txt\n+++ b/Documentation/git-describe.txt\n@@ -22,9 +22,9 @@ abbreviated object name of the most recent commit. The result\n is a \"human-readable\" object name which can also be used to\n identify the commit to other git commands.\n \n-By default (without --all or --tags) `git describe` only shows\n+By default (without `--all` or `--tags`) `git describe` only shows\n annotated tags. For more information about creating annotated tags\n-see the -a and -s options to linkgit:git-tag[1].\n+see the `-a` and `-s` options to linkgit:git-tag[1].\n \n If the given object refers to a blob, it will be described\n as `:`, such that the blob can be found\n@@ -60,7 +60,7 @@ OPTIONS\n --contains::\n \tInstead of finding the tag that predates the commit, find\n \tthe tag that comes after the commit, and thus contains it.\n-\tAutomatically implies --tags.\n+\tAutomatically implies `--tags`.\n \n --abbrev=::\n \tInstead of using the default 7 hexadecimal digits as the\n@@ -77,7 +77,7 @@ OPTIONS\n \n --exact-match::\n \tOnly output exact matches (a tag directly references the\n-\tsupplied commit). This is a synonym for --candidates=0.\n+\tsupplied commit). This is a synonym for `--candidates=0`.\n \n --debug::\n \tVerbosely display information about the searching strategy\n@@ -110,9 +110,9 @@ OPTIONS\n \texcluding respectively \"refs/heads/\" and \"refs/remotes/\" prefix;\n \treferences of other types are never considered. If given multiple times,\n \ta list of patterns will be accumulated and tags matching any of the\n-\tpatterns will be excluded. When combined with --match a tag will be\n-\tconsidered when it matches at least one --match pattern and does not\n-\tmatch any of the --exclude patterns. Use `--no-exclude` to clear and\n+\tpatterns will be excluded. When combined with `--match` a tag will be\n+\tconsidered when it matches at least one `--match` pattern and does not\n+\tmatch any of the `--exclude` patterns. Use `--no-exclude` to clear and\n \treset the list of patterns.\n \n --always::\n@@ -150,7 +150,7 @@ Doing a 'git describe' on a tag-name will just show the tag name:\n \t[torvalds@g5 git]$ git describe v1.0.4\n \tv1.0.4\n \n-With --all, the command can use branch heads as references, so\n+With `--all`, the command can use branch heads as references, so\n the output shows the reference path as well:\n \n \t[torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2\n@@ -159,7 +159,7 @@ the output shows the reference path as well:\n \t[torvalds@g5 git]$ git describe --all --abbrev=4 HEAD^\n \theads/lt/describe-7-g975b\n \n-With --abbrev set to 0, the command can be used to find the\n+With `--abbrev` set to 0, the command can be used to find the\n closest tagname without any suffix:\n \n \t[torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2\ndiff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt\nindex 2fc24c542f..b9225cd824 100644\n--- a/Documentation/git-diff-tree.txt\n+++ b/Documentation/git-diff-tree.txt\n@@ -18,7 +18,7 @@ DESCRIPTION\n Compares the content and mode of the blobs found via two tree objects.\n \n If there is only one given, the commit is compared with its parents\n-(see --stdin below).\n+(see `--stdin` below).\n \n Note that 'git diff-tree' can use the tree encapsulated in a commit object.\n \n@@ -37,7 +37,7 @@ include::diff-options.txt[]\n recurse into sub-trees\n \n -t::\n-\tshow tree entry itself as well as subtrees. Implies -r.\n+\tshow tree entry itself as well as subtrees. Implies `-r`.\n \n --root::\n \tWhen `--root` is specified the initial commit will be shown as a big\n@@ -113,7 +113,7 @@ include::pretty-options.txt[]\n --combined-all-paths::\n \tThis flag causes combined diffs (used for merge commits) to\n \tlist the name of the file from all parents. It thus only has\n-\teffect when -c or --cc are specified, and is likely only\n+\teffect when `-c` or `--cc` are specified, and is likely only\n \tuseful if filename changes are detected (i.e. when either\n \trename or copy detection have been requested).\n \ndiff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt\nindex 7f4c8a8ce7..9f4b46c910 100644\n--- a/Documentation/git-diff.txt\n+++ b/Documentation/git-diff.txt\n@@ -48,9 +48,9 @@ files on disk.\n \tdo not give , it defaults to HEAD.\n \tIf HEAD does not exist (e.g. unborn branches) and\n \t is not given, it shows all staged changes.\n-\t--staged is a synonym of --cached.\n+\t`--staged` is a synonym of `--cached`.\n +\n-If --merge-base is given, instead of using , use the merge base\n+If `--merge-base` is given, instead of using , use the merge base\n of and HEAD. `git diff --merge-base A` is equivalent to\n `git diff $(git merge-base A HEAD)`.\n \n@@ -67,7 +67,7 @@ of and HEAD. `git diff --merge-base A` is equivalent to\n \tThis is to view the changes between two arbitrary\n \t.\n +\n-If --merge-base is given, use the merge base of the two commits for the\n+If `--merge-base` is given, use the merge base of the two commits for the\n \"before\" side. `git diff --merge-base A B` is equivalent to\n `git diff $(git merge-base A B) B`.\n \ndiff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt\nindex 1978dbdc6a..a1c02918f9 100644\n--- a/Documentation/git-fast-export.txt\n+++ b/Documentation/git-fast-export.txt\n@@ -67,14 +67,14 @@ produced incorrect results if you gave these options.\n \thave been completed, or to save the marks table across\n \tincremental runs. As is only opened and truncated\n \tat completion, the same path can also be safely given to\n-\t--import-marks.\n+\t`--import-marks`.\n \tThe file will not be written if no new object has been\n \tmarked/exported.\n \n --import-marks=::\n \tBefore processing any input, load the marks specified in\n \t. The input file must exist, must be readable, and\n-\tmust use the same format as produced by --export-marks.\n+\tmust use the same format as produced by `--export-marks`.\n \n --mark-tags::\n \tIn addition to labelling blobs and commits with mark ids, also\n@@ -86,7 +86,7 @@ produced incorrect results if you gave these options.\n \tidentifiers.\n +\n Any commits (or tags) that have already been marked will not be\n-exported again. If the backend uses a similar --import-marks file,\n+exported again. If the backend uses a similar `--import-marks` file,\n this allows for incremental bidirectional exporting of the repository\n by keeping the marks the same across runs.\n \n@@ -130,7 +130,7 @@ by keeping the marks the same across runs.\n \tand will make master{tilde}4 no longer have master{tilde}5 as\n \ta parent (though both the old master{tilde}4 and new\n \tmaster{tilde}4 will have all the same files). Use\n-\t--reference-excluded-parents to instead have the stream\n+\t`--reference-excluded-parents` to instead have the stream\n \trefer to commits in the excluded range of history by their\n \tsha1sum. Note that the resulting stream can only be used by a\n \trepository which already contains the necessary parent\n@@ -160,7 +160,7 @@ by keeping the marks the same across runs.\n \tto export. For example, `master~10..master` causes the\n \tcurrent master reference to be exported along with all objects\n \tadded since its 10th ancestor commit and (unless the\n-\t--reference-excluded-parents option is specified) all files\n+\t`--reference-excluded-parents` option is specified) all files\n \tcommon to master{tilde}9 and master{tilde}10.\n \n EXAMPLES\ndiff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt\nindex 39cfa05b28..ff67238633 100644\n--- a/Documentation/git-fast-import.txt\n+++ b/Documentation/git-fast-import.txt\n@@ -40,7 +40,7 @@ OPTIONS\n \tnot contain the old commit).\n \n --quiet::\n-\tDisable the output shown by --stats, making fast-import usually\n+\tDisable the output shown by `--stats`, making fast-import usually\n \tbe silent when it is successful. However, if the import stream\n \thas directives intended to show user output (e.g. `progress`\n \tdirectives), the corresponding messages will still be shown.\n@@ -49,7 +49,7 @@ OPTIONS\n \tDisplay some basic statistics about the objects fast-import has\n \tcreated, the packfiles they were stored into, and the\n \tmemory used by fast-import during this run. Showing this output\n-\tis currently the default, but can be disabled with --quiet.\n+\tis currently the default, but can be disabled with `--quiet`.\n \n --allow-unsafe-features::\n \tMany command-line options can be provided as part of the\n@@ -97,23 +97,23 @@ Locations of Marks Files\n \thave been completed, or to save the marks table across\n \tincremental runs. As is only opened and truncated\n \tat checkpoint (or completion) the same path can also be\n-\tsafely given to --import-marks.\n+\tsafely given to `--import-marks`.\n \n --import-marks=::\n \tBefore processing any input, load the marks specified in\n \t. The input file must exist, must be readable, and\n-\tmust use the same format as produced by --export-marks.\n+\tmust use the same format as produced by `--export-marks`.\n \tMultiple options may be supplied to import more than one\n \tset of marks. If a mark is defined to different values,\n \tthe last file wins.\n \n --import-marks-if-exists=::\n-\tLike --import-marks but instead of erroring out, silently\n+\tLike `--import-marks` but instead of erroring out, silently\n \tskips the file if it does not exist.\n \n --[no-]relative-marks::\n-\tAfter specifying --relative-marks the paths specified\n-\twith --import-marks= and --export-marks= are relative\n+\tAfter specifying `--relative-marks` the paths specified\n+\twith `--import-marks`= and `--export-marks`= are relative\n \tto an internal directory in the current repository.\n \tIn git-fast-import this means that the paths are relative\n \tto the .git/info/fast-import directory. However, other\n@@ -217,8 +217,8 @@ fast-forward update, fast-import will skip updating that ref and instead\n prints a warning message. fast-import will always attempt to update all\n branch refs, and does not stop on the first failure.\n \n-Branch updates can be forced with --force, but it's recommended that\n-this only be used on an otherwise quiet repository. Using --force\n+Branch updates can be forced with `--force`, but it's recommended that\n+this only be used on an otherwise quiet repository. Using `--force`\n is not necessary for an initial import into an empty repository.\n \n \n@@ -269,11 +269,11 @@ Date Formats\n ~~~~~~~~~~~~\n The following date formats are supported. A frontend should select\n the format it will use for this import by passing the format name\n-in the --date-format= command-line option.\n+in the `--date-format`= command-line option.\n \n `raw`::\n \tThis is the Git native format and is `