* [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale
@ 2021-04-09 4:02 Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 01/13] doc: typeset command-line options in monospace Firmin Martin
` (13 more replies)
0 siblings, 14 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
This patch series aims to make the documentation fully compliant to the
CodingGuidelines regarding monospace font. After it, new contributors
who just want to change a little portion of the documention could just
look around how it has been done without being confused by the
inconsistency between the documentation and the CodingGuidelines.
Concretely: unquoted, single-quoted or double-quoted entities detailed
below in the summary are wrapped or converted in backticks.
Except some easy cases, the methodology consists of using simple regex
to find relevant files, then interactively substitute targeted entities
with progressively smarter regex to exclude false positives. As the
review process could be very tedious, I have been very cautious and have
reviewed myself a couple of times every changes. Consequently, mistakes,
if there are any, are not due to the regex, but my personal
misinterpretation of the context.
Below is some changes I plan to make in v2 which request
comments/approvals of the community.
* Placeholders and option values should be in italic. (Cf. man man)
- e.g. `--date`='<format>', `--notes`[='<ref>'], `branch.`'<name>'`.remote`
- e.g. `--date`='rfc2822'
- Compare gcc and git-add
- man gcc vs. man git-add
- https://linux.die.net/man/1/gcc vs. https://linux.die.net/man/1/git-add
* The Synopsis section should be formatted based on the current
CodingGuidelines plus the above suggestion. IOW, for instance, options should
be wrapped in backticks. Again, to have an idea, compare gcc and git-add.
Best,
Firmin
Firmin Martin (13):
doc: typeset command-line options in monospace
doc: typeset branches and remotes in monospace
doc: typeset configuration options in monospace
doc: typeset git-related commands in monospace
doc: typeset git-svn subcommands in monospace
doc: typeset dummy URLs and protocols in monospace
doc: typeset git dotfiles in monospace
doc: typeset filepath and $variables in monospace
doc: typeset command/option/value entries in monospace
doc: typeset more command entries in monospace
doc: typeset config option entries in monospace
doc: typeset environment vars without $ in monospace
doc: typeset common programs in monospace
Documentation/CodingGuidelines | 2 +-
Documentation/MyFirstContribution.txt | 8 +-
Documentation/SubmittingPatches | 2 +-
Documentation/blame-options.txt | 50 +-
Documentation/config.txt | 38 +-
Documentation/config/diff.txt | 2 +-
Documentation/config/gitcvs.txt | 6 +-
Documentation/diff-format.txt | 12 +-
Documentation/diff-generate-patch.txt | 8 +-
Documentation/diff-options.txt | 252 +++----
Documentation/fetch-options.txt | 136 ++--
Documentation/git-add.txt | 86 +--
Documentation/git-am.txt | 116 +--
Documentation/git-apply.txt | 84 +--
Documentation/git-archimport.txt | 34 +-
Documentation/git-archive.txt | 52 +-
Documentation/git-bisect-lk2009.txt | 188 ++---
Documentation/git-bisect.txt | 48 +-
Documentation/git-blame.txt | 32 +-
Documentation/git-branch.txt | 156 ++--
Documentation/git-bugreport.txt | 14 +-
Documentation/git-bundle.txt | 74 +-
Documentation/git-cat-file.txt | 42 +-
Documentation/git-check-attr.txt | 18 +-
Documentation/git-check-ignore.txt | 16 +-
Documentation/git-check-mailmap.txt | 4 +-
Documentation/git-check-ref-format.txt | 16 +-
Documentation/git-checkout-index.txt | 42 +-
Documentation/git-checkout.txt | 114 +--
Documentation/git-cherry-pick.txt | 76 +-
Documentation/git-cherry.txt | 20 +-
Documentation/git-citool.txt | 6 +-
Documentation/git-clean.txt | 66 +-
Documentation/git-clone.txt | 104 +--
Documentation/git-column.txt | 26 +-
Documentation/git-commit-graph.txt | 12 +-
Documentation/git-commit-tree.txt | 22 +-
Documentation/git-commit.txt | 174 ++---
Documentation/git-config.txt | 174 ++---
Documentation/git-count-objects.txt | 16 +-
.../git-credential-cache--daemon.txt | 2 +-
Documentation/git-credential-cache.txt | 8 +-
Documentation/git-credential-store.txt | 12 +-
Documentation/git-credential.txt | 16 +-
Documentation/git-cvsexportcommit.txt | 46 +-
Documentation/git-cvsimport.txt | 84 +--
Documentation/git-cvsserver.txt | 110 +--
Documentation/git-daemon.txt | 150 ++--
Documentation/git-describe.txt | 80 +-
Documentation/git-diff-files.txt | 18 +-
Documentation/git-diff-index.txt | 34 +-
Documentation/git-diff-tree.txt | 46 +-
Documentation/git-diff.txt | 64 +-
Documentation/git-difftool.txt | 78 +-
Documentation/git-fast-export.txt | 84 +--
Documentation/git-fast-import.txt | 140 ++--
Documentation/git-fetch-pack.txt | 72 +-
Documentation/git-fetch.txt | 46 +-
Documentation/git-filter-branch.txt | 164 ++---
Documentation/git-fmt-merge-msg.txt | 30 +-
Documentation/git-for-each-ref.txt | 80 +-
Documentation/git-for-each-repo.txt | 4 +-
Documentation/git-format-patch.txt | 132 ++--
Documentation/git-fsck-objects.txt | 2 +-
Documentation/git-fsck.txt | 74 +-
Documentation/git-gc.txt | 36 +-
Documentation/git-get-tar-commit-id.txt | 8 +-
Documentation/git-grep.txt | 178 ++---
Documentation/git-gui.txt | 32 +-
Documentation/git-hash-object.txt | 20 +-
Documentation/git-help.txt | 78 +-
Documentation/git-http-backend.txt | 72 +-
Documentation/git-http-fetch.txt | 24 +-
Documentation/git-http-push.txt | 22 +-
Documentation/git-imap-send.txt | 20 +-
Documentation/git-index-pack.txt | 48 +-
Documentation/git-init-db.txt | 2 +-
Documentation/git-init.txt | 28 +-
Documentation/git-instaweb.txt | 44 +-
Documentation/git-interpret-trailers.txt | 80 +-
Documentation/git-log.txt | 56 +-
Documentation/git-ls-files.txt | 126 ++--
Documentation/git-ls-remote.txt | 46 +-
Documentation/git-ls-tree.txt | 38 +-
Documentation/git-mailinfo.txt | 36 +-
Documentation/git-mailsplit.txt | 20 +-
Documentation/git-maintenance.txt | 32 +-
Documentation/git-merge-base.txt | 32 +-
Documentation/git-merge-file.txt | 26 +-
Documentation/git-merge-index.txt | 16 +-
Documentation/git-merge-one-file.txt | 6 +-
Documentation/git-merge-tree.txt | 4 +-
Documentation/git-merge.txt | 78 +-
Documentation/git-mergetool--lib.txt | 8 +-
Documentation/git-mergetool.txt | 40 +-
Documentation/git-mktag.txt | 4 +-
Documentation/git-mktree.txt | 8 +-
Documentation/git-multi-pack-index.txt | 18 +-
Documentation/git-mv.txt | 28 +-
Documentation/git-name-rev.txt | 32 +-
Documentation/git-notes.txt | 170 ++---
Documentation/git-p4.txt | 318 ++++----
Documentation/git-pack-objects.txt | 122 ++--
Documentation/git-pack-redundant.txt | 10 +-
Documentation/git-pack-refs.txt | 12 +-
Documentation/git-patch-id.txt | 22 +-
Documentation/git-prune-packed.txt | 10 +-
Documentation/git-prune.txt | 30 +-
Documentation/git-pull.txt | 42 +-
Documentation/git-push.txt | 136 ++--
Documentation/git-quiltimport.txt | 18 +-
Documentation/git-range-diff.txt | 16 +-
Documentation/git-read-tree.txt | 118 +--
Documentation/git-rebase.txt | 384 +++++-----
Documentation/git-receive-pack.txt | 48 +-
Documentation/git-reflog.txt | 36 +-
Documentation/git-remote-ext.txt | 40 +-
Documentation/git-remote-fd.txt | 16 +-
Documentation/git-remote.txt | 62 +-
Documentation/git-repack.txt | 64 +-
Documentation/git-replace.txt | 42 +-
Documentation/git-request-pull.txt | 12 +-
Documentation/git-rerere.txt | 80 +-
Documentation/git-reset.txt | 60 +-
Documentation/git-restore.txt | 58 +-
Documentation/git-rev-list.txt | 6 +-
Documentation/git-rev-parse.txt | 148 ++--
Documentation/git-revert.txt | 54 +-
Documentation/git-rm.txt | 32 +-
Documentation/git-send-email.txt | 192 ++---
Documentation/git-send-pack.txt | 44 +-
Documentation/git-sh-i18n--envsubst.txt | 2 +-
Documentation/git-sh-i18n.txt | 4 +-
Documentation/git-sh-setup.txt | 10 +-
Documentation/git-shell.txt | 26 +-
Documentation/git-shortlog.txt | 32 +-
Documentation/git-show-branch.txt | 66 +-
Documentation/git-show-index.txt | 4 +-
Documentation/git-show-ref.txt | 58 +-
Documentation/git-show.txt | 12 +-
Documentation/git-sparse-checkout.txt | 18 +-
Documentation/git-stage.txt | 2 +-
Documentation/git-stash.txt | 80 +-
Documentation/git-status.txt | 78 +-
Documentation/git-stripspace.txt | 16 +-
Documentation/git-submodule.txt | 172 ++---
Documentation/git-svn.txt | 690 +++++++++---------
Documentation/git-switch.txt | 76 +-
Documentation/git-symbolic-ref.txt | 22 +-
Documentation/git-tag.txt | 108 +--
Documentation/git-unpack-file.txt | 4 +-
Documentation/git-unpack-objects.txt | 12 +-
Documentation/git-update-index.txt | 132 ++--
Documentation/git-update-ref.txt | 40 +-
Documentation/git-update-server-info.txt | 6 +-
Documentation/git-upload-archive.txt | 10 +-
Documentation/git-upload-pack.txt | 20 +-
Documentation/git-var.txt | 20 +-
Documentation/git-verify-commit.txt | 10 +-
Documentation/git-verify-pack.txt | 14 +-
Documentation/git-verify-tag.txt | 10 +-
Documentation/git-web--browse.txt | 26 +-
Documentation/git-whatchanged.txt | 8 +-
Documentation/git-worktree.txt | 74 +-
Documentation/git-write-tree.txt | 12 +-
Documentation/git.txt | 142 ++--
Documentation/gitattributes.txt | 88 +--
Documentation/gitcli.txt | 6 +-
Documentation/gitcore-tutorial.txt | 212 +++---
Documentation/gitcredentials.txt | 20 +-
Documentation/gitcvs-migration.txt | 14 +-
Documentation/gitdiffcore.txt | 60 +-
Documentation/giteveryday.txt | 24 +-
Documentation/gitfaq.txt | 6 +-
Documentation/githooks.txt | 26 +-
Documentation/gitignore.txt | 16 +-
Documentation/gitk.txt | 64 +-
Documentation/gitmailmap.txt | 2 +-
Documentation/gitmodules.txt | 26 +-
Documentation/gitnamespaces.txt | 12 +-
Documentation/gitremote-helpers.txt | 90 +--
Documentation/gitrepository-layout.txt | 114 +--
Documentation/gitsubmodules.txt | 2 +-
Documentation/gittutorial-2.txt | 38 +-
Documentation/gittutorial.txt | 100 +--
Documentation/gitweb.conf.txt | 320 ++++----
Documentation/gitweb.txt | 168 ++---
Documentation/gitworkflows.txt | 76 +-
Documentation/glossary-content.txt | 38 +-
Documentation/howto/revert-branch-rebase.txt | 2 +-
.../howto/setup-git-server-over-http.txt | 2 +-
Documentation/i18n.txt | 4 +-
Documentation/merge-options.txt | 100 +--
Documentation/merge-strategies.txt | 36 +-
Documentation/pretty-formats.txt | 16 +-
Documentation/pretty-options.txt | 52 +-
Documentation/pull-fetch-param.txt | 18 +-
Documentation/rev-list-options.txt | 242 +++---
Documentation/revisions.txt | 76 +-
Documentation/sequencer.txt | 8 +-
Documentation/signoff-option.txt | 8 +-
Documentation/urls-remotes.txt | 12 +-
Documentation/urls.txt | 40 +-
Documentation/user-manual.txt | 116 +--
204 files changed, 5971 insertions(+), 5971 deletions(-)
--
2.31.1.133.g84d06cdc06
^ permalink raw reply [flat|nested] 20+ messages in thread
* [RFC PATCH v1 01/13] doc: typeset command-line options in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
@ 2021-04-09 4:02 ` Firmin Martin
2021-04-09 9:49 ` Bagas Sanjaya
2021-04-09 4:02 ` [RFC PATCH v1 02/13] doc: typeset branches and remotes " Firmin Martin
` (12 subsequent siblings)
13 siblings, 1 reply; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Wrap command-line options with backticks as indicated in the
CodingGuidelines.
The following command and regex assisted the process.
REGEX="^(?![[:blank:]]*[\$]).*[^-\`+<[:punct:][:alnum:]]\-{1,2}[[:alpha:]][a-z0-9-]*(=[\"<]?([[:alnum:]])+[>\"]?)?[^\`-]" &&
grep -Pn "$REGEX" *.txt --exclude-dir=RelNotes
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/SubmittingPatches | 2 +-
Documentation/blame-options.txt | 6 +-
Documentation/config/diff.txt | 2 +-
Documentation/config/gitcvs.txt | 6 +-
Documentation/diff-generate-patch.txt | 4 +-
Documentation/diff-options.txt | 8 +-
Documentation/fetch-options.txt | 16 +--
Documentation/git-add.txt | 2 +-
Documentation/git-apply.txt | 2 +-
Documentation/git-archimport.txt | 2 +-
Documentation/git-archive.txt | 2 +-
Documentation/git-branch.txt | 2 +-
Documentation/git-bundle.txt | 10 +-
Documentation/git-checkout-index.txt | 6 +-
Documentation/git-checkout.txt | 4 +-
Documentation/git-cherry-pick.txt | 2 +-
Documentation/git-clean.txt | 8 +-
Documentation/git-clone.txt | 4 +-
Documentation/git-column.txt | 2 +-
Documentation/git-commit.txt | 16 +--
Documentation/git-config.txt | 6 +-
Documentation/git-count-objects.txt | 6 +-
Documentation/git-cvsexportcommit.txt | 8 +-
Documentation/git-cvsimport.txt | 12 +-
Documentation/git-cvsserver.txt | 12 +-
Documentation/git-daemon.txt | 22 ++--
Documentation/git-describe.txt | 18 +--
Documentation/git-diff-tree.txt | 6 +-
Documentation/git-diff.txt | 6 +-
Documentation/git-fast-export.txt | 10 +-
Documentation/git-fast-import.txt | 42 +++----
Documentation/git-fetch-pack.txt | 4 +-
Documentation/git-fetch.txt | 6 +-
Documentation/git-filter-branch.txt | 26 ++---
Documentation/git-fmt-merge-msg.txt | 2 +-
Documentation/git-for-each-ref.txt | 4 +-
Documentation/git-format-patch.txt | 6 +-
Documentation/git-fsck.txt | 6 +-
Documentation/git-gc.txt | 4 +-
Documentation/git-grep.txt | 4 +-
Documentation/git-help.txt | 8 +-
Documentation/git-http-fetch.txt | 2 +-
Documentation/git-http-push.txt | 2 +-
Documentation/git-index-pack.txt | 12 +-
Documentation/git-init.txt | 2 +-
Documentation/git-interpret-trailers.txt | 18 +--
Documentation/git-ls-files.txt | 24 ++--
Documentation/git-ls-remote.txt | 2 +-
Documentation/git-ls-tree.txt | 6 +-
Documentation/git-mailinfo.txt | 4 +-
Documentation/git-mailsplit.txt | 2 +-
Documentation/git-merge-index.txt | 2 +-
Documentation/git-mv.txt | 2 +-
Documentation/git-name-rev.txt | 10 +-
Documentation/git-notes.txt | 4 +-
Documentation/git-p4.txt | 26 ++---
Documentation/git-pack-objects.txt | 36 +++---
Documentation/git-patch-id.txt | 6 +-
Documentation/git-prune.txt | 2 +-
Documentation/git-pull.txt | 6 +-
Documentation/git-push.txt | 10 +-
Documentation/git-quiltimport.txt | 2 +-
Documentation/git-read-tree.txt | 6 +-
Documentation/git-rebase.txt | 108 +++++++++---------
Documentation/git-repack.txt | 2 +-
Documentation/git-reset.txt | 4 +-
Documentation/git-rev-parse.txt | 6 +-
Documentation/git-rm.txt | 2 +-
Documentation/git-send-email.txt | 42 +++----
Documentation/git-send-pack.txt | 2 +-
Documentation/git-show-branch.txt | 2 +-
Documentation/git-show-ref.txt | 12 +-
Documentation/git-status.txt | 10 +-
Documentation/git-submodule.txt | 2 +-
Documentation/git-svn.txt | 76 ++++++------
Documentation/git-tag.txt | 4 +-
Documentation/git-update-index.txt | 12 +-
Documentation/git-update-ref.txt | 6 +-
Documentation/git-verify-pack.txt | 2 +-
Documentation/git-web--browse.txt | 2 +-
Documentation/git-whatchanged.txt | 2 +-
Documentation/git.txt | 4 +-
Documentation/gitcore-tutorial.txt | 2 +-
Documentation/gitdiffcore.txt | 30 ++---
Documentation/gitk.txt | 6 +-
Documentation/gittutorial-2.txt | 4 +-
Documentation/gittutorial.txt | 4 +-
Documentation/gitweb.conf.txt | 6 +-
Documentation/howto/revert-branch-rebase.txt | 2 +-
.../howto/setup-git-server-over-http.txt | 2 +-
Documentation/merge-options.txt | 22 ++--
Documentation/pretty-formats.txt | 12 +-
Documentation/pretty-options.txt | 20 ++--
Documentation/rev-list-options.txt | 28 ++---
Documentation/signoff-option.txt | 2 +-
Documentation/urls.txt | 4 +-
Documentation/user-manual.txt | 4 +-
97 files changed, 479 insertions(+), 479 deletions(-)
diff --git a/Documentation/SubmittingPatches b/Documentation/SubmittingPatches
index 0452db2e67..e7623d967b 100644
--- a/Documentation/SubmittingPatches
+++ b/Documentation/SubmittingPatches
@@ -158,7 +158,7 @@ invocation of `git show`:
git show -s --pretty=reference <commit>
....
-or, on an older version of Git without support for --pretty=reference:
+or, on an older version of Git without support for `--pretty=reference`:
....
git show -s --date=short --pretty='format:%h (%s, %ad)' <commit>
diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt
index 117f4cf806..860e8e2f5c 100644
--- a/Documentation/blame-options.txt
+++ b/Documentation/blame-options.txt
@@ -50,7 +50,7 @@ include::line-range-format.txt[]
--line-porcelain::
Show the porcelain format, but output commit information for
each line, not just the first time a commit is referenced.
- Implies --porcelain.
+ Implies `--porcelain`.
--incremental::
Show the result incrementally in a format designed for
@@ -71,11 +71,11 @@ include::line-range-format.txt[]
`-` to make the command read from the standard input).
--date <format>::
- Specifies the format used to output dates. If --date is not
+ Specifies the format used to output dates. If `--date` is not
provided, the value of the blame.date config variable is
used. If the blame.date config variable is also not set, the
iso format is used. For supported values, see the discussion
- of the --date option at linkgit:git-log[1].
+ of the `--date` option at linkgit:git-log[1].
--[no-]progress::
Progress status is reported on the standard error stream
diff --git a/Documentation/config/diff.txt b/Documentation/config/diff.txt
index 2d3331f55c..7556df330c 100644
--- a/Documentation/config/diff.txt
+++ b/Documentation/config/diff.txt
@@ -113,7 +113,7 @@ diff.relative::
diff.orderFile::
File indicating how to order files within a diff.
- See the '-O' option to linkgit:git-diff[1] for details.
+ See the `-O` option to linkgit:git-diff[1] for details.
If `diff.orderFile` is a relative pathname, it is treated as
relative to the top of the working tree.
diff --git a/Documentation/config/gitcvs.txt b/Documentation/config/gitcvs.txt
index 02da427fd9..a188638340 100644
--- a/Documentation/config/gitcvs.txt
+++ b/Documentation/config/gitcvs.txt
@@ -16,16 +16,16 @@ gitcvs.usecrlfattr::
the attributes force Git to treat a file as text,
the `-k` mode will be left blank so CVS clients will
treat it as text. If they suppress text conversion, the file
- will be set with '-kb' mode, which suppresses any newline munging
+ will be set with `-kb` mode, which suppresses any newline munging
the client might otherwise do. If the attributes do not allow
the file type to be determined, then `gitcvs.allBinary` is
used. See linkgit:gitattributes[5].
gitcvs.allBinary::
This is used if `gitcvs.usecrlfattr` does not resolve
- the correct '-kb' mode to use. If true, all
+ the correct `-kb` mode to use. If true, all
unresolved files are sent to the client in
- mode '-kb'. This causes the client to treat them
+ mode `-kb`. This causes the client to treat them
as binary files, which suppresses any newline munging it
otherwise might do. Alternatively, if it is set to "guess",
then the contents of the file are examined to decide if
diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt
index 2db8eacc3e..2615b29cb0 100644
--- a/Documentation/diff-generate-patch.txt
+++ b/Documentation/diff-generate-patch.txt
@@ -13,7 +13,7 @@ You can customize the creation of patch text via the
`GIT_EXTERNAL_DIFF` and the `GIT_DIFF_OPTS` environment variables
(see linkgit:git[1]).
-What the -p option produces is slightly different from the traditional
+What the `-p` option produces is slightly different from the traditional
diff format:
1. It is preceded with a "git diff" header that looks like this:
@@ -149,7 +149,7 @@ Similar to two-line header for traditional 'unified' diff
format, `/dev/null` is used to signal created or deleted
files.
+
-However, if the --combined-all-paths option is provided, instead of a
+However, if the `--combined-all-paths` option is provided, instead of a
two-line from-file/to-file you get a N+1 line from-file/to-file header,
where N is the number of parents in the merge commit
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index aa2b5c11f2..13e0753862 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -471,7 +471,7 @@ ifndef::git-format-patch[]
that is immediately followed by a tab character inside the
initial indent of the line are considered whitespace errors.
Exits with non-zero status if problems are found. Not compatible
- with --exit-code.
+ with `--exit-code`.
--ws-error-highlight=<kind>::
Highlight whitespace errors in the `context`, `old` or `new`
@@ -522,10 +522,10 @@ original should remain in the result for Git to consider it a total
rewrite (i.e. otherwise the resulting patch will be a series of
deletion and insertion mixed together with context lines).
+
-When used with -M, a totally-rewritten file is also considered as the
-source of a rename (usually -M only considers a file that disappeared
+When used with `-M`, a totally-rewritten file is also considered as the
+source of a rename (usually `-M` only considers a file that disappeared
as the source of a rename), and the number `n` controls this aspect of
-the -B option (defaults to 50%). `-B20%` specifies that a change with
+the `-B` option (defaults to 50%). `-B20%` specifies that a change with
addition and deletion compared to 20% or more of the file's size are
eligible for being picked up as a possible source of a rename to
another file.
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 07783deee3..4ccd65c166 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -115,10 +115,10 @@ endif::git-pull[]
Before fetching, remove any remote-tracking references that no
longer exist on the remote. Tags are not subject to pruning
if they are fetched only because of the default tag
- auto-following or due to a --tags option. However, if tags
+ auto-following or due to a `--tags` option. However, if tags
are fetched due to an explicit refspec (either on the command
line or in the remote configuration, for example if the remote
- was cloned with the --mirror option), then they are also
+ was cloned with the `--mirror` option), then they are also
subject to pruning. Supplying `--prune-tags` is a shorthand for
providing the tag refspec.
ifndef::git-pull[]
@@ -164,7 +164,7 @@ endif::git-pull[]
Fetch all tags from the remote (i.e., fetch remote tags
`refs/tags/*` into local tags with the same name), in addition
to whatever else would otherwise be fetched. Using this
- option alone does not subject tags to pruning, even if --prune
+ option alone does not subject tags to pruning, even if `--prune`
is used (though tags may be pruned anyway if they are also the
destination of an explicit refspec; see `--prune`).
@@ -215,7 +215,7 @@ ifndef::git-pull[]
--recurse-submodules-default=[yes|on-demand]::
This option is used internally to temporarily provide a
- non-negative default value for the --recurse-submodules
+ non-negative default value for the `--recurse-submodules`
option. All other methods of configuring fetch's submodule
recursion (such as settings in linkgit:gitmodules[5] and
linkgit:git-config[1]) override this option, as does
@@ -240,7 +240,7 @@ endif::git-pull[]
ifndef::git-pull[]
-q::
--quiet::
- Pass --quiet to git-fetch-pack and silence any other internally
+ Pass `--quiet` to git-fetch-pack and silence any other internally
used git commands. Progress is not reported to the standard error
stream.
@@ -267,14 +267,14 @@ endif::git-pull[]
--show-forced-updates::
By default, git checks if a branch is force-updated during
fetch. This can be disabled through fetch.showForcedUpdates, but
- the --show-forced-updates option guarantees this check occurs.
+ the `--show-forced-updates` option guarantees this check occurs.
See linkgit:git-config[1].
--no-show-forced-updates::
By default, git checks if a branch is force-updated during
- fetch. Pass --no-show-forced-updates or set fetch.showForcedUpdates
+ fetch. Pass `--no-show-forced-updates` or set fetch.showForcedUpdates
to false to skip this check for performance reasons. If used during
- 'git-pull' the --ff-only option will still check for forced updates
+ 'git-pull' the `--ff-only` option will still check for forced updates
before attempting a fast-forward update. See linkgit:git-config[1].
-4::
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index be5e3ac54b..6a7cb07a8a 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -164,7 +164,7 @@ for "git add --no-all <pathspec>...", i.e. ignored removed files.
true to make this the default behaviour.
--ignore-missing::
- This option can only be used together with --dry-run. By using
+ This option can only be used together with `--dry-run`. By using
this option the user can check if any of the given files would
be ignored, no matter if they are already present in the work
tree or not.
diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
index 91d9a8601c..f1c8098c0b 100644
--- a/Documentation/git-apply.txt
+++ b/Documentation/git-apply.txt
@@ -233,7 +233,7 @@ behavior:
adjusting the hunk headers appropriately).
--directory=<root>::
- Prepend <root> to all filenames. If a "-p" argument was also passed,
+ Prepend <root> to all filenames. If a `-p` argument was also passed,
it is applied before prepending the new root.
+
For example, a patch that talks about updating `a/git-gui.sh` to `b/git-gui.sh`
diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt
index a595a0ffee..b477e3c495 100644
--- a/Documentation/git-archimport.txt
+++ b/Documentation/git-archimport.txt
@@ -98,7 +98,7 @@ OPTIONS
-a::
Attempt to auto-register archives at `http://mirrors.sourcecontrol.net`
- This is particularly useful with the -D option.
+ This is particularly useful with the `-D` option.
-t <tmpdir>::
Override the default tempdir.
diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index 9f8172828d..0af18c9df3 100644
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -77,7 +77,7 @@ OPTIONS
linkgit:git-upload-archive[1] for details.
--exec=<git-upload-archive>::
- Used with --remote to specify the path to the
+ Used with `--remote` to specify the path to the
'git-upload-archive' on the remote side.
<tree-ish>::
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 94dc9a54f2..271b4ee34e 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -280,7 +280,7 @@ start-point is either a local or remote-tracking branch.
--sort=<key>::
Sort based on the key given. Prefix `-` to sort in descending
- order of the value. You may use the --sort=<key> option
+ order of the value. You may use the `--sort=<key>` option
multiple times, in which case the last key becomes the primary
key. The keys supported are the same as those in `git
for-each-ref`. Sort order defaults to the value configured for the
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index 53804cad4b..4f1e59a3b2 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -88,19 +88,19 @@ unbundle <file>::
the standard error stream is not directed to a terminal.
--all-progress::
- When --stdout is specified then progress report is
+ When `--stdout` is specified then progress report is
displayed during the object count and compression phases
but inhibited during the write-out phase. The reason is
that in some cases the output stream is directly linked
to another command which may wish to display progress
status of its own as it processes incoming pack data.
- This flag is like --progress except that it forces progress
- report for the write-out phase as well even if --stdout is
+ This flag is like `--progress` except that it forces progress
+ report for the write-out phase as well even if `--stdout` is
used.
--all-progress-implied::
- This is used to imply --all-progress whenever progress display
- is activated. Unlike --all-progress this flag doesn't actually
+ This is used to imply `--all-progress` whenever progress display
+ is activated. Unlike `--all-progress` this flag doesn't actually
force any progress display by itself.
--version=<version>::
diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt
index 4d33e7be0f..b06d3ae3d9 100644
--- a/Documentation/git-checkout-index.txt
+++ b/Documentation/git-checkout-index.txt
@@ -52,7 +52,7 @@ OPTIONS
--stage=<number>|all::
Instead of checking out unmerged entries, copy out the
files from named stage. <number> must be between 1 and 3.
- Note: --stage=all automatically implies --temp.
+ Note: `--stage=all` automatically implies `--temp`.
--temp::
Instead of copying the files to the working directory
@@ -88,7 +88,7 @@ $ find . -name '*.h' -print0 | xargs -0 git checkout-index -f --
which will force all existing `*.h` files to be replaced with their
cached copies. If an empty command line implied "all", then this would
force-refresh everything in the index, which was not the point. But
-since 'git checkout-index' accepts --stdin it would be faster to use:
+since 'git checkout-index' accepts `--stdin` it would be faster to use:
----------------
$ find . -name '*.h' -print0 | git checkout-index -f -z --stdin
@@ -128,7 +128,7 @@ or `.` if there is no stage entry. Paths which only have a stage 0
entry will always be omitted from the output.
In both formats RS (the record separator) is newline by default
-but will be the null byte if -z was passed on the command line.
+but will be the null byte if `-z` was passed on the command line.
The temporary file names are always safe strings; they will never
contain directory separators or whitespace characters. The path
field is always relative to the current directory and the temporary
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index b1a6fe4499..3336b8dace 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -151,13 +151,13 @@ of it").
-B <new_branch>::
Creates the branch `<new_branch>` and start it at `<start_point>`;
if it already exists, then reset it to `<start_point>`. This is
- equivalent to running "git branch" with "-f"; see
+ equivalent to running "git branch" with `-f`; see
linkgit:git-branch[1] for details.
-t::
--track::
When creating a new branch, set up "upstream" configuration. See
- "--track" in linkgit:git-branch[1] for details.
+ `--track` in linkgit:git-branch[1] for details.
+
If no `-b` option is given, the name of the new branch will be
derived from the remote-tracking branch, by looking at the local part of
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index 5d750314b2..0127f56204 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -126,7 +126,7 @@ effect to your index in a row.
indicating that an explicit invocation of `git commit
--allow-empty` is required. This option overrides that
behavior, allowing empty commits to be preserved automatically
- in a cherry-pick. Note that when "--ff" is in effect, empty
+ in a cherry-pick. Note that when `--ff` is in effect, empty
commits that meet the "fast-forward" requirement will be kept
even without this option. Note also, that use of this option only
keeps commits that were initially empty (i.e. the commit recorded the
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index a7f309dff5..f4246300ae 100644
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -28,8 +28,8 @@ OPTIONS
-d::
Normally, when no <path> is specified, git clean will not
recurse into untracked directories to avoid removing too much.
- Specify -d to have it recurse into such directories as well.
- If any paths are specified, -d is irrelevant; all untracked
+ Specify `-d` to have it recurse into such directories as well.
+ If any paths are specified, `-d` is irrelevant; all untracked
files matching the specified paths (with exceptions for nested
git directories mentioned under `--force`) will be removed.
@@ -37,9 +37,9 @@ OPTIONS
--force::
If the Git configuration variable clean.requireForce is not set
to false, 'git clean' will refuse to delete files or directories
- unless given -f or -i. Git will refuse to modify untracked
+ unless given `-f` or `-i`. Git will refuse to modify untracked
nested git repositories (directories with a .git subdirectory)
- unless a second -f is given.
+ unless a second `-f` is given.
-i::
--interactive::
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 3fe3810f1c..22334771d1 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -31,7 +31,7 @@ currently active branch.
After the clone, a plain `git fetch` without arguments will update
all the remote-tracking branches, and a `git pull` without
arguments will in addition merge the remote master branch into the
-current master branch, if any (this is untrue when "--single-branch"
+current master branch, if any (this is untrue when `--single-branch`
is given; see below).
This default configuration is achieved by creating references to
@@ -52,7 +52,7 @@ OPTIONS
to save space when possible.
+
If the repository is specified as a local path (e.g., `/path/to/repo`),
-this is the default, and --local is essentially a no-op. If the
+this is the default, and `--local` is essentially a no-op. If the
repository is specified as a URL, then this flag is ignored (and we
never use the local optimizations). Specifying `--no-local` will
override the default when `/path/to/repo` is given, using the regular
diff --git a/Documentation/git-column.txt b/Documentation/git-column.txt
index f58e9c43e6..84a02ac15c 100644
--- a/Documentation/git-column.txt
+++ b/Documentation/git-column.txt
@@ -29,7 +29,7 @@ OPTIONS
syntax in linkgit:git-config[1].
--raw-mode=<n>::
- Same as --mode but take mode encoded as a number. This is mainly used
+ Same as `--mode` but take mode encoded as a number. This is mainly used
by other commands that have already parsed layout mode.
--width=<width>::
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 340c5fbb48..6d0d663b50 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -36,18 +36,18 @@ The content to be committed can be specified in several ways:
and the index, again before using the 'commit' command;
3. by listing files as arguments to the 'commit' command
- (without --interactive or --patch switch), in which
+ (without `--interactive` or `--patch` switch), in which
case the commit will ignore changes staged in the index, and instead
record the current content of the listed files (which must already
be known to Git);
-4. by using the -a switch with the 'commit' command to automatically
+4. by using the `-a` switch with the 'commit' command to automatically
"add" changes from all known files (i.e. all files that are already
listed in the index) and to automatically "rm" files in the index
that have been removed from the working tree, and then perform the
actual commit;
-5. by using the --interactive or --patch switches with the 'commit' command
+5. by using the `--interactive` or `--patch` switches with the 'commit' command
to decide one by one which files or hunks should be part of the commit
in addition to contents in the index,
before finalizing the operation. See the ``Interactive Mode'' section of
@@ -84,7 +84,7 @@ OPTIONS
-c <commit>::
--reedit-message=<commit>::
- Like '-C', but with `-c` the editor is invoked, so that
+ Like `-C`, but with `-c` the editor is invoked, so that
the user can further edit the commit message.
--fixup=[(amend|reword):]<commit>::
@@ -134,7 +134,7 @@ See linkgit:git-rebase[1] for details.
linkgit:git-rebase[1] for details.
--reset-author::
- When used with -C/-c/--amend options, or when committing after a
+ When used with `-C`/`-c`/`--amend` options, or when committing after a
conflicting cherry-pick, declare that the authorship of the
resulting commit now belongs to the committer. This also renews
the author timestamp.
@@ -173,7 +173,7 @@ See linkgit:git-rebase[1] for details.
Override the commit author. Specify an explicit author using the
standard `A U Thor <author@example.com>` format. Otherwise <author>
is assumed to be a pattern and is used to search for an existing
- commit by that author (i.e. rev-list --all -i --author=<author>);
+ commit by that author (i.e. `git rev-list --all -i --author=<author>`);
the commit author is then copied from the first such commit found.
--date=<date>::
@@ -223,7 +223,7 @@ include::signoff-option.txt[]
is primarily for use by foreign SCM interface scripts.
--allow-empty-message::
- Like --allow-empty this command is primarily for use by foreign
+ Like `--allow-empty` this command is primarily for use by foreign
SCM interface scripts. It allows you to create a commit with an
empty commit message without using plumbing commands like
linkgit:git-commit-tree[1].
@@ -337,7 +337,7 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
+
--
The mode parameter is optional (defaults to 'all'), and is used to
-specify the handling of untracked files; when -u is not used, the
+specify the handling of untracked files; when `-u` is not used, the
default is 'normal', i.e. show untracked files and directories.
The possible options are:
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 4b4cc5c5e8..b93394ea45 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -92,7 +92,7 @@ OPTIONS
Like get, but returns all values for a multi-valued key.
--get-regexp::
- Like --get-all, but interprets the name as a regular expression and
+ Like `--get-all`, but interprets the name as a regular expression and
writes out the key names. Regular expression matching is currently
case-sensitive and done against a canonicalized version of the key
in which section and variable names are lowercased, but subsection
@@ -337,8 +337,8 @@ ENVIRONMENT
GIT_CONFIG::
Take the configuration from the given file instead of .git/config.
- Using the "--global" option forces this to ~/.gitconfig. Using the
- "--system" option forces this to $(prefix)/etc/gitconfig.
+ Using the `--global` option forces this to ~/.gitconfig. Using the
+ `--system` option forces this to $(prefix)/etc/gitconfig.
GIT_CONFIG_NOSYSTEM::
Whether to skip reading settings from the system-wide
diff --git a/Documentation/git-count-objects.txt b/Documentation/git-count-objects.txt
index cb9b4d2e46..d12ce08789 100644
--- a/Documentation/git-count-objects.txt
+++ b/Documentation/git-count-objects.txt
@@ -24,11 +24,11 @@ OPTIONS
+
count: the number of loose objects
+
-size: disk space consumed by loose objects, in KiB (unless -H is specified)
+size: disk space consumed by loose objects, in KiB (unless `-H` is specified)
+
in-pack: the number of in-pack objects
+
-size-pack: disk space consumed by the packs, in KiB (unless -H is specified)
+size-pack: disk space consumed by the packs, in KiB (unless `-H` is specified)
+
prune-packable: the number of loose objects that are also present in
the packs. These objects could be pruned using `git prune-packed`.
@@ -36,7 +36,7 @@ the packs. These objects could be pruned using `git prune-packed`.
garbage: the number of files in object database that are neither valid loose
objects nor valid packs
+
-size-garbage: disk space consumed by garbage files, in KiB (unless -H is
+size-garbage: disk space consumed by garbage files, in KiB (unless `-H` is
specified)
+
alternate: absolute path of alternate object databases; may appear
diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt
index 00154b6c85..f08ab508af 100644
--- a/Documentation/git-cvsexportcommit.txt
+++ b/Documentation/git-cvsexportcommit.txt
@@ -18,7 +18,7 @@ DESCRIPTION
Exports a commit from Git to a CVS checkout, making it easier
to merge patches from a Git repository into a CVS repository.
-Specify the name of a CVS checkout using the -w switch or execute it
+Specify the name of a CVS checkout using the `-w` switch or execute it
from the root of the CVS working copy. In the latter case GIT_DIR must
be defined. See examples below.
@@ -40,7 +40,7 @@ OPTIONS
-p::
Be pedantic (paranoid) when applying patches. Invokes patch with
- --fuzz=0
+ `--fuzz=0`
-a::
Add authorship information. Adds Author line, and Committer (if
@@ -48,7 +48,7 @@ OPTIONS
-d::
Set an alternative CVSROOT to use. This corresponds to the CVS
- -d parameter. Usually users will not want to set this, except
+ `-d` parameter. Usually users will not want to set this, except
if using CVS in an asymmetric fashion.
-f::
@@ -99,7 +99,7 @@ $ git cvsexportcommit -v <commit-sha1>
$ cvs commit -F .msg <files>
------------
-Merge one patch into CVS (-c and -w options). The working directory is within the Git Repo::
+Merge one patch into CVS (`-c` and `-w` options). The working directory is within the Git Repo::
+
------------
$ git cvsexportcommit -v -c -w ~/project_cvs_checkout <commit-sha1>
diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt
index de1ebed67d..143c726511 100644
--- a/Documentation/git-cvsimport.txt
+++ b/Documentation/git-cvsimport.txt
@@ -38,7 +38,7 @@ created by 'git cvsimport'. By default initial import will create and populate
"master" branch from the CVS repository's main branch which you're free
to work with; after that, you need to 'git merge' incremental imports, or
any CVS branches, yourself. It is advisable to specify a named remote via
--r to separate and protect the incoming branches.
+`-r` to separate and protect the incoming branches.
If you intend to set up a shared public repository that all developers can
read/write, or if you want to use linkgit:git-cvsserver[1], then you
@@ -74,7 +74,7 @@ OPTIONS
akin to the way 'git clone' uses 'origin' by default.
-o <branch-for-HEAD>::
- When no remote is specified (via -r) the `HEAD` branch
+ When no remote is specified (via `-r`) the `HEAD` branch
from CVS is imported to the 'origin' branch within the Git
repository, as `HEAD` already has a special meaning for Git.
When a remote is specified the `HEAD` branch is named
@@ -82,7 +82,7 @@ OPTIONS
Use this option if you want to import into a different
branch.
+
-Use '-o master' for continuing an import that was initially done by
+Use `-o master` for continuing an import that was initially done by
the old cvs2git tool.
-i::
@@ -91,7 +91,7 @@ the old cvs2git tool.
not create them if they do not exist.
-k::
- Kill keywords: will extract files with '-kk' from the CVS archive
+ Kill keywords: will extract files with `-kk` from the CVS archive
to avoid noisy changesets. Highly recommended, but off by default
to preserve compatibility with early imported trees.
@@ -103,7 +103,7 @@ the old cvs2git tool.
-p <options-for-cvsps>::
Additional options for cvsps.
- The options `-u` and '-A' are implicit and should not be used here.
+ The options `-u` and `-A` are implicit and should not be used here.
+
If you need to pass multiple options, separate them with a comma.
@@ -158,7 +158,7 @@ all along. If a time zone is specified, GIT_AUTHOR_DATE will
have the corresponding offset applied.
+
For convenience, this data is saved to `$GIT_DIR/cvs-authors`
-each time the '-A' option is provided and read from that same
+each time the `-A` option is provided and read from that same
file each time 'git cvsimport' is run.
+
It is not recommended to use this feature if you intend to
diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
index 1b1c71ad9d..955bae46c9 100644
--- a/Documentation/git-cvsserver.txt
+++ b/Documentation/git-cvsserver.txt
@@ -119,7 +119,7 @@ for example:
------
You can use the 'htpasswd' facility that comes with Apache to make these
files, but Apache's MD5 crypt method differs from the one used by most C
-library's crypt() function, so don't use the -m option.
+library's crypt() function, so don't use the `-m` option.
Alternatively you can produce the password with perl's crypt() operator:
-----
@@ -312,7 +312,7 @@ ENVIRONMENT
These variables obviate the need for command-line options in some
circumstances, allowing easier restricted usage through git-shell.
-GIT_CVSSERVER_BASE_PATH takes the place of the argument to --base-path.
+GIT_CVSSERVER_BASE_PATH takes the place of the argument to `--base-path`.
GIT_CVSSERVER_ROOT specifies a single-directory whitelist. The
repository must still be configured to allow access through
@@ -361,7 +361,7 @@ All the operations required for normal use are supported, including
checkout, diff, status, update, log, add, remove, commit.
Most CVS command arguments that read CVS tags or revision numbers
-(typically -r) work, and also support any git refspec
+(typically `-r`) work, and also support any git refspec
(tag, branch, commit ID, etc).
However, CVS revision numbers for non-default branches are not well
emulated, and cvs log does not show tags or branches at
@@ -374,7 +374,7 @@ As described elsewhere on this page, the "module" parameter
of cvs checkout is interpreted as a branch name, and it becomes
the main branch. It remains the main branch for a given sandbox
even if you temporarily make another branch sticky with
-cvs update -r. Alternatively, the -r argument can indicate
+cvs update -r. Alternatively, the `-r` argument can indicate
some other branch to actually checkout, even though the module
is still the "main" branch. Tradeoffs (as currently
implemented): Each new "module" creates a new database on disk with
@@ -385,7 +385,7 @@ many operations, like cvs update.
If you want to refer to a git refspec that has characters that are
not allowed by CVS, you have two options. First, it may just work
-to supply the git refspec directly to the appropriate CVS -r argument;
+to supply the git refspec directly to the appropriate CVS `-r` argument;
some CVS clients don't seem to do much sanity checking of the argument.
Second, if that fails, you can use a special character escape mechanism
that only uses characters that are valid in CVS tags. A sequence
@@ -415,7 +415,7 @@ Alternatively, if `gitcvs.usecrlfattr` config is not enabled
or the attributes do not allow automatic detection for a filename, then
the server uses the `gitcvs.allBinary` config for the default setting.
If `gitcvs.allBinary` is set, then file not otherwise
-specified will default to '-kb' mode. Otherwise the `-k` mode
+specified will default to `-kb` mode. Otherwise the `-k` mode
is left blank. But if `gitcvs.allBinary` is set to "guess", then
the correct `-k` mode will be guessed based on the contents of
the file.
diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index fdc28c041c..2794a2d0c1 100644
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -55,14 +55,14 @@ OPTIONS
--base-path=<path>::
Remap all the path requests as relative to the given path.
This is sort of "Git root" - if you run 'git daemon' with
- '--base-path=/srv/git' on example.com, then if you later try to pull
+ `--base-path=/srv/git` on example.com, then if you later try to pull
'git://example.com/hello.git', 'git daemon' will interpret the path
as `/srv/git/hello.git`.
--base-path-relaxed::
- If --base-path is enabled and repo lookup fails, with this option
+ If `--base-path` is enabled and repo lookup fails, with this option
'git daemon' will attempt to lookup without prefixing the base path.
- This is useful for switching to --base-path usage, while still
+ This is useful for switching to `--base-path` usage, while still
allowing the old paths.
--interpolated-path=<pathtemplate>::
@@ -81,16 +81,16 @@ OPTIONS
do not have the 'git-daemon-export-ok' file.
--inetd::
- Have the server run as an inetd service. Implies --syslog (may be
+ Have the server run as an inetd service. Implies `--syslog` (may be
overridden with `--log-destination=`).
- Incompatible with --detach, --port, --listen, --user and --group
+ Incompatible with `--detach`, `--port`, `--listen`, `--user` and `--group`
options.
--listen=<host_or_ipaddr>::
Listen on a specific IP address or hostname. IP addresses can
be either an IPv4 address or an IPv6 address if supported. If IPv6
- is not supported, then --listen=hostname is also not supported and
- --listen must be given an IPv4 address.
+ is not supported, then `--listen=hostname` is also not supported and
+ `--listen` must be given an IPv4 address.
Can be given more than once.
Incompatible with `--inetd` option.
@@ -116,7 +116,7 @@ OPTIONS
--log-destination=<destination>::
Send log messages to the specified destination.
- Note that this option does not imply --verbose,
+ Note that this option does not imply `--verbose`,
thus by default only error conditions will be logged.
The <destination> must be one of:
+
@@ -154,7 +154,7 @@ otherwise `stderr`.
old connections to time out.
--detach::
- Detach from the shell. Implies --syslog.
+ Detach from the shell. Implies `--syslog`.
--pid-file=<file>::
Save the process id in 'file'. Ignored when the daemon
@@ -200,7 +200,7 @@ Git configuration files in that directory are readable by `<user>`.
is more convenient for clients, but may leak information about
the existence of unexported repositories. When informative
errors are not enabled, all errors report "access denied" to the
- client. The default is --no-informative-errors.
+ client. The default is `--no-informative-errors`.
--access-hook=<path>::
Every time a client connects, first run an external command
@@ -219,7 +219,7 @@ it declines the service.
<directory>::
A directory to add to the whitelist of allowed directories. Unless
- --strict-paths is specified this will also include subdirectories
+ `--strict-paths` is specified this will also include subdirectories
of each named directory.
SERVICES
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index a88f6ae2c6..a3f015743b 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -22,9 +22,9 @@ abbreviated object name of the most recent commit. The result
is a "human-readable" object name which can also be used to
identify the commit to other git commands.
-By default (without --all or --tags) `git describe` only shows
+By default (without `--all` or `--tags`) `git describe` only shows
annotated tags. For more information about creating annotated tags
-see the -a and -s options to linkgit:git-tag[1].
+see the `-a` and `-s` options to linkgit:git-tag[1].
If the given object refers to a blob, it will be described
as `<commit-ish>:<path>`, such that the blob can be found
@@ -60,7 +60,7 @@ OPTIONS
--contains::
Instead of finding the tag that predates the commit, find
the tag that comes after the commit, and thus contains it.
- Automatically implies --tags.
+ Automatically implies `--tags`.
--abbrev=<n>::
Instead of using the default 7 hexadecimal digits as the
@@ -77,7 +77,7 @@ OPTIONS
--exact-match::
Only output exact matches (a tag directly references the
- supplied commit). This is a synonym for --candidates=0.
+ supplied commit). This is a synonym for `--candidates=0`.
--debug::
Verbosely display information about the searching strategy
@@ -110,9 +110,9 @@ OPTIONS
excluding respectively "refs/heads/" and "refs/remotes/" prefix;
references of other types are never considered. If given multiple times,
a list of patterns will be accumulated and tags matching any of the
- patterns will be excluded. When combined with --match a tag will be
- considered when it matches at least one --match pattern and does not
- match any of the --exclude patterns. Use `--no-exclude` to clear and
+ patterns will be excluded. When combined with `--match` a tag will be
+ considered when it matches at least one `--match` pattern and does not
+ match any of the `--exclude` patterns. Use `--no-exclude` to clear and
reset the list of patterns.
--always::
@@ -150,7 +150,7 @@ Doing a 'git describe' on a tag-name will just show the tag name:
[torvalds@g5 git]$ git describe v1.0.4
v1.0.4
-With --all, the command can use branch heads as references, so
+With `--all`, the command can use branch heads as references, so
the output shows the reference path as well:
[torvalds@g5 git]$ git describe --all --abbrev=4 v1.0.5^2
@@ -159,7 +159,7 @@ the output shows the reference path as well:
[torvalds@g5 git]$ git describe --all --abbrev=4 HEAD^
heads/lt/describe-7-g975b
-With --abbrev set to 0, the command can be used to find the
+With `--abbrev` set to 0, the command can be used to find the
closest tagname without any suffix:
[torvalds@g5 git]$ git describe --abbrev=0 v1.0.5^2
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index 2fc24c542f..b9225cd824 100644
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -18,7 +18,7 @@ DESCRIPTION
Compares the content and mode of the blobs found via two tree objects.
If there is only one <tree-ish> given, the commit is compared with its parents
-(see --stdin below).
+(see `--stdin` below).
Note that 'git diff-tree' can use the tree encapsulated in a commit object.
@@ -37,7 +37,7 @@ include::diff-options.txt[]
recurse into sub-trees
-t::
- show tree entry itself as well as subtrees. Implies -r.
+ show tree entry itself as well as subtrees. Implies `-r`.
--root::
When `--root` is specified the initial commit will be shown as a big
@@ -113,7 +113,7 @@ include::pretty-options.txt[]
--combined-all-paths::
This flag causes combined diffs (used for merge commits) to
list the name of the file from all parents. It thus only has
- effect when -c or --cc are specified, and is likely only
+ effect when `-c` or `--cc` are specified, and is likely only
useful if filename changes are detected (i.e. when either
rename or copy detection have been requested).
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 7f4c8a8ce7..9f4b46c910 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -48,9 +48,9 @@ files on disk.
do not give <commit>, it defaults to HEAD.
If HEAD does not exist (e.g. unborn branches) and
<commit> is not given, it shows all staged changes.
- --staged is a synonym of --cached.
+ `--staged` is a synonym of `--cached`.
+
-If --merge-base is given, instead of using <commit>, use the merge base
+If `--merge-base` is given, instead of using <commit>, use the merge base
of <commit> and HEAD. `git diff --merge-base A` is equivalent to
`git diff $(git merge-base A HEAD)`.
@@ -67,7 +67,7 @@ of <commit> and HEAD. `git diff --merge-base A` is equivalent to
This is to view the changes between two arbitrary
<commit>.
+
-If --merge-base is given, use the merge base of the two commits for the
+If `--merge-base` is given, use the merge base of the two commits for the
"before" side. `git diff --merge-base A B` is equivalent to
`git diff $(git merge-base A B) B`.
diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt
index 1978dbdc6a..a1c02918f9 100644
--- a/Documentation/git-fast-export.txt
+++ b/Documentation/git-fast-export.txt
@@ -67,14 +67,14 @@ 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`.
--mark-tags::
In addition to labelling blobs and commits with mark ids, also
@@ -86,7 +86,7 @@ produced incorrect results if you gave these options.
identifiers.
+
Any commits (or tags) that have already been marked will not be
-exported again. If the backend uses a similar --import-marks file,
+exported again. 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.
@@ -130,7 +130,7 @@ by keeping the marks the same across runs.
and will make master{tilde}4 no longer have master{tilde}5 as
a parent (though both the old master{tilde}4 and new
master{tilde}4 will have all the same files). Use
- --reference-excluded-parents to instead have the stream
+ `--reference-excluded-parents` to instead have the stream
refer to commits in the excluded range of history by their
sha1sum. Note that the resulting stream can only be used by a
repository which already contains the necessary parent
@@ -160,7 +160,7 @@ by keeping the marks the same across runs.
to export. For example, `master~10..master` causes the
current master reference to be exported along with all objects
added since its 10th ancestor commit and (unless the
- --reference-excluded-parents option is specified) all files
+ `--reference-excluded-parents` option is specified) all files
common to master{tilde}9 and master{tilde}10.
EXAMPLES
diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt
index 39cfa05b28..ff67238633 100644
--- a/Documentation/git-fast-import.txt
+++ b/Documentation/git-fast-import.txt
@@ -40,7 +40,7 @@ OPTIONS
not contain the old commit).
--quiet::
- Disable the output shown by --stats, making fast-import usually
+ Disable the output shown by `--stats`, making fast-import usually
be silent when it is successful. However, if the import stream
has directives intended to show user output (e.g. `progress`
directives), the corresponding messages will still be shown.
@@ -49,7 +49,7 @@ OPTIONS
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`.
--allow-unsafe-features::
Many command-line options can be provided as part of the
@@ -97,23 +97,23 @@ 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.
--import-marks-if-exists=<file>::
- Like --import-marks but instead of erroring out, silently
+ Like `--import-marks` but instead of erroring out, silently
skips the file if it does not exist.
--[no-]relative-marks::
- After specifying --relative-marks the paths specified
- with --import-marks= and --export-marks= are relative
+ After specifying `--relative-marks` the paths specified
+ with `--import-marks`= and `--export-marks`= are relative
to an internal directory in the current repository.
In git-fast-import this means that the paths are relative
to the .git/info/fast-import directory. However, other
@@ -217,8 +217,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.
@@ -269,11 +269,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
@@ -381,7 +381,7 @@ and control the current import process. More detailed discussion
`alias`::
Record that a mark refers to a given object without first
- creating any new object. Using --import-marks and referring
+ creating any new object. Using `--import-marks` and referring
to missing marks will cause fast-import to fail, so aliases
can provide a way to set otherwise pruned commits to a valid
value (e.g. the nearest non-pruned ancestor).
@@ -501,7 +501,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.
@@ -989,7 +989,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.
@@ -1152,10 +1152,10 @@ force::
import-marks::
import-marks-if-exists::
- Like --import-marks except in two respects: first, only one
+ Like `--import-marks` except in two respects: first, only one
"feature import-marks" or "feature import-marks-if-exists"
- command is allowed per stream; second, an --import-marks=
- or --import-marks-if-exists command-line option overrides
+ command is allowed per stream; second, an `--import-marks=`
+ or `--import-marks-if-exists` command-line option overrides
any of these "feature" commands in the stream; third,
"feature import-marks-if-exists" like a corresponding
command-line option silently skips a nonexistent file.
@@ -1346,7 +1346,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
@@ -1411,7 +1411,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!
@@ -1425,7 +1425,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.
@@ -1534,7 +1534,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
~~~~~~~~~~~~~~~
diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt
index c975884793..88c2b9d426 100644
--- a/Documentation/git-fetch-pack.txt
+++ b/Documentation/git-fetch-pack.txt
@@ -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.
@@ -97,7 +97,7 @@ be in a separate packet, and the list must end with a flush packet.
This option can be specified multiple times.
--deepen-relative::
- Argument --depth specifies the number of commits from the
+ Argument `--depth` specifies the number of commits from the
current shallow boundary instead of from the tip of each
remote branch history.
diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt
index 9067c2079e..85b073a61a 100644
--- a/Documentation/git-fetch.txt
+++ b/Documentation/git-fetch.txt
@@ -25,7 +25,7 @@ of <refspec> below for ways to control this behavior).
By default, any tag that points into the histories being fetched is
also fetched; the effect is to fetch tags that
point at branches that you are interested in. This default behavior
-can be changed by using the --tags or --no-tags options or by
+can be changed by using the `--tags` or `--no-tags` options or by
configuring remote.<name>.tagOpt. By using a refspec that fetches tags
explicitly, you can fetch tags that do not point into branches you
are interested in as well.
@@ -204,7 +204,7 @@ representing the status of a single ref. Each line is of the form:
<flag> <summary> <from> -> <to> [<reason>]
-------------------------------
-The status of up-to-date refs is shown only if the --verbose option is
+The status of up-to-date refs is shown only if the `--verbose` option is
used.
In compact output mode, specified with configuration variable
@@ -287,7 +287,7 @@ include::transfer-data-leaks.txt[]
BUGS
----
-Using --recurse-submodules can only fetch new commits in already checked
+Using `--recurse-submodules` can only fetch new commits in already checked
out submodules right now. When e.g. upstream added a new submodule in the
just fetched commits of the superproject the submodule itself cannot be
fetched, making it impossible to check out that submodule later without
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 62e482a95e..2de3511459 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -133,8 +133,8 @@ OPTIONS
It will receive the parent string on stdin and shall output
the new parent string on stdout. The parent string is in
the format described in linkgit:git-commit-tree[1]: empty for
- the initial commit, "-p parent" for a normal commit and
- "-p parent1 -p parent2 -p parent3 ..." for a merge commit.
+ the initial commit, `-p parent` for a normal commit and
+ `-p parent1 -p parent2 -p parent3 ...` for a merge commit.
--msg-filter <command>::
This is the filter for rewriting the commit messages.
@@ -170,7 +170,7 @@ and that makes no change to the tree.
tag name is expected on standard output.
+
The original tags are not deleted, but can be overwritten;
-use "--tag-name-filter cat" to simply update the tags. In this
+use `--tag-name-filter cat` to simply update the tags. In this
case, be very careful and make sure you have the old tags
backed up in case the conversion has run afoul.
+
@@ -598,12 +598,12 @@ with:
sensitive files and others which don't. This comes about in
multiple different ways:
- ** the default to only doing a partial history rewrite ('--all' is not
+ ** the default to only doing a partial history rewrite (`--all` is not
the default and few examples show it)
** the fact that there's no automatic post-run cleanup
- ** the fact that --tag-name-filter (when used to rename tags) doesn't
+ ** the fact that `--tag-name-filter` (when used to rename tags) doesn't
remove the old tags but just adds new ones with the new name
** the fact that little educational information is provided to inform
@@ -623,15 +623,15 @@ with:
git-filter-branch command. (The backup in refs/original/ is not a
real backup; it dereferences tags first.)
- ** Running git-filter-branch with either --tags or --all in your
+ ** Running git-filter-branch with either `--tags` or `--all` in your
<rev-list options>. In order to retain annotated tags as
- annotated, you must use --tag-name-filter (and must not have
+ annotated, you must use `--tag-name-filter` (and must not have
restored from refs/original/ in a previously botched rewrite).
* Any commit messages that specify an encoding will become corrupted
by the rewrite; git-filter-branch ignores the encoding, takes the
original bytes, and feeds it to commit-tree without telling it the
- proper encoding. (This happens whether or not --msg-filter is
+ proper encoding. (This happens whether or not `--msg-filter` is
used.)
* Commit messages (even if they are all UTF-8) by default become
@@ -650,21 +650,21 @@ with:
dependencies (node_modules or similar) which couldn't have ever been
functional since it's missing some files.)
-* If --prune-empty isn't specified, then the filtering process can
+* If `--prune-empty` isn't specified, then the filtering process can
create hoards of confusing empty commits
-* If --prune-empty is specified, then intentionally placed empty
+* If `--prune-empty` is specified, then intentionally placed empty
commits from before the filtering operation are also pruned instead
of just pruning commits that became empty due to filtering rules.
-* If --prune-empty is specified, sometimes empty commits are missed
+* If `--prune-empty` is specified, sometimes empty commits are missed
and left around anyway (a somewhat rare bug, but it happens...)
* A minor issue, but users who have a goal to update all names and
- emails in a repository may be led to --env-filter which will only
+ emails in a repository may be led to `--env-filter` which will only
update authors and committers, missing taggers.
-* If the user provides a --tag-name-filter that maps multiple tags to
+* If the user provides a `--tag-name-filter` that maps multiple tags to
the same name, no warning or error is provided; git-filter-branch
simply overwrites each tag in some undocumented pre-defined order
resulting in only one tag at the end. (A git-filter-branch
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index 6793d8fc05..9004861eae 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -36,7 +36,7 @@ OPTIONS
merged.
--[no-]summary::
- Synonyms to --log and --no-log; these are deprecated and will be
+ Synonyms to `--log` and `--no-log`; these are deprecated and will be
removed in the future.
-m <message>::
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 2ae2478de7..e035edf11d 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -40,7 +40,7 @@ OPTIONS
--sort=<key>::
A field name to sort on. Prefix `-` to sort in
descending order of the value. When unspecified,
- `refname` is used. You may use the --sort=<key> option
+ `refname` is used. You may use the `--sort=<key>` option
multiple times, in which case the last key becomes the primary
key.
@@ -309,7 +309,7 @@ Ref: %(*refname)
A simple example showing the use of shell eval on the output,
-demonstrating the use of --shell. List the prefixes of all heads:
+demonstrating the use of `--shell`. List the prefixes of all heads:
------------
#!/bin/sh
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 911da181a1..ca500ba72c 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -238,8 +238,8 @@ populated with placeholder text.
`--subject-prefix` option) has ` v<n>` appended to it. E.g.
`--reroll-count=4` may produce `v4-0001-add-makefile.patch`
file that has "Subject: [PATCH v4 1/20] Add makefile" in it.
- `<n>` does not have to be an integer (e.g. "--reroll-count=4.4",
- or "--reroll-count=4rev2" are allowed), but the downside of
+ `<n>` does not have to be an integer (e.g. `--reroll-count=4.4`,
+ or `--reroll-count=4rev2` are allowed), but the downside of
using such a reroll-count is that the range-diff/interdiff
with the previous version does not state exactly which
version the new interation is compared against.
@@ -346,7 +346,7 @@ set.
number.
--signature-file=<file>::
- Works just like --signature except the signature is read from a file.
+ Works just like `--signature` except the signature is read from a file.
--suffix=.<sfx>::
Instead of using `.patch` as the suffix for generated
diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt
index bd596619c0..e932c75181 100644
--- a/Documentation/git-fsck.txt
+++ b/Documentation/git-fsck.txt
@@ -25,7 +25,7 @@ OPTIONS
+
If no objects are given, 'git fsck' defaults to using the
index file, all SHA-1 references in `refs` namespace, and all reflogs
-(unless --no-reflogs is given) as heads.
+(unless `--no-reflogs` is given) as heads.
--unreachable::
Print out objects that exist but that aren't reachable from any
@@ -59,7 +59,7 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs
and in packed Git archives found in $GIT_DIR/objects/pack
and corresponding pack subdirectories in alternate
object pools. This is now default; you can turn it off
- with --no-full.
+ with `--no-full`.
--connectivity-only::
Check only the connectivity of reachable objects, making sure
@@ -100,7 +100,7 @@ care about this output and want to speed it up further.
--[no-]progress::
Progress status is reported on the standard error stream by
default when it is attached to a terminal, unless
- --no-progress or --verbose is specified. --progress forces
+ `--no-progress` or `--verbose` is specified. `--progress` forces
progress status even if the standard error stream is not
directed to a terminal.
diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
index 853967dea0..9d27c3a41e 100644
--- a/Documentation/git-gc.txt
+++ b/Documentation/git-gc.txt
@@ -57,9 +57,9 @@ be performed as well.
--prune=<date>::
Prune loose objects older than date (default is 2 weeks ago,
overridable by the config variable `gc.pruneExpire`).
- --prune=now prunes loose objects regardless of their age and
+ `--prune=now` prunes loose objects regardless of their age and
increases the risk of corruption if another process is writing to
- the repository concurrently; see "NOTES" below. --prune is on by
+ the repository concurrently; see "NOTES" below. `--prune` is on by
default.
--no-prune::
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 4e0ba8234a..84102cc596 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -66,7 +66,7 @@ grep.fullName::
If set to true, enable `--full-name` option by default.
grep.fallbackToNoIndex::
- If set to true, fall back to git grep --no-index if git grep
+ If set to true, fall back to git grep `--no-index` if git grep
is executed outside of a git repository. Defaults to false.
@@ -123,7 +123,7 @@ OPTIONS
levels of directories. A value of -1 means no limit.
This option is ignored if <pathspec> contains active wildcards.
In other words if "a*" matches a directory named "a*",
- "*" is matched literally so --max-depth is still effective.
+ "*" is matched literally so `--max-depth` is still effective.
-r::
--recursive::
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 44fe8860b3..a19f275f60 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -98,16 +98,16 @@ variable will be checked. The following values are supported for this
variable; they make 'git help' behave as their corresponding command-
line option:
-* "man" corresponds to '-m|--man',
-* "info" corresponds to '-i|--info',
-* "web" or "html" correspond to '-w|--web'.
+* "man" corresponds to `-m`|`--man`,
+* "info" corresponds to `-i`|`--info`,
+* "web" or "html" correspond to `-w`|`--web`.
help.browser, web.browser and browser.<tool>.path
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The `help.browser`, `web.browser` and `browser.<tool>.path` will also
be checked if the 'web' format is chosen (either by command-line
-option or configuration variable). See '-w|--web' in the OPTIONS
+option or configuration variable). See `-w`|`--web` in the OPTIONS
section above and linkgit:git-web{litdd}browse[1].
man.viewer
diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt
index 9fa17b60e4..969e553e4a 100644
--- a/Documentation/git-http-fetch.txt
+++ b/Documentation/git-http-fetch.txt
@@ -47,7 +47,7 @@ commit-id::
URL and uses index-pack to generate corresponding .idx and .keep files.
The hash is used to determine the name of the temporary file and is
arbitrary. The output of index-pack is printed to stdout. Requires
- --index-pack-args.
+ `--index-pack-args`.
--index-pack-args=<args>::
For internal use only. The command to run on the contents of the
diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt
index ea03a4eeb0..5dd4d2b63a 100644
--- a/Documentation/git-http-push.txt
+++ b/Documentation/git-http-push.txt
@@ -44,7 +44,7 @@ OPTIONS
-d::
-D::
Remove <ref> from remote repository. The specified branch
- cannot be the remote HEAD. If -d is specified the following
+ cannot be the remote HEAD. If `-d` is specified the following
other conditions must also be met:
- Remote HEAD must resolve to an object that exists locally
diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt
index 7fa74b9e79..bde1cf4a5c 100644
--- a/Documentation/git-index-pack.txt
+++ b/Documentation/git-index-pack.txt
@@ -49,7 +49,7 @@ OPTIONS
<pack-file> is not specified, the pack is written to
objects/pack/ directory of the current Git repository with
a default name determined from the pack content. If
- <pack-file> is not specified consider using --keep to
+ <pack-file> is not specified consider using `--keep` to
prevent a race condition between this process and
'git repack'.
@@ -57,18 +57,18 @@ OPTIONS
Fix a "thin" pack produced by `git pack-objects --thin` (see
linkgit:git-pack-objects[1] for details) by adding the
excluded objects the deltified objects are based on to the
- pack. This option only makes sense in conjunction with --stdin.
+ pack. This option only makes sense in conjunction with `--stdin`.
--keep::
Before moving the index into its final destination
create an empty .keep file for the associated pack file.
- This option is usually necessary with --stdin to prevent a
+ This option is usually necessary with `--stdin` to prevent a
simultaneous 'git repack' process from deleting
the newly constructed pack and index before refs can be
updated to use objects contained in the pack.
--keep=<msg>::
- Like --keep create a .keep file before moving the index into
+ Like `--keep` create a .keep file before moving the index into
its final destination, but rather than creating an empty file
place '<msg>' followed by an LF into the .keep file. The '<msg>'
message can later be searched for within all .keep files to
@@ -112,7 +112,7 @@ name of the pack/idx file (see "Notes").
the current repository (set by `extensions.objectFormat`), or 'sha1' if no
value is set or outside a repository.
+
-This option cannot be used with --stdin.
+This option cannot be used with `--stdin`.
+
include::object-format-disclaimer.txt[]
@@ -120,7 +120,7 @@ NOTES
-----
Once the index has been created, the hash that goes into the name of
-the pack/idx file is printed to stdout. If --stdin was
+the pack/idx file is printed to stdout. If `--stdin` was
also used then this is prefixed by either "pack\t", or "keep\t" if a
new .keep file was successfully created. This is useful to remove a
.keep file used as a lock to prevent the race with 'git repack'
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index b611d80697..a3f061517d 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -35,7 +35,7 @@ directory is used.
Running 'git init' in an existing repository is safe. It will not
overwrite things that are already there. The primary reason for
rerunning 'git init' is to pick up newly added templates (or to move
-the repository to another place if --separate-git-dir is given).
+the repository to another place if `--separate-git-dir` is given).
OPTIONS
-------
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index 96ec6499f0..4288e5405c 100644
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -87,27 +87,27 @@ OPTIONS
--where <placement>::
--no-where::
Specify where all new trailers will be added. A setting
- provided with '--where' overrides all configuration variables
- and applies to all '--trailer' options until the next occurrence of
- '--where' or '--no-where'. Possible values are `after`, `before`,
+ provided with `--where` overrides all configuration variables
+ and applies to all `--trailer` options until the next occurrence of
+ `--where` or `--no-where`. Possible values are `after`, `before`,
`end` or `start`.
--if-exists <action>::
--no-if-exists::
Specify what action will be performed when there is already at
least one trailer with the same <token> in the message. A setting
- provided with '--if-exists' overrides all configuration variables
- and applies to all '--trailer' options until the next occurrence of
- '--if-exists' or '--no-if-exists'. Possible actions are `addIfDifferent`,
+ provided with `--if-exists` overrides all configuration variables
+ and applies to all `--trailer` options until the next occurrence of
+ `--if-exists` or `--no-if-exists`. Possible actions are `addIfDifferent`,
`addIfDifferentNeighbor`, `add`, `replace` and `doNothing`.
--if-missing <action>::
--no-if-missing::
Specify what action will be performed when there is no other
trailer with the same <token> in the message. A setting
- provided with '--if-missing' overrides all configuration variables
- and applies to all '--trailer' options until the next occurrence of
- '--if-missing' or '--no-if-missing'. Possible actions are `doNothing`
+ provided with `--if-missing` overrides all configuration variables
+ and applies to all `--trailer` options until the next occurrence of
+ `--if-missing` or `--no-if-missing`. Possible actions are `doNothing`
or `add`.
--only-trailers::
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 6d11ab506b..b42f179aef 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -65,11 +65,11 @@ OPTIONS
name (with a trailing slash) and not its whole contents.
--no-empty-directory::
- Do not list empty directories. Has no effect without --directory.
+ Do not list empty directories. Has no effect without `--directory`.
-u::
--unmerged::
- Show unmerged files in the output (forces --stage)
+ Show unmerged files in the output (forces `--stage`)
-k::
--killed::
@@ -111,7 +111,7 @@ OPTIONS
error (return 1).
--with-tree=<tree-ish>::
- When using --error-unmatch to expand the user supplied
+ When using `--error-unmatch` to expand the user supplied
<file> (i.e. path pattern) arguments to paths, pretend
that paths which were removed in the index since the
named <tree-ish> are still present. Using this option
@@ -156,13 +156,13 @@ a space) at the start of each line:
--recurse-submodules::
Recursively calls ls-files on each active submodule in the repository.
- Currently there is only support for the --cached mode.
+ Currently there is only support for the `--cached` mode.
--abbrev[=<n>]::
Instead of showing the full 40-byte hexadecimal object
lines, show the shortest prefix that is at least '<n>'
hexdigits long that uniquely refers the object.
- Non default number of digits can be specified with --abbrev=<n>.
+ Non default number of digits can be specified with `--abbrev=<n>`.
--debug::
After each line that describes a file, add more data about its
@@ -224,29 +224,29 @@ EXCLUDE PATTERNS
'git ls-files' can use a list of "exclude patterns" when
traversing the directory tree and finding files to show when the
-flags --others or --ignored are specified. linkgit:gitignore[5]
+flags `--others` or `--ignored` are specified. linkgit:gitignore[5]
specifies the format of exclude patterns.
These exclude patterns come from these places, in order:
- 1. The command-line flag --exclude=<pattern> specifies a
+ 1. The command-line flag `--exclude=<pattern>` specifies a
single pattern. Patterns are ordered in the same order
they appear in the command line.
- 2. The command-line flag --exclude-from=<file> specifies a
+ 2. The command-line flag `--exclude-from=<file>` specifies a
file containing a list of patterns. Patterns are ordered
in the same order they appear in the file.
- 3. The command-line flag --exclude-per-directory=<name> specifies
+ 3. The command-line flag `--exclude-per-directory=<name>` specifies
a name of the file in each directory 'git ls-files'
examines, normally `.gitignore`. Files in deeper
directories take precedence. Patterns are ordered in the
same order they appear in the files.
-A pattern specified on the command line with --exclude or read
-from the file specified with --exclude-from is relative to the
+A pattern specified on the command line with `--exclude` or read
+from the file specified with `--exclude-from` is relative to the
top of the directory tree. A pattern read from a file specified
-by --exclude-per-directory is relative to the directory that the
+by `--exclude-per-directory` is relative to the directory that the
pattern file appears in.
SEE ALSO
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index 492e573856..4cb4e2fd5d 100644
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -87,7 +87,7 @@ OPTIONS
<refs>...::
When unspecified, all references, after filtering done
- with --heads and --tags, are shown. When <refs>... are
+ with `--heads` and `--tags`, are shown. When <refs>... are
specified, only references matching the given patterns
are displayed.
diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
index db02d6d79a..6ed9030c1e 100644
--- a/Documentation/git-ls-tree.txt
+++ b/Documentation/git-ls-tree.txt
@@ -31,7 +31,7 @@ in the current working directory. Note that:
root level (e.g. `git ls-tree -r HEAD:sub dir`) in this case, as that
would result in asking for `sub/sub/dir` in the `HEAD` commit.
However, the current working directory can be ignored by passing
- --full-tree option.
+ `--full-tree` option.
OPTIONS
-------
@@ -64,7 +64,7 @@ OPTIONS
Instead of showing the full 40-byte hexadecimal object
lines, show the shortest prefix that is at least '<n>'
hexdigits long that uniquely refers the object.
- Non default number of digits can be specified with --abbrev=<n>.
+ Non default number of digits can be specified with `--abbrev`=<n>.
--full-name::
Instead of showing the path names relative to the current working
@@ -72,7 +72,7 @@ OPTIONS
--full-tree::
Do not limit the listing to the current working directory.
- Implies --full-name.
+ Implies `--full-name`.
[<path>...]::
When paths are given, show them (note that this isn't really raw
diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt
index d343f040f5..5bc2982909 100644
--- a/Documentation/git-mailinfo.txt
+++ b/Documentation/git-mailinfo.txt
@@ -45,7 +45,7 @@ Finally, runs of whitespace are normalized to a single ASCII space
character.
-b::
- When -k is not in effect, all leading strings bracketed with '['
+ When `-k` is not in effect, all leading strings bracketed with '['
and ']' pairs are stripped. This option limits the stripping to
only the pairs whose bracketed string contains the word "PATCH".
@@ -60,7 +60,7 @@ Note that the patch is always used as-is without charset
conversion, even with this flag.
--encoding=<encoding>::
- Similar to -u. But when re-coding, the charset specified here is
+ Similar to `-u`. But when re-coding, the charset specified here is
used instead of the one specified by `i18n.commitEncoding` or UTF-8.
-n::
diff --git a/Documentation/git-mailsplit.txt b/Documentation/git-mailsplit.txt
index e3b2a88c4b..6e357716ec 100644
--- a/Documentation/git-mailsplit.txt
+++ b/Documentation/git-mailsplit.txt
@@ -42,7 +42,7 @@ OPTIONS
filenames.
-f<nn>::
- Skip the first <nn> numbers, for example if -f3 is specified,
+ Skip the first <nn> numbers, for example if `-f`3 is specified,
start the numbering with 0004.
--keep-cr::
diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt
index 2ab84a91e5..9fdfe6a31b 100644
--- a/Documentation/git-merge-index.txt
+++ b/Documentation/git-merge-index.txt
@@ -37,7 +37,7 @@ OPTIONS
failure usually indicates conflicts during the merge). This is for
porcelains which might want to emit custom messages.
-If 'git merge-index' is called with multiple <file>s (or -a) then it
+If 'git merge-index' is called with multiple <file>s (or `-a`) then it
processes them in turn only stopping if merge returns a non-zero exit
code.
diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt
index 79449bf98f..b3808dcc06 100644
--- a/Documentation/git-mv.txt
+++ b/Documentation/git-mv.txt
@@ -50,7 +50,7 @@ Moving a submodule using a gitfile (which means they were cloned
with a Git version 1.7.8 or newer) will update the gitfile and
core.worktree setting to make the submodule work in the new location.
It also will attempt to update the submodule.<name>.path setting in
-the linkgit:gitmodules[5] file and stage that file (unless -n is used).
+the linkgit:gitmodules[5] file and stage that file (unless `-n` is used).
BUGS
----
diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt
index 5cb0eb0855..99979fe55b 100644
--- a/Documentation/git-name-rev.txt
+++ b/Documentation/git-name-rev.txt
@@ -34,9 +34,9 @@ OPTIONS
Do not use any ref whose name matches a given shell pattern. The
pattern can be one of branch name, tag name or fully qualified ref
name. If given multiple times, a ref will be excluded when it matches
- any of the given patterns. When used together with --refs, a ref will
- be used as a match only when it matches at least one --refs pattern and
- does not match any --exclude patterns. Use `--no-exclude` to clear the
+ any of the given patterns. When used together with `--refs`, a ref will
+ be used as a match only when it matches at least one `--refs` pattern and
+ does not match any `--exclude` patterns. Use `--no-exclude` to clear the
list of exclude patterns.
--all::
@@ -45,12 +45,12 @@ OPTIONS
--stdin::
Transform stdin by substituting all the 40-character SHA-1
hexes (say $hex) with "$hex ($rev_name)". When used with
- --name-only, substitute with "$rev_name", omitting $hex
+ `--name-only`, substitute with "$rev_name", omitting $hex
altogether. Intended for the scripter's use.
--name-only::
Instead of printing both the SHA-1 and the name, print only
- the name. If given with --tags the usual tag prefix of
+ the name. If given with `--tags` the usual tag prefix of
"tags/" is also omitted from the name, matching the output
of `git-describe` more closely.
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 0a4200674c..b0a5ab9a72 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -152,7 +152,7 @@ OPTIONS
-c <object>::
--reedit-message=<object>::
- Like '-C', but with `-c` the editor is invoked, so that
+ Like `-C`, but with `-c` the editor is invoked, so that
the user can further edit the note message.
--allow-empty::
@@ -251,7 +251,7 @@ When done, the user can either finalize the merge with
'git notes merge --abort'.
Users may select an automated merge strategy from among the following using
-either -s/--strategy option or configuring notes.mergeStrategy accordingly:
+either `-s`/`--strategy` option or configuring notes.mergeStrategy accordingly:
"ours" automatically resolves conflicting notes in favor of the local
version (i.e. the current notes ref).
diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index f89e68b424..d9d29a5efa 100644
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -180,7 +180,7 @@ The git commit is created relative to the current origin revision (HEAD by defau
A parent commit is created based on the origin, and then the unshelve commit is
created based on that.
-The origin revision can be changed with the "--origin" option.
+The origin revision can be changed with the `--origin` option.
If the target branch in refs/remotes/p4-unshelved already exists, the old one will
be renamed.
@@ -221,7 +221,7 @@ subsequent 'sync' operations.
+
By default a <ref> not starting with refs/ is treated as the
name of a remote-tracking branch (under refs/remotes/). This
-behavior can be modified using the --import-local option.
+behavior can be modified using the `--import-local` option.
+
The default <ref> is "master".
+
@@ -265,7 +265,7 @@ Git repository:
Import at most 'n' changes, rather than the entire range of
changes included in the given revision specifier. A typical
usage would be use '@all' as the revision specifier, but then
- to use '--max-changes 1000' to import only the last 1000
+ to use `--max-changes 1000` to import only the last 1000
revisions rather than the entire revision history.
--changes-block-size <n>::
@@ -347,7 +347,7 @@ These options can be used to modify 'git p4 submit' behavior.
--update-shelve CHANGELIST::
Update an existing shelved changelist with this commit. Implies
- --shelve. Repeat for multiple shelved changelists.
+ `--shelve`. Repeat for multiple shelved changelists.
--conflict=(ask|skip|quit)::
Conflicts can occur when applying a commit to p4. When this
@@ -371,7 +371,7 @@ These options can be used to modify 'git p4 submit' behavior.
--disable-p4sync::
Disable the automatic sync of p4/master from Perforce after commits have
- been submitted. Implies --disable-rebase. Can also be set with
+ been submitted. Implies `--disable-rebase`. Can also be set with
git-p4.disableP4Sync. Sync with origin/master still goes ahead if possible.
Hooks for submit
@@ -560,27 +560,27 @@ They all are in the 'git-p4' section.
General variables
~~~~~~~~~~~~~~~~~
git-p4.user::
- User specified as an option to all p4 commands, with '-u <user>'.
+ User specified as an option to all p4 commands, with `-u <user>`.
The environment variable `P4USER` can be used instead.
git-p4.password::
Password specified as an option to all p4 commands, with
- '-P <password>'.
+ `-P <password>`.
The environment variable `P4PASS` can be used instead.
git-p4.port::
Port specified as an option to all p4 commands, with
- '-p <port>'.
+ `-p <port>`.
The environment variable `P4PORT` can be used instead.
git-p4.host::
Host specified as an option to all p4 commands, with
- '-h <host>'.
+ `-h <host>`.
The environment variable `P4HOST` can be used instead.
git-p4.client::
Client specified as an option to all p4 commands, with
- '-c <client>', including the client spec.
+ `-c <client>`, including the client spec.
git-p4.retries::
Specifies the number of times to retry a p4 command (notably,
@@ -619,7 +619,7 @@ git-p4.ignoredP4Labels::
unimportable labels are discovered.
git-p4.importLabels::
- Import p4 labels into git, as per --import-labels.
+ Import p4 labels into git, as per `--import-labels`.
git-p4.labelImportRegexp::
Only p4 labels matching this regular expression will be imported. The
@@ -734,7 +734,7 @@ git-p4.attemptRCSCleanup::
present.
git-p4.exportLabels::
- Export Git tags to p4 labels, as per --export-labels.
+ Export Git tags to p4 labels, as per `--export-labels`.
git-p4.labelExportRegexp::
Only p4 labels matching this regular expression will be exported. The
@@ -742,7 +742,7 @@ git-p4.labelExportRegexp::
git-p4.conflict::
Specify submit behavior when a conflict with p4 is found, as per
- --conflict. The default behavior is 'ask'.
+ `--conflict`. The default behavior is 'ask'.
git-p4.disableRebase::
Do not rebase the tree against p4/master following a submit.
diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index 25d9fbe37a..a78721517b 100644
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -101,13 +101,13 @@ Incompatible with `--revs`, or options that imply `--revs` (such as
the pack are stored using delta compression. The
objects are first internally sorted by type, size and
optionally names and compared against the other objects
- within --window to see if using delta compression saves
- space. --depth limits the maximum delta depth; making
+ within `--window` to see if using delta compression saves
+ space. `--depth` limits the maximum delta depth; making
it too deep affects the performance on the unpacker
side, because delta data needs to be applied that many
times to get to the necessary object.
+
-The default value for --window is 10 and --depth is 50. The maximum
+The default value for `--window` is 10 and `--depth` is 50. The maximum
depth is 4095.
--window-memory=<n>::
@@ -165,19 +165,19 @@ depth is 4095.
the standard error stream is not directed to a terminal.
--all-progress::
- When --stdout is specified then progress report is
+ When `--stdout` is specified then progress report is
displayed during the object count and compression phases
but inhibited during the write-out phase. The reason is
that in some cases the output stream is directly linked
to another command which may wish to display progress
status of its own as it processes incoming pack data.
- This flag is like --progress except that it forces progress
- report for the write-out phase as well even if --stdout is
+ This flag is like `--progress` except that it forces progress
+ report for the write-out phase as well even if `--stdout` is
used.
--all-progress-implied::
- This is used to imply --all-progress whenever progress display
- is activated. Unlike --all-progress this flag doesn't actually
+ This is used to imply `--all-progress` whenever progress display
+ is activated. Unlike `--all-progress` this flag doesn't actually
force any progress display by itself.
-q::
@@ -194,7 +194,7 @@ depth is 4095.
--no-reuse-object::
This flag tells the command not to reuse existing object data at all,
including non deltified object, forcing recompression of everything.
- This implies --no-reuse-delta. Useful only in the obscure case where
+ This implies `--no-reuse-delta`. Useful only in the obscure case where
wholesale enforcement of a different compression level on the
packed data is desired.
@@ -203,12 +203,12 @@ depth is 4095.
generated pack. If not specified, pack compression level is
determined first by pack.compression, then by core.compression,
and defaults to -1, the zlib default, if neither is set.
- Add --no-reuse-object if you want to force a uniform compression
+ Add `--no-reuse-object` if you want to force a uniform compression
level on all data no matter the source.
--[no-]sparse::
Toggle the "sparse" algorithm to determine which objects to include in
- the pack, when combined with the "--revs" option. This algorithm
+ the pack, when combined with the `--revs` option. This algorithm
only walks trees that appear in paths that introduce new objects.
This can have significant performance benefits when computing
a pack to send a small change. However, it is possible that extra
@@ -220,7 +220,7 @@ depth is 4095.
--thin::
Create a "thin" pack by omitting the common objects between a
sender and a receiver in order to reduce network transfer. This
- option only makes sense in conjunction with --stdout.
+ option only makes sense in conjunction with `--stdout`.
+
Note: A thin pack violates the packed archive format by omitting
required objects and is thus unusable by Git without making it
@@ -229,7 +229,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::
@@ -279,16 +279,16 @@ So does `git bundle` (see linkgit:git-bundle[1]) when it creates a bundle.
A debug option to help with future "partial clone" development.
This option specifies how missing objects are handled.
+
-The form '--missing=error' requests that pack-objects stop with an error if
+The form `--missing=error` requests that pack-objects stop with an error if
a missing object is encountered. If the repository is a partial clone, an
attempt to fetch missing objects will be made before declaring them missing.
This is the default action.
+
-The form '--missing=allow-any' will allow object traversal to continue
+The form `--missing=allow-any` will allow object traversal to continue
if a missing object is encountered. No fetch of a missing object will occur.
Missing objects will silently be omitted from the results.
+
-The form '--missing=allow-promisor' is like 'allow-any', but will only
+The form `--missing=allow-promisor` is like 'allow-any', but will only
allow object traversal to continue for EXPECTED promisor missing objects.
No fetch of a missing object will occur. An unexpected missing object will
raise an error.
@@ -302,7 +302,7 @@ raise an error.
--keep-unreachable::
Objects unreachable from the refs in packs named with
- --unpacked= option are added to the resulting pack, in
+ `--unpacked`= option are added to the resulting pack, in
addition to the reachable objects that are not in packs marked
with *.keep files. This implies `--revs`.
@@ -363,7 +363,7 @@ to recompute deltas on the fly due to crossing island boundaries.
When repacking with delta islands the delta window tends to get
clogged with candidates that are forbidden by the config. Repacking
-with a big --window helps (and doesn't take as long as it otherwise
+with a big `--window` helps (and doesn't take as long as it otherwise
might because we can reject some object pairs based on islands before
doing any computation on the content).
diff --git a/Documentation/git-patch-id.txt b/Documentation/git-patch-id.txt
index 442caff8a9..fb5b194b8a 100644
--- a/Documentation/git-patch-id.txt
+++ b/Documentation/git-patch-id.txt
@@ -34,15 +34,15 @@ OPTIONS
Use a "stable" sum of hashes as the patch ID. With this option:
- Reordering file diffs that make up a patch does not affect the ID.
In particular, two patches produced by comparing the same two trees
- with two different settings for "-O<orderfile>" result in the same
+ with two different settings for `-O<orderfile>` result in the same
patch ID signature, thereby allowing the computed result to be used
as a key to index some meta-information about the change between
the two trees;
- Result is different from the value produced by git 1.9 and older
- or produced when an "unstable" hash (see --unstable below) is
+ or produced when an "unstable" hash (see `--unstable` below) is
configured - even when used on a diff output taken without any use
- of "-O<orderfile>", thereby making existing databases storing such
+ of `-O<orderfile>`, thereby making existing databases storing such
"unstable" or historical patch-ids unusable.
This is the default if patchid.stable is set to true.
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt
index 03552dd86f..7bad035e47 100644
--- a/Documentation/git-prune.txt
+++ b/Documentation/git-prune.txt
@@ -75,7 +75,7 @@ should instead call 'git gc', which handles pruning along with
many other housekeeping tasks.
For a description of which objects are considered for pruning, see
-'git fsck''s --unreachable option.
+'git fsck''s `--unreachable` option.
SEE ALSO
--------
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index 5c3fb67c01..edecf393d3 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -82,7 +82,7 @@ OPTIONS
-v::
--verbose::
- Pass --verbose to git-fetch and git-merge.
+ Pass `--verbose` to git-fetch and git-merge.
--[no-]recurse-submodules[=yes|on-demand|no]::
This option controls if new commits of populated submodules should
@@ -132,7 +132,7 @@ published that history already. Do *not* use this option
unless you have read linkgit:git-rebase[1] carefully.
--no-rebase::
- Override earlier --rebase.
+ Override earlier `--rebase`.
Options related to fetching
~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -239,7 +239,7 @@ include::transfer-data-leaks.txt[]
BUGS
----
-Using --recurse-submodules can only fetch new commits in already checked
+Using `--recurse-submodules` can only fetch new commits in already checked
out submodules right now. When e.g. upstream added a new submodule in the
just fetched commits of the superproject the submodule itself cannot be
fetched, making it impossible to check out that submodule later without
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index a953c7c387..fc91d41ce0 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -277,7 +277,7 @@ that specifies the expected current value of the ref explicitly are
still experimental and their semantics may change as we gain experience
with this feature.
+
-"--no-force-with-lease" will cancel all the previous --force-with-lease on the
+`--no-force-with-lease` will cancel all the previous `--force-with-lease` on the
command line.
+
A general note on safety: supplying this option without an expected
@@ -416,8 +416,8 @@ Specifying `--no-force-if-includes` disables this behavior.
--[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.
-4::
--ipv4::
@@ -443,13 +443,13 @@ representing the status of a single ref. Each line is of the form:
<flag> <summary> <from> -> <to> (<reason>)
-------------------------------
-If --porcelain is used, then each line of the output is of the form:
+If `--porcelain` is used, then each line of the output is of the form:
-------------------------------
<flag> \t <from>:<to> \t <summary> (<reason>)
-------------------------------
-The status of up-to-date refs is shown only if --porcelain or --verbose
+The status of up-to-date refs is shown only if `--porcelain` or `--verbose`
option is used.
flag::
diff --git a/Documentation/git-quiltimport.txt b/Documentation/git-quiltimport.txt
index 70562dc4c0..edae01d55d 100644
--- a/Documentation/git-quiltimport.txt
+++ b/Documentation/git-quiltimport.txt
@@ -21,7 +21,7 @@ in the quilt patchset.
For each patch the code attempts to extract the author from the
patch description. If that fails it falls back to the author
-specified with --author. If the --author flag was not given
+specified with `--author`. If the `--author` flag was not given
the patch description is displayed and the user is asked to
interactively enter the author of the patch.
diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index 5fa8bab64c..3f53688170 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -38,7 +38,7 @@ OPTIONS
started.
--reset::
- Same as -m, except that unmerged entries are discarded instead
+ Same as `-m`, except that unmerged entries are discarded instead
of failing. When used with `-u`, updates leading to loss of
working tree changes will not abort the operation.
@@ -116,7 +116,7 @@ OPTIONS
located in.
--[no-]recurse-submodules::
- Using --recurse-submodules will update the content of all active
+ Using `--recurse-submodules` will update the content of all active
submodules according to the commit recorded in the superproject by
calling read-tree recursively, also setting the submodules' HEAD to be
detached at that commit.
@@ -227,7 +227,7 @@ refer to the presence of a path in the specified commit:
In all "keep index" cases, the index entry stays as in the
original index file. If the entry is not up to date,
'git read-tree' keeps the copy in the work tree intact when
-operating under the -u flag.
+operating under the `-u` flag.
When this form of 'git read-tree' returns successfully, you can
see which of the "local changes" that you made were carried forward by running
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index f08ae27e2a..f063d54623 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -34,7 +34,7 @@ description on `--fork-point` below); or by `git log HEAD`, if the
`--root` option is specified.
The current branch is reset to <upstream>, or <newbase> if the
---onto option was supplied. This has the exact same effect as
+`--onto` option was supplied. This has the exact same effect as
`git reset --hard <upstream>` (or <newbase>). ORIG_HEAD is set
to point at the tip of the branch before the reset.
@@ -130,7 +130,7 @@ We can get this using the following command:
git rebase --onto master next topic
-Another example of --onto option is to rebase part of a
+Another example of `--onto` option is to rebase part of a
branch. If we have the following situation:
------------
@@ -175,7 +175,7 @@ would result in the removal of commits F and G:
------------
This is useful if F and G were flawed in some way, or should not be
-part of topicA. Note that the argument to --onto and the <upstream>
+part of topicA. Note that the argument to `--onto` and the <upstream>
parameter can be any valid commit-ish.
In case of conflict, 'git rebase' will stop at the first problematic commit
@@ -210,7 +210,7 @@ OPTIONS
-------
--onto <newbase>::
Starting point at which to create the new commits. If the
- --onto option is not specified, the starting point is
+ `--onto` option is not specified, the starting point is
<upstream>. May be any valid commit, and not just an
existing branch name.
+
@@ -229,9 +229,9 @@ top of an upstream branch. While the feature is being worked on, the
upstream branch may advance and it may not be the best idea to keep
rebasing on top of the upstream but to keep the base commit as-is.
+
-Although both this option and --fork-point find the merge base between
+Although both this option and `--fork-point` find the merge base between
<upstream> and <branch>, this option uses the merge base as the _starting
-point_ on which new commits will be created, whereas --fork-point uses
+point_ on which new commits will be created, whereas `--fork-point` uses
the merge base to determine the _set of commits_ which will be rebased.
+
See also INCOMPATIBLE OPTIONS below.
@@ -258,7 +258,7 @@ See also INCOMPATIBLE OPTIONS below.
Abort the rebase operation but HEAD is not reset back to the
original branch. The index and working tree are also left
unchanged as a result. If a temporary stash entry was created
- using --autostash, it will be saved to the stash list.
+ using `--autostash`, it will be saved to the stash list.
--apply::
Use applying strategies to rebase (calling `git-am`
@@ -276,13 +276,13 @@ See also INCOMPATIBLE OPTIONS below.
With ask (implied by --interactive), the rebase will halt when
an empty commit is applied allowing you to choose whether to
drop it, edit files more, or just commit the empty changes.
- Other options, like --exec, will use the default of drop unless
- -i/--interactive is explicitly specified.
+ Other options, like `--exec`, will use the default of drop unless
+ `-i`/`--interactive` is explicitly specified.
+
-Note that commits which start empty are kept (unless --no-keep-empty
+Note that commits which start empty are kept (unless `--no-keep-empty`
is specified), and commits which are clean cherry-picks (as determined
by `git log --cherry-mark ...`) are detected and dropped as a
-preliminary step (unless --reapply-cherry-picks is passed).
+preliminary step (unless `--reapply-cherry-picks` is passed).
+
See also INCOMPATIBLE OPTIONS below.
@@ -291,7 +291,7 @@ See also INCOMPATIBLE OPTIONS below.
Do not keep commits that start empty before the rebase
(i.e. that do not change anything from its parent) in the
result. The default is to keep commits which start empty,
- since creating such commits requires passing the --allow-empty
+ since creating such commits requires passing the `--allow-empty`
override flag to `git commit`, signifying that a user is very
intentionally creating such a commit and thus wants to keep
it.
@@ -303,7 +303,7 @@ flag exists as a convenient shortcut, such as for cases where external
tools generate many empty commits and you want them all removed.
+
For commits which do not start empty but become empty after rebasing,
-see the --empty flag.
+see the `--empty` flag.
+
See also INCOMPATIBLE OPTIONS below.
@@ -362,7 +362,7 @@ See also INCOMPATIBLE OPTIONS below.
--strategy=<strategy>::
Use the given merge strategy.
If there is no `-s` option 'git merge-recursive' is used
- instead. This implies --merge.
+ instead. This implies `--merge`.
+
Because 'git rebase' replays each commit from the working branch
on top of the <upstream> branch using the given strategy, using
@@ -396,11 +396,11 @@ See also INCOMPATIBLE OPTIONS below.
-q::
--quiet::
- Be quiet. Implies --no-stat.
+ Be quiet. Implies `--no-stat`.
-v::
--verbose::
- Be verbose. Implies --stat.
+ Be verbose. Implies `--stat`.
--stat::
Show a diffstat of what changed upstream since the last rebase. The
@@ -415,13 +415,13 @@ See also INCOMPATIBLE OPTIONS below.
--verify::
Allows the pre-rebase hook to run, which is the default. This option can
- be used to override --no-verify. See also linkgit:githooks[5].
+ be used to override `--no-verify`. See also linkgit:githooks[5].
-C<n>::
Ensure at least <n> lines of surrounding context match before
and after each change. When fewer lines of surrounding
context exist they all must match. By default no context is
- ever ignored. Implies --apply.
+ ever ignored. Implies `--apply`.
+
See also INCOMPATIBLE OPTIONS below.
@@ -444,7 +444,7 @@ details).
and <branch> when calculating which commits have been
introduced by <branch>.
+
-When --fork-point is active, 'fork_point' will be used instead of
+When `--fork-point` is active, 'fork_point' will be used instead of
<upstream> to calculate the set of commits to rebase, where
'fork_point' is the result of `git merge-base --fork-point <upstream>
<branch>` command (see linkgit:git-merge-base[1]). If 'fork_point'
@@ -478,7 +478,7 @@ if the other side had no changes that conflicted.
--whitespace=<option>::
This flag is passed to the 'git apply' program
(see linkgit:git-apply[1]) that applies the patch.
- Implies --apply.
+ Implies `--apply`.
+
See also INCOMPATIBLE OPTIONS below.
@@ -582,10 +582,10 @@ See also INCOMPATIBLE OPTIONS below.
--root::
Rebase all commits reachable from <branch>, instead of
limiting them with an <upstream>. This allows you to rebase
- the root commit(s) on a branch. When used with --onto, it
+ the root commit(s) on a branch. When used with `--onto`, it
will skip changes already contained in <newbase> (instead of
- <upstream>) whereas without --onto it will operate on every change.
- When used together with both --onto and --preserve-merges,
+ <upstream>) whereas without `--onto` it will operate on every change.
+ When used together with both `--onto` and `--preserve-merges`,
'all' root commits will be rewritten to have <newbase> as parent
instead.
+
@@ -629,39 +629,39 @@ INCOMPATIBLE OPTIONS
The following options:
- * --apply
- * --whitespace
- * -C
+ * `--apply`
+ * `--whitespace`
+ * `-C`
are incompatible with the following options:
- * --merge
- * --strategy
- * --strategy-option
- * --allow-empty-message
- * --[no-]autosquash
- * --rebase-merges
- * --preserve-merges
- * --interactive
- * --exec
- * --no-keep-empty
- * --empty=
- * --reapply-cherry-picks
- * --edit-todo
- * --root when used in combination with --onto
+ * `--merge`
+ * `--strategy`
+ * `--strategy-option`
+ * `--allow-empty-message`
+ * `--[no-]autosquash`
+ * `--rebase-merges`
+ * `--preserve-merges`
+ * `--interactive`
+ * `--exec`
+ * `--no-keep-empty`
+ * `--empty=`
+ * `--reapply-cherry-picks`
+ * `--edit-todo`
+ * `--root` when used in combination with `--onto`
In addition, the following pairs of options are incompatible:
- * --preserve-merges and --interactive
- * --preserve-merges and --signoff
- * --preserve-merges and --rebase-merges
- * --preserve-merges and --empty=
- * --preserve-merges and --ignore-whitespace
- * --preserve-merges and --committer-date-is-author-date
- * --preserve-merges and --ignore-date
- * --keep-base and --onto
- * --keep-base and --root
- * --fork-point and --root
+ * `--preserve-merges` and `--interactive`
+ * `--preserve-merges` and `--signoff`
+ * `--preserve-merges` and `--rebase-merges`
+ * `--preserve-merges` and `--empty=`
+ * `--preserve-merges` and `--ignore-whitespace`
+ * `--preserve-merges` and `--committer-date-is-author-date`
+ * `--preserve-merges` and `--ignore-date`
+ * `--keep-base` and `--onto`
+ * `--keep-base` and `--root`
+ * `--fork-point` and `--root`
BEHAVIORAL DIFFERENCES
-----------------------
@@ -683,13 +683,13 @@ also drops commits that become empty and has no option for controlling
this behavior.
The merge backend keeps intentionally empty commits by default (though
-with -i they are marked as empty in the todo list editor, or they can
-be dropped automatically with --no-keep-empty).
+with `-i` they are marked as empty in the todo list editor, or they can
+be dropped automatically with `--no-keep-empty`).
Similar to the apply backend, by default the merge backend drops
-commits that become empty unless -i/--interactive is specified (in
+commits that become empty unless `-i`/`--interactive` is specified (in
which case it stops and asks the user what to do). The merge backend
-also has an --empty={drop,keep,ask} option for changing the behavior
+also has an `--empty={drop,keep,ask}` option for changing the behavior
of handling commits that become empty.
Directory rename detection
diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt
index 317d63cf0d..98373e4f36 100644
--- a/Documentation/git-repack.txt
+++ b/Documentation/git-repack.txt
@@ -96,7 +96,7 @@ to the new separate pack will be written.
affects the performance on the unpacker side, because delta data needs
to be applied that many times to get to the necessary object.
+
-The default value for --window is 10 and --depth is 50. The maximum
+The default value for `--window` is 10 and `--depth` is 50. The maximum
depth is 4095.
--threads=<n>::
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 252e2d4e47..e9e816a986 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -89,7 +89,7 @@ but carries forward unmerged index entries.
changes, reset is aborted.
--[no-]recurse-submodules::
- When the working tree is updated, using --recurse-submodules will
+ When the working tree is updated, using `--recurse-submodules` will
also recursively reset the working tree of all active submodules
according to the commit recorded in the superproject, also setting
the submodules' HEAD to be detached at that commit.
@@ -345,7 +345,7 @@ $ git commit ... <8>
------------
+
<1> First, reset the history back one commit so that we remove the original
- commit, but leave the working tree with all the changes. The -N ensures
+ commit, but leave the working tree with all the changes. The `-N` ensures
that any new files added with `HEAD` are still marked so that `git add -p`
will find them.
<2> Next, we interactively select diff hunks to add using the `git add -p`
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index 6b8ca085aa..4b1af8c5a6 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -152,7 +152,7 @@ for another option.
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
@@ -306,12 +306,12 @@ Other Options
--since=datestring::
--after=datestring::
Parse the date string, and output the corresponding
- --max-age= parameter for 'git rev-list'.
+ `--max-age=` parameter for 'git rev-list'.
--until=datestring::
--before=datestring::
Parse the date string, and output the corresponding
- --min-age= parameter for 'git rev-list'.
+ `--min-age=` parameter for 'git rev-list'.
<args>...::
Flags and parameters to be parsed.
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt
index ab750367fd..e7ff1b5fbd 100644
--- a/Documentation/git-rm.txt
+++ b/Documentation/git-rm.txt
@@ -151,7 +151,7 @@ still uses a .git directory, `git rm` will move the submodules
git directory into the superprojects git directory to protect
the submodule's history. If it exists the submodule.<name> section
in the linkgit:gitmodules[5] file will also be removed and that file
-will be staged (unless --cached or -n are used).
+will be staged (unless `--cached` or `-n` are used).
A submodule is considered up to date when the HEAD is the same as
recorded in the index, no tracked files are modified and no untracked
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 93708aefea..afd41a010e 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -87,7 +87,7 @@ See the CONFIGURATION section for `sendemail.multiEdit`.
--reply-to=<address>::
Specify the address where replies from recipients should go to.
Use this if replies to messages should go to another address than what
- is specified with the --from parameter.
+ is specified with the `--from` parameter.
--in-reply-to=<identifier>::
Make the first mail (or all the mails with `--no-thread`) appear as a
@@ -108,19 +108,19 @@ illustration below where `[PATCH v2 0/3]` is in reply to `[PATCH 0/2]`:
[PATCH v2 2/3] New tests
[PATCH v2 3/3] Implementation
+
-Only necessary if --compose is also set. If --compose
+Only necessary if `--compose` is also set. If `--compose`
is not set, this will be prompted for.
--subject=<string>::
Specify the initial subject of the email thread.
- Only necessary if --compose is also set. If --compose
+ Only necessary if `--compose` is also set. If `--compose`
is not set, this will be prompted for.
--to=<address>,...::
Specify the primary recipient of the emails generated. Generally, this
will be the upstream maintainer of the project involved. Default is the
value of the `sendemail.to` configuration value; if that is unspecified,
- and --to-cmd is not specified, this will be prompted for.
+ and `--to-cmd` is not specified, this will be prompted for.
+
This option may be specified multiple times.
@@ -163,7 +163,7 @@ Sending
This is useful if your default address is not the address that is
subscribed to a list. In order to use the 'From' address, set the
value to "auto". If you use the sendmail binary, you must have
- suitable privileges for the -f parameter. Default is the value of the
+ suitable privileges for the `-f` parameter. Default is the value of the
`sendemail.envelopeSender` configuration variable; if that is
unspecified, choosing the envelope sender is left to your MTA.
@@ -232,12 +232,12 @@ a password is obtained using 'git-credential'.
Default value can be specified by the `sendemail.smtpServerOption`
configuration option.
+
-The --smtp-server-option option must be repeated for each option you want
+The `--smtp-server-option` option must be repeated for each option you want
to pass to the server. Likewise, different lines in the configuration files
must be used for each option.
--smtp-ssl::
- Legacy alias for '--smtp-encryption ssl'.
+ Legacy alias for `--smtp-encryption ssl`.
--smtp-ssl-cert-path::
Path to a store of trusted CA certificates for SMTP SSL/TLS
@@ -264,7 +264,7 @@ must be used for each option.
Some email servers (e.g. smtp.163.com) limit the number emails to be
sent per session (connection) and this will lead to a failure when
sending many messages. With this option, send-email will disconnect after
- sending $<num> messages and wait for a few seconds (see --relogin-delay)
+ sending $<num> messages and wait for a few seconds (see `--relogin-delay`)
and reconnect, to work around such a limit. You may want to
use some form of credential helper to avoid having to retype
your password every time this happens. Defaults to the
@@ -272,7 +272,7 @@ must be used for each option.
--relogin-delay=<int>::
Waiting $<int> seconds before reconnecting to SMTP server. Used together
- with --batch-size option. Defaults to the `sendemail.smtpReloginDelay`
+ with `--batch-size` option. Defaults to the `sendemail.smtpReloginDelay`
configuration variable.
Automating
@@ -300,7 +300,7 @@ Automating
--[no-]chain-reply-to::
If this is set, each email will be sent as a reply to the previous
- email sent. If disabled with "--no-chain-reply-to", all emails after
+ email sent. If disabled with `--no-chain-reply-to`, all emails after
the first will be sent as replies to the first email sent. When using
this, it is recommended that the first file given be an overview of the
entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
@@ -315,19 +315,19 @@ Automating
--[no-]signed-off-by-cc::
If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
cc list. Default is the value of `sendemail.signedoffbycc` configuration
- value; if that is unspecified, default to --signed-off-by-cc.
+ value; if that is unspecified, default to `--signed-off-by-cc`.
--[no-]cc-cover::
If this is set, emails found in Cc: headers in the first patch of
the series (typically the cover letter) are added to the cc list
for each email set. Default is the value of 'sendemail.cccover'
- configuration value; if that is unspecified, default to --no-cc-cover.
+ configuration value; if that is unspecified, default to `--no-cc-cover`.
--[no-]to-cover::
If this is set, emails found in To: headers in the first patch of
the series (typically the cover letter) are added to the to list
for each email set. Default is the value of 'sendemail.tocover'
- configuration value; if that is unspecified, default to --no-to-cover.
+ configuration value; if that is unspecified, default to `--no-to-cover`.
--suppress-cc=<category>::
Specify an additional category of recipients to suppress the
@@ -345,19 +345,19 @@ Automating
- 'misc-by' will avoid including anyone mentioned in Acked-by,
Reviewed-by, Tested-by and other "-by" lines in the patch body,
except Signed-off-by (use 'sob' for that).
-- 'cccmd' will avoid running the --cc-cmd.
+- 'cccmd' will avoid running the `--cc-cmd`.
- 'body' is equivalent to 'sob' + 'bodycc' + 'misc-by'.
- 'all' will suppress all auto cc values.
--
+
Default is the value of `sendemail.suppresscc` configuration value; if
-that is unspecified, default to 'self' if --suppress-from is
-specified, as well as 'body' if --no-signed-off-cc is specified.
+that is unspecified, default to 'self' if `--suppress-from` is
+specified, as well as 'body' if `--no-signed-off-cc` is specified.
--[no-]suppress-from::
If this is set, do not add the From: address to the cc: list.
Default is the value of `sendemail.suppressFrom` configuration
- value; if that is unspecified, default to --no-suppress-from.
+ value; if that is unspecified, default to `--no-suppress-from`.
--[no-]thread::
If this is set, the In-Reply-To and References headers will be
@@ -366,10 +366,10 @@ specified, as well as 'body' if --no-signed-off-cc is specified.
wording) or to the first email (`shallow` threading) is
governed by "--[no-]chain-reply-to".
+
-If disabled with "--no-thread", those headers will not be added
-(unless specified with --in-reply-to). Default is the value of the
+If disabled with `--no-thread`, those headers will not be added
+(unless specified with `--in-reply-to`). Default is the value of the
`sendemail.thread` configuration value; if that is unspecified,
-default to --thread.
+default to `--thread`.
+
It is up to the user to ensure that no In-Reply-To header already
exists when 'git send-email' is asked to add it (especially note that
@@ -389,7 +389,7 @@ Administering
- 'never' will never confirm before sending
- 'cc' will confirm before sending when send-email has automatically
added addresses from the patch to the Cc list
-- 'compose' will confirm before sending the first message when using --compose.
+- 'compose' will confirm before sending the first message when using `--compose`.
- 'auto' is equivalent to 'cc' + 'compose'
--
+
diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt
index 44fd146b91..2cd2d823b3 100644
--- a/Documentation/git-send-pack.txt
+++ b/Documentation/git-send-pack.txt
@@ -32,7 +32,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,
diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index 5cc2fcefba..0ce603646f 100644
--- a/Documentation/git-show-branch.txt
+++ b/Documentation/git-show-branch.txt
@@ -126,7 +126,7 @@ OPTIONS
default to color output.
Same as `--color=never`.
-Note that --more, --list, --independent and --merge-base options
+Note that `--more`, `--list`, `--independent` and `--merge-base` options
are mutually exclusive.
diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index ab4d271925..8c739adc70 100644
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -23,7 +23,7 @@ particular ref exists.
By default, shows the tags, heads, and remote refs.
-The --exclude-existing form is a filter that does the inverse. It reads
+The `--exclude-existing` form is a filter that does the inverse. It reads
refs from stdin, one ref per line, and shows those that don't exist in
the local repository.
@@ -54,7 +54,7 @@ OPTIONS
--hash[=<n>]::
Only show the SHA-1 hash, not the reference name. When combined with
- --dereference the dereferenced tag will still be shown after the SHA-1.
+ `--dereference` the dereferenced tag will still be shown after the SHA-1.
--verify::
@@ -110,7 +110,7 @@ $ git show-ref --head --dereference
...
-----------------------------------------------------------------------------
-When using --hash (and not --dereference) the output format is: '<SHA-1 ID>'
+When using `--hash` (and not `--dereference`) the output format is: '<SHA-1 ID>'
-----------------------------------------------------------------------------
$ git show-ref --heads --hash
@@ -145,7 +145,7 @@ will only match the exact branch called "master".
If nothing matches, 'git show-ref' will return an error code of 1,
and in the case of verification, it will show an error message.
-For scripting, you can ask it to be quiet with the "--quiet" flag, which
+For scripting, you can ask it to be quiet with the `--quiet` flag, which
allows you to do things like
-----------------------------------------------------------------------------
@@ -157,11 +157,11 @@ to check whether a particular branch exists or not (notice how we don't
actually want to show any results, and we want to use the full refname for it
in order to not trigger the problem with ambiguous partial matches).
-To show only tags, or only proper branch heads, use "--tags" and/or "--heads"
+To show only tags, or only proper branch heads, use `--tags` and/or `--heads`
respectively (using both means that it shows tags and heads, but not other
random references under the refs/ subdirectory).
-To do automatic tag object dereferencing, use the "-d" or "--dereference"
+To do automatic tag object dereferencing, use the `-d` or `--dereference`
flag, so you can do
-----------------------------------------------------------------------------
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 83f38e3198..2fa3bc58f7 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -109,7 +109,7 @@ It is optional: it defaults to 'traditional'.
The possible options are:
- 'traditional' - Shows ignored files and directories, unless
- --untracked-files=all is specified, in which case
+ `--untracked-files=all` is specified, in which case
individual files in ignored directories are
displayed.
- 'no' - Show no ignored files.
@@ -252,7 +252,7 @@ via `git add` in the superproject to prepare a commit.
'm' and '?' are applied recursively. For example if a nested submodule
in a submodule contains an untracked file, this is reported as '?' as well.
-If -b is used the short-format status is preceded by a line
+If `-b` is used the short-format status is preceded by a line
## branchname tracking info
@@ -271,7 +271,7 @@ format, with a few exceptions:
2. The user's status.relativePaths configuration is not respected; paths
shown will always be relative to the repository root.
-There is also an alternate -z format recommended for machine parsing. In
+There is also an alternate `-z` format recommended for machine parsing. In
that format, the status field is the same, but some other things
change. First, the '\->' is omitted from rename entries and the field
order is reversed (e.g 'from \-> to' becomes 'to from'). Second, a NUL
@@ -425,11 +425,11 @@ directory.
If `status.submoduleSummary` is set to a non zero number or true (identical
to -1 or an unlimited number), the submodule summary will be enabled for
the long format and a summary of commits for modified submodules will be
-shown (see --summary-limit option of linkgit:git-submodule[1]). Please note
+shown (see `--summary-limit` option of linkgit:git-submodule[1]). Please note
that the summary output from the status command will be suppressed for all
submodules when `diff.ignoreSubmodules` is set to 'all' or only for those
submodules where `submodule.<name>.ignore=all`. To also view the summary for
-ignored submodules you can either use the --ignore-submodules=dirty command
+ignored submodules you can either use the `--ignore-submodules=dirty` command
line option or the 'git submodule summary' command, which shows a similar
output but does not honor these settings.
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 7e5f995f77..1bcde161ca 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -432,7 +432,7 @@ options carefully.
--[no-]single-branch::
This option is only valid for the update command.
- Clone only one branch during update: HEAD or one specified by --branch.
+ Clone only one branch during update: HEAD or one specified by `--branch`.
<path>...::
Paths to submodule(s). When specified this will restrict the command
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 67b143cc81..3f55e9c419 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -17,8 +17,8 @@ It provides a bidirectional flow of changes between a Subversion and a Git
repository.
'git svn' can track a standard Subversion repository,
-following the common "trunk/branches/tags" layout, with the --stdlayout option.
-It can also follow branches and tags in any layout with the -T/-t/-b options
+following the common "trunk/branches/tags" layout, with the `--stdlayout` option.
+It can also follow branches and tags in any layout with the `-T`/`-t`/`-b` options
(see options to 'init' below, and also the 'clone' command).
Once tracking a Subversion repository (with any of the above methods), the Git
@@ -32,7 +32,7 @@ COMMANDS
Initializes an empty Git repository with additional
metadata directories for 'git svn'. The Subversion URL
may be specified as a command-line argument, or as full
- URL arguments to -T/-t/-b. Optionally, the target
+ URL arguments to `-T`/`-t`/`-b`. Optionally, the target
directory to operate on can be specified as a second
argument. Normally this command initializes the current
directory.
@@ -47,11 +47,11 @@ COMMANDS
--stdlayout;;
These are optional command-line options for init. Each of
these flags can point to a relative repository path
- (--tags=project/tags) or a full url
- (--tags=https://foo.org/project/tags).
- You can specify more than one --tags and/or --branches options, in case
+ (`--tags=project/tags`) or a full url
+ (`--tags=https://foo.org/project/tags`).
+ You can specify more than one `--tags` and/or `--branches` options, in case
your Subversion repository places tags or branches under multiple paths.
- The option --stdlayout is
+ The option `--stdlayout` is
a shorthand way of setting trunk,tags,branches as the relative paths,
which is the Subversion default. If any of the other options are given
as well, they take precedence.
@@ -77,7 +77,7 @@ COMMANDS
to the names of remotes if trunk/branches/tags are
specified. The prefix does not automatically include a
trailing slash, so be sure you include one in the
- argument if that is what you want. If --branches/-b is
+ argument if that is what you want. If `--branches`/`-b` is
specified, the prefix must include a trailing slash.
Setting a prefix (with a trailing slash) is strongly
encouraged in any case, as your SVN-tracking refs will
@@ -108,8 +108,8 @@ your Perl's Getopt::Long is < v2.37).
be preserved as a config key. See 'fetch' for a description
of `--include-paths`.
--no-minimize-url;;
- When tracking multiple directories (using --stdlayout,
- --branches, or --tags options), git svn will attempt to connect
+ When tracking multiple directories (using `--stdlayout`,
+ `--branches`, or `--tags` options), git svn will attempt to connect
to the root (or highest allowed level) of the Subversion
repository. This default allows better tracking of history if
entire projects are moved within a repository, but may cause
@@ -130,7 +130,7 @@ This automatically updates the rev_map if needed (see
--localtime;;
Store Git commit times in the local time zone instead of UTC. This
- makes 'git log' (even without --date=local) show the same times
+ makes 'git log' (even without `--date=local`) show the same times
that `svn log` would in the local time zone.
+
This doesn't interfere with interoperating with the Subversion
@@ -220,7 +220,7 @@ config key: svn-remote.<name>.include-paths
are also tracked and removed when no longer necessary.
--placeholder-filename=<filename>;;
- Set the name of placeholder files created by --preserve-empty-dirs.
+ Set the name of placeholder files created by `--preserve-empty-dirs`.
Default: ".gitignore"
'rebase'::
@@ -317,7 +317,7 @@ committing anything to SVN.
-d<path>;;
--destination=<path>;;
- If more than one --branches (or --tags) option was given to the 'init'
+ If more than one `--branches` (or `--tags`) option was given to the 'init'
or 'clone' command, you must provide the location of the branch (or
tag) you wish to create in the SVN repository. <path> specifies which
path to use to create the branch or tag and should match the pattern
@@ -327,7 +327,7 @@ committing anything to SVN.
git config --get-all svn-remote.<name>.branches
git config --get-all svn-remote.<name>.tags
+
-where <name> is the name of the SVN repository as specified by the -R option to
+where <name> is the name of the SVN repository as specified by the `-R` option to
'init' (or "svn" by default).
--username;;
@@ -345,7 +345,7 @@ where <name> is the name of the SVN repository as specified by the -R option to
--parents;;
Create parent folders. This parameter is equivalent to the parameter
- --parents on svn cp commands and is useful for non-standard repository
+ `--parents` on svn cp commands and is useful for non-standard repository
layouts.
'tag'::
@@ -354,7 +354,7 @@ where <name> is the name of the SVN repository as specified by the -R option to
'log'::
This should make it easy to look up svn log messages when svn
- users refer to -r/--revision numbers.
+ users refer to `-r`/`--revision` numbers.
+
The following features from `svn log' are supported:
+
@@ -365,10 +365,10 @@ The following features from `svn log' are supported:
HEAD, NEXT, BASE, PREV, etc ...
-v;;
--verbose;;
- it's not completely compatible with the --verbose
+ it's not completely compatible with the `--verbose`
output in svn log, but reasonably close.
--limit=<n>;;
- is NOT the same as --max-count, doesn't count
+ is NOT the same as `--max-count`, doesn't count
merged/excluded commits
--incremental;;
supported
@@ -380,7 +380,7 @@ New features:
--show-commit;;
shows the Git commit sha1, as well
--oneline;;
- our version of --pretty=oneline
+ our version of `--pretty=oneline`
--
+
NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
@@ -433,7 +433,7 @@ Any other arguments are passed directly to 'git log'
'create-ignore'::
Recursively finds the svn:ignore property on directories and
creates matching .gitignore files. The resulting files are staged to
- be committed, but are not committed. Use -r/--revision to refer to a
+ be committed, but are not committed. Use `-r`/`--revision` to refer to a
specific revision.
'show-ignore'::
@@ -458,7 +458,7 @@ Any other arguments are passed directly to 'git log'
URL of the target Subversion repository. The final argument
(URL) may be omitted if you are working from a 'git svn'-aware
repository (that has been `init`-ed with 'git svn').
- The -r<revision> option is required for this.
+ The `-r<revision>` option is required for this.
+
The commit message is supplied either directly with the `-m` or `-F`
option, or indirectly from the tag or commit when the second tree-ish
@@ -477,18 +477,18 @@ denotes such an object, or it is requested by invoking an editor (see
'info'::
Shows information about a file or directory similar to what
- `svn info' provides. Does not currently support a -r/--revision
- argument. Use the --url option to output only the value of the
+ `svn info' provides. Does not currently support a `-r`/`--revision`
+ argument. Use the `--url` option to output only the value of the
'URL:' field.
'proplist'::
Lists the properties stored in the Subversion repository about a
- given file or directory. Use -r/--revision to refer to a specific
+ given file or directory. Use `-r`/`--revision` to refer to a specific
Subversion revision.
'propget'::
Gets the Subversion property given as the first argument, for a
- file. A specific revision can be specified with -r/--revision.
+ file. A specific revision can be specified with `-r`/`--revision`.
'propset'::
Sets the Subversion property given as the first argument, to the
@@ -505,7 +505,7 @@ This will set the property 'svn:keywords' to 'FreeBSD=%H' for the file
'devel/py-tipper/Makefile'.
'show-externals'::
- Shows the Subversion externals. Use -r/--revision to specify a
+ Shows the Subversion externals. Use `-r`/`--revision` to specify a
specific revision.
'gc'::
@@ -517,10 +517,10 @@ This will set the property 'svn:keywords' to 'FreeBSD=%H' for the file
This allows you to re-'fetch' an SVN revision. Normally the
contents of an SVN revision should never change and 'reset'
should not be necessary. However, if SVN permissions change,
- or if you alter your --ignore-paths option, a 'fetch' may fail
+ or if you alter your `--ignore-paths` option, a 'fetch' may fail
with "not found in commit" (file not previously visible) or
"checksum mismatch" (missed a modification). If the problem
- file cannot be ignored forever (with --ignore-paths) the only
+ file cannot be ignored forever (with `--ignore-paths`) the only
way to repair the repo is to use 'reset'.
+
Only the rev_map and refs/remotes/git-svn are changed (see
@@ -735,8 +735,8 @@ ADVANCED OPTIONS
--follow-parent::
This option is only relevant if we are tracking branches (using
- one of the repository layout options --trunk, --tags,
- --branches, --stdlayout). For each tracked branch, try to find
+ one of the repository layout options `--trunk`, `--tags`,
+ `--branches`, `--stdlayout`). For each tracked branch, try to find
out where its revision was copied from, and set
a suitable parent in the first Git commit for the branch.
This is especially helpful when we're tracking a directory
@@ -747,7 +747,7 @@ ADVANCED OPTIONS
However, following long/convoluted histories can take a long
time, so disabling this feature may speed up the cloning
process. This feature is enabled by default, use
- --no-follow-parent to disable it.
+ `--no-follow-parent` to disable it.
+
[verse]
config key: svn.followparent
@@ -951,7 +951,7 @@ compatibility with SVN (see the CAVEATS section below).
HANDLING OF SVN BRANCHES
------------------------
-If 'git svn' is configured to fetch branches (and --follow-branches
+If 'git svn' is configured to fetch branches (and `--follow-branches`
is in effect), it sometimes creates multiple Git branches for one
SVN branch, where the additional branches have names of the form
'branchname@nnn' (with nnn an SVN revision number). These additional
@@ -1031,14 +1031,14 @@ before 'dcommit' on will require forcing an overwrite of the existing ref
on the remote repository. This is generally considered bad practice,
see the linkgit:git-push[1] documentation for details.
-Do not use the --amend option of linkgit:git-commit[1] on a change you've
-already dcommitted. It is considered bad practice to --amend commits
+Do not use the `--amend` option of linkgit:git-commit[1] on a change you've
+already dcommitted. It is considered bad practice to `--amend` commits
you've already pushed to a remote repository for other users, and
dcommit with SVN is analogous to that.
When cloning an SVN repository, if none of the options for describing
-the repository layout is used (--trunk, --tags, --branches,
---stdlayout), 'git svn clone' will create a Git repository with
+the repository layout is used (`--trunk`, `--tags`, `--branches`,
+`--stdlayout`), 'git svn clone' will create a Git repository with
completely linear history, where branches and tags appear as separate
directories in the working copy. While this is the easiest way to get a
copy of a complete repository, for projects with many branches it will
@@ -1051,7 +1051,7 @@ without giving any repository layout options. If the full history with
branches and tags is required, the options `--trunk` / `--branches` /
`--tags` must be used.
-When using multiple --branches or --tags, 'git svn' does not automatically
+When using multiple `--branches` or `--tags`, 'git svn' does not automatically
handle name collisions (for example, if two branches from different paths have
the same name, or if a branch and a tag have the same name). In these cases,
use 'init' to set up your Git repository then, before your first 'fetch', edit
@@ -1142,7 +1142,7 @@ Multiple fetch, branches, and tags keys are supported:
------------------------------------------------------------------------
Creating a branch in such a configuration requires disambiguating which
-location to use using the -d or --destination flag:
+location to use using the `-d` or `--destination` flag:
------------------------------------------------------------------------
$ git svn branch -d branches/server release-2-3-0
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 31a97a1b6c..b802972bb2 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -111,7 +111,7 @@ options for details.
--sort=<key>::
Sort based on the key given. Prefix `-` to sort in
- descending order of the value. You may use the --sort=<key> option
+ descending order of the value. You may use the `--sort=<key>` option
multiple times, in which case the last key becomes the primary
key. Also supports "version:refname" or "v:refname" (tag
names are treated as versions). The "version:refname" sort
@@ -236,7 +236,7 @@ On Re-tagging
What should you do when you tag a wrong commit and you would
want to re-tag?
-If you never pushed anything out, just re-tag it. Use "-f" to
+If you never pushed anything out, just re-tag it. Use `-f` to
replace the old one. And you're done.
But if you have pushed things out (or others could just read
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index 2853f168d9..936b64045e 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -56,21 +56,21 @@ OPTIONS
updates are needed by checking stat() information.
-q::
- Quiet. If --refresh finds that the index needs an update, the
+ Quiet. If `--refresh` finds that the index needs an update, the
default behavior is to error out. This option makes
'git update-index' continue anyway.
--ignore-submodules::
Do not try to update submodules. This option is only respected
- when passed before --refresh.
+ when passed before `--refresh`.
--unmerged::
- If --refresh finds unmerged changes in the index, the default
+ If `--refresh` finds unmerged changes in the index, the default
behavior is to error out. This option makes 'git update-index'
continue anyway.
--ignore-missing::
- Ignores missing files during a --refresh
+ Ignores missing files during a `--refresh`
--cacheinfo <mode>,<object>,<path>::
--cacheinfo <mode> <object> <path>::
@@ -140,13 +140,13 @@ you will need to handle the situation manually.
--force-remove::
Remove the file from the index even when the working directory
- still has such a file. (Implies --remove.)
+ still has such a file. (Implies `--remove`.)
--replace::
By default, when a file `path` exists in the index,
'git update-index' refuses an attempt to add `path/file`.
Similarly if a file `path/file` exists, a file `path`
- cannot be added. With --replace flag, existing entries
+ cannot be added. With `--replace` flag, existing entries
that conflict with the entry being added are
automatically removed with warning messages.
diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index 48b6683071..3c3da97c29 100644
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -37,7 +37,7 @@ them and update them as a regular file (i.e. it will allow the
filesystem to follow them, but will overwrite such a symlink to
somewhere else with a regular filename).
-If --no-deref is given, <ref> itself is overwritten, rather than
+If `--no-deref` is given, <ref> itself is overwritten, rather than
the result of following the symbolic pointers.
In general, using
@@ -164,12 +164,12 @@ stored in <ref>, "newsha1" is the 40 character hexadecimal value of
<newvalue> and "committer" is the committer's name, email address
and date in the standard Git committer ident format.
-Optionally with -m:
+Optionally with `-m`:
oldsha1 SP newsha1 SP committer TAB message LF
Where all fields are as described above and "message" is the
-value supplied to the -m option.
+value supplied to the `-m` option.
An update will fail (without changing <ref>) if the current user is
unable to create a new log file, append to the existing log file
diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt
index 61ca6d04c2..e1e537fcfb 100644
--- a/Documentation/git-verify-pack.txt
+++ b/Documentation/git-verify-pack.txt
@@ -38,7 +38,7 @@ OPTIONS
OUTPUT FORMAT
-------------
-When specifying the -v option the format used is:
+When specifying the `-v` option the format used is:
SHA-1 type size size-in-packfile offset-in-packfile
diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt
index 8d162b56c5..d53b2570df 100644
--- a/Documentation/git-web--browse.txt
+++ b/Documentation/git-web--browse.txt
@@ -62,7 +62,7 @@ CONF.VAR (from -c option) and web.browser
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The web browser can be specified using a configuration variable passed
-with the -c (or --config) command-line option, or the `web.browser`
+with the `-c` (or `--config`) command-line option, or the `web.browser`
configuration variable if the former is not used.
browser.<tool>.path
diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt
index 8b63ceb00e..798a43965b 100644
--- a/Documentation/git-whatchanged.txt
+++ b/Documentation/git-whatchanged.txt
@@ -35,7 +35,7 @@ Examples
`git whatchanged --since="2 weeks ago" -- gitk`::
Show the changes during the last two weeks to the file 'gitk'.
- The "--" is necessary to avoid confusion with the *branch* named
+ The `--` is necessary to avoid confusion with the *branch* named
'gitk'
GIT
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 3a9c44987f..fc49a4fd42 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -566,9 +566,9 @@ Git Commits
Git Diffs
~~~~~~~~~
`GIT_DIFF_OPTS`::
- Only valid setting is "--unified=??" or "-u??" to set the
+ Only valid setting is `--unified=??` or `-u??` to set the
number of context lines shown when a unified diff is created.
- This takes precedence over any "-U" or "--unified" option
+ This takes precedence over any `-U` or `--unified` option
value passed on the Git diff command line.
`GIT_EXTERNAL_DIFF`::
diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
index c0b95256cc..633439702f 100644
--- a/Documentation/gitcore-tutorial.txt
+++ b/Documentation/gitcore-tutorial.txt
@@ -941,7 +941,7 @@ branch head. Please see linkgit:gitrevisions[7] if you want to
see more complex cases.
[NOTE]
-Without the '--more=1' option, 'git show-branch' would not output the
+Without the `--more=1` option, 'git show-branch' would not output the
'[master^]' commit, as '[mybranch]' commit is a common ancestor of
both 'master' and 'mybranch' tips. Please see linkgit:git-show-branch[1]
for details.
diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt
index 0d57f86abc..fbc458c3e5 100644
--- a/Documentation/gitdiffcore.txt
+++ b/Documentation/gitdiffcore.txt
@@ -55,7 +55,7 @@ is under consideration.
The result of comparison is passed from these commands to what is
internally called "diffcore", in a format similar to what is output
-when the -p option is not used. E.g.
+when the `-p` option is not used. E.g.
------------------------------------------------
in-place edit :100644 100644 bcd1234... 0123456... M file0
@@ -89,7 +89,7 @@ diffcore-break: For Splitting Up Complete Rewrites
--------------------------------------------------
The second transformation in the chain is diffcore-break, and is
-controlled by the -B option to the 'git diff-{asterisk}' commands. This is
+controlled by the `-B` option to the 'git diff-{asterisk}' commands. This is
used to detect a filepair that represents "complete rewrite" and
break such filepair into two filepairs that represent delete and
create. E.g. If the input contained this filepair:
@@ -117,14 +117,14 @@ score defaults to 50% of the size of the smaller of the original
and the result (i.e. if the edit shrinks the file, the size of
the result is used; if the edit lengthens the file, the size of
the original is used), and can be customized by giving a number
-after "-B" option (e.g. "-B75" to tell it to use 75%).
+after `-B` option (e.g. `-B75` to tell it to use 75%).
diffcore-rename: For Detecting Renames and Copies
-------------------------------------------------
This transformation is used to detect renames and copies, and is
-controlled by the -M option (to detect renames) and the -C option
+controlled by the `-M` option (to detect renames) and the `-C` option
(to detect copies as well) to the 'git diff-{asterisk}' commands. If the
input contained these filepairs:
@@ -141,9 +141,9 @@ merges these filepairs and creates:
:100644 100644 0123456... 0123456... R100 fileX file0
------------------------------------------------
-When the "-C" option is used, the original contents of modified files,
+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:
@@ -166,7 +166,7 @@ In both rename and copy detection, the same "extent of changes"
algorithm used in diffcore-break is used to determine if two
files are "similar enough", and can be customized to use
a similarity score different from the default of 50% by giving a
-number after the "-M" or "-C" option (e.g. "-M8" to tell it to use
+number after the `-M` or `-C` option (e.g. `-M8` to tell it to use
8/10 = 80%).
Note that when rename detection is on but both copy and break
@@ -189,7 +189,7 @@ preliminary pass; so if there are several remaining ext.txt files
throughout the directory hierarchy after exact rename detection, this
preliminary step may be skipped for those files.
-Note. When the "-C" option is used with `--find-copies-harder`
+Note. When the `-C` option is used with `--find-copies-harder`
option, 'git diff-{asterisk}' commands feed unmodified filepairs to
diffcore mechanism as well as modified ones. This lets the copy
detector consider unmodified files as copy source candidates at
@@ -222,13 +222,13 @@ transformation merges them back into the original
The "extent of changes" parameter can be tweaked from the
default 80% (that is, unless more than 80% of the original
material is deleted, the broken pairs are merged back into a
-single modification) by giving a second number to -B option,
+single modification) by giving a second number to `-B` option,
like these:
-* -B50/60 (give 50% "break score" to diffcore-break, use 60%
+* `-B50/60` (give 50% "break score" to diffcore-break, use 60%
for diffcore-merge-broken).
-* -B/60 (the same as above, since diffcore-break defaults to 50%).
+* `-B/60` (the same as above, since diffcore-break defaults to 50%).
Note that earlier implementation left a broken pair as a separate
creation and deletion patches. This was an unnecessary hack and
@@ -245,10 +245,10 @@ diffcore-pickaxe: For Detecting Addition/Deletion of Specified String
This transformation limits the set of filepairs to those that change
specified strings between the preimage and the postimage in a certain
-way. -S<block of text> and -G<regular expression> options are used to
+way. `-S<block of text>` and `-G<regular expression>` options are used to
specify different ways these strings are sought.
-"-S<block of text>" detects filepairs whose preimage and postimage
+`-S<block of text>` detects filepairs whose preimage and postimage
have different number of occurrences of the specified block of text.
By definition, it will not detect in-file moves. Also, when a
changeset moves a file wholesale without affecting the interesting
@@ -258,7 +258,7 @@ rename-detected filepair). When used with `--pickaxe-regex`, treat
the <block of text> as an extended POSIX regular expression to match,
instead of a literal string.
-"-G<regular expression>" (mnemonic: grep) detects filepairs whose
+`-G<regular expression>` (mnemonic: grep) detects filepairs whose
textual diff has an added or a deleted line that matches the given
regular expression. This means that it will detect in-file (or what
rename-detection considers the same file) moves, which is noise. The
@@ -277,7 +277,7 @@ diffcore-order: For Sorting the Output Based on Filenames
---------------------------------------------------------
This is used to reorder the filepairs according to the user's
-(or project's) taste, and is controlled by the -O option to the
+(or project's) taste, and is controlled by the `-O` option to the
'git diff-{asterisk}' commands.
This takes a text file each of whose lines is a shell glob
diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index d50e9ed10e..6ceeae227c 100644
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -112,7 +112,7 @@ include::line-range-options.txt[]
<path>...::
Limit commits to the ones touching files in the given paths. Note, to
- avoid ambiguity with respect to revision names use "--" to separate the paths
+ avoid ambiguity with respect to revision names use `--` to separate the paths
from any preceding options.
gitk-specific options
@@ -130,7 +130,7 @@ gitk-specific options
--select-commit=<ref>::
Select the specified commit after loading the graph.
- Default behavior is equivalent to specifying '--select-commit=HEAD'.
+ Default behavior is equivalent to specifying `--select-commit=HEAD`.
Examples
--------
@@ -142,7 +142,7 @@ gitk v2.6.12.. include/scsi drivers/scsi::
gitk --since="2 weeks ago" \-- gitk::
Show the changes during the last two weeks to the file 'gitk'.
- The "--" is necessary to avoid confusion with the *branch* named
+ The `--` is necessary to avoid confusion with the *branch* named
'gitk'
gitk --max-count=100 --all \-- Makefile::
diff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt
index 8bdb7d0bd3..e1e09070ad 100644
--- a/Documentation/gittutorial-2.txt
+++ b/Documentation/gittutorial-2.txt
@@ -318,7 +318,7 @@ index a042389..513feba 100644
------------------------------------------------
At any time, we can create a new commit using 'git commit' (without
-the "-a" option), and verify that the state committed only includes the
+the `-a` option), and verify that the state committed only includes the
changes stored in the index file, not the additional change that is
still only in our working tree:
@@ -336,7 +336,7 @@ index 513feba..ba3da7b 100644
------------------------------------------------
So by default 'git commit' uses the index to create the commit, not
-the working tree; the "-a" option to commit tells it to first update
+the working tree; the `-a` option to commit tells it to first update
the index with all changes in the working tree.
Finally, it's worth looking at the effect of 'git add' on the index
diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt
index 59ef5cef1f..ff366cc752 100644
--- a/Documentation/gittutorial.txt
+++ b/Documentation/gittutorial.txt
@@ -95,13 +95,13 @@ $ git add file1 file2 file3
------------------------------------------------
You are now ready to commit. You can see what is about to be committed
-using 'git diff' with the --cached option:
+using 'git diff' with the `--cached` option:
------------------------------------------------
$ git diff --cached
------------------------------------------------
-(Without --cached, 'git diff' will show you any changes that
+(Without `--cached`, 'git diff' will show you any changes that
you've made but not yet added to the index.) You can also get a brief
summary of the situation with 'git status':
diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt
index 7963a79ba9..181c543a64 100644
--- a/Documentation/gitweb.conf.txt
+++ b/Documentation/gitweb.conf.txt
@@ -459,14 +459,14 @@ $fallback_encoding::
@diff_opts::
Rename detection options for git-diff and git-diff-tree. The default is
- (\'-M'); set it to (\'-C') or (\'-C', \'-C') to also detect copies,
- or set it to () i.e. empty list if you don't want to have renames
+ `('-M')`; set it to `('-C')` or `('-C', '-C')` to also detect copies,
+ or set it to `()` i.e. empty list if you don't want to have renames
detection.
+
*Note* that rename and especially copy detection can be quite
CPU-intensive. Note also that non Git tools can have problems with
patches generated with options mentioned above, especially when they
-involve file copies (\'-C') or criss-cross renames (\'-B').
+involve file copies `('-C')` or criss-cross renames `('-B')`.
Some optional features and policies
diff --git a/Documentation/howto/revert-branch-rebase.txt b/Documentation/howto/revert-branch-rebase.txt
index a3e5595a56..29b15a1173 100644
--- a/Documentation/howto/revert-branch-rebase.txt
+++ b/Documentation/howto/revert-branch-rebase.txt
@@ -54,7 +54,7 @@ since then. I just limited the output to the first handful using
Now I know 'master^2~4' (pronounce it as "find the second parent of
the 'master', and then go four generations back following the first
parent") is the one I would want to revert. Since I also want to say
-why I am reverting it, the '-n' flag is given to 'git revert'. This
+why I am reverting it, the `-n` flag is given to 'git revert'. This
prevents it from actually making a commit, and instead 'git revert'
leaves the commit log message it wanted to use in '.msg' file:
diff --git a/Documentation/howto/setup-git-server-over-http.txt b/Documentation/howto/setup-git-server-over-http.txt
index bfe6f9b500..7a34937da0 100644
--- a/Documentation/howto/setup-git-server-over-http.txt
+++ b/Documentation/howto/setup-git-server-over-http.txt
@@ -163,7 +163,7 @@ Create this file by
$ htpasswd -c /etc/apache2/passwd.git <user>
You will be asked a password, and the file is created. Subsequent calls
-to htpasswd should omit the '-c' option, since you want to append to the
+to htpasswd should omit the `-c` option, since you want to append to the
existing file.
You need to restart Apache.
diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
index eb0aabd396..bf43c33d27 100644
--- a/Documentation/merge-options.txt
+++ b/Documentation/merge-options.txt
@@ -1,16 +1,16 @@
--commit::
--no-commit::
Perform the merge and commit the result. This option can
- be used to override --no-commit.
+ be used to override `--no-commit`.
+
-With --no-commit perform the merge and stop just before creating
+With `--no-commit` perform the merge and stop just before creating
a merge commit, to give the user a chance to inspect and further
tweak the merge result before committing.
+
Note that fast-forward updates do not create a merge commit and
-therefore there is no way to stop those merges with --no-commit.
+therefore there is no way to stop those merges with `--no-commit`.
Thus, if you want to ensure your branch is not changed or updated
-by the merge command, use --no-ff with --no-commit.
+by the merge command, use `--no-ff` with `--no-commit`.
--edit::
-e::
@@ -74,7 +74,7 @@ When not possible, refuse to merge and exit with a non-zero status.
one-line descriptions from at most <n> actual commits that are being
merged. See also linkgit:git-fmt-merge-msg[1].
+
-With --no-log do not list one-line descriptions from the
+With `--no-log` do not list one-line descriptions from the
actual commits being merged.
include::signoff-option.txt[]
@@ -85,7 +85,7 @@ include::signoff-option.txt[]
Show a diffstat at the end of the merge. The diffstat is also
controlled by the configuration option merge.stat.
+
-With -n or --no-stat do not show a diffstat at the end of the
+With `-n` or `--no-stat` do not show a diffstat at the end of the
merge.
--squash::
@@ -98,10 +98,10 @@ merge.
the current branch whose effect is the same as merging another
branch (or more in case of an octopus).
+
-With --no-squash perform the merge and commit the result. This
-option can be used to override --squash.
+With `--no-squash` perform the merge and commit the result. This
+option can be used to override `--squash`.
+
-With --squash, --commit is not allowed, and will fail.
+With `--squash`, `--commit` is not allowed, and will fail.
--no-verify::
This option bypasses the pre-merge and commit-msg hooks.
@@ -130,13 +130,13 @@ With --squash, --commit is not allowed, and will fail.
--summary::
--no-summary::
- Synonyms to --stat and --no-stat; these are deprecated and will be
+ Synonyms to `--stat` and `--no-stat`; these are deprecated and will be
removed in the future.
ifndef::git-pull[]
-q::
--quiet::
- Operate quietly. Implies --no-progress.
+ Operate quietly. Implies `--no-progress`.
-v::
--verbose::
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index 45133066e4..d8a755faf1 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -93,8 +93,8 @@ confused as starting a new commit.
+
The 'raw' format shows the entire commit exactly as
stored in the commit object. Notably, the hashes are
-displayed in full, regardless of whether --abbrev or
---no-abbrev are used, and 'parents' information show the
+displayed in full, regardless of whether `--abbrev` or
+`--no-abbrev` are used, and 'parents' information show the
true parent commits, without taking grafts or history
simplification into account. Note that this format affects the way
commits are displayed, but not the way the diff is shown e.g. with
@@ -144,7 +144,7 @@ The placeholders are:
on the next placeholders until the color is switched
again.
'%m':: left (`<`), right (`>`) or boundary (`-`) mark
-'%w([<w>[,<i1>[,<i2>]]])':: switch line wrapping, like the -w option of
+'%w([<w>[,<i1>[,<i2>]]])':: switch line wrapping, like the `-w` option of
linkgit:git-shortlog[1].
'%<(<N>[,trunc|ltrunc|mtrunc])':: make the next placeholder take at
least N columns, padding spaces on
@@ -183,7 +183,7 @@ The placeholders are:
'%al':: author email local-part (the part before the '@' sign)
'%aL':: author local-part (see '%al') respecting .mailmap, see
linkgit:git-shortlog[1] or linkgit:git-blame[1])
-'%ad':: author date (format respects --date= option)
+'%ad':: author date (format respects `--date=` option)
'%aD':: author date, RFC2822 style
'%ar':: author date, relative
'%at':: author date, UNIX timestamp
@@ -199,14 +199,14 @@ The placeholders are:
'%cl':: committer email local-part (the part before the '@' sign)
'%cL':: committer local-part (see '%cl') respecting .mailmap, see
linkgit:git-shortlog[1] or linkgit:git-blame[1])
-'%cd':: committer date (format respects --date= option)
+'%cd':: committer date (format respects `--date=` option)
'%cD':: committer date, RFC2822 style
'%cr':: committer date, relative
'%ct':: committer date, UNIX timestamp
'%ci':: committer date, ISO 8601-like format
'%cI':: committer date, strict ISO 8601 format
'%cs':: committer date, short format (`YYYY-MM-DD`)
-'%d':: ref names, like the --decorate option of linkgit:git-log[1]
+'%d':: ref names, like the `--decorate` option of linkgit:git-log[1]
'%D':: ref names without the " (", ")" wrapping.
'%(describe[:options])':: human-readable name, like
linkgit:git-describe[1]; empty string for
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index 27ddaf84a1..f8c61dd42e 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -6,7 +6,7 @@
'full', 'fuller', 'reference', 'email', 'raw', 'format:<string>'
and 'tformat:<string>'. When '<format>' is none of the above,
and has '%placeholder' in it, it acts as if
- '--pretty=tformat:<format>' were given.
+ `--pretty=tformat:<format>` were given.
+
See the "PRETTY FORMATS" section for some additional details for each
format. When '=<format>' part is omitted, it defaults to 'medium'.
@@ -17,19 +17,19 @@ configuration (see linkgit:git-config[1]).
--abbrev-commit::
Instead of showing the full 40-byte hexadecimal commit object
name, show a prefix that names the object uniquely.
- "--abbrev=<n>" (which also modifies diff output, if it is displayed)
+ `--abbrev=<n>` (which also modifies diff output, if it is displayed)
option can be used to specify the minimum length of the prefix.
+
-This should make "--pretty=oneline" a whole lot more readable for
+This should make `--pretty=oneline` a whole lot more readable for
people using 80-column terminals.
--no-abbrev-commit::
Show the full 40-byte hexadecimal commit object name. This negates
`--abbrev-commit`, either explicit or implied by other options such
- as "--oneline". It also overrides the `log.abbrevCommit` variable.
+ as `--oneline`. It also overrides the `log.abbrevCommit` variable.
--oneline::
- This is a shorthand for "--pretty=oneline --abbrev-commit"
+ This is a shorthand for `--pretty=oneline --abbrev-commit`
used together.
--encoding=<encoding>::
@@ -73,21 +73,21 @@ to display. The ref can specify the full refname when it begins
with `refs/notes/`; when it begins with `notes/`, `refs/` and otherwise
`refs/notes/` is prefixed to form a full name of the ref.
+
-Multiple --notes options can be combined to control which notes are
-being displayed. Examples: "--notes=foo" will show only notes from
-"refs/notes/foo"; "--notes=foo --notes" will show both notes from
+Multiple `--notes` options can be combined to control which notes are
+being displayed. Examples: `--notes=foo` will show only notes from
+"refs/notes/foo"; `--notes=foo --notes` will show both notes from
"refs/notes/foo" and from the default notes ref(s).
--no-notes::
Do not show notes. This negates the above `--notes` option, by
resetting the list of notes refs from which notes are shown.
Options are parsed in the order given on the command line, so e.g.
- "--notes --notes=foo --no-notes --notes=bar" will only show notes
+ `--notes --notes=foo --no-notes --notes=bar` will only show notes
from "refs/notes/bar".
--show-notes[=<ref>]::
--[no-]standard-notes::
- These options are deprecated. Use the above --notes/--no-notes
+ These options are deprecated. Use the above `--notes`/`--no-notes`
options instead.
endif::git-rev-list[]
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index b1c8f86c6e..965cb32f9c 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -885,38 +885,38 @@ ifdef::git-rev-list[]
blobs) from the list of printed objects. The '<filter-spec>'
may be one of the following:
+
-The form '--filter=blob:none' omits all blobs.
+The form `--filter=blob:none` omits all blobs.
+
-The form '--filter=blob:limit=<n>[kmg]' omits blobs larger than n bytes
+The form `--filter=blob:limit=<n>[kmg]` omits blobs larger than n bytes
or units. n may be zero. The suffixes k, m, and g can be used to name
units in KiB, MiB, or GiB. For example, 'blob:limit=1k' is the same
as 'blob:limit=1024'.
+
-The form '--filter=sparse:oid=<blob-ish>' uses a sparse-checkout
+The form `--filter=sparse:oid=<blob-ish>` uses a sparse-checkout
specification contained in the blob (or blob-expression) '<blob-ish>'
to omit blobs that would not be not required for a sparse checkout on
the requested refs.
+
-The form '--filter=tree:<depth>' omits all blobs and trees whose depth
+The form `--filter=tree:<depth>` omits all blobs and trees whose depth
from the root tree is >= <depth> (minimum depth if an object is located
at multiple depths in the commits traversed). <depth>=0 will not include
any trees or blobs unless included explicitly in the command-line (or
-standard input when --stdin is used). <depth>=1 will include only the
+standard input when `--stdin` is used). <depth>=1 will include only the
tree and blobs which are referenced directly by a commit reachable from
<commit> or an explicitly-given object. <depth>=2 is like <depth>=1
while also including trees and blobs one more level removed from an
explicitly-given commit or tree.
+
-Note that the form '--filter=sparse:path=<path>' that wants to read
+Note that the form `--filter=sparse:path=<path>` that wants to read
from an arbitrary path on the filesystem has been dropped for security
reasons.
+
-Multiple '--filter=' flags can be specified to combine filters. Only
+Multiple `--filter=` flags can be specified to combine filters. Only
objects which are accepted by every filter are included.
+
-The form '--filter=combine:<filter1>+<filter2>+...<filterN>' can also be
+The form `--filter=combine:<filter1>+<filter2>+...<filterN>` can also be
used to combined several filters, but this is harder than just repeating
-the '--filter' flag and is usually not necessary. Filters are joined by
+the `--filter` flag and is usually not necessary. Filters are joined by
'{plus}' and individual filters are %-encoded (i.e. URL-encoded).
Besides the '{plus}' and '%' characters, the following characters are
reserved and also must be encoded: `~!@#$^&*()[]{}\;",<>?`+'`+
@@ -938,18 +938,18 @@ equivalent.
A debug option to help with future "partial clone" development.
This option specifies how missing objects are handled.
+
-The form '--missing=error' requests that rev-list stop with an error if
+The form `--missing=error` requests that rev-list stop with an error if
a missing object is encountered. This is the default action.
+
-The form '--missing=allow-any' will allow object traversal to continue
+The form `--missing=allow-any` will allow object traversal to continue
if a missing object is encountered. Missing objects will silently be
omitted from the results.
+
-The form '--missing=allow-promisor' is like 'allow-any', but will only
+The form `--missing=allow-promisor` is like 'allow-any', but will only
allow object traversal to continue for EXPECTED promisor missing objects.
Unexpected missing objects will raise an error.
+
-The form '--missing=print' is like 'allow-any', but will also print a
+The form `--missing=print` is like 'allow-any', but will also print a
list of the missing objects. Object IDs are prefixed with a ``?'' character.
--exclude-promisor-objects::
@@ -1113,7 +1113,7 @@ This implies the `--topo-order` option by default, but the
`--date-order` option may also be specified.
--show-linear-break[=<barrier>]::
- When --graph is not used, all history branches are flattened
+ When `--graph` is not used, all history branches are flattened
which can make it hard to see that the two consecutive commits
do not belong to a linear branch. This option puts a barrier
in between them in that case. If `<barrier>` is specified, it
diff --git a/Documentation/signoff-option.txt b/Documentation/signoff-option.txt
index 12aa2333e4..597d057c6e 100644
--- a/Documentation/signoff-option.txt
+++ b/Documentation/signoff-option.txt
@@ -14,5 +14,5 @@ endif::git-commit[]
leadership of the project to which you're contributing to
understand how the signoffs are used in that project.
+
-The --no-signoff option can be used to countermand an earlier --signoff
+The `--no-signoff` option can be used to countermand an earlier `--signoff`
option on the command line.
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index 1c229d7581..c50ddd3120 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -44,13 +44,13 @@ syntaxes may be used:
ifndef::git-clone[]
These two syntaxes are mostly equivalent, except when cloning, when
-the former implies --local option. See linkgit:git-clone[1] for
+the former implies `--local` option. See linkgit:git-clone[1] for
details.
endif::git-clone[]
ifdef::git-clone[]
These two syntaxes are mostly equivalent, except the former implies
---local option.
+`--local` option.
endif::git-clone[]
'git clone', 'git fetch' and 'git pull', but not 'git push', will also
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index fd480b8645..0f9a699c09 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -293,7 +293,7 @@ ref: refs/heads/master
=== Examining an old version without creating a new branch
The `git switch` command normally expects a branch head, but will also
-accept an arbitrary commit when invoked with --detach; for example,
+accept an arbitrary commit when invoked with `--detach`; for example,
you can check out the commit referenced by a tag:
------------------------------------------------
@@ -305,7 +305,7 @@ changes and commit them, and you can discard any commits you make in this
state without impacting any branches by performing another switch.
If you want to create a new branch to retain commits you create, you may
-do so (now or later) by using -c with the switch command again. Example:
+do so (now or later) by using `-c` with the switch command again. Example:
git switch -c new_branch_name
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 02/13] doc: typeset branches and remotes in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 01/13] doc: typeset command-line options in monospace Firmin Martin
@ 2021-04-09 4:02 ` Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 03/13] doc: typeset configuration options " Firmin Martin
` (11 subsequent siblings)
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Wrap branch and remote names with backticks as indicated in the
CodingGuidelines.
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/diff-options.txt | 2 +-
Documentation/git-add.txt | 10 +--
Documentation/git-am.txt | 4 +-
Documentation/git-archimport.txt | 2 +-
Documentation/git-bisect-lk2009.txt | 10 +--
Documentation/git-bisect.txt | 6 +-
Documentation/git-branch.txt | 22 +++---
Documentation/git-bundle.txt | 6 +-
Documentation/git-check-ref-format.txt | 2 +-
Documentation/git-checkout.txt | 2 +-
Documentation/git-cherry-pick.txt | 22 +++---
Documentation/git-cherry.txt | 4 +-
Documentation/git-clone.txt | 16 ++---
Documentation/git-commit-tree.txt | 2 +-
Documentation/git-commit.txt | 6 +-
Documentation/git-config.txt | 2 +-
Documentation/git-cvsimport.txt | 8 +--
Documentation/git-cvsserver.txt | 2 +-
Documentation/git-describe.txt | 6 +-
Documentation/git-diff-index.txt | 6 +-
Documentation/git-diff.txt | 20 +++---
Documentation/git-fast-export.txt | 16 ++---
Documentation/git-fetch-pack.txt | 2 +-
Documentation/git-fetch.txt | 4 +-
Documentation/git-filter-branch.txt | 2 +-
Documentation/git-fmt-merge-msg.txt | 4 +-
Documentation/git-for-each-ref.txt | 12 ++--
Documentation/git-format-patch.txt | 4 +-
Documentation/git-http-push.txt | 6 +-
Documentation/git-log.txt | 8 +--
Documentation/git-ls-remote.txt | 2 +-
Documentation/git-merge.txt | 2 +-
Documentation/git-notes.txt | 12 ++--
Documentation/git-p4.txt | 4 +-
Documentation/git-pull.txt | 4 +-
Documentation/git-push.txt | 8 +--
Documentation/git-read-tree.txt | 4 +-
Documentation/git-rebase.txt | 92 +++++++++++++-------------
Documentation/git-reflog.txt | 4 +-
Documentation/git-request-pull.txt | 2 +-
Documentation/git-rerere.txt | 34 +++++-----
Documentation/git-reset.txt | 6 +-
Documentation/git-rev-parse.txt | 4 +-
Documentation/git-revert.txt | 8 +--
Documentation/git-rm.txt | 2 +-
Documentation/git-show-ref.txt | 2 +-
Documentation/git-show.txt | 2 +-
Documentation/git-stash.txt | 8 +--
Documentation/git-status.txt | 12 ++--
Documentation/git-submodule.txt | 28 ++++----
Documentation/git-svn.txt | 20 +++---
Documentation/git-switch.txt | 10 +--
Documentation/git-symbolic-ref.txt | 2 +-
Documentation/git-tag.txt | 2 +-
Documentation/git-update-ref.txt | 4 +-
Documentation/git-worktree.txt | 2 +-
Documentation/git.txt | 4 +-
Documentation/gitcli.txt | 2 +-
Documentation/gitcore-tutorial.txt | 36 +++++-----
Documentation/giteveryday.txt | 16 ++---
Documentation/githooks.txt | 8 +--
Documentation/gitk.txt | 2 +-
Documentation/gitnamespaces.txt | 2 +-
Documentation/gitremote-helpers.txt | 6 +-
Documentation/gitrepository-layout.txt | 4 +-
Documentation/gittutorial-2.txt | 2 +-
Documentation/gittutorial.txt | 44 ++++++------
Documentation/gitweb.txt | 4 +-
Documentation/gitworkflows.txt | 70 ++++++++++----------
Documentation/glossary-content.txt | 12 ++--
Documentation/rev-list-options.txt | 2 +-
Documentation/revisions.txt | 52 +++++++--------
Documentation/user-manual.txt | 78 +++++++++++-----------
73 files changed, 421 insertions(+), 421 deletions(-)
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 13e0753862..e4ac746428 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -803,7 +803,7 @@ endif::git-format-patch[]
Ignore changes to submodules in the diff generation. <when> can be
either "none", "untracked", "dirty" or "all", which is the default.
Using "none" will consider the submodule modified when it either contains
- untracked or modified files or its HEAD differs from the commit recorded
+ untracked or modified files or its `HEAD` differs from the commit recorded
in the superproject and can be used to override any settings of the
'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
"untracked" is used submodules are not considered dirty when they only
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index 6a7cb07a8a..8ec99c5c12 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -256,7 +256,7 @@ The main command loop has 6 subcommands (plus help and quit).
status::
- This shows the change between HEAD and index (i.e. what will be
+ This shows the change between `HEAD` and index (i.e. what will be
committed if you say `git commit`), and between index and
working tree files (i.e. what you could stage further before
`git commit` using `git add`) for each path. A sample output
@@ -268,7 +268,7 @@ status::
2: +403/-35 +1/-1 git-add--interactive.perl
------------
+
-It shows that foo.png has differences from HEAD (but that is
+It shows that foo.png has differences from `HEAD` (but that is
binary so line count cannot be shown) and there is no
difference between indexed copy and the working tree
version (if the working tree version were also different,
@@ -311,7 +311,7 @@ revert::
This has a very similar UI to 'update', and the staged
information for selected paths are reverted to that of the
- HEAD version. Reverting new paths makes them untracked.
+ `HEAD` version. Reverting new paths makes them untracked.
add untracked::
@@ -350,7 +350,7 @@ variable `interactive.singleKey` to `true`.
diff::
This lets you review what will be committed (i.e. between
- HEAD and index).
+ `HEAD` and index).
EDITING PATCHES
@@ -389,7 +389,7 @@ There are also more complex operations that can be performed. But beware
that because the patch is applied only to the index and not the working
tree, the working tree will appear to "undo" the change in the index.
For example, introducing a new line into the index that is in neither
-the HEAD nor the working tree will stage the new line for commit, but
+the `HEAD` nor the working tree will stage the new line for commit, but
the line will appear to be reverted in the working tree.
Avoid using these constructs, or do so with extreme caution.
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index decd8ae122..cd56054be0 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -176,7 +176,7 @@ default. You can use `--no-utf8` to override this.
Restore the original branch and abort the patching operation.
--quit::
- Abort the patching operation but keep HEAD and the index
+ Abort the patching operation but keep `HEAD` and the index
untouched.
--show-current-patch[=(diff|raw)]::
@@ -229,7 +229,7 @@ operation is finished, so if you decide to start over from scratch,
run `git am --abort` before running the command with mailbox
names.
-Before any patches are applied, ORIG_HEAD is set to the tip of the
+Before any patches are applied, `ORIG_HEAD` is set to the tip of the
current branch. This is useful if you have problems with multiple
commits, like running 'git am' on the wrong branch or an error in the
commits that is more easily fixed by changing the mailbox (e.g.
diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt
index b477e3c495..6e2dec5ef1 100644
--- a/Documentation/git-archimport.txt
+++ b/Documentation/git-archimport.txt
@@ -45,7 +45,7 @@ archives that it imports, it is also possible to specify Git branch names
manually. To do so, write a Git branch name after each <archive/branch>
parameter, separated by a colon. This way, you can shorten the Arch
branch names and convert Arch jargon to Git jargon, for example mapping a
-"PROJECT{litdd}devo{litdd}VERSION" branch to "master".
+"PROJECT{litdd}devo{litdd}VERSION" branch to `master`.
Associating multiple Arch branches to one Git branch is possible; the
result will make the most sense only if no commits are made to the first
diff --git a/Documentation/git-bisect-lk2009.txt b/Documentation/git-bisect-lk2009.txt
index f3d9566c89..1276424d65 100644
--- a/Documentation/git-bisect-lk2009.txt
+++ b/Documentation/git-bisect-lk2009.txt
@@ -767,8 +767,8 @@ They cannot be on a branch that has no link with the branch of the
bad commit and yet not be neither one of its ancestor nor one of its
descendants.
-For example, there can be a "main" branch, and a "dev" branch that was
-forked of the main branch at a commit named "D" like this:
+For example, there can be a `main` branch, and a `dev` branch that was
+forked of the `main` branch at a commit named "D" like this:
-------------
A-B-C-D-E-F-G <--main
@@ -776,7 +776,7 @@ A-B-C-D-E-F-G <--main
H-I-J <--dev
-------------
-The commit "D" is called a "merge base" for branch "main" and "dev"
+The commit "D" is called a "merge base" for branch `main` and `dev`
because it's the best common ancestor for these branches for a merge.
Now let's suppose that commit J is bad and commit G is good and that
@@ -794,7 +794,7 @@ H-I-J
-------------
But what happens if the first bad commit is "B" and if it has been
-fixed in the "main" branch by commit "F"?
+fixed in the `main` branch by commit "F"?
The result of such a bisection would be that we would find that H is
the first bad commit, when in fact it's B. So that would be wrong!
@@ -1229,7 +1229,7 @@ message or the author. And it can also be used instead of git "grafts"
to link a repository with another old repository.
In fact it's this last feature that "sold" it to the Git community, so
-it is now in the "master" branch of Git's Git repository and it should
+it is now in the `master` branch of Git's Git repository and it should
be released in Git 1.6.5 in October or November 2009.
One problem with "git replace" is that currently it stores all the
diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
index fbb39fbdf5..ff50c66e29 100644
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt
@@ -98,7 +98,7 @@ Bisect reset
~~~~~~~~~~~~
After a bisect session, to clean up the bisection state and return to
-the original HEAD, issue the following command:
+the original `HEAD`, issue the following command:
------------------------------------------------
$ git bisect reset
@@ -379,7 +379,7 @@ branch contained broken or non-buildable commits, but the merge itself was OK.
EXAMPLES
--------
-* Automatically bisect a broken build between v1.2 and HEAD:
+* Automatically bisect a broken build between v1.2 and `HEAD`:
+
------------
$ git bisect start HEAD v1.2 -- # HEAD is bad, v1.2 is good
@@ -387,7 +387,7 @@ $ git bisect run make # "make" builds the app
$ git bisect reset # quit the bisect session
------------
-* Automatically bisect a test failure between origin and HEAD:
+* Automatically bisect a test failure between `origin` and `HEAD`:
+
------------
$ git bisect start HEAD origin -- # HEAD is bad, origin is good
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 271b4ee34e..fa38fa4dc1 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -175,7 +175,7 @@ This option is only applicable in non-verbose mode.
the pattern(s).
--show-current::
- Print the name of the current branch. In detached HEAD state,
+ Print the name of the current branch. In detached `HEAD` state,
nothing is printed.
-v::
@@ -186,7 +186,7 @@ This option is only applicable in non-verbose mode.
relationship to upstream branch (if any). If given twice, print
the path of the linked worktree (if any) and the name of the upstream
branch, as well (see also `git remote show <remote>`). Note that the
- current worktree's HEAD will not have its path printed (it will always
+ current worktree's `HEAD` will not have its path printed (it will always
be your current directory).
-q::
@@ -250,15 +250,15 @@ start-point is either a local or remote-tracking branch.
--no-contains [<commit>]::
Only list branches which don't contain the specified commit
- (HEAD if not specified). Implies `--list`.
+ (`HEAD` if not specified). Implies `--list`.
--merged [<commit>]::
Only list branches whose tips are reachable from the
- specified commit (HEAD if not specified). Implies `--list`.
+ specified commit (`HEAD` if not specified). Implies `--list`.
--no-merged [<commit>]::
Only list branches whose tips are not reachable from the
- specified commit (HEAD if not specified). Implies `--list`.
+ specified commit (`HEAD` if not specified). Implies `--list`.
<branchname>::
The name of the branch to create or delete.
@@ -269,7 +269,7 @@ start-point is either a local or remote-tracking branch.
<start-point>::
The new branch head will point to this commit. It may be
given as a branch name, a commit-id, or a tag. If this
- option is omitted, the current HEAD will be used instead.
+ option is omitted, the current `HEAD` will be used instead.
<oldbranch>::
The name of an existing branch to rename.
@@ -286,7 +286,7 @@ start-point is either a local or remote-tracking branch.
for-each-ref`. Sort order defaults to the value configured for the
`branch.sort` variable if exists, or to sorting based on the
full refname (including `refs/...` prefix). This lists
- detached HEAD (if present) first, then local branches and
+ detached `HEAD` (if present) first, then local branches and
finally remote-tracking branches. See linkgit:git-config[1].
@@ -328,10 +328,10 @@ $ git branch -d -r origin/todo origin/html origin/man <1>
$ git branch -D test <2>
------------
+
-<1> Delete the remote-tracking branches "todo", "html" and "man". The next
+<1> Delete the remote-tracking branches `todo`, `html` and `man`. The next
'fetch' or 'pull' will create them again unless you configure them not to.
See linkgit:git-fetch[1].
-<2> Delete the "test" branch even if the "master" branch (or whichever branch
+<2> Delete the `test` branch even if the `master` branch (or whichever branch
is currently checked out) does not have all commits from the test branch.
Listing branches from a specific remote::
@@ -365,10 +365,10 @@ serve four related but different purposes:
contain the specified <commit>.
- `--merged` is used to find all branches which can be safely deleted,
- since those branches are fully contained by HEAD.
+ since those branches are fully contained by `HEAD`.
- `--no-merged` is used to find branches which are candidates for merging
- into HEAD, since those branches are not fully contained by HEAD.
+ into `HEAD`, since those branches are not fully contained by `HEAD`.
include::ref-reachability-filters.txt[]
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index 4f1e59a3b2..20da47cbd6 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -68,7 +68,7 @@ unbundle <file>::
'git rev-list' (and containing a named ref, see SPECIFYING REFERENCES
below), that specifies the specific objects and references
to transport. For example, `master~10..master` causes the
- current master reference to be packaged along with all objects
+ current `master` reference to be packaged along with all objects
added since its 10th ancestor commit. There is no explicit
limit to the number of references and objects that may be
packaged.
@@ -146,7 +146,7 @@ Assume you want to transfer the history from a repository R1 on machine A
to another repository R2 on machine B.
For whatever reason, direct connection between A and B is not allowed,
but we can move data from A to B via some mechanism (CD, email, etc.).
-We want to update R2 with development made on the branch master in R1.
+We want to update R2 with development made on the branch `master` in R1.
To bootstrap the process, you can first create a bundle that does not have
any basis. You can use a tag to remember up to what commit you last
@@ -167,7 +167,7 @@ create a new repository on machine B by cloning from it:
machineB$ git clone -b master /home/me/tmp/file.bundle R2
----------------
-This will define a remote called "origin" in the resulting repository that
+This will define a remote called `origin` in the resulting repository that
lets you fetch and pull from the bundle. The $GIT_DIR/config file in R2 will
have an entry like this:
diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt
index ee6a4144fb..f39622c0da 100644
--- a/Documentation/git-check-ref-format.txt
+++ b/Documentation/git-check-ref-format.txt
@@ -80,7 +80,7 @@ reference name expressions (see linkgit:gitrevisions[7]):
With the `--branch` option, the command takes a name and checks if
it can be used as a valid branch name (e.g. when creating a new
branch). But be cautious when using the
-previous checkout syntax that may refer to a detached HEAD state.
+previous checkout syntax that may refer to a detached `HEAD` state.
The rule `git check-ref-format --branch $name` implements
may be stricter than what `git check-ref-format refs/heads/$name`
says (e.g. a dash may appear at the beginning of a ref component,
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 3336b8dace..192dbfe9b0 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -189,7 +189,7 @@ one for the purposes of disambiguation, even if the `<branch>` isn't
unique across all remotes. Set it to
e.g. `checkout.defaultRemote=origin` to always checkout remote
branches from there if `<branch>` is ambiguous but exists on the
-'origin' remote. See also `checkout.defaultRemote` in
+`origin` remote. See also `checkout.defaultRemote` in
linkgit:git-config[1].
+
`--guess` is the default behavior. Use `--no-guess` to disable it.
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index 0127f56204..6069cc77a0 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -17,7 +17,7 @@ DESCRIPTION
Given one or more existing commits, apply the change each one
introduces, recording a new commit for each. This requires your
-working tree to be clean (no modifications from the HEAD commit).
+working tree to be clean (no modifications from the `HEAD` commit).
When it is not obvious how to apply a change, the following
happens:
@@ -96,7 +96,7 @@ OPTIONS
each named commit to your working tree and the index,
without making any commit. In addition, when this
option is used, your index does not have to match the
- HEAD commit. The cherry-pick is done against the
+ `HEAD` commit. The cherry-pick is done against the
beginning state of your index.
+
This is useful when cherry-picking more than one commits'
@@ -117,7 +117,7 @@ effect to your index in a row.
earlier `--gpg-sign`.
--ff::
- If the current HEAD is the same as the parent of the
+ If the current `HEAD` is the same as the parent of the
cherry-pick'ed commit, then a fast forward to this commit will
be performed.
@@ -176,13 +176,13 @@ EXAMPLES
`git cherry-pick ^HEAD master`::
Apply the changes introduced by all commits that are ancestors
- of master but not of HEAD to produce new commits.
+ of `master` but not of `HEAD` to produce new commits.
`git cherry-pick maint next ^master`::
`git cherry-pick maint master..next`::
Apply the changes introduced by all commits that are
- ancestors of maint or next, but not master or any of its
+ ancestors of `maint` or `next`, but not `master` or any of its
ancestors. Note that the latter does not mean `maint` and
everything between `master` and `next`; specifically,
`maint` will not be used if it is included in `master`.
@@ -190,27 +190,27 @@ EXAMPLES
`git cherry-pick master~4 master~2`::
Apply the changes introduced by the fifth and third last
- commits pointed to by master and create 2 new commits with
+ commits pointed to by `master` and create 2 new commits with
these changes.
`git cherry-pick -n master~1 next`::
Apply to the working tree and the index the changes introduced
- by the second last commit pointed to by master and by the last
+ by the second last commit pointed to by `master` and by the last
commit pointed to by next, but do not create any commit with
these changes.
`git cherry-pick --ff ..next`::
- If history is linear and HEAD is an ancestor of next, update
- the working tree and advance the HEAD pointer to match next.
+ If history is linear and `HEAD` is an ancestor of next, update
+ the working tree and advance the `HEAD` pointer to match next.
Otherwise, apply the changes introduced by those commits that
- are in next but not HEAD to the current branch, creating a new
+ are in next but not `HEAD` to the current branch, creating a new
commit for each new change.
`git rev-list --reverse master -- README | git cherry-pick -n --stdin`::
- Apply the changes introduced by all commits on the master
+ Apply the changes introduced by all commits on the `master`
branch that touched README to the working tree and index,
so the result can be inspected and made into a single new
commit if suitable.
diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt
index 0ea921a593..4374f398fa 100644
--- a/Documentation/git-cherry.txt
+++ b/Documentation/git-cherry.txt
@@ -31,10 +31,10 @@ OPTIONS
<upstream>::
Upstream branch to search for equivalent commits.
- Defaults to the upstream branch of HEAD.
+ Defaults to the upstream branch of `HEAD`.
<head>::
- Working branch; defaults to HEAD.
+ Working branch; defaults to `HEAD`.
<limit>::
Do not report commits up to (and including) limit.
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 22334771d1..8cd602a852 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -30,8 +30,8 @@ currently active branch.
After the clone, a plain `git fetch` without arguments will update
all the remote-tracking branches, and a `git pull` without
-arguments will in addition merge the remote master branch into the
-current master branch, if any (this is untrue when `--single-branch`
+arguments will in addition merge the remote `master` branch into the
+current `master` branch, if any (this is untrue when `--single-branch`
is given; see below).
This default configuration is achieved by creating references to
@@ -147,7 +147,7 @@ objects from the source repository into a pack in the cloned repository.
-n::
--no-checkout::
- No checkout of HEAD is performed after the clone is complete.
+ No checkout of `HEAD` is performed after the clone is complete.
--[no-]reject-shallow::
Fail if the source repository is a shallow repository.
@@ -198,11 +198,11 @@ objects from the source repository into a pack in the cloned repository.
-b <name>::
--branch <name>::
- Instead of pointing the newly created HEAD to the branch pointed
- to by the cloned repository's HEAD, point to `<name>` branch
+ Instead of pointing the newly created `HEAD` to the branch pointed
+ to by the cloned repository's `HEAD`, point to `<name>` branch
instead. In a non-bare repository, this is the branch that will
be checked out.
- `--branch` can also take tags and detaches the HEAD at that commit
+ `--branch` can also take tags and detaches the `HEAD` at that commit
in the resulting repository.
-u <upload-pack>::
@@ -224,7 +224,7 @@ objects from the source repository into a pack in the cloned repository.
linkgit:git-config[1] (e.g., `core.eol=true`). If multiple
values are given for the same key, each value will be written to
the config file. This makes it safe, for example, to add
- additional fetch refspecs to the origin remote.
+ additional fetch refspecs to the `origin` remote.
+
Due to limitations of the current implementation, some configuration
variables do not take effect until after the initial fetch and checkout.
@@ -253,7 +253,7 @@ corresponding `--mirror` and `--no-tags` options instead.
branch remote's `HEAD` points at.
Further fetches into the resulting repository will only update the
remote-tracking branch for the branch this option was used for the
- initial cloning. If the HEAD at the remote did not point at any
+ initial cloning. If the `HEAD` at the remote did not point at any
branch when `--single-branch` clone was made, no remote-tracking
branch is created.
diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt
index 2e2c581098..b76a825c94 100644
--- a/Documentation/git-commit-tree.txt
+++ b/Documentation/git-commit-tree.txt
@@ -36,7 +36,7 @@ While a tree represents a particular directory state of a working
directory, a commit represents that state in "time", and explains how
to get there.
-Normally a commit would identify a new "HEAD" state, and while Git
+Normally a commit would identify a new `HEAD` state, and while Git
doesn't care where you save the note about that state, in practice we
tend to just write the result to the file that is pointed at by
`.git/HEAD`, so that we can always see what the last committed
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 6d0d663b50..f507ae00a1 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -21,9 +21,9 @@ DESCRIPTION
-----------
Create a new commit containing the current contents of the index and
the given log message describing the changes. The new commit is a
-direct child of HEAD, usually the tip of the current branch, and the
+direct child of `HEAD`, usually the tip of the current branch, and the
branch is updated to point to it (unless no branch is associated with
-the working tree, in which case HEAD is "detached" as described in
+the working tree, in which case `HEAD` is "detached" as described in
linkgit:git-checkout[1]).
The content to be committed can be specified in several ways:
@@ -352,7 +352,7 @@ configuration variable documented in linkgit:git-config[1].
-v::
--verbose::
- Show unified diff between the HEAD commit and what
+ Show unified diff between the `HEAD` commit and what
would be committed at the bottom of the commit message
template to help the user describe the commit by reminding
what changes the commit has.
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index b93394ea45..e6d70ffda1 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -148,7 +148,7 @@ See also <<FILES>>.
--blob blob::
Similar to `--file` but use the given blob instead of a file. E.g.
you can use 'master:.gitmodules' to read values from the file
- '.gitmodules' in the master branch. See "SPECIFYING REVISIONS"
+ '.gitmodules' in the `master` branch. See "SPECIFYING REVISIONS"
section in linkgit:gitrevisions[7] for a more complete list of
ways to spell blob names.
diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt
index 143c726511..95fa94de74 100644
--- a/Documentation/git-cvsimport.txt
+++ b/Documentation/git-cvsimport.txt
@@ -35,7 +35,7 @@ Please see the section <<issues,ISSUES>> for further reference.
You should *never* do any work of your own on the branches that are
created by 'git cvsimport'. By default initial import will create and populate a
-"master" branch from the CVS repository's main branch which you're free
+`master` branch from the CVS repository's main branch which you're free
to work with; after that, you need to 'git merge' incremental imports, or
any CVS branches, yourself. It is advisable to specify a named remote via
`-r` to separate and protect the incoming branches.
@@ -71,11 +71,11 @@ OPTIONS
-r <remote>::
The Git remote to import this CVS repository into.
Moves all CVS branches into remotes/<remote>/<branch>
- akin to the way 'git clone' uses 'origin' by default.
+ akin to the way 'git clone' uses `origin` by default.
-o <branch-for-HEAD>::
When no remote is specified (via `-r`) the `HEAD` branch
- from CVS is imported to the 'origin' branch within the Git
+ from CVS is imported to the `origin` branch within the Git
repository, as `HEAD` already has a special meaning for Git.
When a remote is specified the `HEAD` branch is named
remotes/<remote>/master mirroring 'git clone' behaviour.
@@ -200,7 +200,7 @@ Problems related to timestamps:
to be used for ordering commits changes may show up in the wrong
order.
* If any files were ever "cvs import"ed more than once (e.g., import of
- more than one vendor release) the HEAD contains the wrong content.
+ more than one vendor release) the `HEAD` contains the wrong content.
* If the timestamp order of different files cross the revision order
within the commit matching time window the order of commits may be
wrong.
diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
index 955bae46c9..c6a926d8d2 100644
--- a/Documentation/git-cvsserver.txt
+++ b/Documentation/git-cvsserver.txt
@@ -199,7 +199,7 @@ allowing access over SSH.
5. Clients should now be able to check out the project. Use the CVS 'module'
name to indicate what Git 'head' you want to check out. This also sets the
name of your newly checked-out directory, unless you tell it otherwise with
- `-d <dir_name>`. For example, this checks out 'master' branch to the
+ `-d <dir_name>`. For example, this checks out `master` branch to the
`project-master` directory:
+
------
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index a3f015743b..7d2649c477 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -30,17 +30,17 @@ If the given object refers to a blob, it will be described
as `<commit-ish>:<path>`, such that the blob can be found
at `<path>` in the `<commit-ish>`, which itself describes the
first commit in which this blob occurs in a reverse revision walk
-from HEAD.
+from `HEAD`.
OPTIONS
-------
<commit-ish>...::
- Commit-ish object names to describe. Defaults to HEAD if omitted.
+ Commit-ish object names to describe. Defaults to `HEAD` if omitted.
--dirty[=<mark>]::
--broken[=<mark>]::
Describe the state of the working tree. When the working
- tree matches HEAD, the output is the same as "git describe
+ tree matches `HEAD`, the output is the same as "git describe
HEAD". If the working tree has local modification "-dirty"
is appended to it. If a repository is corrupt and Git
cannot determine if there is local modification, Git will
diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt
index 27acb31cbf..10e79a29aa 100644
--- a/Documentation/git-diff-index.txt
+++ b/Documentation/git-diff-index.txt
@@ -31,7 +31,7 @@ include::diff-options.txt[]
--merge-base::
Instead of comparing <tree-ish> directly, use the merge base
- between <tree-ish> and HEAD instead. <tree-ish> must be a
+ between <tree-ish> and `HEAD` instead. <tree-ish> must be a
commit.
-m::
@@ -53,7 +53,7 @@ CACHED MODE
-----------
If `--cached` is specified, it allows you to ask:
- show me the differences between HEAD and the current index
+ show me the differences between `HEAD` and the current index
contents (the ones I'd write using 'git write-tree')
For example, let's say that you have worked on your working directory, updated
@@ -89,7 +89,7 @@ the more useful of the two in that what it does can't be emulated with
a 'git write-tree' + 'git diff-tree'. Thus that's the default mode.
The non-cached version asks the question:
- show me the differences between HEAD and the currently checked out
+ show me the differences between `HEAD` and the currently checked out
tree - index contents _and_ files that aren't up to date
which is obviously a very useful question too, since that tells you what
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 9f4b46c910..33a47958bc 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -45,20 +45,20 @@ files on disk.
This form is to view the changes you staged for the next
commit relative to the named <commit>. Typically you
would want comparison with the latest commit, so if you
- do not give <commit>, it defaults to HEAD.
- If HEAD does not exist (e.g. unborn branches) and
+ do not give <commit>, it defaults to `HEAD`.
+ If `HEAD` does not exist (e.g. unborn branches) and
<commit> is not given, it shows all staged changes.
`--staged` is a synonym of `--cached`.
+
If `--merge-base` is given, instead of using <commit>, use the merge base
-of <commit> and HEAD. `git diff --merge-base A` is equivalent to
+of <commit> and `HEAD`. `git diff --merge-base A` is equivalent to
`git diff $(git merge-base A HEAD)`.
'git diff' [<options>] <commit> [--] [<path>...]::
This form is to view the changes you have in your
working tree relative to the named <commit>. You can
- use HEAD to compare it with the latest commit, or a
+ use `HEAD` to compare it with the latest commit, or a
branch name to compare with the tip of a different
branch.
@@ -85,7 +85,7 @@ If `--merge-base` is given, use the merge base of the two commits for the
This is synonymous to the earlier form (without the `..`) for
viewing the changes between two arbitrary <commit>. If <commit> on
one side is omitted, it will have the same effect as
- using HEAD instead.
+ using `HEAD` instead.
'git diff' [<options>] <commit>\...<commit> [--] [<path>...]::
@@ -93,7 +93,7 @@ If `--merge-base` is given, use the merge base of the two commits for the
and up to the second <commit>, starting at a common ancestor
of both <commit>. `git diff A...B` is equivalent to
`git diff $(git merge-base A B) B`. You can omit any one
- of <commit>, which has the same effect as using HEAD instead.
+ of <commit>, which has the same effect as using `HEAD` instead.
Just in case you are doing something exotic, it should be
noted that all of the <commit> in the above description, except
@@ -165,8 +165,8 @@ $ git diff HEAD^ HEAD <3>
------------
+
<1> Instead of using the tip of the current branch, compare with the
- tip of "test" branch.
-<2> Instead of comparing with the tip of "test" branch, compare with
+ tip of `test` branch.
+<2> Instead of comparing with the tip of `test` branch, compare with
the tip of the current branch, but limit the comparison to the
file "test".
<3> Compare the version before the last commit and the last commit.
@@ -179,9 +179,9 @@ $ git diff topic..master <2>
$ git diff topic...master <3>
------------
+
-<1> Changes between the tips of the topic and the master branches.
+<1> Changes between the tips of the `topic` and the `master` branches.
<2> Same as above.
-<3> Changes that occurred on the master branch since when the topic
+<3> Changes that occurred on the `master` branch since when the `topic`
branch was started off it.
Limiting the diff output::
diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt
index a1c02918f9..3a6a77abac 100644
--- a/Documentation/git-fast-export.txt
+++ b/Documentation/git-fast-export.txt
@@ -126,10 +126,10 @@ by keeping the marks the same across runs.
--reference-excluded-parents::
By default, running a command such as `git fast-export
- master~5..master` will not include the commit master{tilde}5
- and will make master{tilde}4 no longer have master{tilde}5 as
- a parent (though both the old master{tilde}4 and new
- master{tilde}4 will have all the same files). Use
+ master~5..master` will not include the commit `master~5`
+ and will make `master~4` no longer have `master~5` as
+ a parent (though both the old `master~4` and new
+ `master~4` will have all the same files). Use
`--reference-excluded-parents` to instead have the stream
refer to commits in the excluded range of history by their
sha1sum. Note that the resulting stream can only be used by a
@@ -158,10 +158,10 @@ by keeping the marks the same across runs.
A list of arguments, acceptable to 'git rev-parse' and
'git rev-list', that specifies the specific objects and references
to export. For example, `master~10..master` causes the
- current master reference to be exported along with all objects
+ current `master` reference to be exported along with all objects
added since its 10th ancestor commit and (unless the
`--reference-excluded-parents` option is specified) all files
- common to master{tilde}9 and master{tilde}10.
+ common to `master~9` and `master~10`.
EXAMPLES
--------
@@ -180,8 +180,8 @@ $ git fast-export master~5..master |
git fast-import
-----------------------------------------------------
-This makes a new branch called 'other' from 'master~5..master'
-(i.e. if 'master' has linear history, it will take the last 5 commits).
+This makes a new branch called `other` from `master~5`..`master`
+(i.e. if `master` has linear history, it will take the last 5 commits).
Note that this assumes that none of the blobs and commit messages
referenced by that revision range contains the string
diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt
index 88c2b9d426..1f48f89e3e 100644
--- a/Documentation/git-fetch-pack.txt
+++ b/Documentation/git-fetch-pack.txt
@@ -116,7 +116,7 @@ be in a separate packet, and the list must end with a flush packet.
<refs>...::
The remote heads to update from. This is relative to
- $GIT_DIR (e.g. "HEAD", "refs/heads/master"). When
+ $GIT_DIR (e.g. `HEAD`, "refs/heads/master"). When
unspecified, update from all heads the remote side has.
+
If the remote has enabled the options `uploadpack.allowTipSHA1InWant`,
diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt
index 85b073a61a..a5ecf00db3 100644
--- a/Documentation/git-fetch.txt
+++ b/Documentation/git-fetch.txt
@@ -87,10 +87,10 @@ This configuration is used in two ways:
<refspec>s given on the command line determine what are to be
fetched (e.g. `master` in the example,
which is a short-hand for `master:`, which in turn means
- "fetch the 'master' branch but I do not explicitly say what
+ "fetch the `master` branch but I do not explicitly say what
remote-tracking branch to update with it from the command line"),
and the example command will
- fetch _only_ the 'master' branch. The `remote.<repository>.fetch`
+ fetch _only_ the `master` branch. The `remote.<repository>.fetch`
values determine which
remote-tracking branch, if any, is updated. When used in this
way, the `remote.<repository>.fetch` values do not have any
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 2de3511459..e2955bc648 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -267,7 +267,7 @@ history, so we also add `--ignore-unmatch`:
git filter-branch --index-filter 'git rm --cached --ignore-unmatch filename' HEAD
--------------------------------------------------------------------------
-Now, you will get the rewritten history saved in HEAD.
+Now, you will get the rewritten history saved in `HEAD`.
To rewrite the repository to look as if `foodir/` had been its project
root, and discard all other history:
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index 9004861eae..86fb26dcea 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -65,8 +65,8 @@ $ git fetch origin master
$ git fmt-merge-msg --log <$GIT_DIR/FETCH_HEAD
---------
-Print a log message describing a merge of the "master" branch from
-the "origin" remote.
+Print a log message describing a merge of the `master` branch from
+the `origin` remote.
SEE ALSO
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index e035edf11d..4bde4f9d05 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -76,18 +76,18 @@ OPTIONS
--merged[=<object>]::
Only list refs whose tips are reachable from the
- specified commit (HEAD if not specified).
+ specified commit (`HEAD` if not specified).
--no-merged[=<object>]::
Only list refs whose tips are not reachable from the
- specified commit (HEAD if not specified).
+ specified commit (`HEAD` if not specified).
--contains[=<object>]::
- Only list refs which contain the specified commit (HEAD if not
+ Only list refs which contain the specified commit (`HEAD` if not
specified).
--no-contains[=<object>]::
- Only list refs which don't contain the specified commit (HEAD
+ Only list refs which don't contain the specified commit (`HEAD`
if not specified).
--ignore-case::
@@ -169,7 +169,7 @@ push::
ref is configured.
HEAD::
- '*' if HEAD matches current ref (the checked out branch), ' '
+ '*' if `HEAD` matches current ref (the checked out branch), ' '
otherwise.
color::
@@ -201,7 +201,7 @@ if::
everything after %(else) is printed. We ignore space when
evaluating the string before %(then), this is useful when we
use the %(HEAD) atom which prints either "*" or " " and we
- want to apply the 'if' condition only on the 'HEAD' ref.
+ want to apply the 'if' condition only on the `HEAD` ref.
Append ":equals=<string>" or ":notequals=<string>" to compare
the value between the %(if:...) and %(then) atoms with the
given string.
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index ca500ba72c..fd7c6c705b 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -706,7 +706,7 @@ $ git format-patch -k --stdout R1..R2 | git am -3 -k
------------
* Extract all commits which are in the current branch but not in the
- origin branch:
+ `origin` branch:
+
------------
$ git format-patch origin
@@ -714,7 +714,7 @@ $ git format-patch origin
+
For each commit a separate file is created in the current directory.
-* Extract all commits that lead to 'origin' since the inception of the
+* Extract all commits that lead to `origin` since the inception of the
project:
+
------------
diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt
index 5dd4d2b63a..7ba8ea2383 100644
--- a/Documentation/git-http-push.txt
+++ b/Documentation/git-http-push.txt
@@ -44,12 +44,12 @@ OPTIONS
-d::
-D::
Remove <ref> from remote repository. The specified branch
- cannot be the remote HEAD. If `-d` is specified the following
+ cannot be the remote `HEAD`. If `-d` is specified the following
other conditions must also be met:
- - Remote HEAD must resolve to an object that exists locally
+ - Remote `HEAD` must resolve to an object that exists locally
- Specified branch resolves to an object that exists locally
- - Specified branch is an ancestor of the remote HEAD
+ - Specified branch is an ancestor of the remote `HEAD`
<ref>...::
The remote refs to update.
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 1bbf865a1b..b306dced1c 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -152,13 +152,13 @@ EXAMPLES
`git log --branches --not --remotes=origin`::
Shows all commits that are in any of local branches but not in
- any of remote-tracking branches for 'origin' (what you have that
- origin doesn't).
+ any of remote-tracking branches for `origin` (what you have that
+ `origin` doesn't).
`git log master --not --remotes=*/master`::
- Shows all commits that are in local master but not in any remote
- repository master branches.
+ Shows all commits that are in local `master` but not in any remote
+ repository `master` branches.
`git log -p -m --first-parent`::
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index 4cb4e2fd5d..af005ece9a 100644
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -59,7 +59,7 @@ OPTIONS
--symref::
In addition to the object pointed by it, show the underlying
ref pointed by it when showing a symbolic ref. Currently,
- upload-pack only shows the symref HEAD, so it will be the only
+ upload-pack only shows the symref `HEAD`, so it will be the only
one shown by ls-remote.
--sort=<key>::
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index 3819fadac1..58fd091d73 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -146,7 +146,7 @@ To avoid recording unrelated changes in the merge commit,
'git pull' and 'git merge' will also abort if there are any changes
registered in the index relative to the `HEAD` commit. (Special
narrow exceptions to this rule may exist depending on which merge
-strategy is in use, but generally, the index must match HEAD.)
+strategy is in use, but generally, the index must match `HEAD`.)
If all named commits are already ancestors of `HEAD`, 'git merge'
will exit early with the message "Already up to date."
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index b0a5ab9a72..ef04e3a8ff 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -60,7 +60,7 @@ list::
This is the default subcommand if no subcommand is given.
add::
- Add notes for a given object (defaults to HEAD). Abort if the
+ Add notes for a given object (defaults to `HEAD`). Abort if the
object already has notes (use `-f` to overwrite existing notes).
However, if you're using `add` interactively (using an editor
to supply the notes contents), then - instead of aborting -
@@ -69,7 +69,7 @@ add::
copy::
Copy the notes for the first object onto the second object (defaults to
- HEAD). Abort if the second object already has notes, or if the first
+ `HEAD`). Abort if the second object already has notes, or if the first
object has none (use -f to overwrite existing notes to the
second object). This subcommand is equivalent to:
`git notes add [-f] -C $(git notes list <from-object>) <to-object>`
@@ -85,14 +85,14 @@ corresponding <to-object>. (The optional `<rest>` is ignored so that
the command can read the input given to the `post-rewrite` hook.)
append::
- Append to the notes of an existing object (defaults to HEAD).
+ Append to the notes of an existing object (defaults to `HEAD`).
Creates a new notes object if needed.
edit::
- Edit the notes for a given object (defaults to HEAD).
+ Edit the notes for a given object (defaults to `HEAD`).
show::
- Show the notes for a given object (defaults to HEAD).
+ Show the notes for a given object (defaults to `HEAD`).
merge::
Merge the given notes ref into the current notes ref.
@@ -110,7 +110,7 @@ When done, the user can either finalize the merge with
'git notes merge --abort'.
remove::
- Remove the notes for given objects (defaults to HEAD). When
+ Remove the notes for given objects (defaults to `HEAD`). When
giving zero or one object from the command line, this is
equivalent to specifying an empty note message to
the `edit` subcommand.
diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index d9d29a5efa..ec23ab7d96 100644
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -76,7 +76,7 @@ This:
2. Imports the full contents of the head revision from the given p4
depot path into a single commit in the Git branch 'refs/remotes/p4/master'.
+
-3. Creates a local branch, 'master' from this remote and checks it out.
+3. Creates a local branch, `master` from this remote and checks it out.
To reproduce the entire p4 history in Git, use the '@all' modifier on
the depot path:
@@ -176,7 +176,7 @@ Unshelve
Unshelving will take a shelved P4 changelist, and produce the equivalent git commit
in the branch refs/remotes/p4-unshelved/<changelist>.
-The git commit is created relative to the current origin revision (HEAD by default).
+The git commit is created relative to the current origin revision (`HEAD` by default).
A parent commit is created based on the origin, and then the unshelve commit is
created based on that.
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index edecf393d3..d9a5507195 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -211,7 +211,7 @@ $ git pull
$ git pull origin
------------------------------------------------
+
-Normally the branch merged in is the HEAD of the remote repository,
+Normally the branch merged in is the `HEAD` of the remote repository,
but the choice is determined by the branch.<name>.remote and
branch.<name>.merge options; see linkgit:git-config[1] for details.
@@ -221,7 +221,7 @@ branch.<name>.merge options; see linkgit:git-config[1] for details.
$ git pull origin next
------------------------------------------------
+
-This leaves a copy of `next` temporarily in FETCH_HEAD, and
+This leaves a copy of `next` temporarily in `FETCH_HEAD`, and
updates the remote-tracking branch `origin/next`.
The same can be done by invoking fetch and merge:
+
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index fc91d41ce0..91dcaa108c 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -667,9 +667,9 @@ made on `satellite`.
(e.g. `refs/heads/experimental`), and delete it.
`git push origin +dev:master`::
- Update the origin repository's master branch with the dev branch,
+ Update the `origin` repository's `master` branch with the `dev` branch,
allowing non-fast-forward updates. *This can leave unreferenced
- commits dangling in the origin repository.* Consider the
+ commits dangling in the `origin` repository.* Consider the
following situation, where a fast-forward is not possible:
+
----
@@ -678,7 +678,7 @@ made on `satellite`.
X---Y---Z dev
----
+
-The above command would change the origin repository to
+The above command would change the `origin` repository to
+
----
A---B (unnamed branch)
@@ -688,7 +688,7 @@ The above command would change the origin repository to
+
Commits A and B would no longer belong to a branch with a symbolic name,
and so would be unreachable. As such, these commits would be removed by
-a `git gc` command on the origin repository.
+a `git gc` command on the `origin` repository.
include::transfer-data-leaks.txt[]
diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index 3f53688170..d22d3855d1 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -118,7 +118,7 @@ OPTIONS
--[no-]recurse-submodules::
Using `--recurse-submodules` will update the content of all active
submodules according to the commit recorded in the superproject by
- calling read-tree recursively, also setting the submodules' HEAD to be
+ calling read-tree recursively, also setting the submodules' `HEAD` to be
detached at that commit.
--no-sparse-checkout::
@@ -356,7 +356,7 @@ $ git fetch git://.... linus
$ LT=`git rev-parse FETCH_HEAD`
----------------
-Your work tree is still based on your HEAD ($JC), but you have
+Your work tree is still based on your `HEAD` ($JC), but you have
some edits since. Three-way merge makes sure that you have not
added or modified index entries since $JC, and if you haven't,
then does the right thing. So with the following sequence:
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index f063d54623..bd9f15ea26 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -35,13 +35,13 @@ description on `--fork-point` below); or by `git log HEAD`, if the
The current branch is reset to <upstream>, or <newbase> if the
`--onto` option was supplied. This has the exact same effect as
-`git reset --hard <upstream>` (or <newbase>). ORIG_HEAD is set
+`git reset --hard <upstream>` (or <newbase>). `ORIG_HEAD` is set
to point at the tip of the branch before the reset.
The commits that were previously saved into the temporary area are
then reapplied to the current branch, one by one, in order. Note that
-any commits in HEAD which introduce the same textual changes as a commit
-in HEAD..<upstream> are omitted (i.e., a patch already accepted upstream
+any commits in `HEAD` which introduce the same textual changes as a commit
+in `HEAD`..<upstream> are omitted (i.e., a patch already accepted upstream
with a different commit message or timestamp will be skipped).
It is possible that a merge failure will prevent this process from being
@@ -51,7 +51,7 @@ that caused the merge failure with `git rebase --skip`. To check out the
original <branch> and remove the .git/rebase-apply working files, use the
command `git rebase --abort` instead.
-Assume the following history exists and the current branch is "topic":
+Assume the following history exists and the current branch is `topic`:
------------
A---B---C topic
@@ -101,9 +101,9 @@ Here is how you would transplant a topic branch based on one
branch to another, to pretend that you forked the topic branch
from the latter branch, using `rebase --onto`.
-First let's assume your 'topic' is based on branch 'next'.
-For example, a feature developed in 'topic' depends on some
-functionality which is found in 'next'.
+First let's assume your `topic` is based on branch `next`.
+For example, a feature developed in `topic` depends on some
+functionality which is found in `next'.
------------
o---o---o---o---o master
@@ -113,9 +113,9 @@ functionality which is found in 'next'.
o---o---o topic
------------
-We want to make 'topic' forked from branch 'master'; for example,
-because the functionality on which 'topic' depends was merged into the
-more stable 'master' branch. We want our tree to look like this:
+We want to make `topic` forked from branch `master`; for example,
+because the functionality on which `topic` depends was merged into the
+more stable `master` branch. We want our tree to look like this:
------------
o---o---o---o---o master
@@ -216,7 +216,7 @@ OPTIONS
+
As a special case, you may use "A\...B" as a shortcut for the
merge base of A and B if there is exactly one merge base. You can
-leave out at most one of A and B, in which case it defaults to HEAD.
+leave out at most one of A and B, in which case it defaults to `HEAD`.
--keep-base::
Set the starting point at which to create the new commits to the
@@ -242,20 +242,20 @@ See also INCOMPATIBLE OPTIONS below.
upstream for the current branch.
<branch>::
- Working branch; defaults to HEAD.
+ Working branch; defaults to `HEAD`.
--continue::
Restart the rebasing process after having resolved a merge conflict.
--abort::
- Abort the rebase operation and reset HEAD to the original
+ Abort the rebase operation and reset `HEAD` to the original
branch. If <branch> was provided when the rebase operation was
- started, then HEAD will be reset to <branch>. Otherwise HEAD
+ started, then `HEAD` will be reset to <branch>. Otherwise `HEAD`
will be reset to where it was when the rebase operation was
started.
--quit::
- Abort the rebase operation but HEAD is not reset back to the
+ Abort the rebase operation but `HEAD` is not reset back to the
original branch. The index and working tree are also left
unchanged as a result. If a temporary stash entry was created
using `--autostash`, it will be saved to the stash list.
@@ -905,7 +905,7 @@ when a command fails due to merge errors. When you are done editing
and/or resolving conflicts you can continue with `git rebase --continue`.
For example, if you want to reorder the last 5 commits, such that what
-was HEAD~4 becomes the new HEAD. To achieve that, you would call
+was `HEAD~4` becomes the new `HEAD`. To achieve that, you would call
'git rebase' like this:
----------------------
@@ -925,8 +925,8 @@ like this:
---o---O---P---Q
------------------
-Suppose you want to rebase the side branch starting at "A" to "Q". Make
-sure that the current HEAD is "B", and call
+Suppose you want to rebase the side branch starting at `A` to `Q`. Make
+sure that the current `HEAD` is `B`, and call
-----------------------------
$ git rebase -i -r --onto Q O
@@ -990,7 +990,7 @@ add other commits. This can be used to split a commit into two:
- Mark the commit you want to split with the action "edit".
- When it comes to editing that commit, execute `git reset HEAD^`. The
- effect is that the HEAD is rewound by one, and the index follows suit.
+ effect is that the `HEAD` is rewound by one, and the index follows suit.
However, the working tree stays the same.
- Now add the changes to the index that you want to have in the first
@@ -1020,8 +1020,8 @@ from the downstream's point of view. The real fix, however, would be
to avoid rebasing the upstream in the first place.
To illustrate, suppose you are in a situation where someone develops a
-'subsystem' branch, and you are working on a 'topic' that is dependent
-on this 'subsystem'. You might end up with a history like the
+`subsystem` branch, and you are working on a `topic` that is dependent
+on this `subsystem`. You might end up with a history like the
following:
------------
@@ -1032,7 +1032,7 @@ following:
*---*---* topic
------------
-If 'subsystem' is rebased against 'master', the following happens:
+If `subsystem` is rebased against `master`, the following happens:
------------
o---o---o---o---o---o---o---o master
@@ -1042,8 +1042,8 @@ If 'subsystem' is rebased against 'master', the following happens:
*---*---* topic
------------
-If you now continue development as usual, and eventually merge 'topic'
-to 'subsystem', the commits from 'subsystem' will remain duplicated forever:
+If you now continue development as usual, and eventually merge `topic`
+to `subsystem`, the commits from `subsystem` will remain duplicated forever:
------------
o---o---o---o---o---o---o---o master
@@ -1055,20 +1055,20 @@ to 'subsystem', the commits from 'subsystem' will remain duplicated forever:
Such duplicates are generally frowned upon because they clutter up
history, making it harder to follow. To clean things up, you need to
-transplant the commits on 'topic' to the new 'subsystem' tip, i.e.,
-rebase 'topic'. This becomes a ripple effect: anyone downstream from
-'topic' is forced to rebase too, and so on!
+transplant the commits on `topic` to the new `subsystem` tip, i.e.,
+rebase `topic`. This becomes a ripple effect: anyone downstream from
+`topic` is forced to rebase too, and so on!
There are two kinds of fixes, discussed in the following subsections:
Easy case: The changes are literally the same.::
- This happens if the 'subsystem' rebase was a simple rebase and
+ This happens if the `subsystem` rebase was a simple rebase and
had no conflicts.
Hard case: The changes are not the same.::
- This happens if the 'subsystem' rebase had conflicts, or used
+ This happens if the `subsystem` rebase had conflicts, or used
`--interactive` to omit, edit, squash, or fixup commits; or
if the upstream used one of `commit --amend`, `reset`, or
a full history rewriting command like
@@ -1079,13 +1079,13 @@ The easy case
~~~~~~~~~~~~~
Only works if the changes (patch IDs based on the diff contents) on
-'subsystem' are literally the same before and after the rebase
-'subsystem' did.
+`subsystem` are literally the same before and after the rebase
+`subsystem` did.
In that case, the fix is easy because 'git rebase' knows to skip
changes that are already present in the new upstream (unless
`--reapply-cherry-picks` is given). So if you say
-(assuming you're on 'topic')
+(assuming you're on `topic`)
------------
$ git rebase subsystem
------------
@@ -1102,7 +1102,7 @@ you will end up with the fixed history
The hard case
~~~~~~~~~~~~~
-Things get more complicated if the 'subsystem' changes do not exactly
+Things get more complicated if the `subsystem` changes do not exactly
correspond to the ones before the rebase.
NOTE: While an "easy case recovery" sometimes appears to be successful
@@ -1110,26 +1110,26 @@ NOTE: While an "easy case recovery" sometimes appears to be successful
example, a commit that was removed via `git rebase
--interactive` will be **resurrected**!
-The idea is to manually tell 'git rebase' "where the old 'subsystem'
-ended and your 'topic' began", that is, what the old merge base
+The idea is to manually tell 'git rebase' "where the old `subsystem`
+ended and your `topic` began", that is, what the old merge base
between them was. You will have to find a way to name the last commit
-of the old 'subsystem', for example:
+of the old `subsystem`, for example:
-* With the 'subsystem' reflog: after 'git fetch', the old tip of
- 'subsystem' is at `subsystem@{1}`. Subsequent fetches will
+* With the `subsystem` reflog: after 'git fetch', the old tip of
+ `subsystem` is at `subsystem@{1}`. Subsequent fetches will
increase the number. (See linkgit:git-reflog[1].)
-* Relative to the tip of 'topic': knowing that your 'topic' has three
- commits, the old tip of 'subsystem' must be `topic~3`.
+* Relative to the tip of `topic`: knowing that your `topic` has three
+ commits, the old tip of `subsystem` must be `topic~3`.
-You can then transplant the old `subsystem..topic` to the new tip by
-saying (for the reflog case, and assuming you are on 'topic' already):
+You can then transplant the old `subsystem`..`topic` to the new tip by
+saying (for the reflog case, and assuming you are on `topic` already):
------------
$ git rebase --onto subsystem subsystem@{1}
------------
The ripple effect of a "hard case" recovery is especially bad:
-'everyone' downstream from 'topic' will now have to perform a "hard
+'everyone' downstream from `topic` will now have to perform a "hard
case" recovery too!
REBASING MERGES
@@ -1193,7 +1193,7 @@ merge -C 6f5e4d report-a-bug # Merge 'report-a-bug'
In contrast to a regular interactive rebase, there are `label`, `reset`
and `merge` commands in addition to `pick` ones.
-The `label` command associates a label with the current HEAD when that
+The `label` command associates a label with the current `HEAD` when that
command is executed. These labels are created as worktree-local refs
(`refs/rewritten/<label>`) that will be deleted when the rebase
finishes. That way, rebase operations in multiple worktrees linked to
@@ -1201,7 +1201,7 @@ the same repository do not interfere with one another. If the `label`
command fails, it is rescheduled immediately, with a helpful message how
to proceed.
-The `reset` command resets the HEAD, index and worktree to the specified
+The `reset` command resets the `HEAD`, index and worktree to the specified
revision. It is similar to an `exec git reset --hard <label>`, but
refuses to overwrite untracked files. If the `reset` command fails, it is
rescheduled immediately, with a helpful message how to edit the todo list
@@ -1209,7 +1209,7 @@ rescheduled immediately, with a helpful message how to edit the todo list
list manually and contains a typo).
The `merge` command will merge the specified revision(s) into whatever
-is HEAD at that time. With `-C <original-commit>`, the commit message of
+is `HEAD` at that time. With `-C <original-commit>`, the commit message of
the specified merge commit will be used. When the `-C` is changed to
a lower-case `-c`, the message will be opened in an editor after a
successful merge so that the user can edit the message.
diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt
index ff487ff77d..cf1d7e0810 100644
--- a/Documentation/git-reflog.txt
+++ b/Documentation/git-reflog.txt
@@ -28,8 +28,8 @@ depending on the subcommand:
Reference logs, or "reflogs", record when the tips of branches and
other references were updated in the local repository. Reflogs are
useful in various Git commands, to specify the old value of a
-reference. For example, `HEAD@{2}` means "where HEAD used to be two
-moves ago", `master@{one.week.ago}` means "where master used to point
+reference. For example, `HEAD@{2}` means "where `HEAD` used to be two
+moves ago", `master@{one.week.ago}` means "where `master` used to point
to one week ago in this local repository", and so on. See
linkgit:gitrevisions[7] for more details.
diff --git a/Documentation/git-request-pull.txt b/Documentation/git-request-pull.txt
index 4d4392d0f8..f58164aee1 100644
--- a/Documentation/git-request-pull.txt
+++ b/Documentation/git-request-pull.txt
@@ -37,7 +37,7 @@ OPTIONS
The repository URL to be pulled from.
<end>::
- Commit to end at (defaults to HEAD). This names the commit
+ Commit to end at (defaults to `HEAD`). This names the commit
at the tip of the history you are asking to be pulled.
+
When the repository named by `<url>` has the commit at a tip of a
diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt
index 4cfc883378..c5c6be5202 100644
--- a/Documentation/git-rerere.txt
+++ b/Documentation/git-rerere.txt
@@ -76,10 +76,10 @@ variables respectively.
DISCUSSION
----------
-When your topic branch modifies an overlapping area that your
-master branch (or upstream) touched since your topic branch
-forked from it, you may want to test it with the latest master,
-even before your topic branch is ready to be pushed upstream:
+When your `topic` branch modifies an overlapping area that your
+`master` branch (or upstream) touched since your `topic` branch
+forked from it, you may want to test it with the latest `master`,
+even before your `topic` branch is ready to be pushed upstream:
------------
o---*---o topic
@@ -87,8 +87,8 @@ even before your topic branch is ready to be pushed upstream:
o---o---o---*---o---o master
------------
-For such a test, you need to merge master and topic somehow.
-One way to do it is to pull master into the topic branch:
+For such a test, you need to merge `master` and `topic` somehow.
+One way to do it is to pull `master` into the `topic` branch:
------------
$ git switch topic
@@ -106,9 +106,9 @@ work-in-progress still works with what is in the latest master.
After this test merge, there are two ways to continue your work
on the topic. The easiest is to build on top of the test merge
-commit `+`, and when your work in the topic branch is finally
-ready, pull the topic branch into master, and/or ask the
-upstream to pull from you. By that time, however, the master or
+commit `+`, and when your work in the `topic` branch is finally
+ready, pull the `topic` branch into `master`, and/or ask the
+upstream to pull from you. By that time, however, the `master` or
the upstream might have been advanced since the test merge `+`,
in which case the final commit graph would look like this:
@@ -124,14 +124,14 @@ in which case the final commit graph would look like this:
o---o---o---*---o---o---o---o---+ master
------------
-When your topic branch is long-lived, however, your topic branch
-would end up having many such "Merge from master" commits on it,
+When your `topic` branch is long-lived, however, your `topic` branch
+would end up having many such "Merge from `master`" commits on it,
which would unnecessarily clutter the development history.
Readers of the Linux kernel mailing list may remember that Linus
complained about such too frequent test merges when a subsystem
maintainer asked to pull from a branch full of "useless merges".
-As an alternative, to keep the topic branch clean of test
+As an alternative, to keep the `topic` branch clean of test
merges, you could blow away the test merge, and keep building on
top of the tip before the test merge:
@@ -148,8 +148,8 @@ top of the tip before the test merge:
o---o---o---*---o---o---o---o---+ master
------------
-This would leave only one merge commit when your topic branch is
-finally ready and merged into the master branch. This merge
+This would leave only one merge commit when your `topic` branch is
+finally ready and merged into the `master` branch. This merge
would require you to resolve the conflict, introduced by the
commits marked with `*`. However, this conflict is often the
same conflict you resolved when you created the test merge you
@@ -163,7 +163,7 @@ usual conflict markers `<<<<<<<`, `=======`, and `>>>>>>>` in
them. Later, after you are done resolving the conflicts,
running 'git rerere' again will record the resolved state of these
files. Suppose you did this when you created the test merge of
-master into the topic branch.
+`master` into the `topic` branch.
Next time, after seeing the same conflicted automerge,
running 'git rerere' will perform a three-way merge between the
@@ -185,12 +185,12 @@ the rerere.enabled config variable).
In our example, when you do the test merge, the manual
resolution is recorded, and it will be reused when you do the
-actual merge later with the updated master and topic branch, as long
+actual merge later with the updated `master` and `topic` branch, as long
as the recorded resolution is still applicable.
The information 'git rerere' records is also used when running
'git rebase'. After blowing away the test merge and continuing
-development on the topic branch:
+development on the `topic` branch:
------------
o---*---o-------o---o topic
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index e9e816a986..4a55d1f1ac 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -3,7 +3,7 @@ git-reset(1)
NAME
----
-git-reset - Reset current HEAD to the specified state
+git-reset - Reset current `HEAD` to the specified state
SYNOPSIS
--------
@@ -92,7 +92,7 @@ but carries forward unmerged index entries.
When the working tree is updated, using `--recurse-submodules` will
also recursively reset the working tree of all active submodules
according to the commit recorded in the superproject, also setting
- the submodules' HEAD to be detached at that commit.
+ the submodules' `HEAD` to be detached at that commit.
--
See "Reset, restore and revert" in linkgit:git[1] for the differences
@@ -187,7 +187,7 @@ $ git switch topic/wip <3>
to be in the `master` branch. You want to continue polishing
them in a topic branch, so create `topic/wip` branch off of the
current `HEAD`.
-<2> Rewind the master branch to get rid of those three commits.
+<2> Rewind the `master` branch to get rid of those three commits.
<3> Switch to `topic/wip` branch and keep working.
Undo commits permanently::
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index 4b1af8c5a6..7c3c0e0007 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -155,7 +155,7 @@ for another option.
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
+ want to name the `master` branch when there is an
unfortunately named tag "master"), and show them as full
refnames (e.g. "refs/heads/master").
@@ -475,7 +475,7 @@ This will error out if $REV is empty or not a valid revision.
$ git rev-parse --default master --verify --end-of-options $REV
------------
+
-but if $REV is empty, the commit object name from master will be printed.
+but if $REV is empty, the commit object name from `master` will be printed.
GIT
---
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index bb92a4a451..a232db1d98 100644
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -17,7 +17,7 @@ DESCRIPTION
Given one or more existing commits, revert the changes that the
related patches introduce, and record some new commits that record
them. This requires your working tree to be clean (no modifications
-from the HEAD commit).
+from the `HEAD` commit).
Note: 'git revert' is used to record some new commits to reverse the
effect of some earlier commits (often only a faulty one). If you want to
@@ -82,7 +82,7 @@ more details.
to revert the named commits to your working tree
and the index, but does not make the commits. In addition,
when this option is used, your index does not have to match
- the HEAD commit. The revert is done against the
+ the `HEAD` commit. The revert is done against the
beginning state of your index.
+
This is useful when reverting more than one commits'
@@ -125,13 +125,13 @@ EXAMPLES
--------
`git revert HEAD~3`::
- Revert the changes specified by the fourth last commit in HEAD
+ Revert the changes specified by the fourth last commit in `HEAD`
and create a new commit with the reverted changes.
`git revert -n master~5..master~2`::
Revert the changes done by commits from the fifth last commit
- in master (included) to the third last commit in master
+ in `master` (included) to the third last commit in `master`
(included), but do not create any commit with the reverted
changes. The revert only modifies the working tree and the
index.
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt
index e7ff1b5fbd..ea1f349a87 100644
--- a/Documentation/git-rm.txt
+++ b/Documentation/git-rm.txt
@@ -153,7 +153,7 @@ the submodule's history. If it exists the submodule.<name> section
in the linkgit:gitmodules[5] file will also be removed and that file
will be staged (unless `--cached` or `-n` are used).
-A submodule is considered up to date when the HEAD is the same as
+A submodule is considered up to date when the `HEAD` is the same as
recorded in the index, no tracked files are modified and no untracked
files that aren't ignored are present in the submodules work tree.
Ignored files are deemed expendable and won't stop a submodule's work
diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index 8c739adc70..9d7ba22603 100644
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -35,7 +35,7 @@ OPTIONS
--head::
- Show the HEAD reference, even if it would normally be filtered out.
+ Show the `HEAD` reference, even if it would normally be filtered out.
--heads::
--tags::
diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt
index 2b1bc7288d..b7a6f9b544 100644
--- a/Documentation/git-show.txt
+++ b/Documentation/git-show.txt
@@ -35,7 +35,7 @@ This manual page describes only the most frequently used options.
OPTIONS
-------
<object>...::
- The names of objects to show (defaults to 'HEAD').
+ The names of objects to show (defaults to `HEAD`).
For a more complete list of ways to spell object names, see
"SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index a8c8c32f1e..a2b69ae00f 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -50,7 +50,7 @@ COMMANDS
push [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [-m|--message <message>] [--pathspec-from-file=<file> [--pathspec-file-nul]] [--] [<pathspec>...]::
Save your local modifications to a new 'stash entry' and roll them
- back to HEAD (in the working tree and in the index).
+ back to `HEAD` (in the working tree and in the index).
The <message> part is optional and gives
the description along with the stashed state.
+
@@ -121,7 +121,7 @@ branch <branchname> [<stash>]::
+
This is useful if the branch on which you ran `git stash push` has
changed enough that `git stash apply` fails due to conflicts. Since
-the stash entry is applied on top of the commit that was HEAD at the
+the stash entry is applied on top of the commit that was `HEAD` at the
time `git stash` was run, it restores the originally stashed state
with no conflicts.
@@ -192,7 +192,7 @@ All changes already added to the index are left intact.
--patch::
This option is only valid for `push` and `save` commands.
+
-Interactively select hunks from the diff between HEAD and the
+Interactively select hunks from the diff between `HEAD` and the
working tree to be stashed. The stash entry is constructed such
that its index state is the same as the index state of your
repository, and its worktree contains only the changes you selected
@@ -237,7 +237,7 @@ Separates pathspec from options for disambiguation purposes.
+
The new stash entry records the modified states only for the files
that match the pathspec. The index entries and working tree files
-are then rolled back to the state in HEAD only for these files,
+are then rolled back to the state in `HEAD` only for these files,
too, leaving files that do not match the pathspec intact.
+
For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 2fa3bc58f7..4b1951c5ce 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -14,7 +14,7 @@ SYNOPSIS
DESCRIPTION
-----------
Displays paths that have differences between the index file and the
-current HEAD commit, paths that have differences between the working
+current `HEAD` commit, paths that have differences between the working
tree and the index file, and paths in the working tree that are not
tracked by Git (and are not ignored by linkgit:gitignore[5]). The first
are what you _would_ commit by running `git commit`; the second and
@@ -88,7 +88,7 @@ configuration variable documented in linkgit:git-config[1].
Ignore changes to submodules when looking for changes. <when> can be
either "none", "untracked", "dirty" or "all", which is the default.
Using "none" will consider the submodule modified when it either contains
- untracked or modified files or its HEAD differs from the commit recorded
+ untracked or modified files or its `HEAD` differs from the commit recorded
in the superproject and can be used to override any settings of the
'ignore' option in linkgit:git-config[1] or linkgit:gitmodules[5]. When
"untracked" is used submodules are not considered dirty when they only
@@ -242,7 +242,7 @@ U U unmerged, both modified
....
Submodules have more state and instead report
- M the submodule has a different HEAD than
+ M the submodule has a different `HEAD` than
recorded in the index
m the submodule has modified content
? the submodule has untracked files
@@ -341,10 +341,10 @@ Field Meaning
<c> is "C" if the commit changed; otherwise ".".
<m> is "M" if it has tracked changes; otherwise ".".
<u> is "U" if there are untracked changes; otherwise ".".
-<mH> The octal file mode in HEAD.
+<mH> The octal file mode in `HEAD`.
<mI> The octal file mode in the index.
<mW> The octal file mode in the worktree.
-<hH> The object name in HEAD.
+<hH> The object name in `HEAD`.
<hI> The object name in the index.
<X><score> The rename or copy score (denoting the percentage
of similarity between the source and target of the
@@ -354,7 +354,7 @@ Field Meaning
<sep> When the `-z` option is used, the 2 pathnames are separated
with a NUL (ASCII 0x00) byte; otherwise, a tab (ASCII 0x09)
byte separates them.
-<origPath> The pathname in the commit at HEAD or in the index.
+<origPath> The pathname in the commit at `HEAD` or in the index.
This is only present in a renamed/copied entry, and
tells where the renamed/copied contents came from.
--------------------------------------------------------
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 1bcde161ca..891c9e48e5 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -39,7 +39,7 @@ add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--dep
to the changeset to be committed next to the current
project: the current project is termed the "superproject".
+
-<repository> is the URL of the new submodule's origin repository.
+<repository> is the URL of the new submodule's `origin` repository.
This may be either an absolute URL, or (if it begins with ./
or ../), the location relative to the superproject's default remote
repository (Please note that to specify a repository 'foo.git'
@@ -50,7 +50,7 @@ of relative URLs in Git is identical to that of relative directories).
+
The default remote is the remote of the remote-tracking branch
of the current branch. If no such remote-tracking branch exists or
-the HEAD is detached, "origin" is assumed to be the default remote.
+the `HEAD` is detached, `origin` is assumed to be the default remote.
If the superproject doesn't have a default remote configured
the superproject is its own authoritative upstream and the current
working directory is used instead.
@@ -88,7 +88,7 @@ If `--recursive` is specified, this command will recurse into nested
submodules, and show their status as well.
+
If you are only interested in changes of the currently initialized
-submodules with respect to the commit recorded in the index or the HEAD,
+submodules with respect to the commit recorded in the index or the `HEAD`,
linkgit:git-status[1] and linkgit:git-diff[1] will provide that information
too (and can also report changes to a submodule's work tree).
@@ -147,7 +147,7 @@ The 'update' procedures supported both from the command line as well as
through the `submodule.<name>.update` configuration are:
checkout;; the commit recorded in the superproject will be
- checked out in the submodule on a detached HEAD.
+ checked out in the submodule on a detached `HEAD`.
+
If `--force` is specified, the submodule will be checked out (using
`git checkout --force`), even if the commit specified
@@ -183,7 +183,7 @@ set-branch (-d|--default) [--] <path>::
Sets the default remote tracking branch for the submodule. The
`--branch` option allows the remote branch to be specified. The
`--default` option removes the submodule.<name>.branch configuration
- key, which causes the tracking branch to default to the remote 'HEAD'.
+ key, which causes the tracking branch to default to the remote `HEAD`.
set-url [--] <path> <newurl>::
Sets the URL of the specified submodule to <newurl>. Then, it will
@@ -191,7 +191,7 @@ set-url [--] <path> <newurl>::
configuration.
summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] [<path>...]::
- Show commit summary between the given commit (defaults to HEAD) and
+ Show commit summary between the given commit (defaults to `HEAD`) and
working tree/index. For a submodule in question, a series of commits
in the submodule between the given super project commit and the
index or working tree (switched by `--cached`) are shown. If the option
@@ -284,7 +284,7 @@ OPTIONS
`.gitmodules` for `update --remote`. A special value of `.` is used to
indicate that the name of the branch in the submodule should be the
same name as the current branch in the current repository. If the
- option is not specified, it defaults to the remote 'HEAD'.
+ option is not specified, it defaults to the remote `HEAD`.
-f::
--force::
@@ -301,12 +301,12 @@ OPTIONS
--cached::
This option is only valid for status and summary commands. These
- commands typically use the commit found in the submodule HEAD, but
+ commands typically use the commit found in the submodule `HEAD`, but
with this option, the commit stored in the index is used instead.
--files::
This option is only valid for the summary command. This command
- compares the commit in the index with that in the submodule HEAD
+ compares the commit in the index with that in the submodule `HEAD`
when this option is used.
-n::
@@ -339,7 +339,7 @@ SHA-1. If you don't want to fetch, you should use `submodule update
--remote --no-fetch`.
+
Use this option to integrate changes from the upstream subproject with
-your submodule's current HEAD. Alternatively, you can run `git pull`
+your submodule's current `HEAD`. Alternatively, you can run `git pull`
from the submodule, which is equivalent except for the remote branch
name: `update --remote` uses the default upstream repository and
`submodule.<name>.branch`, while `git pull` uses the submodule's
@@ -355,7 +355,7 @@ the submodule itself.
--checkout::
This option is only valid for the update command.
- Checkout the commit recorded in the superproject on a detached HEAD
+ Checkout the commit recorded in the superproject on a detached `HEAD`
in the submodule. This is the default behavior, the main use of
this option is to override `submodule.$name.update` when set to
a value other than `checkout`.
@@ -365,7 +365,7 @@ the submodule itself.
--merge::
This option is only valid for the update command.
Merge the commit recorded in the superproject into the current branch
- of the submodule. If this option is given, the submodule's HEAD will
+ of the submodule. If this option is given, the submodule's `HEAD` will
not be detached. If a merge failure prevents this process, you will
have to resolve the resulting conflicts within the submodule with the
usual conflict resolution tools.
@@ -375,7 +375,7 @@ the submodule itself.
--rebase::
This option is only valid for the update command.
Rebase the current branch onto the commit recorded in the
- superproject. If this option is given, the submodule's HEAD will not
+ superproject. If this option is given, the submodule's `HEAD` will not
be detached. If a merge failure prevents this process, you will have
to resolve these failures with linkgit:git-rebase[1].
If the key `submodule.$name.update` is set to `rebase`, this option is
@@ -432,7 +432,7 @@ options carefully.
--[no-]single-branch::
This option is only valid for the update command.
- Clone only one branch during update: HEAD or one specified by `--branch`.
+ Clone only one branch during update: `HEAD` or one specified by `--branch`.
<path>...::
Paths to submodule(s). When specified this will restrict the command
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 3f55e9c419..f316b7dfc4 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -140,7 +140,7 @@ repository, either don't use this option or you should both use it in
the same local time zone.
--parent;;
- Fetch only from the SVN parent of the current HEAD.
+ Fetch only from the SVN parent of the current `HEAD`.
--ignore-refs=<regex>;;
Ignore refs for branches or tags matching the Perl regular
@@ -224,7 +224,7 @@ config key: svn-remote.<name>.include-paths
Default: ".gitignore"
'rebase'::
- This fetches revisions from the SVN parent of the current HEAD
+ This fetches revisions from the SVN parent of the current `HEAD`
and rebases the current (uncommitted to SVN) work against it.
+
This works similarly to `svn update` or 'git pull' except that
@@ -394,7 +394,7 @@ Any other arguments are passed directly to 'git log'
output of this mode is format-compatible with the output of
`svn blame' by default. Like the SVN blame command,
local uncommitted changes in the working tree are ignored;
- the version of the file in the HEAD revision is annotated. Unknown
+ the version of the file in the `HEAD` revision is annotated. Unknown
arguments are passed directly to 'git blame'.
+
--git-format;;
@@ -558,7 +558,7 @@ git svn fetch
r2---r3---A---B master
------------
+
-Then fixup "master" with 'git rebase'.
+Then fixup `master` with 'git rebase'.
Do NOT use 'git merge' or your history will not be compatible with a
future 'dcommit'!
+
@@ -954,7 +954,7 @@ HANDLING OF SVN BRANCHES
If 'git svn' is configured to fetch branches (and `--follow-branches`
is in effect), it sometimes creates multiple Git branches for one
SVN branch, where the additional branches have names of the form
-'branchname@nnn' (with nnn an SVN revision number). These additional
+`branchname@nnn` (with nnn an SVN revision number). These additional
branches are created if 'git svn' cannot find a parent commit for the
first commit in an SVN branch, to connect the branch to the history of
the other branches.
@@ -976,7 +976,7 @@ branch was copied from and create appropriate Git commits. This is
indicated by the message "Initializing parent: <branchname>".
Additionally, it will create a special branch named
-'<branchname>@<SVN-Revision>', where <SVN-Revision> is the SVN revision
+`<branchname>@<SVN-Revision>`, where <SVN-Revision> is the SVN revision
number the branch was copied from. This branch will point to the newly
created parent commit of the branch. If in SVN the branch was deleted
and later recreated from a different version, there will be multiple
@@ -988,12 +988,12 @@ single SVN revision.
An example: in an SVN repository with a standard
trunk/tags/branches layout, a directory trunk/sub is created in r.100.
In r.200, trunk/sub is branched by copying it to branches/. 'git svn
-clone -s' will then create a branch 'sub'. It will also create new Git
+clone -s' will then create a branch `sub`. It will also create new Git
commits for r.100 through r.199 and use these as the history of branch
-'sub'. Thus there will be two Git commits for each revision from r.100
+`sub`. Thus there will be two Git commits for each revision from r.100
to r.199 (one containing trunk/, one containing trunk/sub/). Finally,
-it will create a branch 'sub@200' pointing to the new parent commit of
-branch 'sub' (i.e. the commit for r.200 and trunk/sub/).
+it will create a branch `sub@200` pointing to the new parent commit of
+branch `sub` (i.e. the commit for r.200 and trunk/sub/).
CAVEATS
-------
diff --git a/Documentation/git-switch.txt b/Documentation/git-switch.txt
index 5c438cd505..5737f25cf6 100644
--- a/Documentation/git-switch.txt
+++ b/Documentation/git-switch.txt
@@ -42,7 +42,7 @@ OPTIONS
<start-point>::
The starting point for the new branch. Specifying a
`<start-point>` allows you to create a branch based on some
- other point in history than where HEAD currently points. (Or,
+ other point in history than where `HEAD` currently points. (Or,
in the case of `--detach`, allows you to inspect and detach
from some other point.)
+
@@ -99,7 +99,7 @@ the `checkout.defaultRemote` configuration variable, we'll use that
one for the purposes of disambiguation, even if the `<branch>` isn't
unique across all remotes. Set it to e.g. `checkout.defaultRemote=origin`
to always checkout remote branches from there if `<branch>` is
-ambiguous but exists on the 'origin' remote. See also
+ambiguous but exists on the `origin` remote. See also
`checkout.defaultRemote` in linkgit:git-config[1].
+
`--guess` is the default behavior. Use `--no-guess` to disable it.
@@ -193,7 +193,7 @@ name, the guessing is aborted. You can explicitly give a name with
EXAMPLES
--------
-The following command switches to the "master" branch:
+The following command switches to the `master` branch:
------------
$ git switch master
@@ -228,14 +228,14 @@ registered in your index file, so `git diff` would show you what
changes you made since the tip of the new branch.
To switch back to the previous branch before we switched to mytopic
-(i.e. "master" branch):
+(i.e. `master` branch):
------------
$ git switch -
------------
You can grow a new branch from any commit. For example, switch to
-"HEAD~3" and create branch "fixup":
+`HEAD~3` and create branch `fixup`:
------------
$ git switch -c fixup HEAD~3
diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt
index ef68ad2b71..2cbec2d033 100644
--- a/Documentation/git-symbolic-ref.txt
+++ b/Documentation/git-symbolic-ref.txt
@@ -39,7 +39,7 @@ OPTIONS
-q::
--quiet::
Do not issue an error message if the <name> is not a
- symbolic ref but a detached HEAD; instead exit with
+ symbolic ref but a detached `HEAD`; instead exit with
non-zero status silently.
--short::
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index b802972bb2..13a0d2abbb 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -209,7 +209,7 @@ This option is only applicable when listing tags without annotation lines.
<commit>::
<object>::
The object that the new tag will refer to, usually a commit.
- Defaults to HEAD.
+ Defaults to `HEAD`.
CONFIGURATION
-------------
diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index 3c3da97c29..be48daa825 100644
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -20,7 +20,7 @@ Given three arguments, stores the <newvalue> in the <ref>,
possibly dereferencing the symbolic refs, after verifying that
the current value of the <ref> matches <oldvalue>.
E.g. `git update-ref refs/heads/master <newvalue> <oldvalue>`
-updates the master branch head to <newvalue> only if its current
+updates the `master` branch head to <newvalue> only if its current
value is <oldvalue>. You can specify 40 "0" or an empty string
as <oldvalue> to make sure that the ref you are creating does
not exist.
@@ -151,7 +151,7 @@ LOGGING UPDATES
---------------
If config parameter "core.logAllRefUpdates" is true and the ref is one
under "refs/heads/", "refs/remotes/", "refs/notes/", or a pseudoref
-like HEAD or ORIG_HEAD; or the file "$GIT_DIR/logs/<ref>" exists then
+like `HEAD` or `ORIG_HEAD`; or the file "$GIT_DIR/logs/<ref>" exists then
`git update-ref` will append a line to the log file
"$GIT_DIR/logs/<ref>" (dereferencing all symbolic refs before creating
the log name) describing the change in ref value. Log lines are
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index f1bb1fa5f5..35bb1bb120 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -97,7 +97,7 @@ list::
List details of each working tree. The main working tree is listed first,
followed by each of the linked working trees. The output details include
whether the working tree is bare, the revision currently checked out, the
-branch currently checked out (or "detached HEAD" if none), "locked" if
+branch currently checked out (or "detached `HEAD`" if none), "locked" if
the worktree is locked, "prunable" if the worktree can be pruned by `prune`
command.
diff --git a/Documentation/git.txt b/Documentation/git.txt
index fc49a4fd42..dcc52adff6 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -516,7 +516,7 @@ double-quotes and respecting backslash escapes. E.g., the value
`GIT_COMMON_DIR`::
If this variable is set to a path, non-worktree files that are
normally in $GIT_DIR will be taken from this path
- instead. Worktree-specific files such as HEAD or index are
+ instead. Worktree-specific files such as `HEAD` or index are
taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
linkgit:git-worktree[1] for
details. This variable has lower precedence than other path
@@ -914,7 +914,7 @@ standard output.
`GIT_PRINT_SHA1_ELLIPSIS` (deprecated)::
If set to `yes`, print an ellipsis following an
(abbreviated) SHA-1 value. This affects indications of
- detached HEADs (linkgit:git-checkout[1]) and the raw
+ detached `HEAD`s (linkgit:git-checkout[1]) and the raw
diff output (linkgit:git-diff[1]). Printing an
ellipsis in the cases mentioned is no longer considered
adequate and support for it is likely to be removed in the
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index 92e4ba6a2f..0fb18e3f35 100644
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -29,7 +29,7 @@ arguments. Here are the rules:
E.g. `git diff -- HEAD` is, "I have a file called HEAD in my work
tree. Please show changes between the version I staged in the index
and what I have in the work tree for that file", not "show difference
- between the HEAD commit and the work tree as a whole". You can say
+ between the `HEAD` commit and the work tree as a whole". You can say
`git diff HEAD --` to ask for the latter.
* Without disambiguating `--`, Git makes a reasonable guess, but errors
diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
index 633439702f..77573c813c 100644
--- a/Documentation/gitcore-tutorial.txt
+++ b/Documentation/gitcore-tutorial.txt
@@ -330,7 +330,7 @@ object name for the commit to its standard output.
And this is where we create the `.git/refs/heads/master` file
which is pointed at by `HEAD`. This file is supposed to contain
-the reference to the top-of-tree of the master branch, and since
+the reference to the top-of-tree of the `master` branch, and since
that's exactly what 'git commit-tree' spits out, we can do this
all with a sequence of simple shell commands:
@@ -402,7 +402,7 @@ In other words, 'git diff-index' normally compares a tree against the
working tree, but when given the `--cached` flag, it is told to
instead compare against just the index cache contents, and ignore the
current working tree state entirely. Since we just wrote the index
-file to HEAD, doing `git diff-index --cached -p HEAD` should thus return
+file to `HEAD`, doing `git diff-index --cached -p HEAD` should thus return
an empty set of differences, and that's exactly what it does.
[NOTE]
@@ -446,7 +446,7 @@ flag or not, since now the index is coherent with the working tree.
Now, since we've updated `hello` in the index, we can commit the new
version. We could do it by writing the tree by hand again, and
committing the tree (this time we'd have to use the `-p HEAD` flag to
-tell commit that the HEAD was the *parent* of the new commit, and that
+tell commit that the `HEAD` was the *parent* of the new commit, and that
this wasn't an initial commit any more), but you've done that once
already, so let's just use the helpful script this time:
@@ -822,7 +822,7 @@ commit log message from the command line.
Now, to make it a bit more interesting, let's assume that somebody else
does some work in the original branch, and simulate that by going back
-to the master branch, and editing the same file differently there:
+to the `master` branch, and editing the same file differently there:
------------
$ git switch master
@@ -838,7 +838,7 @@ $ echo "Lots of fun" >>example
$ git commit -m "Some fun." -i hello example
------------
-since the master branch is obviously in a much better mood.
+since the `master` branch is obviously in a much better mood.
Now, you've got two branches, and you decide that you want to merge the
work done. Before we do that, let's introduce a cool graphical tool that
@@ -933,21 +933,21 @@ shows an ordinary commit on the current branch, `-` is a merge commit), which
means they are now part of the `master` branch. Only the "Some
work" commit has the plus `+` character in the second column,
because `mybranch` has not been merged to incorporate these
-commits from the master branch. The string inside brackets
+commits from the `master` branch. The string inside brackets
before the commit log message is a short name you can use to
-name the commit. In the above example, 'master' and 'mybranch'
-are branch heads. 'master^' is the first parent of 'master'
+name the commit. In the above example, `master` and `mybranch`
+are branch heads. `master^` is the first parent of `master`
branch head. Please see linkgit:gitrevisions[7] if you want to
see more complex cases.
[NOTE]
Without the `--more=1` option, 'git show-branch' would not output the
'[master^]' commit, as '[mybranch]' commit is a common ancestor of
-both 'master' and 'mybranch' tips. Please see linkgit:git-show-branch[1]
+both `master` and `mybranch` tips. Please see linkgit:git-show-branch[1]
for details.
[NOTE]
-If there were more commits on the 'master' branch after the merge, the
+If there were more commits on the `master` branch after the merge, the
merge commit itself would not be shown by 'git show-branch' by
default. You would need to provide `--sparse` option to make the
merge commit visible in this case.
@@ -1523,7 +1523,7 @@ like this:
the initial cloning is stored in the remote.origin.url
configuration variable.
-2. Do your work in your repository on 'master' branch.
+2. Do your work in your repository on `master` branch.
3. Run `git fetch origin` from the public repository of your
upstream every once in a while. This does only the first
@@ -1559,9 +1559,9 @@ using branches with Git.
We have already seen how branches work previously,
with "fun and work" example using two branches. The idea is the
same if there are more than two branches. Let's say you started
-out from "master" head, and have some new code in the "master"
-branch, and two independent fixes in the "commit-fix" and
-"diff-fix" branches:
+out from `master` head, and have some new code in the `master`
+branch, and two independent fixes in the `commit-fix` and
+`diff-fix` branches:
------------
$ git show-branch
@@ -1577,8 +1577,8 @@ $ git show-branch
------------
Both fixes are tested well, and at this point, you want to merge
-in both of them. You could merge in 'diff-fix' first and then
-'commit-fix' next, like this:
+in both of them. You could merge in `diff-fix` first and then
+`commit-fix` next, like this:
------------
$ git merge -m "Merge fix in diff-fix" diff-fix
@@ -1607,8 +1607,8 @@ first and the other next, when what you have are a set of truly
independent changes (if the order mattered, then they are not
independent by definition). You could instead merge those two
branches into the current branch at once. First let's undo what
-we just did and start over. We would want to get the master
-branch before these two merges by resetting it to 'master~2':
+we just did and start over. We would want to get the `master`
+branch before these two merges by resetting it to `master~2`:
------------
$ git reset --hard master~2
diff --git a/Documentation/giteveryday.txt b/Documentation/giteveryday.txt
index faba2ef088..03c9e5e8d5 100644
--- a/Documentation/giteveryday.txt
+++ b/Documentation/giteveryday.txt
@@ -104,8 +104,8 @@ modification will be caught if you do `git commit -a` later.
<6> look at all your changes including the previous commit.
<7> amend the previous commit, adding all your new changes,
using your original message.
-<8> switch to the master branch.
-<9> merge a topic branch into your master branch.
+<8> switch to the `master` branch.
+<9> merge a topic branch into your `master` branch.
<10> review commit logs; other forms to limit output can be
combined and include `-10` (to show up to 10 commits),
`--until=2005-12-10`, etc.
@@ -123,7 +123,7 @@ addition to the ones needed by a standalone developer.
* linkgit:git-clone[1] from the upstream to prime your local
repository.
- * linkgit:git-pull[1] and linkgit:git-fetch[1] from "origin"
+ * linkgit:git-pull[1] and linkgit:git-fetch[1] from `origin`
to keep up-to-date with the upstream.
* linkgit:git-push[1] to shared repository, if you adopt CVS
@@ -160,9 +160,9 @@ $ git reset --hard ORIG_HEAD <10>
$ git gc <11>
------------
+
-<1> checkout a new branch `mine` from master.
+<1> checkout a new branch `mine` from `master`.
<2> repeat as needed.
-<3> extract patches from your branch, relative to master,
+<3> extract patches from your branch, relative to `master`,
<4> and email them.
<5> return to `master`, ready to see what's new
<6> `git pull` fetches from `origin` by default and merges into the
@@ -210,7 +210,7 @@ remote-tracking branches on the mothership machine. You could use this
as a back-up method. Likewise, you can pretend that mothership
"fetched" from you (useful when access is one sided).
<5> on mothership machine, merge the work done on the satellite
-machine into the master branch.
+machine into the `master` branch.
Branch off of a specific tag.::
+
@@ -305,7 +305,7 @@ master or exposed as a part of a stable branch.
<8> and bundle topic branches still cooking.
<9> backport a critical fix.
<10> create a signed tag.
-<11> make sure master was not accidentally rewound beyond that
+<11> make sure `master` was not accidentally rewound beyond that
already pushed out.
<12> In the output from `git show-branch`, `master` should have
everything `ko/master` has, and `next` should have
@@ -446,7 +446,7 @@ refs/tags/v[0-9]* david
<2> and make the shared repository writable by the group.
<3> use update-hook example by Carl from Documentation/howto/
for branch policy control.
-<4> alice and cindy can push into master, only bob can push into doc-update.
+<4> alice and cindy can push into `master`, only bob can push into `doc-update`.
david is the release manager and is the only person who can
create and push version tags.
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index b51959ff94..5e87987882 100644
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -189,8 +189,8 @@ post-checkout
This hook is invoked when a linkgit:git-checkout[1] or
linkgit:git-switch[1] is run after having updated the
-worktree. The hook is given three parameters: the ref of the previous HEAD,
-the ref of the new HEAD (which may or may not have changed), and a flag
+worktree. The hook is given three parameters: the ref of the previous `HEAD`,
+the ref of the new `HEAD` (which may or may not have changed), and a flag
indicating whether the checkout was a branch checkout (changing branches,
flag=1) or a file checkout (retrieving a file from the index, flag=0).
This hook cannot affect the outcome of `git switch` or `git checkout`,
@@ -199,11 +199,11 @@ these two commands.
It is also run after linkgit:git-clone[1], unless the `--no-checkout` (`-n`) option is
used. The first parameter given to the hook is the null-ref, the second the
-ref of the new HEAD and the flag is always 1. Likewise for `git worktree add`
+ref of the new `HEAD` and the flag is always 1. Likewise for `git worktree add`
unless `--no-checkout` is used.
This hook can be used to perform repository validity checks, auto-display
-differences from the previous HEAD if different, or set working dir metadata
+differences from the previous `HEAD` if different, or set working dir metadata
properties.
post-merge
diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index 6ceeae227c..29bd307bb9 100644
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -64,7 +64,7 @@ linkgit:git-rev-list[1] for a complete list.
--merge::
After an attempt to merge stops with conflicts, show the commits on
- the history between two branches (i.e. the HEAD and the MERGE_HEAD)
+ the history between two branches (i.e. the `HEAD` and the `MERGE_HEAD`)
that modify the conflicted files and do not exist on all the heads
being merged.
diff --git a/Documentation/gitnamespaces.txt b/Documentation/gitnamespaces.txt
index b614969ad2..29bac9e1bf 100644
--- a/Documentation/gitnamespaces.txt
+++ b/Documentation/gitnamespaces.txt
@@ -16,7 +16,7 @@ DESCRIPTION
-----------
Git supports dividing the refs of a single repository into multiple
-namespaces, each of which has its own branches, tags, and HEAD. Git can
+namespaces, each of which has its own branches, tags, and `HEAD`. Git can
expose each namespace as an independent repository to pull from and push
to, while sharing the object store, and exposing all the refs to
operations such as linkgit:git-gc[1].
diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
index 6f1e269ae4..f5ac7ae7ca 100644
--- a/Documentation/gitremote-helpers.txt
+++ b/Documentation/gitremote-helpers.txt
@@ -322,9 +322,9 @@ Supported if the helper has the "fetch" capability.
(if there is only one reference to push, a single 'push' command
is followed by a blank line). For example, the following would
be two batches of 'push', the first asking the remote-helper
- to push the local ref 'master' to the remote ref 'master' and
- the local `HEAD` to the remote 'branch', and the second
- asking to push ref 'foo' to ref 'bar' (forced update requested
+ to push the local ref `master` to the remote ref `master` and
+ the local `HEAD` to the remote `branch`, and the second
+ asking to push ref `foo` to ref `bar` (forced update requested
by the '+').
+
------------
diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt
index 1a2ef4c150..e174a28360 100644
--- a/Documentation/gitrepository-layout.txt
+++ b/Documentation/gitrepository-layout.txt
@@ -128,7 +128,7 @@ HEAD::
describing the currently active branch. It does not mean
much if the repository is not associated with any working tree
(i.e. a 'bare' repository), but a valid Git repository
- *must* have the HEAD file; some porcelains may use it to
+ *must* have the `HEAD` file; some porcelains may use it to
guess the designated "default" branch of the repository
(usually 'master'). It is legal if the named branch
'name' does not (yet) exist. In some legacy setups, it is
@@ -137,7 +137,7 @@ HEAD::
+
HEAD can also record a specific commit directly, instead of
being a symref to point at the current branch. Such a state
-is often called 'detached HEAD.' See linkgit:git-checkout[1]
+is often called 'detached `HEAD`.' See linkgit:git-checkout[1]
for details.
config::
diff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt
index e1e09070ad..2b3cba8ae3 100644
--- a/Documentation/gittutorial-2.txt
+++ b/Documentation/gittutorial-2.txt
@@ -132,7 +132,7 @@ and the contents of these files is just the compressed data plus a
header identifying their length and their type. The type is either a
blob, a tree, a commit, or a tag.
-The simplest commit to find is the HEAD commit, which we can find
+The simplest commit to find is the `HEAD` commit, which we can find
from .git/HEAD:
------------------------------------------------
diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt
index ff366cc752..089a89f776 100644
--- a/Documentation/gittutorial.txt
+++ b/Documentation/gittutorial.txt
@@ -182,7 +182,7 @@ Managing branches
-----------------
A single Git repository can maintain multiple branches of
-development. To create a new branch named "experimental", use
+development. To create a new branch named `experimental`, use
------------------------------------------------
$ git branch experimental
@@ -201,8 +201,8 @@ you'll get a list of all existing branches:
* master
------------------------------------------------
-The "experimental" branch is the one you just created, and the
-"master" branch is a default branch that was created for you
+The `experimental` branch is the one you just created, and the
+`master` branch is a default branch that was created for you
automatically. The asterisk marks the branch you are currently on;
type
@@ -211,7 +211,7 @@ $ git switch experimental
------------------------------------------------
to switch to the experimental branch. Now edit a file, commit the
-change, and switch back to the master branch:
+change, and switch back to the `master` branch:
------------------------------------------------
(edit file)
@@ -220,9 +220,9 @@ $ git switch master
------------------------------------------------
Check that the change you made is no longer visible, since it was
-made on the experimental branch and you're back on the master branch.
+made on the experimental branch and you're back on the `master` branch.
-You can make a different change on the master branch:
+You can make a different change on the `master` branch:
------------------------------------------------
(edit file)
@@ -230,7 +230,7 @@ $ git commit -a
------------------------------------------------
at this point the two branches have diverged, with different changes
-made in each. To merge the changes made in experimental into master, run
+made in each. To merge the changes made in `experimental` into `master`, run
------------------------------------------------
$ git merge experimental
@@ -310,7 +310,7 @@ alice$ cd /home/alice/project
alice$ git pull /home/bob/myrepo master
------------------------------------------------
-This merges the changes from Bob's "master" branch into Alice's
+This merges the changes from Bob's `master` branch into Alice's
current branch. If Alice has made her own changes in the meantime,
then she may need to manually fix any conflicts.
@@ -327,7 +327,7 @@ some way and pull again when this happens).
Alice can peek at what Bob did without merging first, using the "fetch"
command; this allows Alice to inspect what Bob did, using a special
-symbol "FETCH_HEAD", in order to determine if he has anything worth
+symbol `FETCH_HEAD`, in order to determine if he has anything worth
pulling, like this:
------------------------------------------------
@@ -336,10 +336,10 @@ alice$ git log -p HEAD..FETCH_HEAD
------------------------------------------------
This operation is safe even if Alice has uncommitted local changes.
-The range notation "HEAD..FETCH_HEAD" means "show everything that is reachable
-from the FETCH_HEAD but exclude anything that is reachable from HEAD".
-Alice already knows everything that leads to her current state (HEAD),
-and reviews what Bob has in his state (FETCH_HEAD) that she has not
+The range notation "`HEAD`..`FETCH_HEAD`" means "show everything that is reachable
+from the `FETCH_HEAD` but exclude anything that is reachable from `HEAD`".
+Alice already knows everything that leads to her current state (`HEAD`),
+and reviews what Bob has in his state (`FETCH_HEAD`) that she has not
seen with this command.
If Alice wants to visualize what Bob did since their histories forked
@@ -397,10 +397,10 @@ alice$ git log -p master..bob/master
-------------------------------------
shows a list of all the changes that Bob made since he branched from
-Alice's master branch.
+Alice's `master` branch.
After examining those changes, Alice
-could merge the changes into her master branch:
+could merge the changes into her `master` branch:
-------------------------------------
alice$ git merge bob/master
@@ -436,8 +436,8 @@ bob$ git config --get remote.origin.url
`git config -l`, and the linkgit:git-config[1] man page
explains the meaning of each option.)
-Git also keeps a pristine copy of Alice's master branch under the
-name "origin/master":
+Git also keeps a pristine copy of Alice's `master` branch under the
+name `origin/master`:
-------------------------------------
bob$ git branch -r
@@ -570,22 +570,22 @@ $ git log v2.5.. Makefile # commits since v2.5 which modify
You can also give 'git log' a "range" of commits where the first is not
necessarily an ancestor of the second; for example, if the tips of
-the branches "stable" and "master" diverged from a common
+the branches `stable` and `master` diverged from a common
commit some time ago, then
-------------------------------------
$ git log stable..master
-------------------------------------
-will list commits made in the master branch but not in the
-stable branch, while
+will list commits made in the `master` branch but not in the
+`stable` branch, while
-------------------------------------
$ git log master..stable
-------------------------------------
-will show the list of commits made on the stable branch but not
-the master branch.
+will show the list of commits made on the `stable` branch but not
+the `master` branch.
The 'git log' command has a weakness: it must present commits in a
list. When the history has lines of development that diverged and
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index 3cc9b034c4..ee6e6a30fd 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -291,7 +291,7 @@ action::
is not set, and to 'summary' otherwise.
revision::
- Revision shown. Defaults to HEAD.
+ Revision shown. Defaults to `HEAD`.
path::
The path within the <repository> that the action is performed on,
@@ -385,7 +385,7 @@ The 'shortlog' view is more compact; it shows one commit per line.
history::
Shows history of the file or directory in a given repository path,
- starting from given revision (defaults to HEAD, i.e. default branch).
+ starting from given revision (defaults to `HEAD`, i.e. default branch).
+
This view is similar to 'shortlog' view.
diff --git a/Documentation/gitworkflows.txt b/Documentation/gitworkflows.txt
index 47cf97f9be..07344bf85a 100644
--- a/Documentation/gitworkflows.txt
+++ b/Documentation/gitworkflows.txt
@@ -75,25 +75,25 @@ As a given feature goes from experimental to stable, it also
"graduates" between the corresponding branches of the software.
`git.git` uses the following 'integration branches':
-* 'maint' tracks the commits that should go into the next "maintenance
+* `maint` tracks the commits that should go into the next "maintenance
release", i.e., update of the last released stable version;
-* 'master' tracks the commits that should go into the next release;
+* `master` tracks the commits that should go into the next release;
-* 'next' is intended as a testing branch for topics being tested for
- stability for master.
+* `next` is intended as a testing branch for topics being tested for
+ stability for `master`.
There is a fourth official branch that is used slightly differently:
-* 'seen' (patches seen by the maintainer) is an integration branch for
+* `seen` (patches seen by the maintainer) is an integration branch for
things that are not quite ready for inclusion yet (see "Integration
Branches" below).
Each of the four branches is usually a direct descendant of the one
above it.
-Conceptually, the feature enters at an unstable branch (usually 'next'
-or 'seen'), and "graduates" to 'master' for the next release once it is
+Conceptually, the feature enters at an unstable branch (usually `next`
+or `seen`), and "graduates" to `master` for the next release once it is
considered stable enough.
@@ -113,7 +113,7 @@ other.
=====================================
This gives a very controlled flow of fixes. If you notice that you
-have applied a fix to e.g. 'master' that is also required in 'maint',
+have applied a fix to e.g. `master` that is also required in `maint`,
you will need to cherry-pick it (using linkgit:git-cherry-pick[1])
downwards. This will happen a few times and is nothing to worry about
unless you do it very frequently.
@@ -149,11 +149,11 @@ Many things can then be done very naturally:
it. If the topic has evolved further in the meantime, merge again.
(Note that you do not necessarily have to merge it to the oldest
integration branch first. For example, you can first merge a bugfix
- to 'next', give it some testing time, and merge to 'maint' when you
+ to `next`, give it some testing time, and merge to `maint` when you
know it is stable.)
-* If you find you need new features from the branch 'other' to continue
- working on your topic, merge 'other' to 'topic'. (However, do not
+* If you find you need new features from the branch `other` to continue
+ working on your topic, merge `other` to `topic`. (However, do not
do this "just habitually", see below.)
* If you find you forked off the wrong branch and want to move it
@@ -207,7 +207,7 @@ If you make it (very) clear that this branch is going to be deleted
right after the testing, you can even publish this branch, for example
to give the testers a chance to work with it, or other developers a
chance to see if their in-progress work will be compatible. `git.git`
-has such an official throw-away integration branch called 'seen'.
+has such an official throw-away integration branch called `seen`.
Branch management for a release
@@ -217,27 +217,27 @@ Assuming you are using the merge approach discussed above, when you
are releasing your project you will need to do some additional branch
management work.
-A feature release is created from the 'master' branch, since 'master'
+A feature release is created from the `master` branch, since `master`
tracks the commits that should go into the next feature release.
-The 'master' branch is supposed to be a superset of 'maint'. If this
-condition does not hold, then 'maint' contains some commits that
-are not included on 'master'. The fixes represented by those commits
+The `master` branch is supposed to be a superset of `maint`. If this
+condition does not hold, then `maint` contains some commits that
+are not included on `master`. The fixes represented by those commits
will therefore not be included in your feature release.
-To verify that 'master' is indeed a superset of 'maint', use git log:
+To verify that `master` is indeed a superset of `maint`, use git log:
-.Verify 'master' is a superset of 'maint'
+.Verify `master` is a superset of `maint`
[caption="Recipe: "]
=====================================
`git log master..maint`
=====================================
This command should not list any commits. Otherwise, check out
-'master' and merge 'maint' into it.
+`master` and merge `maint` into it.
Now you can proceed with the creation of the feature release. Apply a
-tag to the tip of 'master' indicating the release version:
+tag to the tip of `master` indicating the release version:
.Release tagging
[caption="Recipe: "]
@@ -251,9 +251,9 @@ others tracking your project. The push could also trigger a
post-update hook to perform release-related items such as building
release tarballs and preformatted documentation pages.
-Similarly, for a maintenance release, 'maint' is tracking the commits
+Similarly, for a maintenance release, `maint` is tracking the commits
to be released. Therefore, in the steps above simply tag and push
-'maint' rather than 'master'.
+`maint` rather than `master`.
Maintenance branch management after a feature release
@@ -275,10 +275,10 @@ where X.Y.Z is the current release).
`git branch maint-X.Y.(Z-1) maint`
=====================================
-The 'maint' branch should now be fast-forwarded to the newly released
+The `maint` branch should now be fast-forwarded to the newly released
code so that maintenance fixes can be tracked for the current release:
-.Update maint to new release
+.Update `maint` to new release
[caption="Recipe: "]
=====================================
* `git checkout maint`
@@ -286,7 +286,7 @@ code so that maintenance fixes can be tracked for the current release:
=====================================
If the merge fails because it is not a fast-forward, then it is
-possible some fixes on 'maint' were missed in the feature release.
+possible some fixes on `maint` were missed in the feature release.
This will not happen if the content of the branches was verified as
described in the previous section.
@@ -294,9 +294,9 @@ described in the previous section.
Branch management for next and seen after a feature release
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-After a feature release, the integration branch 'next' may optionally be
-rewound and rebuilt from the tip of 'master' using the surviving
-topics on 'next':
+After a feature release, the integration branch `next` may optionally be
+rewound and rebuilt from the tip of `master` using the surviving
+topics on `next`:
.Rewind and rebuild next
[caption="Recipe: "]
@@ -307,20 +307,20 @@ topics on 'next':
* ...
=====================================
-The advantage of doing this is that the history of 'next' will be
-clean. For example, some topics merged into 'next' may have initially
+The advantage of doing this is that the history of `next` will be
+clean. For example, some topics merged into `next` may have initially
looked promising, but were later found to be undesirable or premature.
-In such a case, the topic is reverted out of 'next' but the fact
+In such a case, the topic is reverted out of `next` but the fact
remains in the history that it was once merged and reverted. By
-recreating 'next', you give another incarnation of such topics a clean
+recreating `next`, you give another incarnation of such topics a clean
slate to retry, and a feature release is a good point in history to do
so.
If you do this, then you should make a public announcement indicating
-that 'next' was rewound and rebuilt.
+that `next` was rewound and rebuilt.
-The same rewind and rebuild process may be followed for 'seen'. A public
-announcement is not necessary since 'seen' is a throw-away branch, as
+The same rewind and rebuild process may be followed for `seen`. A public
+announcement is not necessary since `seen` is a throw-away branch, as
described above.
diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index 67c7a50b96..88ee109fdf 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -113,16 +113,16 @@ to point at the new commit.
[[def_detached_HEAD]]detached HEAD::
Normally the <<def_HEAD,HEAD>> stores the name of a
<<def_branch,branch>>, and commands that operate on the
- history HEAD represents operate on the history leading to the
- tip of the branch the HEAD points at. However, Git also
+ history `HEAD` represents operate on the history leading to the
+ tip of the branch the `HEAD` points at. However, Git also
allows you to <<def_checkout,check out>> an arbitrary
<<def_commit,commit>> that isn't necessarily the tip of any
- particular branch. The HEAD in such a state is called
+ particular branch. The `HEAD` in such a state is called
"detached".
+
Note that commands that operate on the history of the current branch
(e.g. `git commit` to build a new history on top of it) still work
-while the HEAD is detached. They update the HEAD to point at the tip
+while the `HEAD` is detached. They update the `HEAD` to point at the tip
of the updated history without affecting any branch. Commands that
update or inquire information _about_ the current branch (e.g. `git
branch --set-upstream-to` that sets what remote-tracking branch the
@@ -193,7 +193,7 @@ for a more flexible and robust system to do the same thing.
[[def_HEAD]]HEAD::
The current <<def_branch,branch>>. In more detail: Your <<def_working_tree,
working tree>> is normally derived from the state of the tree
- referred to by HEAD. HEAD is a reference to one of the
+ referred to by `HEAD`. `HEAD` is a reference to one of the
<<def_head,heads>> in your repository, except when using a
<<def_detached_HEAD,detached HEAD>>, in which case it directly
references an arbitrary commit.
@@ -456,7 +456,7 @@ exclude;;
like refs for the purposes of rev-parse, but which are treated
specially by git. Pseudorefs both have names that are all-caps,
and always start with a line consisting of a
- <<def_SHA1,SHA-1>> followed by whitespace. So, HEAD is not a
+ <<def_SHA1,SHA-1>> followed by whitespace. So, `HEAD` is not a
pseudoref, because it is sometimes a symbolic ref. They might
optionally contain some additional data. `MERGE_HEAD` and
`CHERRY_PICK_HEAD` are examples. Unlike
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 965cb32f9c..e6e9669f68 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -252,7 +252,7 @@ to list all commits on only one side of them is with
`--left-right` (see the example below in the description of
the `--left-right` option). However, it shows the commits that were
cherry-picked from the other branch (for example, ``3rd on b'' may be
-cherry-picked from branch A). With this option, such pairs of commits are
+cherry-picked from branch `A`). With this option, such pairs of commits are
excluded from the output.
--left-only::
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index d9169c062e..33f30b62eb 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -23,8 +23,8 @@ characters and to avoid word splitting.
followed by a dash and a number of commits, followed by a dash, a
'g', and an abbreviated object name.
-'<refname>', e.g. 'master', 'heads/master', 'refs/heads/master'::
- A symbolic ref name. E.g. 'master' typically means the commit
+'<refname>', e.g. `master`, 'heads/master', 'refs/heads/master'::
+ A symbolic ref name. E.g. `master` typically means the commit
object referenced by 'refs/heads/master'. If you
happen to have both 'heads/master' and 'tags/master', you can
explicitly say 'heads/master' to tell Git which one you mean.
@@ -65,7 +65,7 @@ some output processing may assume ref names in UTF-8.
'@'::
'@' alone is a shortcut for `HEAD`.
-'[<refname>]@{<date>}', e.g. 'master@\{yesterday\}', 'HEAD@{5 minutes ago}'::
+'[<refname>]@{<date>}', e.g. `master@{yesterday}`, `HEAD@{5 minutes ago}`::
A ref followed by the suffix '@' with a date specification
enclosed in a brace
pair (e.g. '\{yesterday\}', '{1 month 2 weeks 3 days 1 hour 1
@@ -74,28 +74,28 @@ some output processing may assume ref names in UTF-8.
used immediately following a ref name and the ref must have an
existing log ('$GIT_DIR/logs/<ref>'). Note that this looks up the state
of your *local* ref at a given time; e.g., what was in your local
- 'master' branch last week. If you want to look at commits made during
+ `master` branch last week. If you want to look at commits made during
certain times, see `--since` and `--until`.
-'<refname>@{<n>}', e.g. 'master@\{1\}'::
+'<refname>@{<n>}', e.g. `master@{1}`::
A ref followed by the suffix '@' with an ordinal specification
enclosed in a brace pair (e.g. '\{1\}', '\{15\}') specifies
- the n-th prior value of that ref. For example 'master@\{1\}'
- is the immediate prior value of 'master' while 'master@\{5\}'
- is the 5th prior value of 'master'. This suffix may only be used
+ the n-th prior value of that ref. For example `master@{1}`
+ is the immediate prior value of `master` while `master@{5}`
+ is the 5th prior value of `master`. This suffix may only be used
immediately following a ref name and the ref must have an existing
log ('$GIT_DIR/logs/<refname>').
'@{<n>}', e.g. '@\{1\}'::
You can use the '@' construct with an empty ref part to get at a
reflog entry of the current branch. For example, if you are on
- branch 'blabla' then '@\{1\}' means the same as 'blabla@\{1\}'.
+ branch `blabla` then `@{1}` means the same as `blabla@{1}`.
'@{-<n>}', e.g. '@{-1}'::
The construct '@{-<n>}' means the <n>th branch/commit checked out
before the current one.
-'[<branchname>]@\{upstream\}', e.g. 'master@\{upstream\}', '@\{u\}'::
+'[<branchname>]@\{upstream\}', e.g. `master@{upstream}`, '@\{u\}'::
The suffix '@\{upstream\}' to a branchname (short form '<branchname>@\{u\}')
refers to the branch that the branch specified by branchname is set to build on
top of (configured with `branch.<name>.remote` and
@@ -103,7 +103,7 @@ some output processing may assume ref names in UTF-8.
current one. These suffixes are also accepted when spelled in uppercase, and
they mean the same thing no matter the case.
-'[<branchname>]@\{push\}', e.g. 'master@\{push\}', '@\{push\}'::
+'[<branchname>]@\{push\}', e.g. `master@{push}`, '@\{push\}'::
The suffix '@\{push}' reports the branch "where we would push to" if
`git push` were run while `branchname` was checked out (or the current
`HEAD` if no branchname is specified). Since our push destination is
@@ -131,7 +131,7 @@ from one location and push to another. In a non-triangular workflow,
This suffix is also accepted when spelled in uppercase, and means the same
thing no matter the case.
-'<rev>{caret}[<n>]', e.g. 'HEAD{caret}, v1.5.1{caret}0'::
+'<rev>{caret}[<n>]', e.g. `HEAD^`, 'v1.5.1{caret}0'::
A suffix '{caret}' to a revision parameter means the first parent of
that commit object. '{caret}<n>' means the <n>th parent (i.e.
'<rev>{caret}'
@@ -139,7 +139,7 @@ thing no matter the case.
'<rev>{caret}0' means the commit itself and is used when '<rev>' is the
object name of a tag object that refers to a commit object.
-'<rev>{tilde}[<n>]', e.g. 'HEAD{tilde}, master{tilde}3'::
+'<rev>{tilde}[<n>]', e.g. `HEAD~`, `master~3`::
A suffix '{tilde}' to a revision parameter means the first parent of
that commit object.
A suffix '{tilde}<n>' to a revision parameter means the commit
@@ -175,7 +175,7 @@ existing tag object.
and dereference the tag recursively until a non-tag object is
found.
-'<rev>{caret}{/<text>}', e.g. 'HEAD^{/fix nasty bug}'::
+'<rev>{caret}{/<text>}', e.g. `HEAD^{/fix nasty bug}`::
A suffix '{caret}' to a revision parameter, followed by a brace
pair that contains a text led by a slash,
is the same as the ':/fix nasty bug' syntax below except that
@@ -186,7 +186,7 @@ existing tag object.
A colon, followed by a slash, followed by a text, names
a commit whose commit message matches the specified regular expression.
This name returns the youngest matching commit which is
- reachable from any ref, including HEAD.
+ reachable from any ref, including `HEAD`.
The regular expression can match any part of the
commit message. To match messages starting with a string, one can use
e.g. ':/^foo'. The special sequence ':/!' is reserved for modifiers to what
@@ -196,7 +196,7 @@ existing tag object.
Depending on the given text, the shell's word splitting rules might
require additional quoting.
-'<rev>:<path>', e.g. 'HEAD:README', 'master:./README'::
+'<rev>:<path>', e.g. `HEAD:README`, `master:./README`::
A suffix ':' followed by a path names the blob or tree
at the given path in the tree-ish object named by the part
before the colon.
@@ -287,12 +287,12 @@ The '...' (three-dot) Symmetric Difference Notation::
It is the set of commits that are reachable from either one of
'r1' (left side) or 'r2' (right side) but not from both.
-In these two shorthand notations, you can omit one end and let it default to HEAD.
-For example, 'origin..' is a shorthand for 'origin..HEAD' and asks "What
-did I do since I forked from the origin branch?" Similarly, '..origin'
-is a shorthand for 'HEAD..origin' and asks "What did the origin do since
-I forked from them?" Note that '..' would mean 'HEAD..HEAD' which is an
-empty range that is both reachable and unreachable from HEAD.
+In these two shorthand notations, you can omit one end and let it default to `HEAD`.
+For example, '`origin`..' is a shorthand for '`origin`..`HEAD`' and asks "What
+did I do since I forked from the `origin` branch?" Similarly, '..`origin`'
+is a shorthand for '`HEAD`..`origin`' and asks "What did the `origin` do since
+I forked from them?" Note that '..' would mean '`HEAD`..`HEAD`' which is an
+empty range that is both reachable and unreachable from `HEAD`.
Other <rev>{caret} Parent Shorthand Notations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -313,7 +313,7 @@ itself).
While '<rev>{caret}<n>' was about specifying a single commit parent, these
three notations also consider its parents. For example you can say
-'HEAD{caret}2{caret}@', however you cannot say 'HEAD{caret}@{caret}2'.
+`HEAD^2^@`, however you cannot say `HEAD^@^2`.
Revision Range Summary
----------------------
@@ -336,17 +336,17 @@ Revision Range Summary
<rev2> but exclude those that are reachable from both. When
either <rev1> or <rev2> is omitted, it defaults to `HEAD`.
-'<rev>{caret}@', e.g. 'HEAD{caret}@'::
+'<rev>{caret}@', e.g. `HEAD^@`::
A suffix '{caret}' followed by an at sign is the same as listing
all parents of '<rev>' (meaning, include anything reachable from
its parents, but not the commit itself).
-'<rev>{caret}!', e.g. 'HEAD{caret}!'::
+'<rev>{caret}!', e.g. `HEAD^!`::
A suffix '{caret}' followed by an exclamation mark is the same
as giving commit '<rev>' and then all its parents prefixed with
'{caret}' to exclude them (and their ancestors).
-'<rev>{caret}-<n>', e.g. 'HEAD{caret}-, HEAD{caret}-2'::
+'<rev>{caret}-<n>', e.g. `HEAD^-`, `HEAD^-2`::
Equivalent to '<rev>{caret}<n>..<rev>', with '<n>' = 1 if not
given.
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 0f9a699c09..62ddf41e75 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -280,7 +280,7 @@ a summary of the commands:
create a new branch `<new>` referencing `<start-point>`, and
check it out.
-The special symbol "HEAD" can always be used to refer to the current
+The special symbol `HEAD` can always be used to refer to the current
branch. In fact, Git uses a file named `HEAD` in the `.git` directory
to remember which branch is current:
@@ -300,7 +300,7 @@ you can check out the commit referenced by a tag:
$ git switch --detach v2.6.17
Note: checking out 'v2.6.17'.
-You are in 'detached HEAD' state. You can look around, make experimental
+You are in 'detached `HEAD`' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by performing another switch.
@@ -309,10 +309,10 @@ do so (now or later) by using `-c` with the switch command again. Example:
git switch -c new_branch_name
-HEAD is now at 427abfa Linux v2.6.17
+`HEAD` is now at 427abfa Linux v2.6.17
------------------------------------------------
-The HEAD then refers to the SHA-1 of the commit instead of to a branch,
+The `HEAD` then refers to the SHA-1 of the commit instead of to a branch,
and git branch shows that you are no longer on a branch:
------------------------------------------------
@@ -323,7 +323,7 @@ $ git branch
master
------------------------------------------------
-In this case we say that the HEAD is "detached".
+In this case we say that the `HEAD` is "detached".
This is an easy way to check out a particular version without having to
make up a name for the new branch. You can still create a new branch
@@ -332,8 +332,8 @@ make up a name for the new branch. You can still create a new branch
[[examining-remote-branches]]
=== Examining branches from a remote repository
-The "master" branch that was created at the time you cloned is a copy
-of the HEAD in the repository that you cloned from. That repository
+The `master` branch that was created at the time you cloned is a copy
+of the `HEAD` in the repository that you cloned from. That repository
may also have had other branches, though, and your local repository
keeps branches which track each of those remote branches, called
remote-tracking branches, which you
@@ -351,7 +351,7 @@ $ git branch -r
origin/todo
------------------------------------------------
-In this example, "origin" is called a remote repository, or "remote"
+In this example, `origin` is called a remote repository, or "remote"
for short. The branches of this repository are called "remote
branches" from our point of view. The remote-tracking branches listed
above were created based on the remote branches at clone time and will
@@ -368,7 +368,7 @@ $ git switch -c my-todo-copy origin/todo
You can also check out `origin/todo` directly to examine it or
write a one-off patch. See <<detached-head,detached head>>.
-Note that the name "origin" is just the name that Git uses by default
+Note that the name `origin` is just the name that Git uses by default
to refer to the repository that you cloned from.
[[how-git-stores-references]]
@@ -391,9 +391,9 @@ under the path given by their name. However, for efficiency reasons
they may also be packed together in a single file; see
linkgit:git-pack-refs[1]).
-As another useful shortcut, the "HEAD" of a repository can be referred
-to just using the name of that repository. So, for example, "origin"
-is usually a shortcut for the HEAD branch in the repository "origin".
+As another useful shortcut, the `HEAD` of a repository can be referred
+to just using the name of that repository. So, for example, `origin`
+is usually a shortcut for the HEAD branch in the repository `origin`.
For the complete list of paths which Git checks for references, and
the order it uses to decide which to choose when there are multiple
@@ -491,9 +491,9 @@ Bisecting: 3537 revisions left to test after this
-------------------------------------------------
If you run `git branch` at this point, you'll see that Git has
-temporarily moved you in "(no branch)". HEAD is now detached from any
+temporarily moved you in "(no branch)". `HEAD` is now detached from any
branch and points directly to a commit (with commit id 65934) that
-is reachable from "master" but not from v2.6.18. Compile and test it,
+is reachable from `master` but not from v2.6.18. Compile and test it,
and see whether it crashes. Assume it does crash. Then:
-------------------------------------------------
@@ -566,7 +566,7 @@ We have seen several ways of naming commits already:
- tag name: refers to the commit pointed to by the given tag
(we've seen branches and tags are special cases of
<<how-git-stores-references,references>>).
- - HEAD: refers to the head of the current branch
+ - `HEAD`: refers to the head of the current branch
There are many more; see the "SPECIFYING REVISIONS" section of the
linkgit:gitrevisions[7] man page for the complete list of ways to
@@ -589,24 +589,24 @@ $ git show HEAD^1 # show the first parent of HEAD
$ git show HEAD^2 # show the second parent of HEAD
-------------------------------------------------
-In addition to HEAD, there are several other special names for
+In addition to `HEAD`, there are several other special names for
commits:
Merges (to be discussed later), as well as operations such as
`git reset`, which change the currently checked-out commit, generally
-set ORIG_HEAD to the value HEAD had before the current operation.
+set `ORIG_HEAD` to the value `HEAD` had before the current operation.
The `git fetch` operation always stores the head of the last fetched
-branch in FETCH_HEAD. For example, if you run `git fetch` without
+branch in `FETCH_HEAD`. For example, if you run `git fetch` without
specifying a local branch as the target of the operation
-------------------------------------------------
$ git fetch git://example.com/proj.git theirbranch
-------------------------------------------------
-the fetched commits will still be available from FETCH_HEAD.
+the fetched commits will still be available from `FETCH_HEAD`.
-When we discuss merges we'll also see the special name MERGE_HEAD,
+When we discuss merges we'll also see the special name `MERGE_HEAD`,
which refers to the other branch that we're merging in to the current
branch.
@@ -914,7 +914,7 @@ any version of a project; for example:
$ git archive -o latest.tar.gz --prefix=project/ HEAD
-------------------------------------------------
-will use HEAD to produce a gzipped tar archive in which each filename
+will use `HEAD` to produce a gzipped tar archive in which each filename
is preceded by `project/`. The output file format is inferred from
the output file extension if possible, see linkgit:git-archive[1] for
details.
@@ -1037,8 +1037,8 @@ at step 3, Git maintains a snapshot of the tree's contents in a
special staging area called "the index."
At the beginning, the content of the index will be identical to
-that of the HEAD. The command `git diff --cached`, which shows
-the difference between the HEAD and the index, should therefore
+that of the `HEAD`. The command `git diff --cached`, which shows
+the difference between the `HEAD` and the index, should therefore
produce no output at that point.
Modifying the index is easy:
@@ -1061,7 +1061,7 @@ After each step you can verify that
$ git diff --cached
-------------------------------------------------
-always shows the difference between the HEAD and the index file--this
+always shows the difference between the `HEAD` and the index file--this
is what you'd commit if you created the commit now--and that
-------------------------------------------------
@@ -1283,8 +1283,8 @@ index 802992c,2b60207..0000000
Recall that the commit which will be committed after we resolve this
conflict will have two parents instead of the usual one: one parent
-will be HEAD, the tip of the current branch; the other will be the
-tip of the other branch, which is stored temporarily in MERGE_HEAD.
+will be `HEAD`, the tip of the current branch; the other will be the
+tip of the other branch, which is stored temporarily in `MERGE_HEAD`.
During the merge, the index holds three versions of each file. Each of
these three "file stages" represents a different version of the file:
@@ -1348,8 +1348,8 @@ $ git log --merge
$ gitk --merge
-------------------------------------------------
-These will display all commits which exist only on HEAD or on
-MERGE_HEAD, and which touch an unmerged file.
+These will display all commits which exist only on `HEAD` or on
+`MERGE_HEAD`, and which touch an unmerged file.
You may also use linkgit:git-mergetool[1], which lets you merge the
unmerged files using external tools such as Emacs or kdiff3.
@@ -1433,7 +1433,7 @@ commit; for example, to revert the most recent commit:
$ git revert HEAD
-------------------------------------------------
-This will create a new commit which undoes the change in HEAD. You
+This will create a new commit which undoes the change in `HEAD`. You
will be given a chance to edit the commit message for the new commit.
You can also revert an earlier change, for example, the next-to-last:
@@ -1486,7 +1486,7 @@ linkgit:git-restore[1]. The command
$ git restore --source=HEAD^ path/to/file
-------------------------------------------------
-replaces path/to/file by the contents it had in the commit HEAD^, and
+replaces path/to/file by the contents it had in the commit `HEAD^`, and
also updates the index to match. It does not change branches.
If you just want to look at an old version of the file, without
@@ -1600,13 +1600,13 @@ $ gitk master@{"1 week ago"} # ... or last week
$ git log --walk-reflogs master # show reflog entries for master
-------------------------------------------------
-A separate reflog is kept for the HEAD, so
+A separate reflog is kept for the `HEAD`, so
-------------------------------------------------
$ git show HEAD@{"1 week ago"}
-------------------------------------------------
-will show what HEAD pointed to one week ago, not what the current branch
+will show what `HEAD` pointed to one week ago, not what the current branch
pointed to one week ago. This allows you to see the history of what
you've checked out.
@@ -1677,7 +1677,7 @@ into your own work.
We have already seen <<Updating-a-repository-With-git-fetch,how to
keep remote-tracking branches up to date>> with linkgit:git-fetch[1],
and how to merge two branches. So you can merge in changes from the
-original repository's master branch with:
+original repository's `master` branch with:
-------------------------------------------------
$ git fetch
@@ -1692,7 +1692,7 @@ $ git pull origin master
-------------------------------------------------
In fact, if you have `master` checked out, then this branch has been
-configured by `git clone` to get changes from the HEAD branch of the
+configured by `git clone` to get changes from the `HEAD` branch of the
origin repository. So often you can
accomplish the above with just a simple
@@ -2568,7 +2568,7 @@ You can also edit a patch series with an interactive rebase. This is
the same as <<reordering-patch-series,reordering a patch series using
`format-patch`>>, so use whichever interface you like best.
-Rebase your current HEAD on the last commit you want to retain as-is.
+Rebase your current `HEAD` on the last commit you want to retain as-is.
For example, if you want to reorder the last 5 commits, use:
-------------------------------------------------
@@ -2980,7 +2980,7 @@ file data at changing paths suggests a rename. (See, for example, the
`-M` option to linkgit:git-diff[1]).
A commit is usually created by linkgit:git-commit[1], which creates a
-commit whose parent is normally the current HEAD, and whose tree is
+commit whose parent is normally the current `HEAD`, and whose tree is
taken from the content currently stored in the index.
[[tree-object]]
@@ -3507,7 +3507,7 @@ $ ls -a
The `git submodule add <repo> <path>` command does a couple of things:
- It clones the submodule from `<repo>` to the given `<path>` under the
- current directory and by default checks out the master branch.
+ current directory and by default checks out the `master` branch.
- It adds the submodule's clone path to the linkgit:gitmodules[5] file and
adds this file to the index, ready to be committed.
- It adds the submodule's current commit ID to the index, ready to be
@@ -3540,7 +3540,7 @@ $ git submodule status
-------------------------------------------------
NOTE: The commit object names shown above would be different for you, but they
-should match the HEAD commit object names of your repositories. You can check
+should match the `HEAD` commit object names of your repositories. You can check
it by running `git ls-remote ../a`.
Pulling down the submodules is a two-step process. First run `git submodule
@@ -4334,7 +4334,7 @@ $ git branch new # create branch "new" starting at current HEAD
$ git branch -d new # delete branch "new"
-----------------------------------------------
-Instead of basing a new branch on current HEAD (the default), use:
+Instead of basing a new branch on current `HEAD` (the default), use:
-----------------------------------------------
$ git branch new test # branch named "test"
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 03/13] doc: typeset configuration options in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 01/13] doc: typeset command-line options in monospace Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 02/13] doc: typeset branches and remotes " Firmin Martin
@ 2021-04-09 4:02 ` Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 04/13] doc: typeset git-related commands " Firmin Martin
` (10 subsequent siblings)
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Wrap configuration options with backticks as indicated in the
CodingGuidelines.
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/blame-options.txt | 4 +--
Documentation/diff-options.txt | 10 +++---
Documentation/fetch-options.txt | 4 +--
Documentation/git-branch.txt | 2 +-
Documentation/git-clean.txt | 2 +-
Documentation/git-column.txt | 6 ++--
Documentation/git-commit.txt | 8 ++---
Documentation/git-config.txt | 10 +++---
Documentation/git-credential-cache.txt | 2 +-
Documentation/git-cvsexportcommit.txt | 2 +-
Documentation/git-fetch.txt | 8 ++---
Documentation/git-filter-branch.txt | 4 +--
Documentation/git-for-each-ref.txt | 2 +-
Documentation/git-fsck.txt | 2 +-
Documentation/git-grep.txt | 4 +--
Documentation/git-help.txt | 4 +--
Documentation/git-init.txt | 2 +-
Documentation/git-interpret-trailers.txt | 8 ++---
Documentation/git-ls-files.txt | 2 +-
Documentation/git-ls-remote.txt | 4 +--
Documentation/git-mailinfo.txt | 4 +--
Documentation/git-mv.txt | 4 +--
Documentation/git-notes.txt | 12 +++----
Documentation/git-p4.txt | 12 +++----
Documentation/git-pull.txt | 4 +--
Documentation/git-push.txt | 2 +-
Documentation/git-rebase.txt | 10 +++---
Documentation/git-receive-pack.txt | 2 +-
Documentation/git-remote.txt | 4 +--
Documentation/git-rerere.txt | 2 +-
Documentation/git-rev-parse.txt | 2 +-
Documentation/git-rm.txt | 2 +-
Documentation/git-send-email.txt | 20 +++++------
Documentation/git-status.txt | 8 ++---
Documentation/git-submodule.txt | 4 +--
Documentation/git-svn.txt | 42 ++++++++++++------------
Documentation/git-update-index.txt | 4 +--
Documentation/git-update-ref.txt | 2 +-
Documentation/git-web--browse.txt | 4 +--
Documentation/git.txt | 10 +++---
Documentation/gitattributes.txt | 10 +++---
Documentation/gitcore-tutorial.txt | 4 +--
Documentation/gitcredentials.txt | 2 +-
Documentation/glossary-content.txt | 2 +-
Documentation/pull-fetch-param.txt | 2 +-
Documentation/user-manual.txt | 2 +-
46 files changed, 133 insertions(+), 133 deletions(-)
diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt
index 860e8e2f5c..1d36a176bb 100644
--- a/Documentation/blame-options.txt
+++ b/Documentation/blame-options.txt
@@ -72,8 +72,8 @@ include::line-range-format.txt[]
--date <format>::
Specifies the format used to output dates. If `--date` is not
- provided, the value of the blame.date config variable is
- used. If the blame.date config variable is also not set, the
+ provided, the value of the `blame.date` config variable is
+ used. If the `blame.date` config variable is also not set, the
iso format is used. For supported values, see the discussion
of the `--date` option at linkgit:git-log[1].
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index e4ac746428..86c19bed1e 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -344,20 +344,20 @@ default::
in the future.
plain::
Any line that is added in one location and was removed
- in another location will be colored with 'color.diff.newMoved'.
- Similarly 'color.diff.oldMoved' will be used for removed lines
+ in another location will be colored with `color.diff.newMoved`.
+ Similarly `color.diff.oldMoved` will be used for removed lines
that are added somewhere else in the diff. This mode picks up any
moved line, but it is not very useful in a review to determine
if a block of code was moved without permutation.
blocks::
Blocks of moved text of at least 20 alphanumeric characters
are detected greedily. The detected blocks are
- painted using either the 'color.diff.{old,new}Moved' color.
+ painted using either the `color.diff.{old,new}Moved` color.
Adjacent blocks cannot be told apart.
zebra::
Blocks of moved text are detected as in 'blocks' mode. The blocks
- are painted using either the 'color.diff.{old,new}Moved' color or
- 'color.diff.{old,new}MovedAlternative'. The change between
+ are painted using either the `color.diff.{old,new}Moved` color or
+ `color.diff.{old,new}MovedAlternative`. The change between
the two colors indicates that a new block was detected.
dimmed-zebra::
Similar to 'zebra', but additional dimming of uninteresting parts
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 4ccd65c166..60a268cc4a 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -266,13 +266,13 @@ endif::git-pull[]
--show-forced-updates::
By default, git checks if a branch is force-updated during
- fetch. This can be disabled through fetch.showForcedUpdates, but
+ fetch. This can be disabled through `fetch.showForcedUpdates`, but
the `--show-forced-updates` option guarantees this check occurs.
See linkgit:git-config[1].
--no-show-forced-updates::
By default, git checks if a branch is force-updated during
- fetch. Pass `--no-show-forced-updates` or set fetch.showForcedUpdates
+ fetch. Pass `--no-show-forced-updates` or set `fetch.showForcedUpdates`
to false to skip this check for performance reasons. If used during
'git-pull' the `--ff-only` option will still check for forced updates
before attempting a fast-forward update. See linkgit:git-config[1].
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index fa38fa4dc1..8ea6e1e523 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -215,7 +215,7 @@ This option is only applicable in non-verbose mode.
upstream when the new branch is checked out.
+
This behavior is the default when the start point is a remote-tracking branch.
-Set the branch.autoSetupMerge configuration variable to `false` if you
+Set the `branch.autoSetupMerge` configuration variable to `false` if you
want `git switch`, `git checkout` and `git branch` to always behave as if `--no-track`
were given. Set it to `always` if you want this behavior when the
start-point is either a local or remote-tracking branch.
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index f4246300ae..cbec3e649a 100644
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -35,7 +35,7 @@ OPTIONS
-f::
--force::
- If the Git configuration variable clean.requireForce is not set
+ If the Git configuration variable `clean.requireForce` is not set
to false, 'git clean' will refuse to delete files or directories
unless given `-f` or `-i`. Git will refuse to modify untracked
nested git repositories (directories with a .git subdirectory)
diff --git a/Documentation/git-column.txt b/Documentation/git-column.txt
index 84a02ac15c..ab545fc52d 100644
--- a/Documentation/git-column.txt
+++ b/Documentation/git-column.txt
@@ -21,11 +21,11 @@ columns.
OPTIONS
-------
--command=<name>::
- Look up layout mode using configuration variable column.<name> and
- column.ui.
+ Look up layout mode using configuration variable `column.<name>` and
+ `column.ui`.
--mode=<mode>::
- Specify layout mode. See configuration variable column.ui for option
+ Specify layout mode. See configuration variable `column.ui` for option
syntax in linkgit:git-config[1].
--raw-mode=<n>::
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index f507ae00a1..6d10f2bdc7 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -244,7 +244,7 @@ verbatim::
scissors::
Same as `whitespace` except that everything from (and including)
the line found below is truncated, if the message is to be edited.
- "`#`" can be customized with core.commentChar.
+ "`#`" can be customized with `core.commentChar`.
# ------------------------ >8 ------------------------
@@ -346,7 +346,7 @@ The possible options are:
- 'normal' - Shows untracked files and directories
- 'all' - Also shows individual files in untracked directories.
-The default can be changed using the status.showUntrackedFiles
+The default can be changed using the `status.showUntrackedFiles`
configuration variable documented in linkgit:git-config[1].
--
@@ -378,7 +378,7 @@ changes to tracked files.
Include the output of linkgit:git-status[1] in the commit
message template when using an editor to prepare the commit
message. Defaults to on, but can be used to override
- configuration variable commit.status.
+ configuration variable `commit.status`.
--no-status::
Do not include the output of linkgit:git-status[1] in the
@@ -552,7 +552,7 @@ include::i18n.txt[]
ENVIRONMENT AND CONFIGURATION VARIABLES
---------------------------------------
The editor used to edit the commit log message will be chosen from the
-`GIT_EDITOR` environment variable, the core.editor configuration variable, the
+`GIT_EDITOR` environment variable, the `core.editor` configuration variable, the
`VISUAL` environment variable, or the `EDITOR` environment variable (in that
order). See linkgit:git-var[1] for details.
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index e6d70ffda1..606411c816 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -99,10 +99,10 @@ OPTIONS
names are not.
--get-urlmatch name URL::
- When given a two-part name section.key, the value for
- section.<url>.key whose <url> part matches the best to the
+ When given a two-part name `section.key`, the value for
+ `section.<url>.key` whose <url> part matches the best to the
given URL is returned (if no such key exists, the value for
- section.key is used as a fallback). When given just the
+ `section.key` is used as a fallback). When given just the
section as name, do so for all the keys in the section and
list them. Returns error code 1 if no value is found.
@@ -421,7 +421,7 @@ To delete the entry for renames, do
% git config --unset diff.renames
------------
-If you want to delete an entry for a multivar (like core.gitproxy above),
+If you want to delete an entry for a multivar (like `core.gitproxy` above),
you have to provide a regex matching the value of exactly one line.
To query the value for a given key, do
@@ -448,7 +448,7 @@ If you want to know all the values for a multivar, do:
% git config --get-all core.gitproxy
------------
-If you like to live dangerously, you can replace *all* core.gitproxy by a
+If you like to live dangerously, you can replace *all* `core.gitproxy` by a
new one with
------------
diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt
index 0216c18ef8..b1a9d9b29a 100644
--- a/Documentation/git-credential-cache.txt
+++ b/Documentation/git-credential-cache.txt
@@ -68,7 +68,7 @@ $ git push http://example.com/repo.git
[your credentials are used automatically]
------------------------------------
-You can provide options via the credential.helper configuration
+You can provide options via the `credential.helper` configuration
variable (this example drops the cache time to 5 minutes):
-------------------------------------------------------
diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt
index f08ab508af..76b16f9dae 100644
--- a/Documentation/git-cvsexportcommit.txt
+++ b/Documentation/git-cvsexportcommit.txt
@@ -72,7 +72,7 @@ OPTIONS
Specify the location of the CVS checkout to use for the export. This
option does not require GIT_DIR to be set before execution if the
current directory is within a Git repository. The default is the
- value of 'cvsexportcommit.cvsdir'.
+ value of `cvsexportcommit.cvsdir`.
-W::
Tell cvsexportcommit that the current working directory is not only
diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt
index a5ecf00db3..6c3f41399f 100644
--- a/Documentation/git-fetch.txt
+++ b/Documentation/git-fetch.txt
@@ -26,13 +26,13 @@ By default, any tag that points into the histories being fetched is
also fetched; the effect is to fetch tags that
point at branches that you are interested in. This default behavior
can be changed by using the `--tags` or `--no-tags` options or by
-configuring remote.<name>.tagOpt. By using a refspec that fetches tags
+configuring `remote.<name>.tagOpt`. By using a refspec that fetches tags
explicitly, you can fetch tags that do not point into branches you
are interested in as well.
'git fetch' can fetch from either a single named repository or URL,
or from several repositories at once if <group> is given and
-there is a remotes.<group> entry in the configuration file.
+there is a `remotes.<group>` entry in the configuration file.
(See linkgit:git-config[1]).
When no remote is specified, by default the `origin` remote will be used,
@@ -208,7 +208,7 @@ The status of up-to-date refs is shown only if the `--verbose` option is
used.
In compact output mode, specified with configuration variable
-fetch.output, if either entire `<from>` or `<to>` is found in the
+`fetch.output`, if either entire `<from>` or `<to>` is found in the
other string, it will be substituted with `*` in the other string. For
example, `master -> origin/master` becomes `master -> origin/*`.
@@ -253,7 +253,7 @@ $ git fetch origin
+
The above command copies all branches from the remote refs/heads/
namespace and stores them to the local refs/remotes/origin/ namespace,
-unless the branch.<name>.fetch option is used to specify a non-default
+unless the `branch.<name>.fetch` option is used to specify a non-default
refspec.
* Using refspecs explicitly:
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index e2955bc648..520d3df371 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -365,7 +365,7 @@ git filter-branch --msg-filter '
The `--env-filter` option can be used to modify committer and/or author
identity. For example, if you found out that your commits have the wrong
-identity due to a misconfigured user.email, you can make a correction,
+identity due to a misconfigured `user.email`, you can make a correction,
before publishing the project, like this:
--------------------------------------------------------
@@ -577,7 +577,7 @@ with:
ls-files will only quote filenames if needed, so folks may not
notice that one of the files didn't match the regex (at least not
until it's much too late). Yes, someone who knows about
- core.quotePath can avoid this (unless they have other special
+ `core.quotePath` can avoid this (unless they have other special
characters like \t, \n, or "), and people who use ls-files -z with
something other than grep can avoid this, but that doesn't mean they
will.
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 4bde4f9d05..64ff4a14f8 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -105,7 +105,7 @@ For all objects, the following names can be used:
refname::
The name of the ref (the part after $GIT_DIR/).
For a non-ambiguous short name of the ref append `:short`.
- The option core.warnAmbiguousRefs is used to select the strict
+ The option `core.warnAmbiguousRefs` is used to select the strict
abbreviation mode. If `lstrip=<N>` (`rstrip=<N>`) is appended, strips `<N>`
slash-separated path components from the front (back) of the refname
(e.g. `%(refname:lstrip=2)` turns `refs/tags/foo` into `foo` and
diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt
index e932c75181..d9a28e278d 100644
--- a/Documentation/git-fsck.txt
+++ b/Documentation/git-fsck.txt
@@ -123,7 +123,7 @@ Any corrupt objects you will have to find in backups or other archives
(i.e., you can just remove them and do an 'rsync' with some other site in
the hopes that somebody else has the object you have corrupted).
-If core.commitGraph is true, the commit-graph file will also be inspected
+If `core.commitGraph` is true, the commit-graph file will also be inspected
using 'git commit-graph verify'. See linkgit:git-commit-graph[1].
Extracted Diagnostics
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 84102cc596..88047cefad 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -209,7 +209,7 @@ providing this option will cause it to die.
Use \0 as the delimiter for pathnames in the output, and print
them verbatim. Without this option, pathnames with "unusual"
characters are quoted as explained for the configuration
- variable core.quotePath (see linkgit:git-config[1]).
+ variable `core.quotePath` (see linkgit:git-config[1]).
-o::
--only-matching::
@@ -355,7 +355,7 @@ EXAMPLES
NOTES ON THREADS
----------------
-The `--threads` option (and the grep.threads configuration) will be ignored when
+The `--threads` option (and the `grep.threads` configuration) will be ignored when
`--open-files-in-pager` is used, forcing a single-threaded execution.
When grepping the object store (with `--cached` or giving tree objects), running
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index a19f275f60..392f7be6fa 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -150,7 +150,7 @@ man.<tool>.path
You can explicitly provide a full path to your preferred man viewer by
setting the configuration variable `man.<tool>.path`. For example, you
can configure the absolute path to konqueror by setting
-'man.konqueror.path'. Otherwise, 'git help' assumes the tool is
+`man.konqueror.path`. Otherwise, 'git help' assumes the tool is
available in PATH.
man.<tool>.cmd
@@ -170,7 +170,7 @@ When 'konqueror' is specified in the `man.viewer` configuration
variable, we launch 'kfmclient' to try to open the man page on an
already opened konqueror in a new tab if possible.
-For consistency, we also try such a trick if 'man.konqueror.path' is
+For consistency, we also try such a trick if `man.konqueror.path` is
set to something like `A_PATH_TO/konqueror`. That means we will try to
launch `A_PATH_TO/kfmclient` instead.
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index a3f061517d..47d61fc505 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -83,7 +83,7 @@ customized via the `init.defaultBranch` configuration variable).
Specify that the Git repository is to be shared amongst several users. This
allows users belonging to the same group to push into that
-repository. When specified, the config variable "core.sharedRepository" is
+repository. When specified, the config variable `core.sharedRepository` is
set so that files and directories under `$GIT_DIR` are created with the
requested permissions. When not specified, Git will use permissions reported
by umask(2).
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index 4288e5405c..1160807e0d 100644
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -217,17 +217,17 @@ If there is a separator, then the key will be used instead of both the
<token> and the default separator when adding the trailer.
trailer.<token>.where::
- This option takes the same values as the 'trailer.where'
+ This option takes the same values as the `trailer.where`
configuration variable and it overrides what is specified by
that option for trailers with the specified <token>.
trailer.<token>.ifexists::
- This option takes the same values as the 'trailer.ifexists'
+ This option takes the same values as the `trailer.ifexists`
configuration variable and it overrides what is specified by
that option for trailers with the specified <token>.
trailer.<token>.ifmissing::
- This option takes the same values as the 'trailer.ifmissing'
+ This option takes the same values as the `trailer.ifmissing`
configuration variable and it overrides what is specified by
that option for trailers with the specified <token>.
@@ -247,7 +247,7 @@ replaced with the <value> part of an existing trailer with the same
<token>, if any, before the command is launched.
+
If some '<token>=<value>' arguments are also passed on the command
-line, when a 'trailer.<token>.command' is configured, the command will
+line, when a `trailer.<token>.command` is configured, the command will
also be executed for each of these arguments. And the <value> part of
these arguments, if any, will be used to replace the `$ARG` string in
the command.
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index b42f179aef..d27a33eb22 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -173,7 +173,7 @@ a space) at the start of each line:
--eol::
Show <eolinfo> and <eolattr> of files.
<eolinfo> is the file content identification used by Git when
- the "text" attribute is "auto" (or not set and core.autocrlf is not false).
+ the "text" attribute is "auto" (or not set and `core.autocrlf` is not false).
<eolinfo> is either "-text", "none", "lf", "crlf", "mixed" or "".
+
"" means the file is not a regular file, it is not in the index or
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index af005ece9a..dbe0c69298 100644
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -53,7 +53,7 @@ OPTIONS
--get-url::
Expand the URL of the given remote repository taking into account any
- "url.<base>.insteadOf" config setting (See linkgit:git-config[1]) and
+ `url.<base>.insteadOf` config setting (See linkgit:git-config[1]) and
exit without talking to the remote.
--symref::
@@ -66,7 +66,7 @@ OPTIONS
Sort based on the key given. Prefix `-` to sort in descending order
of the value. Supports "version:refname" or "v:refname" (tag names
are treated as versions). The "version:refname" sort order can also
- be affected by the "versionsort.suffix" configuration variable.
+ be affected by the `versionsort.suffix` configuration variable.
See linkgit:git-for-each-ref[1] for more sort options, but be aware
keys like `committerdate` that require access to the objects
themselves will not work for refs whose objects have not yet been
diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt
index 5bc2982909..c54feb665b 100644
--- a/Documentation/git-mailinfo.txt
+++ b/Documentation/git-mailinfo.txt
@@ -84,10 +84,10 @@ with comments and suggestions on the message you are responding to, and to
conclude it with a patch submission, separating the discussion and the
beginning of the proposed commit log message with a scissors line.
+
-This can be enabled by default with the configuration option mailinfo.scissors.
+This can be enabled by default with the configuration option `mailinfo.scissors`.
--no-scissors::
- Ignore scissors lines. Useful for overriding mailinfo.scissors settings.
+ Ignore scissors lines. Useful for overriding `mailinfo.scissors` settings.
<msg>::
The commit log message extracted from e-mail, usually
diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt
index b3808dcc06..ceb039a697 100644
--- a/Documentation/git-mv.txt
+++ b/Documentation/git-mv.txt
@@ -48,8 +48,8 @@ SUBMODULES
----------
Moving a submodule using a gitfile (which means they were cloned
with a Git version 1.7.8 or newer) will update the gitfile and
-core.worktree setting to make the submodule work in the new location.
-It also will attempt to update the submodule.<name>.path setting in
+`core.worktree` setting to make the submodule work in the new location.
+It also will attempt to update the `submodule.<name>.path` setting in
the linkgit:gitmodules[5] file and stage that file (unless `-n` is used).
BUGS
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index ef04e3a8ff..ac1d191352 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -44,9 +44,9 @@ using the `--notes` option. Such notes are added as a patch commentary
after a three dash separator line.
To change which notes are shown by 'git log', see the
-"notes.displayRef" configuration in linkgit:git-log[1].
+`notes.displayRef` configuration in linkgit:git-log[1].
-See the "notes.rewrite.<command>" configuration for a way to carry
+See the `notes.rewrite.<command>` configuration for a way to carry
notes across commands that rewrite commits.
@@ -161,7 +161,7 @@ OPTIONS
--ref <ref>::
Manipulate the notes tree in <ref>. This overrides
- `GIT_NOTES_REF` and the "core.notesRef" configuration. The ref
+ `GIT_NOTES_REF` and the `core.notesRef` configuration. The ref
specifies the full refname when it begins with `refs/notes/`; when it
begins with `notes/`, `refs/` and otherwise `refs/notes/` is prefixed
to form a full name of the ref.
@@ -185,7 +185,7 @@ OPTIONS
When merging notes, resolve notes conflicts using the given
strategy. The following strategies are recognized: "manual"
(default), "ours", "theirs", "union" and "cat_sort_uniq".
- This option overrides the "notes.mergeStrategy" configuration setting.
+ This option overrides the `notes.mergeStrategy` configuration setting.
See the "NOTES MERGE STRATEGIES" section below for more
information on each notes merge strategy.
@@ -251,7 +251,7 @@ When done, the user can either finalize the merge with
'git notes merge --abort'.
Users may select an automated merge strategy from among the following using
-either `-s`/`--strategy` option or configuring notes.mergeStrategy accordingly:
+either `-s`/`--strategy` option or configuring `notes.mergeStrategy` accordingly:
"ours" automatically resolves conflicting notes in favor of the local
version (i.e. the current notes ref).
@@ -327,7 +327,7 @@ This setting can be overridden by passing the `--strategy` option.
notes.<name>.mergeStrategy::
Which merge strategy to choose when doing a notes merge into
refs/notes/<name>. This overrides the more general
- "notes.mergeStrategy". See the "NOTES MERGE STRATEGIES" section above
+ `notes.mergeStrategy`. See the "NOTES MERGE STRATEGIES" section above
for more information on each available strategy.
notes.displayRef::
diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index ec23ab7d96..326c553083 100644
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -135,7 +135,7 @@ Submit
Submitting changes from a Git repository back to the p4 repository
requires a separate p4 client workspace. This should be specified
using the `P4CLIENT` environment variable or the Git configuration
-variable 'git-p4.client'. The p4 client must exist, but the client root
+variable `git-p4.client`. The p4 client must exist, but the client root
will be created and populated if it does not already exist.
To submit all changes that are in the current Git branch but not in
@@ -367,12 +367,12 @@ These options can be used to modify 'git p4 submit' behavior.
--disable-rebase::
Disable the automatic rebase after all commits have been successfully
- submitted. Can also be set with git-p4.disableRebase.
+ submitted. Can also be set with `git-p4.disableRebase`.
--disable-p4sync::
Disable the automatic sync of p4/master from Perforce after commits have
been submitted. Implies `--disable-rebase`. Can also be set with
- git-p4.disableP4Sync. Sync with origin/master still goes ahead if possible.
+ `git-p4.disableP4Sync`. Sync with origin/master still goes ahead if possible.
Hooks for submit
----------------
@@ -490,7 +490,7 @@ paths map through overlays to the same location in the repository,
dedicating a client spec just for 'git p4'.
The name of the client can be given to 'git p4' in multiple ways. The
-variable 'git-p4.client' takes precedence if it exists. Otherwise,
+variable `git-p4.client` takes precedence if it exists. Otherwise,
normal p4 mechanisms of determining the client are used: environment
variable `P4CLIENT`, a file referenced by `P4CONFIG`, or the local host name.
@@ -530,7 +530,7 @@ called 'master', and one for //depot/branch1 called 'depot/branch1'.
However, it is not necessary to create branches in p4 to be able to use
them like branches. Because it is difficult to infer branch
relationships automatically, a Git configuration setting
-'git-p4.branchList' can be used to explicitly identify branch
+`git-p4.branchList` can be used to explicitly identify branch
relationships. It is a list of "source:destination" pairs, like a
simple p4 branch specification, where the "source" and "destination" are
the path elements in the p4 repository. The example above relied on the
@@ -748,7 +748,7 @@ git-p4.disableRebase::
Do not rebase the tree against p4/master following a submit.
git-p4.disableP4Sync::
- Do not sync p4/master with Perforce following a submit. Implies git-p4.disableRebase.
+ Do not sync p4/master with Perforce following a submit. Implies `git-p4.disableRebase`.
IMPLEMENTATION DETAILS
----------------------
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index d9a5507195..e637686597 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -212,8 +212,8 @@ $ git pull origin
------------------------------------------------
+
Normally the branch merged in is the `HEAD` of the remote repository,
-but the choice is determined by the branch.<name>.remote and
-branch.<name>.merge options; see linkgit:git-config[1] for details.
+but the choice is determined by the `branch.<name>.remote` and
+`branch.<name>.merge` options; see linkgit:git-config[1] for details.
* Merge into the current branch the remote branch `next`:
+
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index 91dcaa108c..aa5db3e6e5 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -411,7 +411,7 @@ Specifying `--no-force-if-includes` disables this behavior.
also be aborted and exit with non-zero status. If 'only' is used all
submodules will be recursively pushed while the superproject is left
unpushed. A value of 'no' or using `--no-recurse-submodules` can be used
- to override the push.recurseSubmodules configuration variable when no
+ to override the `push.recurseSubmodules` configuration variable when no
submodule recursion is required.
--[no-]verify::
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index bd9f15ea26..22287372f7 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -21,7 +21,7 @@ If <branch> is specified, 'git rebase' will perform an automatic
it remains on the current branch.
If <upstream> is not specified, the upstream configured in
-branch.<name>.remote and branch.<name>.merge options will be used (see
+`branch.<name>.remote` and `branch.<name>.merge` options will be used (see
linkgit:git-config[1] for details) and the `--fork-point` option is
assumed. If you are currently not on any branch or if the current
branch does not have a configured upstream, the rebase will abort.
@@ -404,7 +404,7 @@ See also INCOMPATIBLE OPTIONS below.
--stat::
Show a diffstat of what changed upstream since the last rebase. The
- diffstat is also controlled by the configuration option rebase.stat.
+ diffstat is also controlled by the configuration option `rebase.stat`.
-n::
--no-stat::
@@ -509,7 +509,7 @@ See also INCOMPATIBLE OPTIONS below.
split commits (see SPLITTING COMMITS below).
+
The commit list format can be changed by setting the configuration option
-rebase.instructionFormat. A customized instruction format will automatically
+`rebase.instructionFormat`. A customized instruction format will automatically
have the long commit hash prepended to the format.
+
See also INCOMPATIBLE OPTIONS below.
@@ -721,7 +721,7 @@ order to apply the changes to the right lines. However, if multiple
areas of the code have the same surrounding lines of context, the
wrong one can be picked. There are real-world cases where this has
caused commits to be reapplied incorrectly with no conflicts reported.
-Setting diff.context to a larger value may prevent such types of
+Setting `diff.context` to a larger value may prevent such types of
problems, but increases the chance of spurious conflicts (since it
will require more lines of matching context to apply).
@@ -737,7 +737,7 @@ content came from. Since the apply backend drops the original
information about the rebased commits and their parents (and instead
generates new fake commits based off limited information in the
generated patches), those commits cannot be identified; instead it has
-to fall back to a commit summary. Also, when merge.conflictStyle is
+to fall back to a commit summary. Also, when `merge.conflictStyle` is
set to diff3, the apply backend will use "constructed merge base" to
label the content from the merge base, and thus provide no information
about the merge base commit whatsoever.
diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt
index 25702ed730..e6136a0938 100644
--- a/Documentation/git-receive-pack.txt
+++ b/Documentation/git-receive-pack.txt
@@ -29,7 +29,7 @@ the send-pack end, it is updating the remote. Confused?)
There are other real-world examples of using update and
post-update hooks found in the Documentation/howto directory.
-'git-receive-pack' honours the receive.denyNonFastForwards config
+'git-receive-pack' honours the `receive.denyNonFastForwards` config
option, which tells it if updates to a ref should be denied if they
are not fast-forwards.
diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 31c29c9b31..a28c72a9e4 100644
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -188,8 +188,8 @@ actually prune them.
Fetch updates for remotes or remote groups in the repository as defined by
`remotes.<group>`. If neither group nor remote is specified on the command line,
-the configuration parameter remotes.default will be used; if
-remotes.default is not defined, all remotes which do not have the
+the configuration parameter `remotes.default` will be used; if
+`remotes.default` is not defined, all remotes which do not have the
configuration parameter `remote.<name>.skipDefaultUpdate` set to true will
be updated. (See linkgit:git-config[1]).
+
diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt
index c5c6be5202..25990dc40b 100644
--- a/Documentation/git-rerere.txt
+++ b/Documentation/git-rerere.txt
@@ -181,7 +181,7 @@ records the hand resolve when it is a new conflict, or reuses the earlier hand
resolve when it is not. 'git commit' also invokes 'git rerere'
when committing a merge result. What this means is that you do
not have to do anything special yourself (besides enabling
-the rerere.enabled config variable).
+the `rerere.enabled` config variable).
In our example, when you do the test merge, the manual
resolution is recorded, and it will be reused when you do the
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index 7c3c0e0007..5f6224847e 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -143,7 +143,7 @@ for another option.
--abbrev-ref[=(strict|loose)]::
A non-ambiguous short name of the objects name.
- The option core.warnAmbiguousRefs is used to select the strict
+ The option `core.warnAmbiguousRefs` is used to select the strict
abbreviation mode.
--symbolic::
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt
index ea1f349a87..56d9b0627f 100644
--- a/Documentation/git-rm.txt
+++ b/Documentation/git-rm.txt
@@ -149,7 +149,7 @@ tree, as their repository lives inside the .git directory of the
superproject. If a submodule (or one of those nested inside it)
still uses a .git directory, `git rm` will move the submodules
git directory into the superprojects git directory to protect
-the submodule's history. If it exists the submodule.<name> section
+the submodule's history. If it exists the `submodule.<name>` section
in the linkgit:gitmodules[5] file will also be removed and that file
will be staged (unless `--cached` or `-n` are used).
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index afd41a010e..9d9ef3d945 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -128,14 +128,14 @@ This option may be specified multiple times.
When encountering a non-ASCII message or subject that does not
declare its encoding, add headers/quoting to indicate it is
encoded in <encoding>. Default is the value of the
- 'sendemail.assume8bitEncoding'; if that is unspecified, this
+ `sendemail.assume8bitEncoding`; if that is unspecified, this
will be prompted for if any non-ASCII files are encountered.
+
Note that no attempts whatsoever are made to validate the encoding.
--compose-encoding=<encoding>::
Specify encoding of compose message. Default is the value of the
- 'sendemail.composeencoding'; if that is unspecified, UTF-8 is assumed.
+ `sendemail.composeencoding`; if that is unspecified, UTF-8 is assumed.
--transfer-encoding=(7bit|8bit|quoted-printable|base64|auto)::
Specify the transfer encoding to be used to send the message over SMTP.
@@ -189,7 +189,7 @@ $ git send-email --smtp-auth="PLAIN LOGIN GSSAPI" ...
+
If at least one of the specified mechanisms matches the ones advertised by the
SMTP server and if it is supported by the utilized SASL library, the mechanism
-is used for authentication. If neither 'sendemail.smtpAuth' nor `--smtp-auth`
+is used for authentication. If neither `sendemail.smtpAuth` nor `--smtp-auth`
is specified, all mechanisms supported by the SASL library can be used. The
special value 'none' maybe specified to completely disable authentication
independently of `--smtp-user`
@@ -290,7 +290,7 @@ Automating
Specify a command to execute once per patch file which
should generate patch file specific "To:" entries.
Output of this command must be single email address per line.
- Default is the value of 'sendemail.tocmd' configuration value.
+ Default is the value of `sendemail.tocmd` configuration value.
--cc-cmd=<command>::
Specify a command to execute once per patch file which
@@ -308,8 +308,8 @@ Automating
--identity=<identity>::
A configuration identity. When given, causes values in the
- 'sendemail.<identity>' subsection to take precedence over
- values in the 'sendemail' section. The default identity is
+ `sendemail.<identity>` subsection to take precedence over
+ values in the `sendemail` section. The default identity is
the value of `sendemail.identity`.
--[no-]signed-off-by-cc::
@@ -320,13 +320,13 @@ Automating
--[no-]cc-cover::
If this is set, emails found in Cc: headers in the first patch of
the series (typically the cover letter) are added to the cc list
- for each email set. Default is the value of 'sendemail.cccover'
+ for each email set. Default is the value of `sendemail.cccover`
configuration value; if that is unspecified, default to `--no-cc-cover`.
--[no-]to-cover::
If this is set, emails found in To: headers in the first patch of
the series (typically the cover letter) are added to the to list
- for each email set. Default is the value of 'sendemail.tocover'
+ for each email set. Default is the value of `sendemail.tocover`
configuration value; if that is unspecified, default to `--no-to-cover`.
--suppress-cc=<category>::
@@ -437,7 +437,7 @@ Information
Instead of the normal operation, dump the shorthand alias names from
the configured alias file(s), one per line in alphabetical order. Note,
this only includes the alias name and not its expanded email addresses.
- See 'sendemail.aliasesfile' for more information about aliases.
+ See `sendemail.aliasesfile` for more information about aliases.
CONFIGURATION
@@ -448,7 +448,7 @@ sendemail.aliasesFile::
email aliases files. You must also supply `sendemail.aliasFileType`.
sendemail.aliasFileType::
- Format of the file(s) specified in sendemail.aliasesFile. Must be
+ Format of the file(s) specified in `sendemail.aliasesFile`. Must be
one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus', or 'sendmail'.
+
What an alias file in each format looks like can be found in
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 4b1951c5ce..0c9b68e981 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -80,7 +80,7 @@ Consider enabling untracked cache and split index if supported (see
--split-index`), Otherwise you can use `no` to have `git status`
return more quickly without showing untracked files.
-The default can be changed using the status.showUntrackedFiles
+The default can be changed using the `status.showUntrackedFiles`
configuration variable documented in linkgit:git-config[1].
--
@@ -163,7 +163,7 @@ at any time.
The paths mentioned in the output, unlike many other Git commands, are
made relative to the current directory if you are working in a
subdirectory (this is on purpose, to help cutting and pasting). See
-the status.relativePaths config option below.
+the `status.relativePaths` config option below.
Short Format
~~~~~~~~~~~~
@@ -265,10 +265,10 @@ based on user configuration. This makes it ideal for parsing by scripts.
The description of the short format above also describes the porcelain
format, with a few exceptions:
-1. The user's color.status configuration is not respected; color will
+1. The user's `color.status` configuration is not respected; color will
always be off.
-2. The user's status.relativePaths configuration is not respected; paths
+2. The user's `status.relativePaths` configuration is not respected; paths
shown will always be relative to the repository root.
There is also an alternate `-z` format recommended for machine parsing. In
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 891c9e48e5..e68d91a406 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -101,7 +101,7 @@ init [--] [<path>...]::
repository will be assumed to be upstream.
+
Optional <path> arguments limit which submodules will be initialized.
-If no path is specified and submodule.active has been configured, submodules
+If no path is specified and `submodule.active` has been configured, submodules
configured to be active will be initialized, otherwise all submodules are
initialized.
+
@@ -182,7 +182,7 @@ set-branch (-b|--branch) <branch> [--] <path>::
set-branch (-d|--default) [--] <path>::
Sets the default remote tracking branch for the submodule. The
`--branch` option allows the remote branch to be specified. The
- `--default` option removes the submodule.<name>.branch configuration
+ `--default` option removes the `submodule.<name>.branch` configuration
key, which causes the tracking branch to default to the remote `HEAD`.
set-url [--] <path> <newurl>::
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index f316b7dfc4..91495cfa01 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -1,4 +1,4 @@
-git-svn(1)
+g-it-svn(1)
==========
NAME
@@ -57,7 +57,7 @@ COMMANDS
as well, they take precedence.
--no-metadata;;
Set the 'noMetadata' option in the [svn-remote] config.
- This option is not recommended, please read the 'svn.noMetadata'
+ This option is not recommended, please read the `svn.noMetadata`
section of this manpage before using this option.
--use-svm-props;;
Set the 'useSvmProps' option in the [svn-remote] config.
@@ -149,7 +149,7 @@ the same local time zone.
can be used to allow only certain refs.
+
[verse]
-config key: svn-remote.<name>.ignore-refs
+config key: `svn-remote.<name>.ignore-refs`
+
If the ignore-refs configuration key is set, and the command-line
option is also given, both regular expressions will be used.
@@ -162,7 +162,7 @@ option is also given, both regular expressions will be used.
'rebase', etc) on a given repository.
+
[verse]
-config key: svn-remote.<name>.ignore-paths
+config key: `svn-remote.<name>.ignore-paths`
+
If the ignore-paths configuration key is set, and the command-line
option is also given, both regular expressions will be used.
@@ -192,7 +192,7 @@ Skip "branches" and "tags" of first level directories;;
precedence over `--include-paths`.
+
[verse]
-config key: svn-remote.<name>.include-paths
+config key: `svn-remote.<name>.include-paths`
--log-window-size=<n>;;
Fetch <n> log entries per request when scanning Subversion history.
@@ -268,12 +268,12 @@ Use of 'dcommit' is preferred to 'set-tree' (below).
method (e.g. `svn+ssh://` or `https://`) for commit.
+
[verse]
-config key: svn-remote.<name>.commiturl
-config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
+config key: `svn-remote.<name>.commiturl`
+config key: `svn.commiturl` (overwrites all `svn-remote.<name>.commiturl` options)
+
Note that the SVN URL of the commiturl config key includes the SVN branch.
If you rather want to set the commit URL for an entire SVN repository use
-svn-remote.<name>.pushurl instead.
+`svn-remote.<name>.pushurl` instead.
+
Using this option for any other purpose (don't ask) is very strongly
discouraged.
@@ -287,7 +287,7 @@ discouraged.
(`--mergeinfo="/branches/foo:1-10 /branches/bar:3,5-6,8"`)
+
[verse]
-config key: svn.pushmergeinfo
+config key: `svn.pushmergeinfo`
+
This option will cause git-svn to attempt to automatically populate the
svn:mergeinfo property in the SVN repository when possible. Currently, this can
@@ -447,7 +447,7 @@ Any other arguments are passed directly to 'git log'
Empty directories are automatically recreated when using
"git svn clone" and "git svn rebase", so "mkdirs" is intended
for use after commands like "git checkout" or "git reset".
- (See the svn-remote.<name>.automkdirs config file option for
+ (See the `svn-remote.<name>.automkdirs` config file option for
more information.)
'commit-diff'::
@@ -609,7 +609,7 @@ cannot version empty directories. Enabling this flag will make
the commit to SVN act like Git.
+
[verse]
-config key: svn.rmdir
+config key: `svn.rmdir`
-e::
--edit::
@@ -620,7 +620,7 @@ default for objects that are commits, and forced on when committing
tree objects.
+
[verse]
-config key: svn.edit
+config key: `svn.edit`
-l<num>::
--find-copies-harder::
@@ -630,8 +630,8 @@ They are both passed directly to 'git diff-tree'; see
linkgit:git-diff-tree[1] for more information.
+
[verse]
-config key: svn.l
-config key: svn.findcopiesharder
+config key: `svn.l`
+config key: `svn.findcopiesharder`
-A<filename>::
--authors-file=<filename>::
@@ -649,7 +649,7 @@ appropriate entry. Re-running the previous 'git svn' command
after the authors-file is modified should continue operation.
+
[verse]
-config key: svn.authorsfile
+config key: `svn.authorsfile`
--authors-prog=<filename>::
If this option is specified, for each SVN committer name that
@@ -665,7 +665,7 @@ to the root of the working tree for 'fetch'. If 'filename' is
not found, it is searched like any other command in '$PATH'.
+
[verse]
-config key: svn.authorsProg
+config key: `svn.authorsProg`
-q::
--quiet::
@@ -705,7 +705,7 @@ creating the branch or tag.
in the log message and use that as the author string.
+
[verse]
-config key: svn.useLogAuthor
+config key: `svn.useLogAuthor`
--add-author-from::
When committing to svn from Git (as part of 'set-tree' or 'dcommit'
@@ -715,7 +715,7 @@ config key: svn.useLogAuthor
will retrieve a valid author string for all commits.
+
[verse]
-config key: svn.addAuthorFrom
+config key: `svn.addAuthorFrom`
ADVANCED OPTIONS
----------------
@@ -750,7 +750,7 @@ ADVANCED OPTIONS
`--no-follow-parent` to disable it.
+
[verse]
-config key: svn.followparent
+config key: `svn.followparent`
CONFIG FILE-ONLY OPTIONS
------------------------
@@ -774,7 +774,7 @@ reports, and archives. If you plan to eventually migrate from SVN to
Git and are certain about dropping SVN history, consider
https://github.com/newren/git-filter-repo[git-filter-repo] instead.
filter-repo also allows reformatting of metadata for ease-of-reading
-and rewriting authorship info for non-"svn.authorsFile" users.
+and rewriting authorship info for non-`svn.authorsFile` users.
svn.useSvmProps::
svn-remote.<name>.useSvmProps::
@@ -1159,7 +1159,7 @@ $GIT_DIR/svn/\**/.rev_map.*::
Mapping between Subversion revision numbers and Git commit
names. In a repository where the noMetadata option is not set,
this can be rebuilt from the git-svn-id: lines that are at the
- end of every commit (see the 'svn.noMetadata' section above for
+ end of every commit (see the `svn.noMetadata` section above for
details).
+
'git svn fetch' and 'git svn rebase' automatically update the rev_map
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index 936b64045e..4eae32e711 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -422,12 +422,12 @@ all index entries and stays unchanged.
All changes in the split index are pushed back to the shared index
file when the number of entries in the split index reaches a level
-specified by the splitIndex.maxPercentChange config variable (see
+specified by the `splitIndex.maxPercentChange` config variable (see
linkgit:git-config[1]).
Each time a new shared index file is created, the old shared index
files are deleted if their modification time is older than what is
-specified by the splitIndex.sharedIndexExpire config variable (see
+specified by the `splitIndex.sharedIndexExpire` config variable (see
linkgit:git-config[1]).
To avoid deleting a shared index file that is still used, its
diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index be48daa825..f8aeea4cb4 100644
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -149,7 +149,7 @@ still see a subset of the modifications.
LOGGING UPDATES
---------------
-If config parameter "core.logAllRefUpdates" is true and the ref is one
+If config parameter `core.logAllRefUpdates` is true and the ref is one
under "refs/heads/", "refs/remotes/", "refs/notes/", or a pseudoref
like `HEAD` or `ORIG_HEAD`; or the file "$GIT_DIR/logs/<ref>" exists then
`git update-ref` will append a line to the log file
diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt
index d53b2570df..6fbe8d5583 100644
--- a/Documentation/git-web--browse.txt
+++ b/Documentation/git-web--browse.txt
@@ -71,7 +71,7 @@ browser.<tool>.path
You can explicitly provide a full path to your preferred browser by
setting the configuration variable `browser.<tool>.path`. For example,
you can configure the absolute path to firefox by setting
-'browser.firefox.path'. Otherwise, 'git web{litdd}browse' assumes the tool
+`browser.firefox.path`. Otherwise, 'git web{litdd}browse' assumes the tool
is available in PATH.
browser.<tool>.cmd
@@ -91,7 +91,7 @@ When 'konqueror' is specified by a command-line option or a
configuration variable, we launch 'kfmclient' to try to open the HTML
man page on an already opened konqueror in a new tab if possible.
-For consistency, we also try such a trick if 'browser.konqueror.path' is
+For consistency, we also try such a trick if `browser.konqueror.path` is
set to something like `A_PATH_TO/konqueror`. That means we will try to
launch `A_PATH_TO/kfmclient` instead.
diff --git a/Documentation/git.txt b/Documentation/git.txt
index dcc52adff6..6aafa3a15c 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -154,8 +154,8 @@ If you just want to run git as if it was started in `<path>` then use
Set the path to the working tree. It can be an absolute path
or a path relative to the current working directory.
This can also be controlled by setting the GIT_WORK_TREE
- environment variable and the core.worktree configuration
- variable (see core.worktree in linkgit:git-config[1] for a
+ environment variable and the `core.worktree` configuration
+ variable (see `core.worktree` in linkgit:git-config[1] for a
more detailed discussion).
--namespace=<path>::
@@ -210,7 +210,7 @@ If you just want to run git as if it was started in `<path>` then use
others (all other commands in `$PATH` that have git- prefix),
list-<category> (see categories in command-list.txt),
nohelpers (exclude helper commands), alias and config
- (retrieve command list from config variable completion.commands)
+ (retrieve command list from config variable `completion.commands`)
GIT COMMANDS
------------
@@ -482,7 +482,7 @@ double-quotes and respecting backslash escapes. E.g., the value
`GIT_WORK_TREE`::
Set the path to the root of the working tree.
This can also be controlled by the `--work-tree` command-line
- option and the core.worktree configuration variable.
+ option and the `core.worktree` configuration variable.
`GIT_NAMESPACE`::
Set the Git namespace; see linkgit:gitnamespaces[7] for details.
@@ -609,7 +609,7 @@ other
~~~~~
`GIT_MERGE_VERBOSITY`::
A number controlling the amount of output shown by
- the recursive merge strategy. Overrides merge.verbosity.
+ the recursive merge strategy. Overrides `merge.verbosity`.
See linkgit:git-merge[1]
`GIT_PAGER`::
diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
index 0a60472bb5..f77d8487bd 100644
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt
@@ -199,7 +199,7 @@ convert them to CRLF when files are checked out.
If you simply want to have CRLF line endings in your working directory
regardless of the repository you are working with, you can set the
-config variable "core.autocrlf" without using any attributes.
+config variable `core.autocrlf` without using any attributes.
------------------------
[core]
@@ -424,7 +424,7 @@ filter driver definition in the config, or a filter driver that exits with
a non-zero status, is not an error but makes the filter a no-op passthru.
You can declare that a filter turns a content that by itself is unusable
-into a usable content by setting the filter.<driver>.required configuration
+into a usable content by setting the `filter.<driver>.required` configuration
variable to `true`.
Note: Whenever the clean filter is changed, the repo should be renormalized:
@@ -437,7 +437,7 @@ attribute for paths.
*.c filter=indent
------------------------
-Then you would define a "filter.indent.clean" and "filter.indent.smudge"
+Then you would define a `filter.indent.clean` and `filter.indent.smudge`
configuration in your .git/config to specify a pair of commands to
modify the contents of C programs when the source files are checked
in ("clean" is run) and checked out (no change is made because the
@@ -723,7 +723,7 @@ Unspecified::
A path to which the `diff` attribute is unspecified
first gets its contents inspected, and if it looks like
- text and is smaller than core.bigFileThreshold, it is treated
+ text and is smaller than `core.bigFileThreshold`, it is treated
as text. Otherwise it would generate `Binary files differ`.
String::
@@ -778,7 +778,7 @@ for paths.
*.tex diff=tex
------------------------
-Then, you would define a "diff.tex.xfuncname" configuration to
+Then, you would define a `diff.tex.xfuncname` configuration to
specify a regular expression that matches a line that you would
want to appear as the hunk header "TEXT". Add a section to your
`$GIT_DIR/config` file (or `$HOME/.gitconfig` file) like this:
diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
index 77573c813c..d1d81cbe15 100644
--- a/Documentation/gitcore-tutorial.txt
+++ b/Documentation/gitcore-tutorial.txt
@@ -1479,7 +1479,7 @@ on that project and has an own "public repository" goes like this:
1. Prepare your work repository, by running 'git clone' on the public
repository of the "project lead". The URL used for the
- initial cloning is stored in the remote.origin.url
+ initial cloning is stored in the `remote.origin.url`
configuration variable.
2. Prepare a public repository accessible to others, just like
@@ -1520,7 +1520,7 @@ like this:
1. Prepare your work repository, by 'git clone' the public
repository of the "project lead" (or a "subsystem
maintainer", if you work on a subsystem). The URL used for
- the initial cloning is stored in the remote.origin.url
+ the initial cloning is stored in the `remote.origin.url`
configuration variable.
2. Do your work in your repository on `master` branch.
diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt
index 758bf39ba3..dffbdfbd0b 100644
--- a/Documentation/gitcredentials.txt
+++ b/Documentation/gitcredentials.txt
@@ -80,7 +80,7 @@ You may also have third-party helpers installed; search for
`credential-*` in the output of `git help -a`, and consult the
documentation of individual helpers. Once you have selected a helper,
you can tell Git to use it by putting its name into the
-credential.helper variable.
+`credential.helper` variable.
1. Find a helper.
+
diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index 88ee109fdf..5d719b4140 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -662,7 +662,7 @@ The most notable example is `HEAD`.
[[def_upstream_branch]]upstream branch::
The default <<def_branch,branch>> that is merged into the branch in
question (or the branch in question is rebased onto). It is configured
- via branch.<name>.remote and branch.<name>.merge. If the upstream branch
+ via `branch.<name>.remote` and `branch.<name>.merge`. If the upstream branch
of 'A' is 'origin/B' sometimes we say "'A' is tracking 'origin/B'".
[[def_working_tree]]working tree::
diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt
index 95a7390b2c..bbf418e48c 100644
--- a/Documentation/pull-fetch-param.txt
+++ b/Documentation/pull-fetch-param.txt
@@ -7,7 +7,7 @@
ifndef::git-pull[]
<group>::
A name referring to a list of repositories as the value
- of remotes.<group> in the configuration file.
+ of `remotes.<group>` in the configuration file.
(See linkgit:git-config[1]).
endif::git-pull[]
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 62ddf41e75..82b20b80df 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -1949,7 +1949,7 @@ Note that the target of a `push` is normally a
<<def_bare_repository,bare>> repository. You can also push to a
repository that has a checked-out working tree, but a push to update the
currently checked-out branch is denied by default to prevent confusion.
-See the description of the receive.denyCurrentBranch option
+See the description of the `receive.denyCurrentBranch` option
in linkgit:git-config[1] for details.
As with `git fetch`, you may also set up configuration options to
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 04/13] doc: typeset git-related commands in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
` (2 preceding siblings ...)
2021-04-09 4:02 ` [RFC PATCH v1 03/13] doc: typeset configuration options " Firmin Martin
@ 2021-04-09 4:02 ` Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 05/13] doc: typeset git-svn subcommands " Firmin Martin
` (9 subsequent siblings)
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Wrap git-related commands with backticks as indicated in the
CodingGuidelines.
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/MyFirstContribution.txt | 8 +-
Documentation/config.txt | 2 +-
Documentation/diff-format.txt | 8 +-
Documentation/diff-generate-patch.txt | 4 +-
Documentation/diff-options.txt | 8 +-
Documentation/fetch-options.txt | 18 +-
Documentation/git-add.txt | 6 +-
Documentation/git-am.txt | 20 +-
Documentation/git-apply.txt | 14 +-
Documentation/git-archimport.txt | 12 +-
Documentation/git-archive.txt | 6 +-
Documentation/git-bisect-lk2009.txt | 164 ++++++++--------
Documentation/git-bisect.txt | 38 ++--
Documentation/git-blame.txt | 10 +-
Documentation/git-branch.txt | 28 +--
Documentation/git-bugreport.txt | 4 +-
Documentation/git-bundle.txt | 34 ++--
Documentation/git-cat-file.txt | 6 +-
Documentation/git-check-attr.txt | 4 +-
Documentation/git-check-ignore.txt | 4 +-
Documentation/git-check-mailmap.txt | 2 +-
Documentation/git-check-ref-format.txt | 8 +-
Documentation/git-checkout-index.txt | 10 +-
Documentation/git-checkout.txt | 42 ++--
Documentation/git-cherry-pick.txt | 6 +-
Documentation/git-cherry.txt | 8 +-
Documentation/git-citool.txt | 6 +-
Documentation/git-clean.txt | 14 +-
Documentation/git-clone.txt | 2 +-
Documentation/git-column.txt | 4 +-
Documentation/git-commit-graph.txt | 4 +-
Documentation/git-commit-tree.txt | 6 +-
Documentation/git-commit.txt | 16 +-
Documentation/git-config.txt | 42 ++--
Documentation/git-count-objects.txt | 2 +-
.../git-credential-cache--daemon.txt | 2 +-
Documentation/git-credential-cache.txt | 2 +-
Documentation/git-credential-store.txt | 4 +-
Documentation/git-credential.txt | 16 +-
Documentation/git-cvsexportcommit.txt | 4 +-
Documentation/git-cvsimport.txt | 20 +-
Documentation/git-cvsserver.txt | 56 +++---
Documentation/git-daemon.txt | 52 ++---
Documentation/git-describe.txt | 22 +--
Documentation/git-diff-files.txt | 4 +-
Documentation/git-diff-index.txt | 20 +-
Documentation/git-diff-tree.txt | 12 +-
Documentation/git-diff.txt | 30 +--
Documentation/git-difftool.txt | 34 ++--
Documentation/git-fast-export.txt | 28 +--
Documentation/git-fast-import.txt | 36 ++--
Documentation/git-fetch-pack.txt | 18 +-
Documentation/git-fetch.txt | 14 +-
Documentation/git-filter-branch.txt | 92 ++++-----
Documentation/git-fmt-merge-msg.txt | 8 +-
Documentation/git-for-each-ref.txt | 4 +-
Documentation/git-for-each-repo.txt | 2 +-
Documentation/git-format-patch.txt | 22 +--
Documentation/git-fsck-objects.txt | 2 +-
Documentation/git-fsck.txt | 8 +-
Documentation/git-gc.txt | 18 +-
Documentation/git-get-tar-commit-id.txt | 8 +-
Documentation/git-grep.txt | 10 +-
Documentation/git-gui.txt | 24 +--
Documentation/git-hash-object.txt | 6 +-
Documentation/git-help.txt | 18 +-
Documentation/git-http-backend.txt | 38 ++--
Documentation/git-http-fetch.txt | 6 +-
Documentation/git-http-push.txt | 2 +-
Documentation/git-imap-send.txt | 4 +-
Documentation/git-index-pack.txt | 10 +-
Documentation/git-init-db.txt | 2 +-
Documentation/git-init.txt | 8 +-
Documentation/git-instaweb.txt | 10 +-
Documentation/git-interpret-trailers.txt | 10 +-
Documentation/git-log.txt | 10 +-
Documentation/git-ls-files.txt | 12 +-
Documentation/git-ls-remote.txt | 6 +-
Documentation/git-ls-tree.txt | 8 +-
Documentation/git-mailinfo.txt | 6 +-
Documentation/git-mailsplit.txt | 2 +-
Documentation/git-maintenance.txt | 2 +-
Documentation/git-merge-base.txt | 20 +-
Documentation/git-merge-file.txt | 12 +-
Documentation/git-merge-index.txt | 10 +-
Documentation/git-merge-one-file.txt | 6 +-
Documentation/git-merge-tree.txt | 4 +-
Documentation/git-merge.txt | 54 +++---
Documentation/git-mergetool--lib.txt | 4 +-
Documentation/git-mergetool.txt | 20 +-
Documentation/git-mktag.txt | 2 +-
Documentation/git-mktree.txt | 2 +-
Documentation/git-multi-pack-index.txt | 4 +-
Documentation/git-mv.txt | 8 +-
Documentation/git-name-rev.txt | 6 +-
Documentation/git-notes.txt | 52 ++---
Documentation/git-p4.txt | 132 ++++++-------
Documentation/git-pack-objects.txt | 8 +-
Documentation/git-pack-redundant.txt | 4 +-
Documentation/git-pack-refs.txt | 2 +-
Documentation/git-patch-id.txt | 12 +-
Documentation/git-prune-packed.txt | 2 +-
Documentation/git-prune.txt | 16 +-
Documentation/git-pull.txt | 18 +-
Documentation/git-push.txt | 24 +--
Documentation/git-quiltimport.txt | 4 +-
Documentation/git-range-diff.txt | 2 +-
Documentation/git-read-tree.txt | 54 +++---
Documentation/git-rebase.txt | 48 ++---
Documentation/git-receive-pack.txt | 28 +--
Documentation/git-reflog.txt | 12 +-
Documentation/git-remote-ext.txt | 26 +--
Documentation/git-remote-fd.txt | 12 +-
Documentation/git-remote.txt | 28 +--
Documentation/git-repack.txt | 14 +-
Documentation/git-replace.txt | 22 +--
Documentation/git-request-pull.txt | 2 +-
Documentation/git-rerere.txt | 34 ++--
Documentation/git-reset.txt | 22 +--
Documentation/git-restore.txt | 6 +-
Documentation/git-rev-list.txt | 6 +-
Documentation/git-rev-parse.txt | 34 ++--
Documentation/git-revert.txt | 10 +-
Documentation/git-rm.txt | 4 +-
Documentation/git-send-email.txt | 28 +--
Documentation/git-send-pack.txt | 12 +-
Documentation/git-sh-i18n--envsubst.txt | 2 +-
Documentation/git-sh-i18n.txt | 2 +-
Documentation/git-sh-setup.txt | 2 +-
Documentation/git-shell.txt | 24 +--
Documentation/git-shortlog.txt | 10 +-
Documentation/git-show-branch.txt | 22 +--
Documentation/git-show-index.txt | 2 +-
Documentation/git-show-ref.txt | 8 +-
Documentation/git-show.txt | 10 +-
Documentation/git-sparse-checkout.txt | 6 +-
Documentation/git-stage.txt | 2 +-
Documentation/git-stash.txt | 28 +--
Documentation/git-status.txt | 6 +-
Documentation/git-stripspace.txt | 8 +-
Documentation/git-submodule.txt | 44 ++---
Documentation/git-svn.txt | 176 ++++++++---------
Documentation/git-switch.txt | 10 +-
Documentation/git-symbolic-ref.txt | 8 +-
Documentation/git-tag.txt | 22 +--
Documentation/git-unpack-file.txt | 2 +-
Documentation/git-unpack-objects.txt | 2 +-
Documentation/git-update-index.txt | 42 ++--
Documentation/git-update-ref.txt | 2 +-
Documentation/git-update-server-info.txt | 2 +-
Documentation/git-upload-archive.txt | 8 +-
Documentation/git-upload-pack.txt | 8 +-
Documentation/git-var.txt | 2 +-
Documentation/git-verify-commit.txt | 4 +-
Documentation/git-verify-pack.txt | 4 +-
Documentation/git-verify-tag.txt | 4 +-
Documentation/git-web--browse.txt | 8 +-
Documentation/git-whatchanged.txt | 6 +-
Documentation/git-worktree.txt | 18 +-
Documentation/git-write-tree.txt | 10 +-
Documentation/git.txt | 36 ++--
Documentation/gitattributes.txt | 22 +--
Documentation/gitcore-tutorial.txt | 164 ++++++++--------
Documentation/gitcredentials.txt | 8 +-
Documentation/gitcvs-migration.txt | 14 +-
Documentation/gitdiffcore.txt | 32 ++--
Documentation/giteveryday.txt | 8 +-
Documentation/gitfaq.txt | 2 +-
Documentation/githooks.txt | 10 +-
Documentation/gitignore.txt | 6 +-
Documentation/gitk.txt | 24 +--
Documentation/gitmodules.txt | 2 +-
Documentation/gitnamespaces.txt | 8 +-
Documentation/gitremote-helpers.txt | 32 ++--
Documentation/gitrepository-layout.txt | 22 +--
Documentation/gittutorial-2.txt | 22 +--
Documentation/gittutorial.txt | 56 +++---
Documentation/gitweb.conf.txt | 180 +++++++++---------
Documentation/gitweb.txt | 90 ++++-----
Documentation/gitworkflows.txt | 6 +-
Documentation/glossary-content.txt | 8 +-
Documentation/i18n.txt | 4 +-
Documentation/merge-options.txt | 4 +-
Documentation/pull-fetch-param.txt | 10 +-
Documentation/revisions.txt | 2 +-
Documentation/urls-remotes.txt | 12 +-
Documentation/urls.txt | 2 +-
Documentation/user-manual.txt | 30 +--
188 files changed, 1731 insertions(+), 1731 deletions(-)
diff --git a/Documentation/MyFirstContribution.txt b/Documentation/MyFirstContribution.txt
index af0a9da62e..06f9f370d7 100644
--- a/Documentation/MyFirstContribution.txt
+++ b/Documentation/MyFirstContribution.txt
@@ -481,7 +481,7 @@ git-psuh - Delight users' typo with a shy horse
SYNOPSIS
--------
[verse]
-'git-psuh [<arg>...]'
+`git-psuh [<arg>...]`
DESCRIPTION
-----------
@@ -590,7 +590,7 @@ you the rest of the options afterwards, untouched.
Now that you have a usage hint, you can teach Git how to show it in the general
command list shown by `git help git` or `git help -a`, which is generated from
-`command-list.txt`. Find the line for 'git-pull' so you can add your 'git-psuh'
+`command-list.txt`. Find the line for `git-pull` so you can add your `git-psuh`
line above it in alphabetical order. Now, we can add some attributes about the
command which impacts where it shows up in the aforementioned help commands. The
top of `command-list.txt` shares some information about what each attribute
@@ -652,7 +652,7 @@ Create a new file `t/t9999-psuh-tutorial.sh`. Begin with the header as so (see
test_description='git-psuh test
-This test runs git-psuh and makes sure it does not crash.'
+This test runs `git-psuh` and makes sure it does not crash.'
. ./test-lib.sh
----
@@ -971,7 +971,7 @@ Here's an example body for `psuh`:
----
Our internal metrics indicate widespread interest in the command
-git-psuh - that is, many users are trying to use it, but finding it is
+`git-psuh` - that is, many users are trying to use it, but finding it is
unavailable, using some unknown workaround instead.
The following handful of patches add the psuh command and implement some
diff --git a/Documentation/config.txt b/Documentation/config.txt
index bf82766a6a..05bcf1bf2b 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -249,7 +249,7 @@ boolean::
`0` and the empty string.
+
When converting a value to its canonical form using the `--type=bool` type
-specifier, 'git config' will ensure that the output is "true" or
+specifier, `git config` will ensure that the output is "true" or
"false" (spelled in lowercase).
integer::
diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt
index fbbd410a84..14ef11d552 100644
--- a/Documentation/diff-format.txt
+++ b/Documentation/diff-format.txt
@@ -1,8 +1,8 @@
Raw output format
-----------------
-The raw output format from "git-diff-index", "git-diff-tree",
-"git-diff-files" and "git diff --raw" are very similar.
+The raw output format from `git-diff-index`, `git-diff-tree`,
+`git-diff-files` and `git diff --raw` are very similar.
These commands all compare two sets of things; what is
compared differs:
@@ -19,7 +19,7 @@ git-diff-tree [-r] <tree-ish-1> <tree-ish-2> [<pattern>...]::
git-diff-files [<pattern>...]::
compares the index and the files on the filesystem.
-The "git-diff-tree" command begins its output by printing the hash of
+The `git-diff-tree` command begins its output by printing the hash of
what is being compared. After that, all the commands print one output
line per changed file.
@@ -86,7 +86,7 @@ verbatim and the line is terminated by a NUL byte.
diff format for merges
----------------------
-"git-diff-tree", "git-diff-files" and "git-diff --raw"
+`git-diff-tree`, `git-diff-files` and `git-diff --raw`
can take `-c` or `--cc` option
to generate diff output also for merge commits. The output differs
from the format described above in the following way:
diff --git a/Documentation/diff-generate-patch.txt b/Documentation/diff-generate-patch.txt
index 2615b29cb0..da1572b765 100644
--- a/Documentation/diff-generate-patch.txt
+++ b/Documentation/diff-generate-patch.txt
@@ -16,7 +16,7 @@ You can customize the creation of patch text via the
What the `-p` option produces is slightly different from the traditional
diff format:
-1. It is preceded with a "git diff" header that looks like this:
+1. It is preceded with a `git diff` header that looks like this:
diff --git a/file1 b/file2
+
@@ -117,7 +117,7 @@ index fabadb8,cc95eb0..4866510
for_each_ref(get_name);
------------
-1. It is preceded with a "git diff" header, that looks like
+1. It is preceded with a `git diff` header, that looks like
this (when the `-c` option is used):
diff --combined file
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 86c19bed1e..34570aa445 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -825,10 +825,10 @@ endif::git-format-patch[]
Prepend an additional prefix to every line of output.
--ita-invisible-in-index::
- By default entries added by "git add -N" appear as an existing
- empty file in "git diff" and a new file in "git diff --cached".
- This option makes the entry appear as a new file in "git diff"
- and non-existent in "git diff --cached". This option could be
+ By default entries added by `git add -N` appear as an existing
+ empty file in `git diff` and a new file in `git diff --cached`.
+ This option makes the entry appear as a new file in `git diff`
+ and non-existent in `git diff --cached`. This option could be
reverted with `--ita-visible-in-index`. Both options are
experimental and could be removed in future.
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 60a268cc4a..6aa07a54b9 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -79,7 +79,7 @@ endif::git-pull[]
-f::
--force::
- When 'git fetch' is used with `<src>:<dst>` refspec it may
+ When `git fetch` is used with `<src>:<dst>` refspec it may
refuse to update the local branch as discussed
ifdef::git-pull[]
in the `<refspec>` part of the linkgit:git-fetch[1]
@@ -223,25 +223,25 @@ ifndef::git-pull[]
-u::
--update-head-ok::
- By default 'git fetch' refuses to update the head which
+ By default `git fetch` refuses to update the head which
corresponds to the current branch. This flag disables the
- check. This is purely for the internal use for 'git pull'
- to communicate with 'git fetch', and unless you are
+ check. This is purely for the internal use for `git pull`
+ to communicate with `git fetch`, and unless you are
implementing your own Porcelain you are not supposed to
use it.
endif::git-pull[]
--upload-pack <upload-pack>::
When given, and the repository to fetch from is handled
- by 'git fetch-pack', `--exec=<upload-pack>` is passed to
+ by `git fetch-pack`, `--exec=<upload-pack>` is passed to
the command to specify non-default path for the command
run on the other end.
ifndef::git-pull[]
-q::
--quiet::
- Pass `--quiet` to git-fetch-pack and silence any other internally
- used git commands. Progress is not reported to the standard error
+ Pass `--quiet` to `git-fetch-pack` and silence any other internally
+ used `git` commands. Progress is not reported to the standard error
stream.
-v::
@@ -265,13 +265,13 @@ endif::git-pull[]
sent to the other side in the order listed on the command line.
--show-forced-updates::
- By default, git checks if a branch is force-updated during
+ By default, `git` checks if a branch is force-updated during
fetch. This can be disabled through `fetch.showForcedUpdates`, but
the `--show-forced-updates` option guarantees this check occurs.
See linkgit:git-config[1].
--no-show-forced-updates::
- By default, git checks if a branch is force-updated during
+ By default, `git` checks if a branch is force-updated during
fetch. Pass `--no-show-forced-updates` or set `fetch.showForcedUpdates`
to false to skip this check for performance reasons. If used during
'git-pull' the `--ff-only` option will still check for forced updates
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index 8ec99c5c12..786c31fc60 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -41,7 +41,7 @@ The `git add` command will not add ignored files by default. If any
ignored files were explicitly specified on the command line, `git add`
will fail with a list of ignored files. Ignored files reached by
directory recursion or filename globbing performed by Git (quote your
-globs before the shell) will be silently ignored. The 'git add' command can
+globs before the shell) will be silently ignored. The `git add` command can
be used to add ignored files with the `-f` (force) option.
Please see linkgit:git-commit[1] for alternative ways to add content to a
@@ -141,8 +141,8 @@ subdirectories).
option is a no-op when no <pathspec> is used.
+
This option is primarily to help users who are used to older
-versions of Git, whose "git add <pathspec>..." was a synonym
-for "git add --no-all <pathspec>...", i.e. ignored removed files.
+versions of Git, whose `git add <pathspec>...` was a synonym
+for `git add --no-all <pathspec>...`, i.e. ignored removed files.
-N::
--intent-to-add::
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index cd56054be0..80f2f89cbd 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -39,13 +39,13 @@ OPTIONS
-k::
--keep::
- Pass `-k` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
+ Pass `-k` flag to `git mailinfo` (see linkgit:git-mailinfo[1]).
--keep-non-patch::
- Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
+ Pass `-b` flag to `git mailinfo` (see linkgit:git-mailinfo[1]).
--[no-]keep-cr::
- With `--keep-cr`, call 'git mailsplit' (see linkgit:git-mailsplit[1])
+ With `--keep-cr`, call `git mailsplit` (see linkgit:git-mailsplit[1])
with the same option, to prevent it from stripping CR at the end of
lines. `am.keepcr` configuration variable can be used to specify the
default behaviour. `--no-keep-cr` is useful to override `am.keepcr`.
@@ -61,7 +61,7 @@ OPTIONS
-m::
--message-id::
- Pass the `-m` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]),
+ Pass the `-m` flag to `git mailinfo` (see linkgit:git-mailinfo[1]),
so that the Message-ID header is added to the commit message.
The `am.messageid` configuration variable can be used to specify
the default behaviour.
@@ -76,7 +76,7 @@ OPTIONS
-u::
--utf8::
- Pass `-u` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
+ Pass `-u` flag to `git mailinfo` (see linkgit:git-mailinfo[1]).
The proposed commit log message taken from the e-mail
is re-coded into UTF-8 encoding (configuration variable
`i18n.commitEncoding` can be used to specify project's
@@ -86,7 +86,7 @@ This was optional in prior versions of git, but now it is the
default. You can use `--no-utf8` to override this.
--no-utf8::
- Pass `-n` flag to 'git mailinfo' (see
+ Pass `-n` flag to `git mailinfo` (see
linkgit:git-mailinfo[1]).
-3::
@@ -97,7 +97,7 @@ default. You can use `--no-utf8` to override this.
it is supposed to apply to and we have those blobs
available locally. `--no-3way` can be used to override
am.threeWay configuration variable. For more information,
- see am.threeWay in linkgit:git-config[1].
+ see `am.threeWay` in linkgit:git-config[1].
--rerere-autoupdate::
--no-rerere-autoupdate::
@@ -113,7 +113,7 @@ default. You can use `--no-utf8` to override this.
--exclude=<path>::
--include=<path>::
--reject::
- These flags are passed to the 'git apply' (see linkgit:git-apply[1])
+ These flags are passed to the `git apply` (see linkgit:git-apply[1])
program that applies
the patch.
@@ -170,7 +170,7 @@ default. You can use `--no-utf8` to override this.
to the screen before exiting. This overrides the
standard message informing you to use `--continue`
or `--skip` to handle the failure. This is solely
- for internal use between 'git rebase' and 'git am'.
+ for internal use between `git rebase` and `git am`.
--abort::
Restore the original branch and abort the patching operation.
@@ -231,7 +231,7 @@ names.
Before any patches are applied, `ORIG_HEAD` is set to the tip of the
current branch. This is useful if you have problems with multiple
-commits, like running 'git am' on the wrong branch or an error in the
+commits, like running `git am` on the wrong branch or an error in the
commits that is more easily fixed by changing the mailbox (e.g.
errors in the "From:" lines).
diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
index f1c8098c0b..a836021d5e 100644
--- a/Documentation/git-apply.txt
+++ b/Documentation/git-apply.txt
@@ -51,7 +51,7 @@ OPTIONS
--summary::
Instead of applying the patch, output a condensed
- summary of information obtained from git diff extended
+ summary of information obtained from `git diff` extended
headers, such as creations, renames and mode changes.
Turns off "apply".
@@ -92,7 +92,7 @@ OPTIONS
with the `--reject` and the `--cached` options.
--build-fake-ancestor=<file>::
- Newer 'git diff' output has embedded 'index information'
+ Newer `git diff` output has embedded 'index information'
for each blob to help identify the original version that
the patch applies to. When this flag is given, and if
the original versions of the blobs are available locally,
@@ -106,7 +106,7 @@ the information is read from the current index instead.
Apply the patch in reverse.
--reject::
- For atomicity, 'git apply' by default fails the whole patch and
+ For atomicity, `git apply` by default fails the whole patch and
does not touch the working tree when some of the hunks
do not apply. This option makes it apply
the parts of the patch that are applicable, and leave the
@@ -133,7 +133,7 @@ linkgit:git-config[1]).
ever ignored.
--unidiff-zero::
- By default, 'git apply' expects that the patch being
+ By default, `git apply` expects that the patch being
applied is a unified diff with at least one line of context.
This provides good safety measures, but breaks down when
applying a diff generated with `--unified=0`. To bypass these
@@ -144,7 +144,7 @@ discouraged.
--apply::
If you use any of the options marked "Turns off
- 'apply'" above, 'git apply' reads and outputs the
+ 'apply'" above, `git apply` reads and outputs the
requested information without actually applying the
patch. Give this flag after those flags to also apply
the patch.
@@ -243,7 +243,7 @@ running `git apply --directory=modules/git-gui`.
--unsafe-paths::
By default, a patch that affects outside the working area
(either a Git controlled working tree, or the current working
- directory when "git apply" is used as a replacement of GNU
+ directory when `git apply` is used as a replacement of GNU
patch) is rejected as a mistake (or a mischief).
+
When `git apply` is used as a "better GNU patch", the user can pass
@@ -263,7 +263,7 @@ apply.whitespace::
SUBMODULES
----------
-If the patch contains any changes to submodules then 'git apply'
+If the patch contains any changes to submodules then `git apply`
treats these changes as follows.
If `--index` is specified (explicitly or implicitly), then the submodule
diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt
index 6e2dec5ef1..b5c9e500ca 100644
--- a/Documentation/git-archimport.txt
+++ b/Documentation/git-archimport.txt
@@ -30,17 +30,17 @@ branches that have different roots, it will refuse to run. In that case,
edit your <archive/branch> parameters to define clearly the scope of the
import.
-'git archimport' uses `tla` extensively in the background to access the
+`git archimport` uses `tla` extensively in the background to access the
Arch repository.
Make sure you have a recent version of `tla` available in the path. `tla` must
-know about the repositories you pass to 'git archimport'.
+know about the repositories you pass to `git archimport`.
-For the initial import, 'git archimport' expects to find itself in an empty
+For the initial import, `git archimport` expects to find itself in an empty
directory. To follow the development of a project that uses Arch, rerun
-'git archimport' with the same parameters as the initial import to perform
+`git archimport` with the same parameters as the initial import to perform
incremental imports.
-While 'git archimport' will try to create sensible branch names for the
+While `git archimport` will try to create sensible branch names for the
archives that it imports, it is also possible to specify Git branch names
manually. To do so, write a Git branch name after each <archive/branch>
parameter, separated by a colon. This way, you can shorten the Arch
@@ -85,7 +85,7 @@ OPTIONS
-o::
Use this for compatibility with old-style branch names used by
- earlier versions of 'git archimport'. Old-style branch names
+ earlier versions of `git archimport`. Old-style branch names
were category{litdd}branch, whereas new-style branch names are
archive,category{litdd}branch{litdd}version. In both cases, names given
on the command-line will override the automatically-generated
diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index 0af18c9df3..4bd6299046 100644
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -21,13 +21,13 @@ structure for the named tree, and writes it out to the standard
output. If <prefix> is specified it is
prepended to the filenames in the archive.
-'git archive' behaves differently when given a tree ID versus when
+`git archive` behaves differently when given a tree ID versus when
given a commit ID or tag ID. In the first case the current time is
used as the modification time of each file in the archive. In the latter
case the commit time as recorded in the referenced commit object is
used instead. Additionally the commit ID is stored in a global
extended pax header if the tar format is used; it can be extracted
-using 'git get-tar-commit-id'. In ZIP files it is stored as a file
+using `git get-tar-commit-id`. In ZIP files it is stored as a file
comment.
OPTIONS
@@ -78,7 +78,7 @@ OPTIONS
--exec=<git-upload-archive>::
Used with `--remote` to specify the path to the
- 'git-upload-archive' on the remote side.
+ `git-upload-archive` on the remote side.
<tree-ish>::
The tree or commit to produce an archive for.
diff --git a/Documentation/git-bisect-lk2009.txt b/Documentation/git-bisect-lk2009.txt
index 1276424d65..b919b3ea42 100644
--- a/Documentation/git-bisect-lk2009.txt
+++ b/Documentation/git-bisect-lk2009.txt
@@ -7,16 +7,16 @@ Fighting regressions with git bisect
Abstract
--------
-"git bisect" enables software users and developers to easily find the
+`git bisect` enables software users and developers to easily find the
commit that introduced a regression. We show why it is important to
-have good tools to fight regressions. We describe how "git bisect"
+have good tools to fight regressions. We describe how `git bisect`
works from the outside and the algorithms it uses inside. Then we
-explain how to take advantage of "git bisect" to improve current
-practices. And we discuss how "git bisect" could improve in the
+explain how to take advantage of `git bisect` to improve current
+practices. And we discuss how `git bisect` could improve in the
future.
-Introduction to "git bisect"
+Introduction to `git bisect`
----------------------------
Git is a Distributed Version Control system (DVCS) created by Linus
@@ -36,14 +36,14 @@ properly fix a problem when you only need to check a very small set of
changes, than when you don't know where look in the first place.
So to help people find commits that introduce a "bad" behavior, the
-"git bisect" set of commands was invented. And it follows of course
-that in "git bisect" parlance, commits where the "interesting
+`git bisect` set of commands was invented. And it follows of course
+that in `git bisect` parlance, commits where the "interesting
behavior" is present are called "bad" commits, while other commits are
called "good" commits. And a commit that introduce the behavior we are
interested in is called a "first bad commit". Note that there could be
more than one "first bad commit" in the commit space we are searching.
-So "git bisect" is designed to help find a "first bad commit". And to
+So `git bisect` is designed to help find a "first bad commit". And to
be as efficient as possible, it tries to perform a binary search.
@@ -133,7 +133,7 @@ time. But this is not the end of the fight yet, as of course it
continues after the release.
And then this is what Ingo Molnar (a well known Linux kernel
-developer) says about his use of git bisect:
+developer) says about his use of `git bisect`:
_____________
I most actively use it during the merge window (when a lot of trees
@@ -152,7 +152,7 @@ Other tools to fight regressions
So what are the tools used to fight regressions? They are nearly the
same as those used to fight regular bugs. The only specific tools are
-test suites and tools similar as "git bisect".
+test suites and tools similar as `git bisect`.
Test suites are very nice. But when they are used alone, they are
supposed to be used so that all the tests are checked after each
@@ -180,17 +180,17 @@ emulate a bisection process or you will perhaps bluntly test each
commit backward starting from the "bad" commit you have which may be
very wasteful.
-"git bisect" overview
+`git bisect` overview
---------------------
Starting a bisection
~~~~~~~~~~~~~~~~~~~~
-The first "git bisect" subcommand to use is "git bisect start" to
+The first `git bisect` subcommand to use is `git bisect start` to
start the search. Then bounds must be set to limit the commit
space. This is done usually by giving one "bad" and at least one
-"good" commit. They can be passed in the initial call to "git bisect
-start" like this:
+"good" commit. They can be passed in the initial call to `git bisect
+start` like this:
-------------
$ git bisect start [BAD [GOOD...]]
@@ -211,7 +211,7 @@ $ git bisect good [COMMIT...]
where BAD, GOOD and COMMIT are all names that can be resolved to a
commit.
-Then "git bisect" will checkout a commit of its choosing and ask the
+Then `git bisect` will checkout a commit of its choosing and ask the
user to test it, like this:
-------------
@@ -224,8 +224,8 @@ Note that the example that we will use is really a toy example, we
will be looking for the first commit that has a version like
"2.6.26-something", that is the commit that has a "SUBLEVEL = 26" line
in the top level Makefile. This is a toy example because there are
-better ways to find this commit with Git than using "git bisect" (for
-example "git blame" or "git log -S<string>").
+better ways to find this commit with Git than using `git bisect` (for
+example `git blame` or `git log -S<string>`).
Driving a bisection manually
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -236,7 +236,7 @@ script or a command.
If the user is driving it, then at each step of the search, the user
will have to test the current commit and say if it is "good" or "bad"
-using the "git bisect good" or "git bisect bad" commands respectively
+using the `git bisect good` or `git bisect bad` commands respectively
that have been described above. For example:
-------------
@@ -245,7 +245,7 @@ Bisecting: 5480 revisions left to test after this (roughly 13 steps)
[66c0b394f08fd89236515c1c84485ea712a157be] KVM: kill file->f_count abuse in kvm
-------------
-And after a few more steps like that, "git bisect" will eventually
+And after a few more steps like that, `git bisect` will eventually
find a first bad commit:
-------------
@@ -287,7 +287,7 @@ index 5cf8258..4492984 100644
# *DOCUMENTATION*
-------------
-And when we are finished we can use "git bisect reset" to go back to
+And when we are finished we can use `git bisect reset` to go back to
the branch we were in before we started bisecting:
-------------
@@ -300,10 +300,10 @@ Switched to branch 'master'
Driving a bisection automatically
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The other way to drive the bisection process is to tell "git bisect"
+The other way to drive the bisection process is to tell `git bisect`
to launch a script or command at each bisection step to know if the
-current commit is "good" or "bad". To do that, we use the "git bisect
-run" command. For example:
+current commit is "good" or "bad". To do that, we use the `git bisect
+run` command. For example:
-------------
$ git bisect start v2.6.27 v2.6.25
@@ -336,19 +336,19 @@ bisect run success
-------------
In this example, we passed "grep '^SUBLEVEL = 25' Makefile" as
-parameter to "git bisect run". This means that at each step, the grep
+parameter to `git bisect run`. This means that at each step, the grep
command we passed will be launched. And if it exits with code 0 (that
-means success) then git bisect will mark the current state as
+means success) then `git bisect` will mark the current state as
"good". If it exits with code 1 (or any code between 1 and 127
included, except the special code 125), then the current state will be
marked as "bad".
-Exit code between 128 and 255 are special to "git bisect run". They
+Exit code between 128 and 255 are special to `git bisect run`. They
make it stop immediately the bisection process. This is useful for
example if the command passed takes too long to complete, because you
can kill it with a signal and it will stop the bisection process.
-It can also be useful in scripts passed to "git bisect run" to "exit
+It can also be useful in scripts passed to `git bisect run` to "exit
255" if some very abnormal situation is detected.
Avoiding untestable commits
@@ -357,15 +357,15 @@ Avoiding untestable commits
Sometimes it happens that the current state cannot be tested, for
example if it does not compile because there was a bug preventing it
at that time. This is what the special exit code 125 is for. It tells
-"git bisect run" that the current commit should be marked as
+`git bisect run` that the current commit should be marked as
untestable and that another one should be chosen and checked out.
-If the bisection process is driven manually, you can use "git bisect
-skip" to do the same thing. (In fact the special exit code 125 makes
-"git bisect run" use "git bisect skip" in the background.)
+If the bisection process is driven manually, you can use `git bisect
+skip` to do the same thing. (In fact the special exit code 125 makes
+`git bisect run` use `git bisect skip` in the background.)
Or if you want more control, you can inspect the current state using
-for example "git bisect visualize". It will launch gitk (or "git log"
+for example `git bisect visualize`. It will launch gitk (or `git log`
if the `DISPLAY` environment variable is not set) to help you find a
better bisection point.
@@ -374,7 +374,7 @@ happen that the regression you are looking for has been introduced by
one of these untestable commits. In this case it's not possible to
tell for sure which commit introduced the regression.
-So if you used "git bisect skip" (or the run script exited with
+So if you used `git bisect skip` (or the run script exited with
special code 125) you could get a result like this:
-------------
@@ -415,7 +415,7 @@ best bisection commit to test at each step is not so simple. Anyway
Linus found and implemented a "truly stupid" algorithm, later improved
by Junio Hamano, that works quite well.
-So the algorithm used by "git bisect" to find the best bisection
+So the algorithm used by `git bisect` to find the best bisection
commit when there are no skipped commits is the following:
1) keep only the commits that:
@@ -530,7 +530,7 @@ Bisection algorithm debugging
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For any commit graph, you can see the number associated with each
-commit using "git rev-list --bisect-all".
+commit using `git rev-list --bisect-all`.
For example, for the above graph, a command like:
@@ -658,7 +658,7 @@ A-B-C-D-E-F O
4 3 2 1
-------------
-but with the algorithm used by git bisect we get:
+but with the algorithm used by `git bisect` we get:
-------------
7 7 6 5
@@ -682,7 +682,7 @@ initially supposed.
Skip algorithm
~~~~~~~~~~~~~~
-When some commits have been skipped (using "git bisect skip"), then
+When some commits have been skipped (using `git bisect skip`), then
the bisection algorithm is the same for step 1) to 3). But then we use
roughly the following steps:
@@ -709,7 +709,7 @@ Skip algorithm discussed
After step 7) (in the skip algorithm), we could check if the second
commit has been skipped and return it if it is not the case. And in
-fact that was the algorithm we used from when "git bisect skip" was
+fact that was the algorithm we used from when `git bisect skip` was
developed in Git version 1.5.4 (released on February 1st 2008) until
Git version 1.6.4 (released July 29th 2009).
@@ -852,10 +852,10 @@ usual after this step.
Best bisecting practices
------------------------
-Using test suites and git bisect together
+Using test suites and `git bisect` together
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you both have a test suite and use git bisect, then it becomes less
+If you both have a test suite and use `git bisect`, then it becomes less
important to check that all tests pass after each commit. Though of
course it is probably a good idea to have some checks to avoid
breaking too many things because it could make bisecting other bugs
@@ -864,7 +864,7 @@ more difficult.
You can focus your efforts to check at a few points (for example rc
and beta releases) that all the T test cases pass for all the N
configurations. And when some tests don't pass you can use "git
-bisect" (or better "git bisect run"). So you should perform roughly:
+bisect" (or better `git bisect run`). So you should perform roughly:
-------------
c * N * T + b * M * log2(M) tests
@@ -879,11 +879,11 @@ you would test everything after each commit.
This means that test suites are good to prevent some bugs from being
committed and they are also quite good to tell you that you have some
bugs. But they are not so good to tell you where some bugs have been
-introduced. To tell you that efficiently, git bisect is needed.
+introduced. To tell you that efficiently, `git bisect` is needed.
The other nice thing with test suites, is that when you have one, you
already know how to test for bad behavior. So you can use this
-knowledge to create a new test case for "git bisect" when it appears
+knowledge to create a new test case for `git bisect` when it appears
that there is a regression. So it will be easier to bisect the bug and
fix it. And then you can add the test case you just created to your
test suite.
@@ -893,7 +893,7 @@ subject to a virtuous circle:
more tests => easier to create tests => easier to bisect => more tests
-So test suites and "git bisect" are complementary tools that are very
+So test suites and `git bisect` are complementary tools that are very
powerful and efficient when used together.
Bisecting build failures
@@ -907,7 +907,7 @@ $ git bisect start BAD GOOD
$ git bisect run make
-------------
-Passing sh -c "some commands" to "git bisect run"
+Passing sh -c "some commands" to `git bisect run`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
For example:
@@ -925,7 +925,7 @@ Finding performance regressions
Here is an example script that comes slightly modified from a real
world script used by Junio Hamano <<4>>.
-This script can be passed to "git bisect run" to find the commit that
+This script can be passed to `git bisect run` to find the commit that
introduced a performance regression:
-------------
@@ -969,7 +969,7 @@ It is also a good idea when using any VCS to have only one small
logical change in each commit.
The smaller the changes in your commit, the most effective "git
-bisect" will be. And you will probably need "git bisect" less in the
+bisect" will be. And you will probably need `git bisect` less in the
first place, as small changes are easier to review even if they are
only reviewed by the committer.
@@ -996,7 +996,7 @@ misleading to know the first bad commit if it happens to be such a
merge, because people might think that the bug comes from bad conflict
resolution when it comes from a semantic change in one branch.
-Anyway "git rebase" can be used to linearize history. This can be used
+Anyway `git rebase` can be used to linearize history. This can be used
either to avoid merging in the first place. Or it can be used to
bisect on a linear history instead of the non linear one, as this
should give more information in case of a semantic change in one
@@ -1016,7 +1016,7 @@ A special work-flow to process regressions can give great results.
Here is an example of a work-flow used by Andreas Ericsson:
* write, in the test suite, a test script that exposes the regression
-* use "git bisect run" to find the commit that introduced it
+* use `git bisect run` to find the commit that introduced it
* fix the bug that is often made obvious by the previous step
* commit both the fix and the test script (and if needed more tests)
@@ -1034,7 +1034,7 @@ due to how we now feel about writing tests).
_____________
Clearly this work-flow uses the virtuous circle between test suites
-and "git bisect". In fact it makes it the standard procedure to deal
+and `git bisect`. In fact it makes it the standard procedure to deal
with regression.
In other messages Andreas says that they also use the "best practices"
@@ -1048,7 +1048,7 @@ is making bisecting easier, more useful and standard.
Involving QA people and if possible end users
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-One nice about "git bisect" is that it is not only a developer
+One nice about `git bisect` is that it is not only a developer
tool. It can effectively be used by QA people or even end users (if
they have access to the source code or if they can get access to all
the builds).
@@ -1091,7 +1091,7 @@ Here is what Ingo Molnar says about that <<7>>:
_____________
i have a fully automated bootup-hang bisection script. It is based on
-"git-bisect run". I run the script, it builds and boots kernels fully
+`git-bisect run`. I run the script, it builds and boots kernels fully
automatically, and when the bootup fails (the script notices that via
the serial log, which it continuously watches - or via a timeout, if
the system does not come up within 10 minutes it's a "bad" kernel),
@@ -1100,28 +1100,28 @@ box. (yeah, i should make use of a managed power outlet to 100%
automate it)
_____________
-Combining test suites, git bisect and other systems together
+Combining test suites, `git bisect` and other systems together
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-We have seen that test suites and git bisect are very powerful when
+We have seen that test suites and `git bisect` are very powerful when
used together. It can be even more powerful if you can combine them
with other systems.
For example some test suites could be run automatically at night with
some unusual (or even random) configurations. And if a regression is
-found by a test suite, then "git bisect" can be automatically
+found by a test suite, then `git bisect` can be automatically
launched, and its result can be emailed to the author of the first bad
-commit found by "git bisect", and perhaps other people too. And a new
+commit found by `git bisect`, and perhaps other people too. And a new
entry in the bug tracking system could be automatically created too.
The future of bisecting
-----------------------
-"git replace"
+`git replace`
~~~~~~~~~~~~~
-We saw earlier that "git bisect skip" is now using a PRNG to try to
+We saw earlier that `git bisect skip` is now using a PRNG to try to
avoid areas in the commit graph where commits are untestable. The
problem is that sometimes the first bad commit will be in an
untestable area.
@@ -1177,26 +1177,26 @@ For example:
$ git bisect start Z' Y
-------------
-If you are using "git bisect run", you can use the same manual fix up
-as above, and then start another "git bisect run" in the special
-branch. Or as the "git bisect" man page says, the script passed to
-"git bisect run" can apply a patch before it compiles and test the
+If you are using `git bisect run`, you can use the same manual fix up
+as above, and then start another `git bisect run` in the special
+branch. Or as the `git bisect` man page says, the script passed to
+`git bisect run` can apply a patch before it compiles and test the
software <<8>>. The patch should turn a current untestable commits
into a testable one. So the testing will result in "good" or "bad" and
-"git bisect" will be able to find the first bad commit. And the script
+`git bisect` will be able to find the first bad commit. And the script
should not forget to remove the patch once the testing is done before
exiting from the script.
-(Note that instead of a patch you can use "git cherry-pick BFC" to
-apply the fix, and in this case you should use "git reset --hard
-HEAD^" to revert the cherry-pick after testing and before returning
+(Note that instead of a patch you can use `git cherry-pick BFC` to
+apply the fix, and in this case you should use `git reset --hard
+HEAD` to revert the cherry-pick after testing and before returning
from the script.)
But the above ways to work around untestable areas are a little bit
clunky. Using special branches is nice because these branches can be
shared by developers like usual branches, but the risk is that people
-will get many such branches. And it disrupts the normal "git bisect"
-work-flow. So, if you want to use "git bisect run" completely
+will get many such branches. And it disrupts the normal `git bisect`
+work-flow. So, if you want to use `git bisect run` completely
automatically, you have to add special code in your script to restart
bisection in the special branches.
@@ -1217,13 +1217,13 @@ With the example above that would give:
...-Y-BBC-X1-X2-X3-X4-X5-X6-BFC-Z
-------------
-That's why the "git replace" command was created. Technically it
+That's why the `git replace` command was created. Technically it
stores replacements "refs" in the "refs/replace/" hierarchy. These
"refs" are like branches (that are stored in "refs/heads/") or tags
(that are stored in "refs/tags"), and that means that they can
automatically be shared like branches or tags among developers.
-"git replace" is a very powerful mechanism. It can be used to fix
+`git replace` is a very powerful mechanism. It can be used to fix
commits in already released history, for example to change the commit
message or the author. And it can also be used instead of git "grafts"
to link a repository with another old repository.
@@ -1232,7 +1232,7 @@ In fact it's this last feature that "sold" it to the Git community, so
it is now in the `master` branch of Git's Git repository and it should
be released in Git 1.6.5 in October or November 2009.
-One problem with "git replace" is that currently it stores all the
+One problem with `git replace` is that currently it stores all the
replacements refs in "refs/replace/", but it would be perhaps better
if the replacement refs that are useful only for bisecting would be in
"refs/replace/bisect/". This way the replacement refs could be used
@@ -1242,7 +1242,7 @@ be used nearly all the time.
Bisecting sporadic bugs
~~~~~~~~~~~~~~~~~~~~~~~
-Another possible improvement to "git bisect" would be to optionally
+Another possible improvement to `git bisect` would be to optionally
add some redundancy to the tests performed so that it would be more
reliable when tracking sporadic bugs.
@@ -1250,7 +1250,7 @@ This has been requested by some kernel developers because some bugs
called sporadic bugs do not appear in all the kernel builds because
they are very dependent on the compiler output.
-The idea is that every 3 test for example, "git bisect" could ask the
+The idea is that every 3 test for example, `git bisect` could ask the
user to test a commit that has already been found to be "good" or
"bad" (because one of its descendants or one of its ancestors has been
found to be "good" or "bad" respectively). If it happens that a commit
@@ -1264,7 +1264,7 @@ on Github that does something like that using Bayesian Search Theory
<<9>>:
_____________
-BBChop is like 'git bisect' (or equivalent), but works when your bug
+BBChop is like `git bisect` (or equivalent), but works when your bug
is intermittent. That is, it works in the presence of false negatives
(when a version happens to work this time even though it contains the
bug). It assumes that there are no false positives (in principle, the
@@ -1283,12 +1283,12 @@ other tools, especially test suites, that are generally used to fight
regressions. But it might be needed to change some work-flows and
(bad) habits to get the most out of it.
-Some improvements to the algorithms inside "git bisect" are possible
+Some improvements to the algorithms inside `git bisect` are possible
and some new features could help in some cases, but overall "git
bisect" works already very well, is used a lot, and is already very
useful. To back up that last claim, let's give the final word to Ingo
Molnar when he was asked by the author how much time does he think
-"git bisect" saves him when he uses it:
+`git bisect` saves him when he uses it:
_____________
a _lot_.
@@ -1307,7 +1307,7 @@ manual help or when bisecting multiple, overlapping bugs, it's rarely
more than an hour.
In fact it's invaluable because there are bugs i would never even
-_try_ to debug if it wasn't for git bisect. In the past there were bug
+_try_ to debug if it wasn't for `git bisect`. In the past there were bug
patterns that were immediately hopeless for me to debug - at best i
could send the crash/bug signature to lkml and hope that someone else
can think of something.
@@ -1316,7 +1316,7 @@ And even if a bisection fails today it tells us something valuable
about the bug: that it's non-deterministic - timing or kernel image
layout dependent.
-So git bisect is unconditional goodness - and feel free to quote that
+So `git bisect` is unconditional goodness - and feel free to quote that
;-)
_____________
@@ -1325,16 +1325,16 @@ Acknowledgments
Many thanks to Junio Hamano for his help in reviewing this paper, for
reviewing the patches I sent to the Git mailing list, for discussing
-some ideas and helping me improve them, for improving "git bisect" a
+some ideas and helping me improve them, for improving `git bisect` a
lot and for his awesome work in maintaining and developing Git.
Many thanks to Ingo Molnar for giving me very useful information that
appears in this paper, for commenting on this paper, for his
-suggestions to improve "git bisect" and for evangelizing "git bisect"
+suggestions to improve `git bisect` and for evangelizing `git bisect`
on the linux kernel mailing lists.
Many thanks to Linus Torvalds for inventing, developing and
-evangelizing "git bisect", Git and Linux.
+evangelizing `git bisect`, Git and Linux.
Many thanks to the many other great people who helped one way or
another when I worked on Git, especially to Andreas Ericsson, Johannes
@@ -1351,7 +1351,7 @@ References
- [[[2]]] http://www.oracle.com/technetwork/java/codeconvtoc-136057.html['Code Conventions for the Java Programming Language'. Sun Microsystems.]
- [[[3]]] https://en.wikipedia.org/wiki/Software_maintenance['Software maintenance'. Wikipedia.]
- [[[4]]] https://lore.kernel.org/git/7vps5xsbwp.fsf_-_@assigned-by-dhcp.cox.net/[Junio C Hamano. 'Automated bisect success story'.]
-- [[[5]]] https://lwn.net/Articles/317154/[Christian Couder. 'Fully automated bisecting with "git bisect run"'. LWN.net.]
+- [[[5]]] https://lwn.net/Articles/317154/[Christian Couder. 'Fully automated bisecting with `git bisect run`'. LWN.net.]
- [[[6]]] https://lwn.net/Articles/277872/[Jonathan Corbet. 'Bisection divides users and developers'. LWN.net.]
- [[[7]]] https://lore.kernel.org/lkml/20071207113734.GA14598@elte.hu/[Ingo Molnar. 'Re: BUG 2.6.23-rc3 can't see sd partitions on Alpha'. Linux-kernel mailing list.]
- [[[8]]] https://www.kernel.org/pub/software/scm/git/docs/git-bisect.html[Junio C Hamano and the git-list. 'git-bisect(1) Manual Page'. Linux Kernel Archives.]
diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
index ff50c66e29..d59422636b 100644
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt
@@ -9,25 +9,25 @@ git-bisect - Use binary search to find the commit that introduced a bug
SYNOPSIS
--------
[verse]
-'git bisect' <subcommand> <options>
+`git bisect` <subcommand> <options>
DESCRIPTION
-----------
The command takes various subcommands, and different options depending
on the subcommand:
- git bisect start [--term-{new,bad}=<term> --term-{old,good}=<term>]
- [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<paths>...]
- git bisect (bad|new|<term-new>) [<rev>]
- git bisect (good|old|<term-old>) [<rev>...]
- git bisect terms [--term-good | --term-bad]
- git bisect skip [(<rev>|<range>)...]
- git bisect reset [<commit>]
- git bisect (visualize|view)
- git bisect replay <logfile>
- git bisect log
- git bisect run <cmd>...
- git bisect help
+ `git bisect` start [--term-{new,bad}=<term> --term-{old,good}=<term>]
+ [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<paths>...]
+ `git bisect` (bad|new|<term-new>) [<rev>]
+ `git bisect` (good|old|<term-old>) [<rev>...]
+ `git bisect` terms [--term-good | --term-bad]
+ `git bisect` skip [(<rev>|<range>)...]
+ `git bisect` reset [<commit>]
+ `git bisect` (visualize|view)
+ `git bisect` replay <logfile>
+ `git bisect` log
+ `git bisect` run <cmd>...
+ `git bisect` help
This command uses a binary search algorithm to find which commit in
your project's history introduced a bug. You use it by first telling
@@ -196,7 +196,7 @@ of `git bisect good` and `git bisect bad` to mark commits.
Bisect visualize/view
~~~~~~~~~~~~~~~~~~~~~
-To see the currently remaining suspects in 'gitk', issue the following
+To see the currently remaining suspects in `gitk`, issue the following
command during the bisection process (the subcommand `view` can be used
as an alternative to `visualize`):
@@ -204,7 +204,7 @@ as an alternative to `visualize`):
$ git bisect visualize
------------
-If the `DISPLAY` environment variable is not set, 'git log' is used
+If the `DISPLAY` environment variable is not set, `git log` is used
instead. You can also give command-line options such as `-p` and
`--stat`.
@@ -344,7 +344,7 @@ header file, or "revision that does not have this commit needs this
patch applied to work around another problem this bisection is not
interested in") applied to the revision being tested.
-To cope with such a situation, after the inner 'git bisect' finds the
+To cope with such a situation, after the inner `git bisect` finds the
next revision to test, the script can apply the patch
before compiling, run the real test, and afterwards decide if the
revision (possibly with the needed patch) passed the test and then
@@ -475,9 +475,9 @@ $ git bisect run sh -c '
$ git bisect reset # quit the bisect session
------------
+
-In this case, when 'git bisect run' finishes, bisect/bad will refer to a commit that
+In this case, when `git bisect run` finishes, bisect/bad will refer to a commit that
has at least one parent whose reachable graph is fully traversable in the sense
-required by 'git pack objects'.
+required by `git pack objects`.
* Look for a fix instead of a regression in the code
+
@@ -502,7 +502,7 @@ help` or `git bisect -h` to get a long usage description.
SEE ALSO
--------
-link:git-bisect-lk2009.html[Fighting regressions with git bisect],
+link:git-bisect-lk2009.html[Fighting regressions with `git bisect`],
linkgit:git-blame[1].
GIT
diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt
index 3bf5d5d8b4..aa1b5d56d3 100644
--- a/Documentation/git-blame.txt
+++ b/Documentation/git-blame.txt
@@ -8,7 +8,7 @@ git-blame - Show what revision and author last modified each line of a file
SYNOPSIS
--------
[verse]
-'git blame' [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]
+`git blame` [-c] [-b] [-l] [--root] [-t] [-f] [-n] [-s] [-e] [-p] [-w] [--incremental]
[-L <range>] [-S <revs-file>] [-M] [-C] [-C] [-C] [--since=<date>]
[--ignore-rev <rev>] [--ignore-revs-file <file>]
[--progress] [--abbrev=<n>] [<rev> | --contents <file> | --reverse <rev>..<rev>]
@@ -30,7 +30,7 @@ lines that were copied and pasted from another file, etc., see the
`-C` and `-M` options.
The report does not tell you anything about lines which have been deleted or
-replaced; you need to use a tool such as 'git diff' or the "pickaxe"
+replaced; you need to use a tool such as `git diff` or the "pickaxe"
interface briefly mentioned in the following paragraph.
Apart from supporting file annotation, Git also supports searching the
@@ -59,7 +59,7 @@ include::blame-options.txt[]
file (see `-M`). The first number listed is the score.
This is the number of alphanumeric characters detected
as having been moved between or within files. This must be above
- a certain threshold for 'git blame' to consider those lines
+ a certain threshold for `git blame` to consider those lines
of code to have been moved.
-f::
@@ -136,7 +136,7 @@ usage like:
SPECIFYING RANGES
-----------------
-Unlike 'git blame' and 'git annotate' in older versions of git, the extent
+Unlike `git blame` and `git annotate` in older versions of git, the extent
of the annotation can be limited to both line ranges and revision
ranges. The `-L` option, which limits annotation to a range of lines, may be
specified multiple times.
@@ -157,7 +157,7 @@ which limits the annotation to the body of the `hello` subroutine.
When you are not interested in changes older than version
v2.6.18, or changes older than 3 weeks, you can use revision
-range specifiers similar to 'git rev-list':
+range specifiers similar to `git rev-list`:
git blame v2.6.18.. -- foo
git blame --since=3.weeks -- foo
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 8ea6e1e523..6f37f11b33 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -8,7 +8,7 @@ git-branch - List, create, or delete branches
SYNOPSIS
--------
[verse]
-'git branch' [--color[=<when>] | --no-color] [--show-current]
+`git branch` [--color[=<when>] | --no-color] [--show-current]
[-v [--abbrev=<n> | --no-abbrev]]
[--column[=<options>] | --no-column] [--sort=<key>]
[--merged [<commit>]] [--no-merged [<commit>]]
@@ -16,13 +16,13 @@ SYNOPSIS
[--points-at <object>] [--format=<format>]
[(-r | --remotes) | (-a | --all)]
[--list] [<pattern>...]
-'git branch' [--track | --no-track] [-f] <branchname> [<start-point>]
-'git branch' (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>]
-'git branch' --unset-upstream [<branchname>]
-'git branch' (-m | -M) [<oldbranch>] <newbranch>
-'git branch' (-c | -C) [<oldbranch>] <newbranch>
-'git branch' (-d | -D) [-r] <branchname>...
-'git branch' --edit-description [<branchname>]
+`git branch` [--track | --no-track] [-f] <branchname> [<start-point>]
+`git branch` (--set-upstream-to=<upstream> | -u <upstream>) [<branchname>]
+`git branch` --unset-upstream [<branchname>]
+`git branch` (-m | -M) [<oldbranch>] <newbranch>
+`git branch` (-c | -C) [<oldbranch>] <newbranch>
+`git branch` (-d | -D) [-r] <branchname>...
+`git branch` --edit-description [<branchname>]
DESCRIPTION
-----------
@@ -60,12 +60,12 @@ can leave out at most one of `A` and `B`, in which case it defaults to
`HEAD`.
Note that this will create the new branch, but it will not switch the
-working tree to it; use "git switch <newbranch>" to switch to the
+working tree to it; use `git switch <newbranch>` to switch to the
new branch.
When a local branch is started off a remote-tracking branch, Git sets up the
branch (specifically the `branch.<name>.remote` and `branch.<name>.merge`
-configuration entries) so that 'git pull' will appropriately merge from
+configuration entries) so that `git pull` will appropriately merge from
the remote-tracking branch. This behavior may be changed via the global
`branch.autoSetupMerge` configuration flag. That setting can be
overridden by using the `--track` and `--no-track` options, and
@@ -87,7 +87,7 @@ has a reflog then the reflog will also be deleted.
Use `-r` together with `-d` to delete remote-tracking branches. Note, that it
only makes sense to delete remote-tracking branches if they no longer exist
-in the remote repository or if 'git fetch' was configured not to fetch
+in the remote repository or if `git fetch` was configured not to fetch
them again. See also the 'prune' subcommand of linkgit:git-remote[1] for a
way to clean up all obsolete remote-tracking branches.
@@ -116,7 +116,7 @@ OPTIONS
-f::
--force::
Reset <branchname> to <startpoint>, even if <branchname> exists
- already. Without `-f`, 'git branch' refuses to change an existing branch.
+ already. Without `-f`, `git branch` refuses to change an existing branch.
In combination with `-d` (or `--delete`), allow deleting the
branch irrespective of its merged status. In combination with
`-m` (or `--move`), allow renaming the branch even if the new
@@ -209,7 +209,7 @@ This option is only applicable in non-verbose mode.
When creating a new branch, set up `branch.<name>.remote` and
`branch.<name>.merge` configuration entries to mark the
start-point branch as "upstream" from the new branch. This
- configuration will tell git to show the relationship between the
+ configuration will tell `git` to show the relationship between the
two branches in `git status` and `git branch -v`. Furthermore,
it directs `git pull` without arguments to pull from the
upstream when the new branch is checked out.
@@ -351,7 +351,7 @@ NOTES
-----
If you are creating a branch that you want to switch to immediately,
-it is easier to use the "git switch" command with its `-c` option to
+it is easier to use the `git switch` command with its `-c` option to
do the same thing with a single command.
The options `--contains`, `--no-contains`, `--merged` and `--no-merged`
diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt
index 66e88c2e31..bb1355248e 100644
--- a/Documentation/git-bugreport.txt
+++ b/Documentation/git-bugreport.txt
@@ -25,7 +25,7 @@ The following information is requested from the user:
The following information is captured automatically:
- - 'git version --build-options'
+ - `git version --build-options`
- uname sysname, release, version, and machine strings
- Compiler-specific info string
- A list of enabled hooks
@@ -46,7 +46,7 @@ OPTIONS
-s <format>::
--suffix <format>::
Specify an alternate suffix for the bugreport name, to create a file
- named 'git-bugreport-<formatted suffix>'. This should take the form of a
+ named `git-bugreport-<formatted suffix>`. This should take the form of a
strftime(3) format string; the current local time will be used.
GIT
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index 20da47cbd6..fb0ebe1257 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -9,11 +9,11 @@ git-bundle - Move objects and refs by archive
SYNOPSIS
--------
[verse]
-'git bundle' create [-q | --quiet | --progress | --all-progress] [--all-progress-implied]
+`git bundle` create [-q | --quiet | --progress | --all-progress] [--all-progress-implied]
[--version=<version>] <file> <git-rev-list-args>
-'git bundle' verify [-q | --quiet] <file>
-'git bundle' list-heads <file> [<refname>...]
-'git bundle' unbundle <file> [<refname>...]
+`git bundle` verify [-q | --quiet] <file>
+`git bundle` list-heads <file> [<refname>...]
+`git bundle` unbundle <file> [<refname>...]
DESCRIPTION
-----------
@@ -23,9 +23,9 @@ machine be replicated on another machine, but the two machines cannot
be directly connected, and therefore the interactive Git protocols (git,
ssh, http) cannot be used.
-The 'git bundle' command packages objects and references in an archive
+The `git bundle` command packages objects and references in an archive
at the originating machine, which can then be imported into another
-repository using 'git fetch', 'git pull', or 'git clone',
+repository using `git fetch`, `git pull`, or `git clone`,
after moving the archive by some means (e.g., by sneakernet).
As no
@@ -40,7 +40,7 @@ OPTIONS
create [options] <file> <git-rev-list-args>::
Used to create a bundle named 'file'. This requires the
'<git-rev-list-args>' arguments to define the bundle contents.
- 'options' contains the options specific to the 'git bundle create'
+ 'options' contains the options specific to the `git bundle create`
subcommand.
verify <file>::
@@ -48,7 +48,7 @@ verify <file>::
cleanly to the current repository. This includes checks on the
bundle format itself as well as checking that the prerequisite
commits exist and are fully linked in the current repository.
- 'git bundle' prints a list of missing commits, if any, and exits
+ `git bundle` prints a list of missing commits, if any, and exits
with a non-zero status.
list-heads <file>::
@@ -57,15 +57,15 @@ list-heads <file>::
printed out.
unbundle <file>::
- Passes the objects in the bundle to 'git index-pack'
+ Passes the objects in the bundle to `git index-pack`
for storage in the repository, then prints the names of all
defined references. If a list of references is given, only
references matching those in the list are printed. This command is
- really plumbing, intended to be called only by 'git fetch'.
+ really plumbing, intended to be called only by `git fetch`.
<git-rev-list-args>::
- A list of arguments, acceptable to 'git rev-parse' and
- 'git rev-list' (and containing a named ref, see SPECIFYING REFERENCES
+ A list of arguments, acceptable to `git rev-parse` and
+ `git rev-list` (and containing a named ref, see SPECIFYING REFERENCES
below), that specifies the specific objects and references
to transport. For example, `master~10..master` causes the
current `master` reference to be packaged along with all objects
@@ -76,10 +76,10 @@ unbundle <file>::
[<refname>...]::
A list of references used to limit the references reported as
- available. This is principally of use to 'git fetch', which
+ available. This is principally of use to `git fetch`, which
expects to receive only those references asked for and not
- necessarily everything in the pack (in this case, 'git bundle' acts
- like 'git fetch-pack').
+ necessarily everything in the pack (in this case, `git bundle` acts
+ like `git fetch-pack`).
--progress::
Progress status is reported on the standard error stream
@@ -117,8 +117,8 @@ unbundle <file>::
SPECIFYING REFERENCES
---------------------
-'git bundle' will only package references that are shown by
-'git show-ref': this includes heads, tags, and remote heads. References
+`git bundle` will only package references that are shown by
+`git show-ref`: this includes heads, tags, and remote heads. References
such as `master~1` cannot be packaged, but are perfectly suitable for
defining the basis. More than one reference may be packaged, and more
than one basis can be specified. The objects packaged are those not
diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
index 4eb0421b3f..3ac3d44fcb 100644
--- a/Documentation/git-cat-file.txt
+++ b/Documentation/git-cat-file.txt
@@ -9,8 +9,8 @@ git-cat-file - Provide content or type and size information for repository objec
SYNOPSIS
--------
[verse]
-'git cat-file' (-t [--allow-unknown-type]| -s [--allow-unknown-type]| -e | -p | <type> | --textconv | --filters ) [--path=<path>] <object>
-'git cat-file' (--batch[=<format>] | --batch-check[=<format>]) [ --textconv | --filters ] [--follow-symlinks]
+`git cat-file` (-t [--allow-unknown-type]| -s [--allow-unknown-type]| -e | -p | <type> | --textconv | --filters ) [--path=<path>] <object>
+`git cat-file` (--batch[=<format>] | --batch-check[=<format>]) [ --textconv | --filters ] [--follow-symlinks]
DESCRIPTION
-----------
@@ -134,7 +134,7 @@ one in the tree.
This option cannot (currently) be used unless `--batch` or
`--batch-check` is used.
+
-For example, consider a git repository containing:
+For example, consider a `git` repository containing:
+
--
f: a file containing "hello\n"
diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt
index 84f41a8e82..0ac496700e 100644
--- a/Documentation/git-check-attr.txt
+++ b/Documentation/git-check-attr.txt
@@ -9,8 +9,8 @@ git-check-attr - Display gitattributes information
SYNOPSIS
--------
[verse]
-'git check-attr' [-a | --all | <attr>...] [--] <pathname>...
-'git check-attr' --stdin [-z] [-a | --all | <attr>...]
+`git check-attr` [-a | --all | <attr>...] [--] <pathname>...
+`git check-attr` --stdin [-z] [-a | --all | <attr>...]
DESCRIPTION
-----------
diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt
index 0c3924a63d..56a4f655c8 100644
--- a/Documentation/git-check-ignore.txt
+++ b/Documentation/git-check-ignore.txt
@@ -9,8 +9,8 @@ git-check-ignore - Debug gitignore / exclude files
SYNOPSIS
--------
[verse]
-'git check-ignore' [<options>] <pathname>...
-'git check-ignore' [<options>] --stdin
+`git check-ignore` [<options>] <pathname>...
+`git check-ignore` [<options>] --stdin
DESCRIPTION
-----------
diff --git a/Documentation/git-check-mailmap.txt b/Documentation/git-check-mailmap.txt
index 02f4418323..302049afe4 100644
--- a/Documentation/git-check-mailmap.txt
+++ b/Documentation/git-check-mailmap.txt
@@ -9,7 +9,7 @@ git-check-mailmap - Show canonical names and email addresses of contacts
SYNOPSIS
--------
[verse]
-'git check-mailmap' [<options>] <contact>...
+`git check-mailmap` [<options>] <contact>...
DESCRIPTION
diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt
index f39622c0da..77beb46e98 100644
--- a/Documentation/git-check-ref-format.txt
+++ b/Documentation/git-check-ref-format.txt
@@ -8,10 +8,10 @@ git-check-ref-format - Ensures that a reference name is well formed
SYNOPSIS
--------
[verse]
-'git check-ref-format' [--normalize]
+`git check-ref-format` [--normalize]
[--[no-]allow-onelevel] [--refspec-pattern]
<refname>
-'git check-ref-format' --branch <branchname-shorthand>
+`git check-ref-format` --branch <branchname-shorthand>
DESCRIPTION
-----------
@@ -73,7 +73,7 @@ reference name expressions (see linkgit:gitrevisions[7]):
. A colon `:` is used as in `srcref:dstref` to mean "use srcref\'s
value and store it in dstref" in fetch and push operations.
It may also be used to select a specific object such as with
- 'git cat-file': "git cat-file blob v1.3.3:refs.c".
+ `git cat-file`: `git cat-file blob v1.3.3:refs.c`.
. at-open-brace `@{` is used as a notation to access a reflog entry.
@@ -88,7 +88,7 @@ but it is explicitly forbidden at the beginning of a branch name).
When run with `--branch` option in a repository, the input is first
expanded for the ``previous checkout syntax''
`@{-n}`. For example, `@{-1}` is a way to refer the last thing that
-was checked out using "git switch" or "git checkout" operation.
+was checked out using `git switch` or `git checkout` operation.
This option should be
used by porcelains to accept this syntax anywhere a branch name is
expected, so they can act as if you typed the branch name. As an
diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt
index b06d3ae3d9..6e49062ea3 100644
--- a/Documentation/git-checkout-index.txt
+++ b/Documentation/git-checkout-index.txt
@@ -9,7 +9,7 @@ git-checkout-index - Copy files from the index to the working tree
SYNOPSIS
--------
[verse]
-'git checkout-index' [-u] [-q] [-a] [-f] [-n] [--prefix=<string>]
+`git checkout-index` [-u] [-q] [-a] [-f] [-n] [--prefix=<string>]
[--stage=<number>|all]
[--temp]
[-z] [--stdin]
@@ -88,7 +88,7 @@ $ find . -name '*.h' -print0 | xargs -0 git checkout-index -f --
which will force all existing `*.h` files to be replaced with their
cached copies. If an empty command line implied "all", then this would
force-refresh everything in the index, which was not the point. But
-since 'git checkout-index' accepts `--stdin` it would be faster to use:
+since `git checkout-index` accepts `--stdin` it would be faster to use:
----------------
$ find . -name '*.h' -print0 | git checkout-index -f -z --stdin
@@ -102,7 +102,7 @@ Using `--` is probably a good policy in scripts.
Using --temp or --stage=all
---------------------------
When `--temp` is used (or implied by `--stage=all`)
-'git checkout-index' will create a temporary file for each index
+`git checkout-index` will create a temporary file for each index
entry being checked out. The index will not be updated with stat
information. These options can be useful if the caller needs all
stages of all unmerged entries so that the unmerged files can be
@@ -147,9 +147,9 @@ To update and refresh only the files already checked out::
$ git checkout-index -n -f -a && git update-index --ignore-missing --refresh
----------------
-Using 'git checkout-index' to "export an entire tree"::
+Using `git checkout-index` to "export an entire tree"::
The prefix ability basically makes it trivial to use
- 'git checkout-index' as an "export as tree" function.
+ `git checkout-index` as an "export as tree" function.
Just read the desired tree into the index, and do:
+
----------------
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 192dbfe9b0..c3fc807d91 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -8,22 +8,22 @@ git-checkout - Switch branches or restore working tree files
SYNOPSIS
--------
[verse]
-'git checkout' [-q] [-f] [-m] [<branch>]
-'git checkout' [-q] [-f] [-m] --detach [<branch>]
-'git checkout' [-q] [-f] [-m] [--detach] <commit>
-'git checkout' [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>]
-'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...
-'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]
-'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]
+`git checkout` [-q] [-f] [-m] [<branch>]
+`git checkout` [-q] [-f] [-m] --detach [<branch>]
+`git checkout` [-q] [-f] [-m] [--detach] <commit>
+`git checkout` [-q] [-f] [-m] [[-b|-B|--orphan] <new_branch>] [<start_point>]
+`git checkout` [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...
+`git checkout` [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]
+`git checkout` (-p|--patch) [<tree-ish>] [--] [<pathspec>...]
DESCRIPTION
-----------
Updates files in the working tree to match the version in the index
-or the specified tree. If no pathspec was given, 'git checkout' will
+or the specified tree. If no pathspec was given, `git checkout` will
also update `HEAD` to set the specified branch as the current
branch.
-'git checkout' [<branch>]::
+`git checkout` [<branch>]::
To prepare for working on `<branch>`, switch to it by updating
the index and the files in the working tree, and by pointing
`HEAD` at the branch. Local modifications to the files in the
@@ -43,12 +43,12 @@ You could omit `<branch>`, in which case the command degenerates to
rather expensive side-effects to show only the tracking information,
if exists, for the current branch.
-'git checkout' -b|-B <new_branch> [<start point>]::
+`git checkout` -b|-B <new_branch> [<start point>]::
Specifying `-b` causes a new branch to be created as if
linkgit:git-branch[1] were called and then checked out. In
this case you can use the `--track` or `--no-track` options,
- which will be passed to 'git branch'. As a convenience,
+ which will be passed to `git branch`. As a convenience,
`--track` without `-b` implies branch creation; see the
description of `--track` below.
+
@@ -60,11 +60,11 @@ $ git branch -f <branch> [<start point>]
$ git checkout <branch>
------------
+
-that is to say, the branch is not reset/created unless "git checkout" is
+that is to say, the branch is not reset/created unless `git checkout` is
successful.
-'git checkout' --detach [<branch>]::
-'git checkout' [--detach] <commit>::
+`git checkout` --detach [<branch>]::
+`git checkout` [--detach] <commit>::
Prepare to work on top of `<commit>`, by detaching `HEAD` at it
(see "DETACHED HEAD" section), and updating the index and the
@@ -79,8 +79,8 @@ be used to detach `HEAD` at the tip of the branch (`git checkout
+
Omitting `<branch>` detaches `HEAD` at the tip of the current branch.
-'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...::
-'git checkout' [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]::
+`git checkout` [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] [--] <pathspec>...::
+`git checkout` [-f|--ours|--theirs|-m|--conflict=<style>] [<tree-ish>] --pathspec-from-file=<file> [--pathspec-file-nul]::
Overwrite the contents of the files that match the pathspec.
When the `<tree-ish>` (most often a commit) is not given,
@@ -96,7 +96,7 @@ specific side of the merge can be checked out of the index by
using `--ours` or `--theirs`. With `-m`, changes made to the working tree
file can be discarded to re-create the original conflicted merge result.
-'git checkout' (-p|--patch) [<tree-ish>] [--] [<pathspec>...]::
+`git checkout` (-p|--patch) [<tree-ish>] [--] [<pathspec>...]::
This is similar to the previous mode, but lets you use the
interactive interface to show the "diff" output and choose which
hunks to use in the result. See below for the description of
@@ -151,7 +151,7 @@ of it").
-B <new_branch>::
Creates the branch `<new_branch>` and start it at `<start_point>`;
if it already exists, then reset it to `<start_point>`. This is
- equivalent to running "git branch" with `-f`; see
+ equivalent to running `git branch` with `-f`; see
linkgit:git-branch[1] for details.
-t::
@@ -333,7 +333,7 @@ Note that this option uses the no overlay mode by default (see also
any branch (see below for details).
+
You can use the `@{-N}` syntax to refer to the N-th last
-branch/commit checked out using "git checkout" operation. You may
+branch/commit checked out using `git checkout` operation. You may
also specify `-` which is synonymous to `@{-1}`.
+
As a special case, you may use `A...B` as a shortcut for the
@@ -384,7 +384,7 @@ a---b---c branch 'master' (refers to commit 'c')
------------
When a commit is created in this state, the branch is updated to refer to
-the new commit. Specifically, 'git commit' creates a new commit `d`, whose
+the new commit. Specifically, `git commit` creates a new commit `d`, whose
parent is commit `c`, and then updates branch `master` to refer to new
commit `d`. `HEAD` still refers to branch `master` and so indirectly now refers
to commit `d`:
@@ -493,7 +493,7 @@ $ git tag foo <3>
leaving `HEAD` detached.
If we have moved away from commit `f`, then we must first recover its object
-name (typically by using git reflog), and then we can create a reference to
+name (typically by using `git reflog`), and then we can create a reference to
it. For example, to see the last two commits to which `HEAD` referred, we
can use either of these commands:
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index 6069cc77a0..fb12a67778 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -8,9 +8,9 @@ git-cherry-pick - Apply the changes introduced by some existing commits
SYNOPSIS
--------
[verse]
-'git cherry-pick' [--edit] [-n] [-m parent-number] [-s] [-x] [--ff]
+`git cherry-pick` [--edit] [-n] [-m parent-number] [-s] [-x] [--ff]
[-S[<keyid>]] <commit>...
-'git cherry-pick' (--continue | --skip | --abort | --quit)
+`git cherry-pick` (--continue | --skip | --abort | --quit)
DESCRIPTION
-----------
@@ -52,7 +52,7 @@ OPTIONS
-e::
--edit::
- With this option, 'git cherry-pick' will let you edit the commit
+ With this option, `git cherry-pick` will let you edit the commit
message prior to committing.
--cleanup=<mode>::
diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt
index 4374f398fa..ab55060668 100644
--- a/Documentation/git-cherry.txt
+++ b/Documentation/git-cherry.txt
@@ -8,7 +8,7 @@ git-cherry - Find commits yet to be applied to upstream
SYNOPSIS
--------
[verse]
-'git cherry' [-v] [<upstream> [<head> [<limit>]]]
+`git cherry` [-v] [<upstream> [<head> [<limit>]]]
DESCRIPTION
-----------
@@ -16,7 +16,7 @@ Determine whether there are commits in `<head>..<upstream>` that are
equivalent to those in the range `<limit>..<head>`.
The equivalence test is based on the diff, after removing whitespace
-and line numbers. git-cherry therefore detects when commits have been
+and line numbers. `git-cherry` therefore detects when commits have been
"copied" by means of linkgit:git-cherry-pick[1], linkgit:git-am[1] or
linkgit:git-rebase[1].
@@ -45,7 +45,7 @@ EXAMPLES
Patch workflows
~~~~~~~~~~~~~~~
-git-cherry is frequently used in patch-based workflows (see
+`git-cherry` is frequently used in patch-based workflows (see
linkgit:gitworkflows[7]) to determine if a series of patches has been
applied by the upstream maintainer. In such a workflow you might
create and send a topic branch like this:
@@ -85,7 +85,7 @@ $ git log --graph --oneline --decorate --boundary origin/master...topic
o 1234567 branch point
------------
-In such cases, git-cherry shows a concise summary of what has yet to
+In such cases, `git-cherry` shows a concise summary of what has yet to
be applied:
------------
diff --git a/Documentation/git-citool.txt b/Documentation/git-citool.txt
index c7a11c36c1..f750f754ae 100644
--- a/Documentation/git-citool.txt
+++ b/Documentation/git-citool.txt
@@ -8,16 +8,16 @@ git-citool - Graphical alternative to git-commit
SYNOPSIS
--------
[verse]
-'git citool'
+`git citool`
DESCRIPTION
-----------
A Tcl/Tk based graphical interface to review modified files, stage
them into the index, enter a commit message and record the new
commit onto the current branch. This interface is an alternative
-to the less interactive 'git commit' program.
+to the less interactive `git commit` program.
-'git citool' is actually a standard alias for `git gui citool`.
+`git citool` is actually a standard alias for `git gui citool`.
See linkgit:git-gui[1] for more details.
GIT
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index cbec3e649a..7923ae27a5 100644
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -8,7 +8,7 @@ git-clean - Remove untracked files from the working tree
SYNOPSIS
--------
[verse]
-'git clean' [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <path>...
+`git clean` [-d] [-f] [-i] [-n] [-q] [-e <pattern>] [-x | -X] [--] <path>...
DESCRIPTION
-----------
@@ -26,19 +26,19 @@ are affected.
OPTIONS
-------
-d::
- Normally, when no <path> is specified, git clean will not
+ Normally, when no <path> is specified, `git clean` will not
recurse into untracked directories to avoid removing too much.
Specify `-d` to have it recurse into such directories as well.
If any paths are specified, `-d` is irrelevant; all untracked
files matching the specified paths (with exceptions for nested
- git directories mentioned under `--force`) will be removed.
+ `git` directories mentioned under `--force`) will be removed.
-f::
--force::
If the Git configuration variable `clean.requireForce` is not set
- to false, 'git clean' will refuse to delete files or directories
+ to false, `git clean` will refuse to delete files or directories
unless given `-f` or `-i`. Git will refuse to modify untracked
- nested git repositories (directories with a .git subdirectory)
+ nested `git` repositories (directories with a .git subdirectory)
unless a second `-f` is given.
-i::
@@ -65,7 +65,7 @@ OPTIONS
still use the ignore rules given with `-e` options from the command
line. This allows removing all untracked
files, including build products. This can be used (possibly in
- conjunction with 'git restore' or 'git reset') to create a pristine
+ conjunction with `git restore` or `git reset`) to create a pristine
working directory to test a clean build.
-X::
@@ -131,7 +131,7 @@ quit::
help::
- Show brief usage of interactive git-clean.
+ Show brief usage of interactive `git-clean`.
SEE ALSO
--------
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 8cd602a852..b8ca823467 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -9,7 +9,7 @@ git-clone - Clone a repository into a new directory
SYNOPSIS
--------
[verse]
-'git clone' [--template=<template_directory>]
+`git clone` [--template=<template_directory>]
[-l] [-s] [--no-hardlinks] [-q] [-n] [--bare] [--mirror]
[-o <name>] [-b <name>] [-u <upload-pack>] [--reference <repository>]
[--dissociate] [--separate-git-dir <git dir>]
diff --git a/Documentation/git-column.txt b/Documentation/git-column.txt
index ab545fc52d..0865d22bdc 100644
--- a/Documentation/git-column.txt
+++ b/Documentation/git-column.txt
@@ -8,14 +8,14 @@ git-column - Display data in columns
SYNOPSIS
--------
[verse]
-'git column' [--command=<name>] [--[raw-]mode=<mode>] [--width=<width>]
+`git column` [--command=<name>] [--[raw-]mode=<mode>] [--width=<width>]
[--indent=<string>] [--nl=<string>] [--padding=<n>]
DESCRIPTION
-----------
This command formats the lines of its standard input into a table with
multiple columns. Each input line occupies one cell of the table. It
-is used internally by other git commands to format output into
+is used internally by other `git` commands to format output into
columns.
OPTIONS
diff --git a/Documentation/git-commit-graph.txt b/Documentation/git-commit-graph.txt
index e1f48c95b3..3246616b10 100644
--- a/Documentation/git-commit-graph.txt
+++ b/Documentation/git-commit-graph.txt
@@ -9,8 +9,8 @@ git-commit-graph - Write and verify Git commit-graph files
SYNOPSIS
--------
[verse]
-'git commit-graph verify' [--object-dir <dir>] [--shallow] [--[no-]progress]
-'git commit-graph write' <options> [--object-dir <dir>] [--[no-]progress]
+`git commit-graph verify` [--object-dir <dir>] [--shallow] [--[no-]progress]
+`git commit-graph write` <options> [--object-dir <dir>] [--[no-]progress]
DESCRIPTION
diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt
index b76a825c94..48a76dd029 100644
--- a/Documentation/git-commit-tree.txt
+++ b/Documentation/git-commit-tree.txt
@@ -9,8 +9,8 @@ git-commit-tree - Create a new commit object
SYNOPSIS
--------
[verse]
-'git commit-tree' <tree> [(-p <parent>)...]
-'git commit-tree' [(-p <parent>)...] [-S[<keyid>]] [(-m <message>)...]
+`git commit-tree` <tree> [(-p <parent>)...]
+`git commit-tree` [(-p <parent>)...] [-S[<keyid>]] [(-m <message>)...]
[(-F <file>)...] <tree>
@@ -77,7 +77,7 @@ A commit encapsulates:
- committer name and email and the commit time.
A commit comment is read from stdin. If a changelog
-entry is not provided via "<" redirection, 'git commit-tree' will just wait
+entry is not provided via "<" redirection, `git commit-tree` will just wait
for one to be entered and terminated with ^D.
include::date-formats.txt[]
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 6d10f2bdc7..3b22ba718c 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -8,7 +8,7 @@ git-commit - Record changes to the repository
SYNOPSIS
--------
[verse]
-'git commit' [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
+`git commit` [-a | --interactive | --patch] [-s] [-v] [-u<mode>] [--amend]
[--dry-run] [(-c | -C | --squash) <commit> | --fixup [(amend|reword):]<commit>)]
[-F <file> | -m <msg>] [--reset-author] [--allow-empty]
[--allow-empty-message] [--no-verify] [-e] [--author=<author>]
@@ -58,7 +58,7 @@ summary of what is included by any of the above for the next
commit by giving the same set of parameters (options and paths).
If you make a commit and then find a mistake immediately after
-that, you can recover from it with 'git reset'.
+that, you can recover from it with `git reset`.
:git-commit: 1
@@ -310,7 +310,7 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
of the paths specified on the
command line, disregarding any contents that have been
staged for other paths. This is the default mode of operation of
- 'git commit' if any paths are given on the command line,
+ `git commit` if any paths are given on the command line,
in which case this option can be omitted.
If this option is specified together with `--amend`, then
no paths need to be specified, which can be used to amend
@@ -409,10 +409,10 @@ EXAMPLES
--------
When recording your own work, the contents of modified files in
your working tree are temporarily stored to a staging area
-called the "index" with 'git add'. A file can be
+called the "index" with `git add`. A file can be
reverted back, only in the index but not in the working tree,
to that of the last commit with `git restore --staged <file>`,
-which effectively reverts 'git add' and prevents the changes to
+which effectively reverts `git add` and prevents the changes to
this file from participating in the next commit. After building
the state to be committed incrementally with these commands,
`git commit` (without any pathname parameter) is used to record what
@@ -468,13 +468,13 @@ $ git commit
this second commit would record the changes to `hello.c` and
`hello.h` as expected.
-After a merge (initiated by 'git merge' or 'git pull') stops
+After a merge (initiated by `git merge` or `git pull`) stops
because of conflicts, cleanly merged
paths are already staged to be committed for you, and paths that
conflicted are left in unmerged state. You would have to first
-check which paths are conflicting with 'git status'
+check which paths are conflicting with `git status`
and after fixing them manually in your working tree, you would
-stage the result as usual with 'git add':
+stage the result as usual with `git add`:
------------
$ git status | grep unmerged
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 606411c816..85e02aff92 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -9,21 +9,21 @@ git-config - Get and set repository or global options
SYNOPSIS
--------
[verse]
-'git config' [<file-option>] [--type=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] name [value [value-pattern]]
-'git config' [<file-option>] [--type=<type>] --add name value
-'git config' [<file-option>] [--type=<type>] [--fixed-value] --replace-all name value [value-pattern]
-'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get name [value-pattern]
-'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all name [value-pattern]
-'git config' [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp name_regex [value-pattern]
-'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch name URL
-'git config' [<file-option>] [--fixed-value] --unset name [value-pattern]
-'git config' [<file-option>] [--fixed-value] --unset-all name [value-pattern]
-'git config' [<file-option>] --rename-section old_name new_name
-'git config' [<file-option>] --remove-section name
-'git config' [<file-option>] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
-'git config' [<file-option>] --get-color name [default]
-'git config' [<file-option>] --get-colorbool name [stdout-is-tty]
-'git config' [<file-option>] -e | --edit
+`git config` [<file-option>] [--type=<type>] [--fixed-value] [--show-origin] [--show-scope] [-z|--null] name [value [value-pattern]]
+`git config` [<file-option>] [--type=<type>] --add name value
+`git config` [<file-option>] [--type=<type>] [--fixed-value] --replace-all name value [value-pattern]
+`git config` [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get name [value-pattern]
+`git config` [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] --get-all name [value-pattern]
+`git config` [<file-option>] [--type=<type>] [--show-origin] [--show-scope] [-z|--null] [--fixed-value] [--name-only] --get-regexp name_regex [value-pattern]
+`git config` [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch name URL
+`git config` [<file-option>] [--fixed-value] --unset name [value-pattern]
+`git config` [<file-option>] [--fixed-value] --unset-all name [value-pattern]
+`git config` [<file-option>] --rename-section old_name new_name
+`git config` [<file-option>] --remove-section name
+`git config` [<file-option>] [--show-origin] [--show-scope] [-z|--null] [--name-only] -l | --list
+`git config` [<file-option>] --get-color name [default]
+`git config` [<file-option>] --get-colorbool name [stdout-is-tty]
+`git config` [<file-option>] -e | --edit
DESCRIPTION
-----------
@@ -41,7 +41,7 @@ prepend a single exclamation mark in front (see also <<EXAMPLES>>),
but note that this only works when the `--fixed-value` option is not
in use.
-The `--type=<type>` option instructs 'git config' to ensure that incoming and
+The `--type=<type>` option instructs `git config` to ensure that incoming and
outgoing values are canonicalize-able under the given <type>. If no
`--type=<type>` is given, no canonicalization will be performed. Callers may
unset an existing `--type` specifier with `--no-type`.
@@ -175,7 +175,7 @@ See also <<FILES>>.
is exactly equal to the `value-pattern`.
--type <type>::
- 'git config' will ensure that any input or output is valid under the given
+ `git config` will ensure that any input or output is valid under the given
type constraint(s), and will canonicalize outgoing values in `<type>`'s
canonical form.
+
@@ -209,7 +209,7 @@ Valid `<type>`'s include:
--no-type::
Un-sets the previously set type specifier (if one was previously set). This
- option requests that 'git config' not canonicalize the retrieved variable.
+ option requests that `git config` not canonicalize the retrieved variable.
`--no-type` has no effect without `--type=<type>` or `--<type>`.
-z::
@@ -284,7 +284,7 @@ FILES
-----
If not set explicitly with `--file`, there are four files where
-'git config' will search for configuration options:
+`git config` will search for configuration options:
$(prefix)/etc/gitconfig::
System-wide configuration file.
@@ -311,7 +311,7 @@ $GIT_DIR/config.worktree::
If no further options are given, all reading options will read all of these
files that are available. If the global or the system-wide configuration
file are not available they will be ignored. If the repository configuration
-file is not available or readable, 'git config' will exit with a non-zero
+file is not available or readable, `git config` will exit with a non-zero
error code. However, in neither case will an error message be issued.
The files are read in the order given above, with last value found taking
@@ -358,7 +358,7 @@ GIT_CONFIG_VALUE_<n>::
in configuration files, but will be overridden by any explicit options
passed via `git -c`.
+
-This is useful for cases where you want to spawn multiple git commands
+This is useful for cases where you want to spawn multiple `git` commands
with a common configuration but cannot depend on a configuration file,
for example when writing scripts.
diff --git a/Documentation/git-count-objects.txt b/Documentation/git-count-objects.txt
index d12ce08789..a52bd618c4 100644
--- a/Documentation/git-count-objects.txt
+++ b/Documentation/git-count-objects.txt
@@ -8,7 +8,7 @@ git-count-objects - Count unpacked number of objects and their disk consumption
SYNOPSIS
--------
[verse]
-'git count-objects' [-v] [-H | --human-readable]
+`git count-objects` [-v] [-H | --human-readable]
DESCRIPTION
-----------
diff --git a/Documentation/git-credential-cache--daemon.txt b/Documentation/git-credential-cache--daemon.txt
index 7051c6bdf8..ed4d4c4f35 100644
--- a/Documentation/git-credential-cache--daemon.txt
+++ b/Documentation/git-credential-cache--daemon.txt
@@ -8,7 +8,7 @@ git-credential-cache--daemon - Temporarily store user credentials in memory
SYNOPSIS
--------
[verse]
-git credential-cache--daemon [--debug] <socket>
+`git credential-cache--daemon` [--debug] <socket>
DESCRIPTION
-----------
diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt
index b1a9d9b29a..e9834b8b95 100644
--- a/Documentation/git-credential-cache.txt
+++ b/Documentation/git-credential-cache.txt
@@ -8,7 +8,7 @@ git-credential-cache - Helper to temporarily store passwords in memory
SYNOPSIS
--------
-----------------------------
-git config credential.helper 'cache [<options>]'
+`git config` credential.helper 'cache [<options>]'
-----------------------------
DESCRIPTION
diff --git a/Documentation/git-credential-store.txt b/Documentation/git-credential-store.txt
index 76b0798856..376b0d6c5f 100644
--- a/Documentation/git-credential-store.txt
+++ b/Documentation/git-credential-store.txt
@@ -8,7 +8,7 @@ git-credential-store - Helper to store credentials on disk
SYNOPSIS
--------
-------------------
-git config credential.helper 'store [<options>]'
+`git config` credential.helper 'store [<options>]'
-------------------
DESCRIPTION
@@ -45,7 +45,7 @@ FILES
-----
If not set explicitly with `--file`, there are two files where
-git-credential-store will search for credentials in order of precedence:
+`git-credential-store` will search for credentials in order of precedence:
~/.git-credentials::
User-specific credentials file.
diff --git a/Documentation/git-credential.txt b/Documentation/git-credential.txt
index 31c81c4c02..9bfcb3f90a 100644
--- a/Documentation/git-credential.txt
+++ b/Documentation/git-credential.txt
@@ -8,7 +8,7 @@ git-credential - Retrieve and store user credentials
SYNOPSIS
--------
------------------
-git credential <fill|approve|reject>
+`git credential` <fill|approve|reject>
------------------
DESCRIPTION
@@ -16,28 +16,28 @@ DESCRIPTION
Git has an internal interface for storing and retrieving credentials
from system-specific helpers, as well as prompting the user for
-usernames and passwords. The git-credential command exposes this
+usernames and passwords. The `git-credential` command exposes this
interface to scripts which may want to retrieve, store, or prompt for
credentials in the same manner as Git. The design of this scriptable
interface models the internal C API; see credential.h for more
background on the concepts.
-git-credential takes an "action" option on the command-line (one of
+`git-credential` takes an "action" option on the command-line (one of
`fill`, `approve`, or `reject`) and reads a credential description
on stdin (see <<IOFMT,INPUT/OUTPUT FORMAT>>).
-If the action is `fill`, git-credential will attempt to add "username"
+If the action is `fill`, `git-credential` will attempt to add "username"
and "password" attributes to the description by reading config files,
by contacting any configured credential helpers, or by prompting the
user. The username and password attributes of the credential
description are then printed to stdout together with the attributes
already provided.
-If the action is `approve`, git-credential will send the description
+If the action is `approve`, `git-credential` will send the description
to any configured credential helpers, which may store the credential
for later use.
-If the action is `reject`, git-credential will send the description to
+If the action is `reject`, `git-credential` will send the description to
any configured credential helpers, which may erase any stored
credential matching the description.
@@ -46,7 +46,7 @@ If the action is `approve` or `reject`, no output should be emitted.
TYPICAL USE OF GIT CREDENTIAL
-----------------------------
-An application using git-credential will typically use `git
+An application using `git-credential` will typically use `git
credential` following these steps:
1. Generate a credential description based on the context.
@@ -61,7 +61,7 @@ information it has):
host=example.com
path=foo.git
- 2. Ask git-credential to give us a username and password for this
+ 2. Ask `git-credential` to give us a username and password for this
description. This is done by running `git credential fill`,
feeding the description from step (1) to its standard input. The complete
credential description (including the credential per se, i.e. the
diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt
index 76b16f9dae..596512ec73 100644
--- a/Documentation/git-cvsexportcommit.txt
+++ b/Documentation/git-cvsexportcommit.txt
@@ -9,7 +9,7 @@ git-cvsexportcommit - Export a single commit to a CVS checkout
SYNOPSIS
--------
[verse]
-'git cvsexportcommit' [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot]
+`git cvsexportcommit` [-h] [-u] [-v] [-c] [-P] [-p] [-a] [-d cvsroot]
[-w cvsworkdir] [-W] [-f] [-m msgprefix] [PARENTCOMMIT] COMMITID
@@ -28,7 +28,7 @@ by default.
Supports file additions, removals, and commits that affect binary files.
-If the commit is a merge commit, you must tell 'git cvsexportcommit' what
+If the commit is a merge commit, you must tell `git cvsexportcommit` what
parent the changeset should be done against.
OPTIONS
diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt
index 95fa94de74..586184bbd4 100644
--- a/Documentation/git-cvsimport.txt
+++ b/Documentation/git-cvsimport.txt
@@ -9,7 +9,7 @@ git-cvsimport - Salvage your data out of another SCM people love to hate
SYNOPSIS
--------
[verse]
-'git cvsimport' [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>]
+`git cvsimport` [-o <branch-for-HEAD>] [-h] [-v] [-d <CVSROOT>]
[-A <author-conv-file>] [-p <options-for-cvsps>] [-P <file>]
[-C <git_repository>] [-z <fuzz>] [-i] [-k] [-u] [-s <subst>]
[-a] [-m] [-M <regex>] [-S <regex>] [-L <commitlimit>]
@@ -34,9 +34,9 @@ At least version 2.1 is required.
Please see the section <<issues,ISSUES>> for further reference.
You should *never* do any work of your own on the branches that are
-created by 'git cvsimport'. By default initial import will create and populate a
+created by `git cvsimport`. By default initial import will create and populate a
`master` branch from the CVS repository's main branch which you're free
-to work with; after that, you need to 'git merge' incremental imports, or
+to work with; after that, you need to `git merge` incremental imports, or
any CVS branches, yourself. It is advisable to specify a named remote via
`-r` to separate and protect the incoming branches.
@@ -55,13 +55,13 @@ OPTIONS
-d <CVSROOT>::
The root of the CVS archive. May be local (a simple path) or remote;
currently, only the :local:, :ext: and :pserver: access methods
- are supported. If not given, 'git cvsimport' will try to read it
+ are supported. If not given, `git cvsimport` will try to read it
from `CVS/Root`. If no such file exists, it checks for the
`CVSROOT` environment variable.
<CVS_module>::
The CVS module you want to import. Relative to <CVSROOT>.
- If not given, 'git cvsimport' tries to read it from
+ If not given, `git cvsimport` tries to read it from
`CVS/Repository`.
-C <target-dir>::
@@ -71,14 +71,14 @@ OPTIONS
-r <remote>::
The Git remote to import this CVS repository into.
Moves all CVS branches into remotes/<remote>/<branch>
- akin to the way 'git clone' uses `origin` by default.
+ akin to the way `git clone` uses `origin` by default.
-o <branch-for-HEAD>::
When no remote is specified (via `-r`) the `HEAD` branch
from CVS is imported to the `origin` branch within the Git
repository, as `HEAD` already has a special meaning for Git.
When a remote is specified the `HEAD` branch is named
- remotes/<remote>/master mirroring 'git clone' behaviour.
+ remotes/<remote>/master mirroring `git clone` behaviour.
Use this option if you want to import into a different
branch.
+
@@ -152,18 +152,18 @@ This option can be used several times to provide several detection regexes.
---------
+
-'git cvsimport' will make it appear as those authors had
+`git cvsimport` will make it appear as those authors had
their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly
all along. If a time zone is specified, GIT_AUTHOR_DATE will
have the corresponding offset applied.
+
For convenience, this data is saved to `$GIT_DIR/cvs-authors`
each time the `-A` option is provided and read from that same
-file each time 'git cvsimport' is run.
+file each time `git cvsimport` is run.
+
It is not recommended to use this feature if you intend to
export changes back to CVS again later with
-'git cvsexportcommit'.
+`git cvsexportcommit`.
-R::
Generate a `$GIT_DIR/cvs-revisions` file containing a mapping from CVS
diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
index c6a926d8d2..bf53d16a7f 100644
--- a/Documentation/git-cvsserver.txt
+++ b/Documentation/git-cvsserver.txt
@@ -17,12 +17,12 @@ export CVS_SERVER="git cvsserver"
pserver (/etc/inetd.conf):
[verse]
-cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
+cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver `git-cvsserver` pserver
Usage:
[verse]
-'git-cvsserver' [<options>] [pserver|server] [<directory> ...]
+`git-cvsserver` [<options>] [pserver|server] [<directory> ...]
OPTIONS
-------
@@ -74,7 +74,7 @@ LIMITATIONS
CVS clients cannot tag, branch or perform Git merges.
-'git-cvsserver' maps Git branches to CVS modules. This is very different
+`git-cvsserver` maps Git branches to CVS modules. This is very different
from what most CVS users would expect since in CVS modules usually represent
one or more directories.
@@ -132,7 +132,7 @@ Then provide your password via the pserver method, for example:
------
No special setup is needed for SSH access, other than having Git tools
in the PATH. If you have clients that do not accept the CVS_SERVER
-environment variable, you can rename 'git-cvsserver' to `cvs`.
+environment variable, you can rename `git-cvsserver` to `cvs`.
Note: Newer CVS versions (>= 1.12.11) also support specifying
CVS_SERVER directly in CVSROOT like
@@ -142,9 +142,9 @@ cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co <HEAD_name>
------
This has the advantage that it will be saved in your 'CVS/Root' files and
you don't need to worry about always setting the correct environment
-variable. SSH users restricted to 'git-shell' don't need to override the default
-with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean
-'git-cvsserver' and pretends that the other end runs the real 'cvs' better.
+variable. SSH users restricted to `git-shell` don't need to override the default
+with CVS_SERVER (and shouldn't) as `git-shell` understands `cvs` to mean
+`git-cvsserver` and pretends that the other end runs the real 'cvs' better.
--
2. For each repo that you want accessible from CVS you need to edit config in
the repo and add the following section.
@@ -157,7 +157,7 @@ with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean
logFile=/path/to/logfile
------
-Note: you need to ensure each user that is going to invoke 'git-cvsserver' has
+Note: you need to ensure each user that is going to invoke `git-cvsserver` has
write access to the log file and to the database (see
<<dbbackend,Database Backend>>. If you want to offer write access over
SSH, the users of course also need write access to the Git repository itself.
@@ -182,7 +182,7 @@ allowing access over SSH.
automatically saving it in your 'CVS/Root' files, then you need to set them
explicitly in your environment. CVSROOT should be set as per normal, but the
directory should point at the appropriate Git repo. As above, for SSH clients
- _not_ restricted to 'git-shell', CVS_SERVER should be set to 'git-cvsserver'.
+ _not_ restricted to `git-shell`, CVS_SERVER should be set to `git-cvsserver`.
+
--
------
@@ -210,32 +210,32 @@ allowing access over SSH.
DATABASE BACKEND
----------------
-'git-cvsserver' uses one database per Git head (i.e. CVS module) to
+`git-cvsserver` uses one database per Git head (i.e. CVS module) to
store information about the repository to maintain consistent
CVS revision numbers. The database needs to be
updated (i.e. written to) after every commit.
If the commit is done directly by using `git` (as opposed to
-using 'git-cvsserver') the update will need to happen on the
-next repository access by 'git-cvsserver', independent of
+using `git-cvsserver`) the update will need to happen on the
+next repository access by `git-cvsserver`, independent of
access method and requested operation.
That means that even if you offer only read access (e.g. by using
-the pserver method), 'git-cvsserver' should have write access to
+the pserver method), `git-cvsserver` should have write access to
the database to work reliably (otherwise you need to make sure
-that the database is up to date any time 'git-cvsserver' is executed).
+that the database is up to date any time `git-cvsserver` is executed).
By default it uses SQLite databases in the Git directory, named
`gitcvs.<module_name>.sqlite`. Note that the SQLite backend creates
temporary files in the same directory as the database file on
write so it might not be enough to grant the users using
-'git-cvsserver' write access to the database file without granting
+`git-cvsserver` write access to the database file without granting
them write access to the directory, too.
The database cannot be reliably regenerated in a
consistent form after the branch it is tracking has changed.
-Example: For merged branches, 'git-cvsserver' only tracks
-one branch of development, and after a 'git merge' an
+Example: For merged branches, `git-cvsserver` only tracks
+one branch of development, and after a `git merge` an
incrementally updated database may track a different branch
than a database regenerated from scratch, causing inconsistent
CVS revision numbers. `git-cvsserver` has no way of knowing which
@@ -250,7 +250,7 @@ configuration variables:
Configuring database backend
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-'git-cvsserver' uses the Perl DBI module. Please also read
+`git-cvsserver` uses the Perl DBI module. Please also read
its documentation if changing these variables, especially
about `DBI->connect()`.
@@ -302,7 +302,7 @@ In `dbDriver` and `dbUser` you can use the following variables:
%a::
access method (one of "ext" or "pserver")
%u::
- Name of the user running 'git-cvsserver'.
+ Name of the user running `git-cvsserver`.
If no name can be determined, the
numeric uid is used.
@@ -310,13 +310,13 @@ ENVIRONMENT
-----------
These variables obviate the need for command-line options in some
-circumstances, allowing easier restricted usage through git-shell.
+circumstances, allowing easier restricted usage through `git-shell`.
GIT_CVSSERVER_BASE_PATH takes the place of the argument to `--base-path`.
GIT_CVSSERVER_ROOT specifies a single-directory whitelist. The
repository must still be configured to allow access through
-git-cvsserver, as described above.
+`git-cvsserver`, as described above.
When these environment variables are set, the corresponding
command-line arguments may not be used.
@@ -343,8 +343,8 @@ you will definitely want to have SSH keys setup.
Alternatively, you can just use the non-standard extssh protocol that Eclipse
offer. In that case CVS_SERVER is ignored, and you will have to replace
-the cvs utility on the server with 'git-cvsserver' or manipulate your `.bashrc`
-so that calling 'cvs' effectively calls 'git-cvsserver'.
+the cvs utility on the server with `git-cvsserver` or manipulate your `.bashrc`
+so that calling 'cvs' effectively calls `git-cvsserver`.
CLIENTS KNOWN TO WORK
---------------------
@@ -361,12 +361,12 @@ All the operations required for normal use are supported, including
checkout, diff, status, update, log, add, remove, commit.
Most CVS command arguments that read CVS tags or revision numbers
-(typically `-r`) work, and also support any git refspec
+(typically `-r`) work, and also support any `git` refspec
(tag, branch, commit ID, etc).
However, CVS revision numbers for non-default branches are not well
emulated, and cvs log does not show tags or branches at
all. (Non-main-branch CVS revision numbers superficially resemble CVS
-revision numbers, but they actually encode a git commit ID directly,
+revision numbers, but they actually encode a `git` commit ID directly,
rather than represent the number of revisions since the branch point.)
Note that there are two ways to checkout a particular branch.
@@ -383,9 +383,9 @@ operations against that main branch are fast. Or alternatively,
-r doesn't take any extra disk space, but may be significantly slower for
many operations, like cvs update.
-If you want to refer to a git refspec that has characters that are
+If you want to refer to a `git` refspec that has characters that are
not allowed by CVS, you have two options. First, it may just work
-to supply the git refspec directly to the appropriate CVS `-r` argument;
+to supply the `git` refspec directly to the appropriate CVS `-r` argument;
some CVS clients don't seem to do much sanity checking of the argument.
Second, if that fails, you can use a special character escape mechanism
that only uses characters that are valid in CVS tags. A sequence
@@ -426,7 +426,7 @@ and `gitcvs.allBinary` to "guess".
DEPENDENCIES
------------
-'git-cvsserver' depends on DBD::SQLite.
+`git-cvsserver` depends on DBD::SQLite.
GIT
---
diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index 2794a2d0c1..e9cce4e468 100644
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -8,7 +8,7 @@ git-daemon - A really simple server for Git repositories
SYNOPSIS
--------
[verse]
-'git daemon' [--verbose] [--syslog] [--export-all]
+`git daemon` [--verbose] [--syslog] [--export-all]
[--timeout=<n>] [--init-timeout=<n>] [--max-connections=<n>]
[--strict-paths] [--base-path=<path>] [--base-path-relaxed]
[--user-path | --user-path=<path>]
@@ -29,39 +29,39 @@ A really simple TCP Git daemon that normally listens on port "DEFAULT_GIT_PORT"
aka 9418. It waits for a connection asking for a service, and will serve
that service if it is enabled.
-It verifies that the directory has the magic file "git-daemon-export-ok", and
+It verifies that the directory has the magic file `git-daemon-export-ok`, and
it will refuse to export any Git directory that hasn't explicitly been marked
for export this way (unless the `--export-all` parameter is specified). If you
-pass some directory paths as 'git daemon' arguments, you can further restrict
+pass some directory paths as `git daemon` arguments, you can further restrict
the offers to a whitelist comprising of those.
By default, only `upload-pack` service is enabled, which serves
-'git fetch-pack' and 'git ls-remote' clients, which are invoked
-from 'git fetch', 'git pull', and 'git clone'.
+`git fetch-pack` and `git ls-remote` clients, which are invoked
+from `git fetch`, `git pull`, and `git clone`.
This is ideally suited for read-only updates, i.e., pulling from
Git repositories.
-An `upload-archive` also exists to serve 'git archive'.
+An `upload-archive` also exists to serve `git archive`.
OPTIONS
-------
--strict-paths::
Match paths exactly (i.e. don't allow "/foo/repo" when the real path is
"/foo/repo.git" or "/foo/repo/.git") and don't do user-relative paths.
- 'git daemon' will refuse to start when this option is enabled and no
+ `git daemon` will refuse to start when this option is enabled and no
whitelist is specified.
--base-path=<path>::
Remap all the path requests as relative to the given path.
- This is sort of "Git root" - if you run 'git daemon' with
+ This is sort of "Git root" - if you run `git daemon` with
`--base-path=/srv/git` on example.com, then if you later try to pull
- 'git://example.com/hello.git', 'git daemon' will interpret the path
+ 'git://example.com/hello.git', `git daemon` will interpret the path
as `/srv/git/hello.git`.
--base-path-relaxed::
If `--base-path` is enabled and repo lookup fails, with this option
- 'git daemon' will attempt to lookup without prefixing the base path.
+ `git daemon` will attempt to lookup without prefixing the base path.
This is useful for switching to `--base-path` usage, while still
allowing the old paths.
@@ -78,7 +78,7 @@ OPTIONS
--export-all::
Allow pulling from all directories that look like Git repositories
(have the 'objects' and 'refs' subdirectories), even if they
- do not have the 'git-daemon-export-ok' file.
+ do not have the `git-daemon-export-ok` file.
--inetd::
Have the server run as an inetd service. Implies `--syslog` (may be
@@ -170,10 +170,10 @@ otherwise `stderr`.
+
Giving these options is an error when used with `--inetd`; use
the facility of inet daemon to achieve the same before spawning
-'git daemon' if needed.
+`git daemon` if needed.
+
Like many programs that switch user id, the daemon does not reset
-environment variables such as `$HOME` when it runs git programs,
+environment variables such as `$HOME` when it runs `git` programs,
e.g. `upload-pack` and `receive-pack`. When using this option, you
may also want to set and export `HOME` to point at the home
directory of `<user>` before starting the daemon, and make sure any
@@ -194,7 +194,7 @@ Git configuration files in that directory are readable by `<user>`.
may be overridden.
--[no-]informative-errors::
- When informative errors are turned on, git-daemon will report
+ When informative errors are turned on, `git-daemon` will report
more verbose errors to the client, differentiating conditions
like "no such repository" from "repository not exported". This
is more convenient for clients, but may leak information about
@@ -227,24 +227,24 @@ SERVICES
These services can be globally enabled/disabled using the
command-line options of this command. If finer-grained
-control is desired (e.g. to allow 'git archive' to be run
+control is desired (e.g. to allow `git archive` to be run
against only in a few selected repositories the daemon serves),
the per-repository configuration file can be used to enable or
disable them.
upload-pack::
- This serves 'git fetch-pack' and 'git ls-remote'
+ This serves `git fetch-pack` and `git ls-remote`
clients. It is enabled by default, but a repository can
disable it by setting `daemon.uploadpack` configuration
item to `false`.
upload-archive::
- This serves 'git archive --remote'. It is disabled by
+ This serves `git archive --remote`. It is disabled by
default, but a repository can enable it by setting
`daemon.uploadarch` configuration item to `true`.
receive-pack::
- This serves 'git send-pack' clients, allowing anonymous
+ This serves `git send-pack` clients, allowing anonymous
push. It is disabled by default, as there is _no_
authentication in the protocol (in other words, anybody
can push anything into the repository, including removal
@@ -262,8 +262,8 @@ $ grep 9418 /etc/services
git 9418/tcp # Git Version Control System
------------
-'git daemon' as inetd server::
- To set up 'git daemon' as an inetd service that handles any
+`git daemon` as inetd server::
+ To set up `git daemon` as an inetd service that handles any
repository under the whitelisted set of directories, /pub/foo
and /pub/bar, place an entry like the following into
/etc/inetd all on one line:
@@ -275,8 +275,8 @@ git 9418/tcp # Git Version Control System
------------------------------------------------
-'git daemon' as inetd server for virtual hosts::
- To set up 'git daemon' as an inetd service that handles
+`git daemon` as inetd server for virtual hosts::
+ To set up `git daemon` as an inetd service that handles
repositories for different virtual hosts, `www.example.com`
and `www.example.org`, place an entry like the following into
`/etc/inetd` all on one line:
@@ -298,8 +298,8 @@ clients, a symlink from `/software` into the appropriate
default repository could be made as well.
-'git daemon' as regular daemon for virtual hosts::
- To set up 'git daemon' as a regular, non-inetd service that
+`git daemon` as regular daemon for virtual hosts::
+ To set up `git daemon` as a regular, non-inetd service that
handles repositories for multiple virtual hosts based on
their IP addresses, start the daemon like this:
+
@@ -316,7 +316,7 @@ Repositories can still be accessed by hostname though, assuming
they correspond to these IP addresses.
selectively enable/disable services per repository::
- To enable 'git archive --remote' and disable 'git fetch' against
+ To enable `git archive --remote` and disable `git fetch` against
a repository, have the following in the configuration file in the
repository (that is the file 'config' next to `HEAD`, 'refs' and
'objects').
@@ -330,7 +330,7 @@ selectively enable/disable services per repository::
ENVIRONMENT
-----------
-'git daemon' will set REMOTE_ADDR to the IP address of the client
+`git daemon` will set REMOTE_ADDR to the IP address of the client
that connected to it, if the IP address is available. REMOTE_ADDR will
be available in the environment of hooks called when
services are performed.
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index 7d2649c477..6cfb444444 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -8,9 +8,9 @@ git-describe - Give an object a human readable name based on an available ref
SYNOPSIS
--------
[verse]
-'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] [<commit-ish>...]
-'git describe' [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]
-'git describe' <blob>
+`git describe` [--all] [--tags] [--contains] [--abbrev=<n>] [<commit-ish>...]
+`git describe` [--all] [--tags] [--contains] [--abbrev=<n>] --dirty[=<mark>]
+`git describe` <blob>
DESCRIPTION
-----------
@@ -20,7 +20,7 @@ shown. Otherwise, it suffixes the tag name with the number of
additional commits on top of the tagged object and the
abbreviated object name of the most recent commit. The result
is a "human-readable" object name which can also be used to
-identify the commit to other git commands.
+identify the commit to other `git` commands.
By default (without `--all` or `--tags`) `git describe` only shows
annotated tags. For more information about creating annotated tags
@@ -40,8 +40,8 @@ OPTIONS
--dirty[=<mark>]::
--broken[=<mark>]::
Describe the state of the working tree. When the working
- tree matches `HEAD`, the output is the same as "git describe
- HEAD". If the working tree has local modification "-dirty"
+ tree matches `HEAD`, the output is the same as `git describe
+ HEAD`. If the working tree has local modification "-dirty"
is appended to it. If a repository is corrupt and Git
cannot determine if there is local modification, Git will
error out, unless `--broken' is given, which appends
@@ -138,14 +138,14 @@ an abbreviated object name for the commit itself ("2414721")
at the end.
The number of additional commits is the number
-of commits which would be displayed by "git log v1.0.4..parent".
+of commits which would be displayed by `git log v1.0.4..parent`.
The hash suffix is "-g" + unambiguous abbreviation for the tip commit
of parent (which was `2414721b194453f058079d897d13c4e377f92dc6`).
-The "g" prefix stands for "git" and is used to allow describing the version of
+The "g" prefix stands for `git` and is used to allow describing the version of
a software depending on the SCM the software is managed with. This is useful
in an environment where people may use different SCMs.
-Doing a 'git describe' on a tag-name will just show the tag name:
+Doing a `git describe` on a tag-name will just show the tag name:
[torvalds@g5 git]$ git describe v1.0.4
v1.0.4
@@ -175,13 +175,13 @@ be sufficient to disambiguate these commits.
SEARCH STRATEGY
---------------
-For each commit-ish supplied, 'git describe' will first look for
+For each commit-ish supplied, `git describe` will first look for
a tag which tags exactly that commit. Annotated tags will always
be preferred over lightweight tags, and tags with newer dates will
always be preferred over tags with older dates. If an exact match
is found, its name will be output and searching will stop.
-If an exact match was not found, 'git describe' will walk back
+If an exact match was not found, `git describe` will walk back
through the commit history to locate an ancestor commit which
has been tagged. The ancestor's tag will be output along with an
abbreviation of the input commit-ish's SHA-1. If `--first-parent` was
diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt
index 906774f0f7..b0fb276b99 100644
--- a/Documentation/git-diff-files.txt
+++ b/Documentation/git-diff-files.txt
@@ -9,14 +9,14 @@ git-diff-files - Compares files in the working tree and the index
SYNOPSIS
--------
[verse]
-'git diff-files' [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>...]
+`git diff-files` [-q] [-0|-1|-2|-3|-c|--cc] [<common diff options>] [<path>...]
DESCRIPTION
-----------
Compares the files in the working tree and the index. When paths
are specified, compares only those named paths. Otherwise all
entries in the index are compared. The output format is the
-same as for 'git diff-index' and 'git diff-tree'.
+same as for `git diff-index` and `git diff-tree`.
OPTIONS
-------
diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt
index 10e79a29aa..87db234e77 100644
--- a/Documentation/git-diff-index.txt
+++ b/Documentation/git-diff-index.txt
@@ -9,7 +9,7 @@ git-diff-index - Compare a tree to the working tree or index
SYNOPSIS
--------
[verse]
-'git diff-index' [-m] [--cached] [--merge-base] [<common diff options>] <tree-ish> [<path>...]
+`git diff-index` [-m] [--cached] [--merge-base] [<common diff options>] <tree-ish> [<path>...]
DESCRIPTION
-----------
@@ -37,7 +37,7 @@ include::diff-options.txt[]
-m::
By default, files recorded in the index but not checked
out are reported as deleted. This flag makes
- 'git diff-index' say that all non-checked-out files are up
+ `git diff-index` say that all non-checked-out files are up
to date.
include::diff-format.txt[]
@@ -54,7 +54,7 @@ CACHED MODE
If `--cached` is specified, it allows you to ask:
show me the differences between `HEAD` and the current index
- contents (the ones I'd write using 'git write-tree')
+ contents (the ones I'd write using `git write-tree`)
For example, let's say that you have worked on your working directory, updated
some files in the index and are ready to commit. You want to see exactly
@@ -66,7 +66,7 @@ object and compare it that way, and to do that, you just do
Example: let's say I had renamed `commit.c` to `git-commit.c`, and I had
done an `update-index` to make that effective in the index file.
`git diff-files` wouldn't show anything at all, since the index file
-matches my working directory. But doing a 'git diff-index' does:
+matches my working directory. But doing a `git diff-index` does:
torvalds@ppc970:~/git> git diff-index --cached HEAD
-100644 blob 4161aecc6700a2eb579e842af0b7f22b98443f74 commit.c
@@ -75,7 +75,7 @@ matches my working directory. But doing a 'git diff-index' does:
You can see easily that the above is a rename.
In fact, `git diff-index --cached` *should* always be entirely equivalent to
-actually doing a 'git write-tree' and comparing that. Except this one is much
+actually doing a `git write-tree` and comparing that. Except this one is much
nicer for the case where you just want to check where you are.
So doing a `git diff-index --cached` is basically very useful when you are
@@ -86,20 +86,20 @@ NON-CACHED MODE
---------------
The "non-cached" mode takes a different approach, and is potentially
the more useful of the two in that what it does can't be emulated with
-a 'git write-tree' + 'git diff-tree'. Thus that's the default mode.
+a `git write-tree` + `git diff-tree`. Thus that's the default mode.
The non-cached version asks the question:
show me the differences between `HEAD` and the currently checked out
tree - index contents _and_ files that aren't up to date
which is obviously a very useful question too, since that tells you what
-you *could* commit. Again, the output matches the 'git diff-tree -r'
+you *could* commit. Again, the output matches the `git diff-tree -r`
output to a tee, but with a twist.
The twist is that if some file doesn't match the index, we don't have
a backing store thing for it, and we use the magic "all-zero" sha1 to
show that. So let's say that you have edited `kernel/sched.c`, but
-have not actually done a 'git update-index' on it yet - there is no
+have not actually done a `git update-index` on it yet - there is no
"object" associated with the new state, and you get:
torvalds@ppc970:~/v2.6/linux> git diff-index --abbrev HEAD
@@ -110,11 +110,11 @@ not up to date and may contain new stuff. The all-zero sha1 means that to
get the real diff, you need to look at the object in the working directory
directly rather than do an object-to-object diff.
-NOTE: As with other commands of this type, 'git diff-index' does not
+NOTE: As with other commands of this type, `git diff-index` does not
actually look at the contents of the file at all. So maybe
`kernel/sched.c` hasn't actually changed, and it's just that you
touched it. In either case, it's a note that you need to
-'git update-index' it to make the index be in sync.
+`git update-index` it to make the index be in sync.
NOTE: You can have a mixture of files show up as "has been updated"
and "is still dirty in the working directory" together. You can always
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index b9225cd824..56354886a4 100644
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -9,7 +9,7 @@ git-diff-tree - Compares the content and mode of blobs found via two tree object
SYNOPSIS
--------
[verse]
-'git diff-tree' [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty]
+`git diff-tree` [--stdin] [-m] [-s] [-v] [--no-commit-id] [--pretty]
[-t] [-r] [-c | --cc] [--combined-all-paths] [--root] [--merge-base]
[<common diff options>] <tree-ish> [<tree-ish>] [<path>...]
@@ -20,7 +20,7 @@ Compares the content and mode of the blobs found via two tree objects.
If there is only one <tree-ish> given, the commit is compared with its parents
(see `--stdin` below).
-Note that 'git diff-tree' can use the tree encapsulated in a commit object.
+Note that `git diff-tree` can use the tree encapsulated in a commit object.
OPTIONS
-------
@@ -69,25 +69,25 @@ The following flags further affect the behavior when comparing
commits (but not trees).
-m::
- By default, 'git diff-tree --stdin' does not show
+ By default, `git diff-tree --stdin` does not show
differences for merge commits. With this flag, it shows
differences to that commit from all of its parents. See
also `-c`.
-s::
- By default, 'git diff-tree --stdin' shows differences,
+ By default, `git diff-tree --stdin` shows differences,
either in machine-readable form (without `-p`) or in patch
form (with `-p`). This output can be suppressed. It is
only useful with `-v` flag.
-v::
- This flag causes 'git diff-tree --stdin' to also show
+ This flag causes `git diff-tree --stdin` to also show
the commit message before the differences.
include::pretty-options.txt[]
--no-commit-id::
- 'git diff-tree' outputs a line with the commit ID when
+ `git diff-tree` outputs a line with the commit ID when
applicable. This flag suppressed the commit ID output.
-c::
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 33a47958bc..7779631421 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -9,12 +9,12 @@ git-diff - Show changes between commits, commit and working tree, etc
SYNOPSIS
--------
[verse]
-'git diff' [<options>] [<commit>] [--] [<path>...]
-'git diff' [<options>] --cached [--merge-base] [<commit>] [--] [<path>...]
-'git diff' [<options>] [--merge-base] <commit> [<commit>...] <commit> [--] [<path>...]
-'git diff' [<options>] <commit>...<commit> [--] [<path>...]
-'git diff' [<options>] <blob> <blob>
-'git diff' [<options>] --no-index [--] <path> <path>
+`git diff` [<options>] [<commit>] [--] [<path>...]
+`git diff` [<options>] --cached [--merge-base] [<commit>] [--] [<path>...]
+`git diff` [<options>] [--merge-base] <commit> [<commit>...] <commit> [--] [<path>...]
+`git diff` [<options>] <commit>...<commit> [--] [<path>...]
+`git diff` [<options>] <blob> <blob>
+`git diff` [<options>] --no-index [--] <path> <path>
DESCRIPTION
-----------
@@ -23,7 +23,7 @@ between the index and a tree, changes between two trees, changes resulting
from a merge, changes between two blob objects, or changes between two
files on disk.
-'git diff' [<options>] [--] [<path>...]::
+`git diff` [<options>] [--] [<path>...]::
This form is to view the changes you made relative to
the index (staging area for the next commit). In other
@@ -31,7 +31,7 @@ files on disk.
further add to the index but you still haven't. You can
stage these changes by using linkgit:git-add[1].
-'git diff' [<options>] --no-index [--] <path> <path>::
+`git diff` [<options>] --no-index [--] <path> <path>::
This form is to compare the given two paths on the
filesystem. You can omit the `--no-index` option when
@@ -40,7 +40,7 @@ files on disk.
or when running the command outside a working tree
controlled by Git. This form implies `--exit-code`.
-'git diff' [<options>] --cached [--merge-base] [<commit>] [--] [<path>...]::
+`git diff` [<options>] --cached [--merge-base] [<commit>] [--] [<path>...]::
This form is to view the changes you staged for the next
commit relative to the named <commit>. Typically you
@@ -54,7 +54,7 @@ If `--merge-base` is given, instead of using <commit>, use the merge base
of <commit> and `HEAD`. `git diff --merge-base A` is equivalent to
`git diff $(git merge-base A HEAD)`.
-'git diff' [<options>] <commit> [--] [<path>...]::
+`git diff` [<options>] <commit> [--] [<path>...]::
This form is to view the changes you have in your
working tree relative to the named <commit>. You can
@@ -62,7 +62,7 @@ of <commit> and `HEAD`. `git diff --merge-base A` is equivalent to
branch name to compare with the tip of a different
branch.
-'git diff' [<options>] [--merge-base] <commit> <commit> [--] [<path>...]::
+`git diff` [<options>] [--merge-base] <commit> <commit> [--] [<path>...]::
This is to view the changes between two arbitrary
<commit>.
@@ -71,7 +71,7 @@ If `--merge-base` is given, use the merge base of the two commits for the
"before" side. `git diff --merge-base A B` is equivalent to
`git diff $(git merge-base A B) B`.
-'git diff' [<options>] <commit> <commit>... <commit> [--] [<path>...]::
+`git diff` [<options>] <commit> <commit>... <commit> [--] [<path>...]::
This form is to view the results of a merge commit. The first
listed <commit> must be the merge itself; the remaining two or
@@ -80,14 +80,14 @@ If `--merge-base` is given, use the merge base of the two commits for the
For instance, if `master` names a merge commit, `git diff master
master^@` gives the same combined diff as `git show master`.
-'git diff' [<options>] <commit>..<commit> [--] [<path>...]::
+`git diff` [<options>] <commit>..<commit> [--] [<path>...]::
This is synonymous to the earlier form (without the `..`) for
viewing the changes between two arbitrary <commit>. If <commit> on
one side is omitted, it will have the same effect as
using `HEAD` instead.
-'git diff' [<options>] <commit>\...<commit> [--] [<path>...]::
+`git diff` [<options>] <commit>\...<commit> [--] [<path>...]::
This form is to view the changes on the branch containing
and up to the second <commit>, starting at a common ancestor
@@ -107,7 +107,7 @@ and the range notations (`<commit>..<commit>` and
`<commit>...<commit>`) do not mean a range as defined in the
"SPECIFYING RANGES" section in linkgit:gitrevisions[7].
-'git diff' [<options>] <blob> <blob>::
+`git diff` [<options>] <blob> <blob>::
This form is to view the differences between the raw
contents of two blob objects.
diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
index 143b0c49d7..b646654941 100644
--- a/Documentation/git-difftool.txt
+++ b/Documentation/git-difftool.txt
@@ -8,13 +8,13 @@ git-difftool - Show changes using common diff tools
SYNOPSIS
--------
[verse]
-'git difftool' [<options>] [<commit> [<commit>]] [--] [<path>...]
+`git difftool` [<options>] [<commit> [<commit>]] [--] [<path>...]
DESCRIPTION
-----------
-'git difftool' is a Git command that allows you to compare and edit files
-between revisions using common diff tools. 'git difftool' is a frontend
-to 'git diff' and accepts the same options and arguments. See
+`git difftool` is a Git command that allows you to compare and edit files
+between revisions using common diff tools. `git difftool` is a frontend
+to `git diff` and accepts the same options and arguments. See
linkgit:git-diff[1].
OPTIONS
@@ -48,23 +48,23 @@ OPTIONS
emerge, kompare, meld, and vimdiff. Run `git difftool --tool-help`
for the list of valid <tool> settings.
+
-If a diff tool is not specified, 'git difftool'
+If a diff tool is not specified, `git difftool`
will use the configuration variable `diff.tool`. If the
-configuration variable `diff.tool` is not set, 'git difftool'
+configuration variable `diff.tool` is not set, `git difftool`
will pick a suitable default.
+
You can explicitly provide a full path to the tool by setting the
configuration variable `difftool.<tool>.path`. For example, you
can configure the absolute path to kdiff3 by setting
-`difftool.kdiff3.path`. Otherwise, 'git difftool' assumes the
+`difftool.kdiff3.path`. Otherwise, `git difftool` assumes the
tool is available in PATH.
+
Instead of running one of the known diff tools,
-'git difftool' can be customized to run an alternative program
+`git difftool` can be customized to run an alternative program
by specifying the command line to invoke in a configuration
variable `difftool.<tool>.cmd`.
+
-When 'git difftool' is invoked with this tool (either through the
+When `git difftool` is invoked with this tool (either through the
`-t` or `--tool` option or the `diff.tool` configuration variable)
the configured command line will be invoked with the following
variables available: `$LOCAL` is set to the name of the temporary
@@ -78,24 +78,24 @@ with custom merge tool commands and has the same value as `$MERGED`.
Print a list of diff tools that may be used with `--tool`.
--[no-]symlinks::
- 'git difftool''s default behavior is create symlinks to the
+ `git difftool`'s default behavior is create symlinks to the
working tree when run in `--dir-diff` mode and the right-hand
side of the comparison yields the same content as the file in
the working tree.
+
-Specifying `--no-symlinks` instructs 'git difftool' to create copies
+Specifying `--no-symlinks` instructs `git difftool` to create copies
instead. `--no-symlinks` is the default on Windows.
-x <command>::
--extcmd=<command>::
Specify a custom command for viewing diffs.
- 'git-difftool' ignores the configured defaults and runs
+ `git-difftool` ignores the configured defaults and runs
`$command $LOCAL $REMOTE` when this option is specified.
Additionally, `$BASE` is set in the environment.
-g::
--[no-]gui::
- When 'git-difftool' is invoked with the `-g` or `--gui` option
+ When `git-difftool` is invoked with the `-g` or `--gui` option
the default diff tool will be read from the configured
`diff.guitool` variable instead of `diff.tool`. The `--no-gui`
option can be used to override this setting. If `diff.guitool`
@@ -103,19 +103,19 @@ instead. `--no-symlinks` is the default on Windows.
`diff.tool`, `merge.tool` until a tool is found.
--[no-]trust-exit-code::
- 'git-difftool' invokes a diff tool individually on each file.
+ `git-difftool` invokes a diff tool individually on each file.
Errors reported by the diff tool are ignored by default.
- Use `--trust-exit-code` to make 'git-difftool' exit when an
+ Use `--trust-exit-code` to make `git-difftool` exit when an
invoked diff tool returns a non-zero exit code.
+
-'git-difftool' will forward the exit code of the invoked tool when
+`git-difftool` will forward the exit code of the invoked tool when
`--trust-exit-code` is used.
See linkgit:git-diff[1] for the full list of supported options.
CONFIG VARIABLES
----------------
-'git difftool' falls back to 'git mergetool' config variables when the
+`git difftool` falls back to `git mergetool` config variables when the
difftool equivalents have not been defined.
diff.tool::
diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt
index 3a6a77abac..24b10d4ad1 100644
--- a/Documentation/git-fast-export.txt
+++ b/Documentation/git-fast-export.txt
@@ -9,23 +9,23 @@ git-fast-export - Git data exporter
SYNOPSIS
--------
[verse]
-'git fast-export [<options>]' | 'git fast-import'
+`git fast-export [<options>]` | `git fast-import`
DESCRIPTION
-----------
This program dumps the given revisions in a form suitable to be piped
-into 'git fast-import'.
+into `git fast-import`.
You can use it as a human-readable bundle replacement (see
linkgit:git-bundle[1]), or as a format that can be edited before being
-fed to 'git fast-import' in order to do history rewrites (an ability
-relied on by tools like 'git filter-repo').
+fed to `git fast-import` in order to do history rewrites (an ability
+relied on by tools like `git filter-repo`).
OPTIONS
-------
--progress=<n>::
Insert 'progress' statements every <n> objects, to be shown by
- 'git fast-import' during import.
+ `git fast-import` during import.
--signed-tags=(verbatim|warn|warn-strip|strip|abort)::
Specify how to handle signed tags. Since any transformation
@@ -139,7 +139,7 @@ by keeping the marks the same across runs.
--show-original-ids::
Add an extra directive to the output for commits and blobs,
`original-oid <SHA1SUM>`. While such directives will likely be
- ignored by importers such as git-fast-import, it may be useful
+ ignored by importers such as `git-fast-import`, it may be useful
for intermediary filters (e.g. for rewriting commit messages
which refer to older commits, or for stripping blobs by id).
@@ -155,8 +155,8 @@ by keeping the marks the same across runs.
be specified.
[<git-rev-list-args>...]::
- A list of arguments, acceptable to 'git rev-parse' and
- 'git rev-list', that specifies the specific objects and references
+ A list of arguments, acceptable to `git rev-parse` and
+ `git rev-list`, that specifies the specific objects and references
to export. For example, `master~10..master` causes the
current `master` reference to be exported along with all objects
added since its 10th ancestor commit and (unless the
@@ -191,14 +191,14 @@ referenced by that revision range contains the string
ANONYMIZING
-----------
-If the `--anonymize` option is given, git will attempt to remove all
+If the `--anonymize` option is given, `git` will attempt to remove all
identifying information from the repository while still retaining enough
of the original tree and history patterns to reproduce some bugs. The
-goal is that a git bug which is found on a private repository will
+goal is that a `git` bug which is found on a private repository will
persist in the anonymized repository, and the latter can be shared with
-git developers to help solve the bug.
+`git` developers to help solve the bug.
-With this option, git will replace all refnames, paths, blob contents,
+With this option, `git` will replace all refnames, paths, blob contents,
commit and tag messages, names, and email addresses in the output with
anonymized data. Two instances of the same string will be replaced
equivalently (e.g., two commits with the same author will have the same
@@ -210,7 +210,7 @@ the tree is retained (e.g., if you have a root tree with 10 files and 3
trees, so will the output), but their names and the contents of the
files will be replaced.
-If you think you have found a git bug, you can start by exporting an
+If you think you have found a `git` bug, you can start by exporting an
anonymized stream of the whole repository:
---------------------------------------------------
@@ -271,7 +271,7 @@ final pathname would be `publicdir/bar.c`.
LIMITATIONS
-----------
-Since 'git fast-import' cannot tag trees, you will not be
+Since `git fast-import` cannot tag trees, you will not be
able to export the linux.git repository completely, as it contains
a tag referencing a tree instead of a commit.
diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt
index ff67238633..eeac242732 100644
--- a/Documentation/git-fast-import.txt
+++ b/Documentation/git-fast-import.txt
@@ -9,14 +9,14 @@ git-fast-import - Backend for fast Git data importers
SYNOPSIS
--------
[verse]
-frontend | 'git fast-import' [<options>]
+frontend | `git fast-import` [<options>]
DESCRIPTION
-----------
This program is usually not what the end user wants to run directly.
Most end users want to use one of the existing frontend programs,
which parses a specific type of foreign source and feeds the contents
-stored there to 'git fast-import'.
+stored there to `git fast-import`.
fast-import reads a mixed command/data stream from standard input and
writes one or more packfiles directly into the current repository.
@@ -25,7 +25,7 @@ updated branch and tag refs, fully updating the current repository
with the newly imported data.
The fast-import backend itself can import into an empty repository (one that
-has already been initialized by 'git init') or incrementally
+has already been initialized by `git init`) or incrementally
update an existing populated repository. Whether or not incremental
imports are supported from a particular foreign source depends on
the frontend program in use.
@@ -115,7 +115,7 @@ Locations of Marks Files
After specifying `--relative-marks` the paths specified
with `--import-marks`= and `--export-marks`= are relative
to an internal directory in the current repository.
- In git-fast-import this means that the paths are relative
+ In `git-fast-import` this means that the paths are relative
to the .git/info/fast-import directory. However, other
importers may use a different location.
+
@@ -166,7 +166,7 @@ Performance and Compression Tuning
This information may be useful after importing projects
whose total object set exceeds the 4 GiB packfile limit,
as these commits can be used as edge points during calls
- to 'git pack-objects'.
+ to `git pack-objects`.
--max-pack-size=<n>::
Maximum size of each output packfile.
@@ -203,9 +203,9 @@ an ideal situation, given that most conversion tools are throw-away
PARALLEL OPERATION
------------------
-Like 'git push' or 'git fetch', imports handled by fast-import are safe to
+Like `git push` or `git fetch`, imports handled by fast-import are safe to
run alongside parallel `git repack -a -d` or `git gc` invocations,
-or any other Git operation (including 'git prune', as loose objects
+or any other Git operation (including `git prune`, as loose objects
are never used by fast-import).
fast-import does not lock the branch or tag refs it is actively importing.
@@ -307,7 +307,7 @@ and some sanity checks on the numeric values may also be performed.
+
An example value is ``Tue Feb 6 11:22:18 2007 -0500''. The Git
parser is accurate, but a little on the lenient side. It is the
-same parser used by 'git am' when applying patches
+same parser used by `git am` when applying patches
received from email.
+
Some malformed strings may be accepted as valid dates. In some of
@@ -343,7 +343,7 @@ time zone.
This particular format is supplied as it's short to implement and
may be useful to a process that wants to create a new commit
right now, without needing to use a working directory or
-'git update-index'.
+`git update-index`.
+
If separate `author` and `committer` commands are used in a `commit`
the timestamps may not match, as the system clock will be polled
@@ -509,7 +509,7 @@ their syntax.
^^^^^^^^^^
The optional `encoding` command indicates the encoding of the commit
message. Most commits are UTF-8 and the encoding is omitted, but this
-allows importing commit messages into git without first reencoding them.
+allows importing commit messages into `git` without first reencoding them.
`from`
^^^^^^
@@ -859,7 +859,7 @@ recommended, as the frontend does not (easily) have access to the
complete set of bytes which normally goes into such a signature.
If signing is required, create lightweight tags from within fast-import with
`reset`, then create the annotated versions of those tags offline
-with the standard 'git tag' process.
+with the standard `git tag` process.
`reset`
~~~~~~~
@@ -1120,7 +1120,7 @@ The <dataref> represents the blob, tree, or commit object at <path>
and can be used in later 'get-mark', 'cat-blob', 'filemodify', or
'ls' commands.
-If there is no file or subtree at that path, 'git fast-import' will
+If there is no file or subtree at that path, `git fast-import` will
instead report
====
@@ -1183,14 +1183,14 @@ done::
abruptly at a convenient point in the stream can go
undetected. This may occur, for example, if an import
front end dies in mid-operation without emitting SIGTERM
- or SIGKILL at its subordinate git fast-import instance.
+ or SIGKILL at its subordinate `git fast-import` instance.
`option`
~~~~~~~~
-Processes the specified option so that git fast-import behaves in a
+Processes the specified option so that `git fast-import` behaves in a
way that suits the frontend's needs.
Note that options specified by the frontend are overridden by any
-options the user may specify to git fast-import itself.
+options the user may specify to `git fast-import` itself.
....
'option' SP <option> LF
@@ -1396,7 +1396,7 @@ is not `refs/heads/TAG_FIXUP`).
When committing fixups, consider using `merge` to connect the
commit(s) which are supplying file revisions to the fixup branch.
-Doing so will allow tools such as 'git blame' to track
+Doing so will allow tools such as `git blame` to track
through the real commit history and properly annotate the source
files.
@@ -1425,7 +1425,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.
@@ -1558,7 +1558,7 @@ memory footprint (less than 2.7 MiB per active branch).
SIGNALS
-------
-Sending *SIGUSR1* to the 'git fast-import' process ends the current
+Sending *SIGUSR1* to the `git fast-import` process ends the current
packfile early, simulating a `checkpoint` command. The impatient
operator can use this facility to peek at the objects and refs from an
import in progress, at the cost of some added running time and worse
diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt
index 1f48f89e3e..eaca893ac8 100644
--- a/Documentation/git-fetch-pack.txt
+++ b/Documentation/git-fetch-pack.txt
@@ -9,21 +9,21 @@ git-fetch-pack - Receive missing objects from another repository
SYNOPSIS
--------
[verse]
-'git fetch-pack' [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag]
+`git fetch-pack` [--all] [--quiet|-q] [--keep|-k] [--thin] [--include-tag]
[--upload-pack=<git-upload-pack>]
[--depth=<n>] [--no-progress]
[-v] <repository> [<refs>...]
DESCRIPTION
-----------
-Usually you would want to use 'git fetch', which is a
+Usually you would want to use `git fetch`, which is a
higher level wrapper of this command, instead.
-Invokes 'git-upload-pack' on a possibly remote repository
+Invokes `git-upload-pack` on a possibly remote repository
and asks it to send objects missing from this repository, to
update the named heads. The list of commits available locally
is found out by scanning the local refs/ hierarchy and sent to
-'git-upload-pack' running on the other end.
+`git-upload-pack` running on the other end.
This command degenerates to download everything to complete the
asked refs from the remote side when the local side does not
@@ -47,12 +47,12 @@ be in a separate packet, and the list must end with a flush packet.
-q::
--quiet::
- Pass `-q` flag to 'git unpack-objects'; this makes the
+ Pass `-q` flag to `git unpack-objects`; this makes the
cloning process less verbose.
-k::
--keep::
- Do not invoke 'git unpack-objects' on received data, but
+ Do not invoke `git unpack-objects` on received data, but
create a single packfile out of it instead, and store it
in the object database. If provided twice then the pack is
locked against repacking.
@@ -68,11 +68,11 @@ be in a separate packet, and the list must end with a flush packet.
otherwise determine the tags this option made available.
--upload-pack=<git-upload-pack>::
- Use this to specify the path to 'git-upload-pack' on the
+ Use this to specify the path to `git-upload-pack` on the
remote side, if is not found on your $PATH.
Installations of sshd ignores the user's environment
setup scripts for login shells (e.g. .bash_profile) and
- your privately installed git may not be found on the system
+ your privately installed `git` may not be found on the system
default $PATH. Another workaround suggested is to set
up your $PATH in ".bashrc", but this flag is for people
who do not want to pay the overhead for non-interactive
@@ -84,7 +84,7 @@ be in a separate packet, and the list must end with a flush packet.
--depth=<n>::
Limit fetching to ancestor-chains not longer than n.
- 'git-upload-pack' treats the special depth 2147483647 as
+ `git-upload-pack` treats the special depth 2147483647 as
infinite even if there is an ancestor-chain that long.
--shallow-since=<date>::
diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt
index 6c3f41399f..b0b5d06aad 100644
--- a/Documentation/git-fetch.txt
+++ b/Documentation/git-fetch.txt
@@ -9,10 +9,10 @@ git-fetch - Download objects and refs from another repository
SYNOPSIS
--------
[verse]
-'git fetch' [<options>] [<repository> [<refspec>...]]
-'git fetch' [<options>] <group>
-'git fetch' --multiple [<options>] [(<repository> | <group>)...]
-'git fetch' --all [<options>]
+`git fetch` [<options>] [<repository> [<refspec>...]]
+`git fetch` [<options>] <group>
+`git fetch` --multiple [<options>] [(<repository> | <group>)...]
+`git fetch` --all [<options>]
DESCRIPTION
@@ -30,7 +30,7 @@ configuring `remote.<name>.tagOpt`. By using a refspec that fetches tags
explicitly, you can fetch tags that do not point into branches you
are interested in as well.
-'git fetch' can fetch from either a single named repository or URL,
+`git fetch` can fetch from either a single named repository or URL,
or from several repositories at once if <group> is given and
there is a `remotes.<group>` entry in the configuration file.
(See linkgit:git-config[1]).
@@ -40,7 +40,7 @@ unless there's an upstream branch configured for the current branch.
The names of refs that are fetched, together with the object names
they point at, are written to `.git/FETCH_HEAD`. This information
-may be used by scripts or other git commands, such as linkgit:git-pull[1].
+may be used by scripts or other `git` commands, such as linkgit:git-pull[1].
OPTIONS
-------
@@ -193,7 +193,7 @@ $ git fetch <url of origin> --prune 'refs/tags/*:refs/tags/*'
OUTPUT
------
-The output of "git fetch" depends on the transport method used; this
+The output of `git fetch` depends on the transport method used; this
section describes the output when fetching over the Git protocol
(either locally or via ssh) and Smart HTTP protocol.
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 520d3df371..b21205d265 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -8,7 +8,7 @@ git-filter-branch - Rewrite branches
SYNOPSIS
--------
[verse]
-'git filter-branch' [--setup <command>] [--subdirectory-filter <directory>]
+`git filter-branch` [--setup <command>] [--subdirectory-filter <directory>]
[--env-filter <command>] [--tree-filter <command>]
[--index-filter <command>] [--parent-filter <command>]
[--msg-filter <command>] [--commit-filter <command>]
@@ -18,13 +18,13 @@ SYNOPSIS
WARNING
-------
-'git filter-branch' has a plethora of pitfalls that can produce non-obvious
+`git filter-branch` has a plethora of pitfalls that can produce non-obvious
manglings of the intended history rewrite (and can leave you with little
time to investigate such problems since it has such abysmal performance).
These safety and performance issues cannot be backward compatibly fixed and
as such, its use is not recommended. Please use an alternative history
filtering tool such as https://github.com/newren/git-filter-repo/[git
-filter-repo]. If you still need to use 'git filter-branch', please
+filter-repo]. If you still need to use `git filter-branch`, please
carefully read <<SAFETY>> (and <<PERFORMANCE>>) to learn about the land
mines of filter-branch, and then vigilantly avoid as many of the hazards
listed there as reasonably possible.
@@ -145,7 +145,7 @@ OPTIONS
--commit-filter <command>::
This is the filter for performing the commit.
If this filter is specified, it will be called instead of the
- 'git commit-tree' command, with arguments of the form
+ `git commit-tree` command, with arguments of the form
"<TREE_ID> [(-p <PARENT_COMMIT_ID>)...]" and the log message on
stdin. The commit id is expected on stdout.
+
@@ -156,7 +156,7 @@ have all of them as parents.
You can use the 'map' convenience function in this filter, and other
convenience functions, too. For example, calling 'skip_commit "$@"'
will leave out the current commit (but not its changes! If you want
-that, use 'git rebase' instead).
+that, use `git rebase` instead).
+
You can also use the `git_commit_non_empty_tree "$@"` instead of
`git commit-tree "$@"` if you don't wish to keep commits with a single parent
@@ -187,7 +187,7 @@ to other tags will be rewritten to point to the underlying commit.
--prune-empty::
Some filters will generate empty commits that leave the tree untouched.
- This option instructs git-filter-branch to remove such commits if they
+ This option instructs `git-filter-branch` to remove such commits if they
have exactly one or zero non-pruned parents; merge commits will
therefore remain intact. This option cannot be used together with
`--commit-filter`, though the same effect can be achieved by using the
@@ -207,7 +207,7 @@ to other tags will be rewritten to point to the underlying commit.
-f::
--force::
- 'git filter-branch' refuses to start with an existing temporary
+ `git filter-branch` refuses to start with an existing temporary
directory or when there are already refs starting with
'refs/original/', unless forced.
@@ -218,10 +218,10 @@ to other tags will be rewritten to point to the underlying commit.
trees. If '<branch>' does not exist it will be created.
<rev-list options>...::
- Arguments for 'git rev-list'. All positive refs included by
+ Arguments for `git rev-list`. All positive refs included by
these options are rewritten. You may also specify options
such as `--all`, but you must use `--` to separate them from
- the 'git filter-branch' options. Implies <<Remap_to_ancestor>>.
+ the `git filter-branch` options. Implies <<Remap_to_ancestor>>.
[[Remap_to_ancestor]]
@@ -257,7 +257,7 @@ However, if the file is absent from the tree of some commit,
a simple `rm filename` will fail for that tree and commit.
Thus you may instead want to use `rm -f filename` as the script.
-Using `--index-filter` with 'git rm' yields a significantly faster
+Using `--index-filter` with `git rm` yields a significantly faster
version. Like with using `rm filename`, `git rm --cached filename`
will fail if the file is absent from the tree of a commit. If you
want to "completely forget" a file, it does not matter when it entered
@@ -341,10 +341,10 @@ as their parents instead of the merge commit.
*NOTE* the changes introduced by the commits, and which are not reverted
by subsequent commits, will still be in the rewritten branch. If you want
to throw out _changes_ together with the commits, you should use the
-interactive mode of 'git rebase'.
+interactive mode of `git rebase`.
You can rewrite the commit log messages using `--msg-filter`. For
-example, 'git svn-id' strings in a repository created by 'git svn' can
+example, `git svn-id` strings in a repository created by `git svn` can
be removed this way:
-------------------------------------------------------
@@ -383,7 +383,7 @@ git filter-branch --env-filter '
To restrict rewriting to only part of the history, specify a revision
range in addition to the new branch name. The new branch name will
-point to the top-most revision that a 'git rev-list' of this range
+point to the top-most revision that a `git rev-list` of this range
will print.
Consider this history:
@@ -422,7 +422,7 @@ git filter-branch --index-filter \
CHECKLIST FOR SHRINKING A REPOSITORY
------------------------------------
-git-filter-branch can be used to get rid of a subset of files,
+`git-filter-branch` can be used to get rid of a subset of files,
usually with some combination of `--index-filter` and
`--subdirectory-filter`. People expect the resulting repository to
be smaller than the original, but you need a few more steps to
@@ -434,7 +434,7 @@ objects until you tell it to. First make sure that:
can help you find renames.
* You really filtered all refs: use `--tag-name-filter cat -- --all`
- when calling git-filter-branch.
+ when calling `git-filter-branch`.
Then there are two ways to get a smaller repository. A safer way is
to clone, that keeps your original intact.
@@ -448,30 +448,30 @@ following points instead (in this order). This is a very destructive
approach, so *make a backup* or go back to cloning it. You have been
warned.
-* Remove the original refs backed up by git-filter-branch: say `git
+* Remove the original refs backed up by `git-filter-branch`: say `git
for-each-ref --format="%(refname)" refs/original/ | xargs -n 1 git
update-ref -d`.
* Expire all reflogs with `git reflog expire --expire=now --all`.
* Garbage collect all unreferenced objects with `git gc --prune=now`
- (or if your git-gc is not new enough to support arguments to
+ (or if your `git-gc` is not new enough to support arguments to
`--prune`, use `git repack -ad; git prune` instead).
[[PERFORMANCE]]
PERFORMANCE
-----------
-The performance of git-filter-branch is glacially slow; its design makes it
+The performance of `git-filter-branch` is glacially slow; its design makes it
impossible for a backward-compatible implementation to ever be fast:
-* In editing files, git-filter-branch by design checks out each and
+* In editing files, `git-filter-branch` by design checks out each and
every commit as it existed in the original repo. If your repo has
`10^5` files and `10^5` commits, but each commit only modifies five
- files, then git-filter-branch will make you do `10^10` modifications,
+ files, then `git-filter-branch` will make you do `10^10` modifications,
despite only having (at most) `5*10^5` unique blobs.
-* If you try and cheat and try to make git-filter-branch only work on
+* If you try and cheat and try to make `git-filter-branch` only work on
files modified in a commit, then two things happen
** you run into problems with deletions whenever the user is simply
@@ -490,16 +490,16 @@ impossible for a backward-compatible implementation to ever be fast:
remove some and thus can avoid checking out each file (i.e. you can
use --index-filter), you still are passing shell snippets for your
filters. This means that for every commit, you have to have a
- prepared git repo where those filters can be run. That's a
+ prepared `git` repo where those filters can be run. That's a
significant setup.
* Further, several additional files are created or updated per commit
- by git-filter-branch. Some of these are for supporting the
- convenience functions provided by git-filter-branch (such as map()),
+ by `git-filter-branch`. Some of these are for supporting the
+ convenience functions provided by `git-filter-branch` (such as map()),
while others are for keeping track of internal state (but could have
also been accessed by user filters; one of git-filter-branch's
regression tests does so). This essentially amounts to using the
- filesystem as an IPC mechanism between git-filter-branch and the
+ filesystem as an IPC mechanism between `git-filter-branch` and the
user-provided filters. Disks tend to be a slow IPC mechanism, and
writing these files also effectively represents a forced
synchronization point between separate processes that we hit with
@@ -511,46 +511,46 @@ impossible for a backward-compatible implementation to ever be fast:
of time between operating systems, but on any platform it is very
slow relative to invoking a function.
-* git-filter-branch itself is written in shell, which is kind of slow.
+* `git-filter-branch` itself is written in shell, which is kind of slow.
This is the one performance issue that could be backward-compatibly
fixed, but compared to the above problems that are intrinsic to the
- design of git-filter-branch, the language of the tool itself is a
+ design of `git-filter-branch`, the language of the tool itself is a
relatively minor issue.
** Side note: Unfortunately, people tend to fixate on the
- written-in-shell aspect and periodically ask if git-filter-branch
+ written-in-shell aspect and periodically ask if `git-filter-branch`
could be rewritten in another language to fix the performance
issues. Not only does that ignore the bigger intrinsic problems
with the design, it'd help less than you'd expect: if
- git-filter-branch itself were not shell, then the convenience
+ `git-filter-branch` itself were not shell, then the convenience
functions (map(), skip_commit(), etc) and the `--setup` argument
could no longer be executed once at the beginning of the program
but would instead need to be prepended to every user filter (and
thus re-executed with every commit).
The https://github.com/newren/git-filter-repo/[git filter-repo] tool is
-an alternative to git-filter-branch which does not suffer from these
+an alternative to `git-filter-branch` which does not suffer from these
performance problems or the safety problems (mentioned below). For those
-with existing tooling which relies upon git-filter-branch, 'git
-filter-repo' also provides
+with existing tooling which relies upon `git-filter-branch`, `git
+filter-repo` also provides
https://github.com/newren/git-filter-repo/blob/master/contrib/filter-repo-demos/filter-lamely[filter-lamely],
-a drop-in git-filter-branch replacement (with a few caveats). While
+a drop-in `git-filter-branch` replacement (with a few caveats). While
filter-lamely suffers from all the same safety issues as
-git-filter-branch, it at least ameliorates the performance issues a
+`git-filter-branch`, it at least ameliorates the performance issues a
little.
[[SAFETY]]
SAFETY
------
-git-filter-branch is riddled with gotchas resulting in various ways to
+`git-filter-branch` is riddled with gotchas resulting in various ways to
easily corrupt repos or end up with a mess worse than what you started
with:
* Someone can have a set of "working and tested filters" which they
document or provide to a coworker, who then runs them on a different
OS where the same commands are not working/tested (some examples in
- the git-filter-branch manpage are also affected by this).
+ the `git-filter-branch` manpage are also affected by this).
BSD vs. GNU userland differences can really bite. If lucky, error
messages are spewed. But just as likely, the commands either don't
do the filtering requested, or silently corrupt by making some
@@ -563,7 +563,7 @@ with:
* Filenames with spaces are often mishandled by shell snippets since
they cause problems for shell pipelines. Not everyone is familiar
- with find -print0, xargs -0, git-ls-files -z, etc. Even people who
+ with `find -print0`, `xargs -0`, `git-ls-files -z`, etc. Even people who
are familiar with these may assume such flags are not relevant
because someone else renamed any such files in their repo back
before the person doing the filtering joined the project. And
@@ -590,7 +590,7 @@ with:
problem.)
* It's far too easy to accidentally mix up old and new history. It's
- still possible with any tool, but git-filter-branch almost
+ still possible with any tool, but `git-filter-branch` almost
invites it. If lucky, the only downside is users getting frustrated
that they don't know how to shrink their repo and remove the old
stuff. If unlucky, they merge old and new history and end up with
@@ -612,7 +612,7 @@ with:
need to understand that they need to rebase their changes for all
their branches on top of new history (or delete and reclone), but
that's only one of multiple concerns to consider. See the
- "DISCUSSION" section of the git filter-repo manual page for more
+ "DISCUSSION" section of the `git filter-repo` manual page for more
details.
* Annotated tags can be accidentally converted to lightweight tags,
@@ -620,16 +620,16 @@ with:
** Someone can do a history rewrite, realize they messed up, restore
from the backups in refs/original/, and then redo their
- git-filter-branch command. (The backup in refs/original/ is not a
+ `git-filter-branch` command. (The backup in refs/original/ is not a
real backup; it dereferences tags first.)
- ** Running git-filter-branch with either `--tags` or `--all` in your
+ ** Running `git-filter-branch` with either `--tags` or `--all` in your
<rev-list options>. In order to retain annotated tags as
annotated, you must use `--tag-name-filter` (and must not have
restored from refs/original/ in a previously botched rewrite).
* Any commit messages that specify an encoding will become corrupted
- by the rewrite; git-filter-branch ignores the encoding, takes the
+ by the rewrite; `git-filter-branch` ignores the encoding, takes the
original bytes, and feeds it to commit-tree without telling it the
proper encoding. (This happens whether or not `--msg-filter` is
used.)
@@ -665,12 +665,12 @@ with:
update authors and committers, missing taggers.
* If the user provides a `--tag-name-filter` that maps multiple tags to
- the same name, no warning or error is provided; git-filter-branch
+ the same name, no warning or error is provided; `git-filter-branch`
simply overwrites each tag in some undocumented pre-defined order
- resulting in only one tag at the end. (A git-filter-branch
+ resulting in only one tag at the end. (A `git-filter-branch`
regression test requires this surprising behavior.)
-Also, the poor performance of git-filter-branch often leads to safety
+Also, the poor performance of `git-filter-branch` often leads to safety
issues:
* Coming up with the correct shell snippet to do the filtering you
@@ -681,7 +681,7 @@ issues:
circumstances (spaces in filenames, non-ascii filenames, funny
author names or emails, invalid timezones, presence of grafts or
replace objects, etc.), meaning they may have to wait a long time,
- hit an error, then restart. The performance of git-filter-branch is
+ hit an error, then restart. The performance of `git-filter-branch` is
so bad that this cycle is painful, reducing the time available to
carefully re-check (to say nothing about what it does to the
patience of the person doing the rewrite even if they do technically
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index 86fb26dcea..a8e9ab914d 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -9,17 +9,17 @@ git-fmt-merge-msg - Produce a merge commit message
SYNOPSIS
--------
[verse]
-'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log]
-'git fmt-merge-msg' [-m <message>] [--log[=<n>] | --no-log] -F <file>
+`git fmt-merge-msg` [-m <message>] [--log[=<n>] | --no-log]
+`git fmt-merge-msg` [-m <message>] [--log[=<n>] | --no-log] -F <file>
DESCRIPTION
-----------
Takes the list of merged objects on stdin and produces a suitable
commit message to be used for the merge commit, usually to be
-passed as the '<merge-message>' argument of 'git merge'.
+passed as the '<merge-message>' argument of `git merge`.
This command is intended mostly for internal use by scripts
-automatically invoking 'git merge'.
+automatically invoking `git merge`.
OPTIONS
-------
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 64ff4a14f8..33fb379df4 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -8,7 +8,7 @@ git-for-each-ref - Output information on each ref
SYNOPSIS
--------
[verse]
-'git for-each-ref' [--count=<count>] [--shell|--perl|--python|--tcl]
+`git for-each-ref` [--count=<count>] [--shell|--perl|--python|--tcl]
[(--sort=<key>)...] [--format=<format>] [<pattern>...]
[--points-at=<object>]
[--merged[=<object>]] [--no-merged[=<object>]]
@@ -125,7 +125,7 @@ objecttype::
The type of the object (`blob`, `tree`, `commit`, `tag`).
objectsize::
- The size of the object (the same as 'git cat-file -s' reports).
+ The size of the object (the same as `git cat-file -s` reports).
Append `:disk` to get the size, in bytes, that the object takes up on
disk. See the note about on-disk sizes in the `CAVEATS` section below.
objectname::
diff --git a/Documentation/git-for-each-repo.txt b/Documentation/git-for-each-repo.txt
index 94bd19da26..c2d6cd6629 100644
--- a/Documentation/git-for-each-repo.txt
+++ b/Documentation/git-for-each-repo.txt
@@ -9,7 +9,7 @@ git-for-each-repo - Run a Git command on a list of repositories
SYNOPSIS
--------
[verse]
-'git for-each-repo' --config=<config> [--] <arguments>
+`git for-each-repo` --config=<config> [--] <arguments>
DESCRIPTION
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index fd7c6c705b..2009a048a9 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -9,7 +9,7 @@ git-format-patch - Prepare patches for e-mail submission
SYNOPSIS
--------
[verse]
-'git format-patch' [-k] [(-o|--output-directory) <dir> | --stdout]
+`git format-patch` [-k] [(-o|--output-directory) <dir> | --stdout]
[--no-thread | --thread[=<style>]]
[(--attach|--inline)[=<boundary>] | --no-attach]
[-s | --signoff]
@@ -39,7 +39,7 @@ DESCRIPTION
Prepare each commit with its "patch" in
one "message" per commit, formatted to resemble a UNIX mailbox.
The output of this command is convenient for e-mail submission or
-for use with 'git am'.
+for use with `git am`.
A "message" generated by the command consists of three parts:
@@ -176,7 +176,7 @@ The default is `--no-thread`, unless the `format.thread` configuration
is set. If `--thread` is specified without a style, it defaults to the
style specified by `format.thread` if any, or else `shallow`.
+
-Beware that the default for 'git send-email' is to thread emails
+Beware that the default for `git send-email` is to thread emails
itself. If you want `git format-patch` to take care of threading, you
will want to ensure that threading is disabled for `git send-email`.
@@ -415,7 +415,7 @@ with configuration variables.
DISCUSSION
----------
-The patch produced by 'git format-patch' is in UNIX mailbox format,
+The patch produced by `git format-patch` is in UNIX mailbox format,
with a fixed "magic" time stamp to indicate that the file is output
from format-patch rather than a real mailbox, like so:
@@ -444,8 +444,8 @@ can save interesting patches in a UNIX mailbox and apply them with
linkgit:git-am[1].
When a patch is part of an ongoing discussion, the patch generated by
-'git format-patch' can be tweaked to take advantage of the 'git am
---scissors' feature. After your response to the discussion comes a
+`git format-patch` can be tweaked to take advantage of the `git am
+--scissors` feature. After your response to the discussion comes a
line that consists solely of "`-- >8 --`" (scissors and perforation),
followed by the patch with unnecessary header fields removed:
@@ -524,11 +524,11 @@ GMail
~~~~~
GMail does not have any way to turn off line wrapping in the web
interface, so it will mangle any emails that you send. You can however
-use "git send-email" and send your patches through the GMail SMTP server, or
+use `git send-email` and send your patches through the GMail SMTP server, or
use any IMAP email client to connect to the google IMAP server and forward
the emails through that.
-For hints on using 'git send-email' to send your patches through the
+For hints on using `git send-email` to send your patches through the
GMail SMTP server, see the EXAMPLE section of linkgit:git-send-email[1].
For hints on submission using the IMAP interface, see the EXAMPLE
@@ -551,7 +551,7 @@ Install the Toggle Word Wrap add-on that is available from
https://addons.mozilla.org/thunderbird/addon/toggle-word-wrap/
It adds a menu entry "Enable Word Wrap" in the composer's "Options" menu
that you can tick off. Now you can compose the message as you otherwise do
-(cut + paste, 'git format-patch' | 'git imap-send', etc), but you have to
+(cut + paste, `git format-patch` | `git imap-send`, etc), but you have to
insert line breaks manually in any text that you type.
Approach #2 (configuration)
@@ -579,7 +579,7 @@ Toggle it to make sure it is set to `false`. Also, search for
Toggle it to make sure it is set to `false`.
After that is done, you should be able to compose email as you
-otherwise would (cut + paste, 'git format-patch' | 'git imap-send', etc),
+otherwise would (cut + paste, `git format-patch` | `git imap-send`, etc),
and the patches will not be mangled.
Approach #3 (external editor)
@@ -699,7 +699,7 @@ EXAMPLES
--------
* Extract commits between revisions R1 and R2, and apply them on top of
- the current branch using 'git am' to cherry-pick them:
+ the current branch using `git am` to `cherry-pick` them:
+
------------
$ git format-patch -k --stdout R1..R2 | git am -3 -k
diff --git a/Documentation/git-fsck-objects.txt b/Documentation/git-fsck-objects.txt
index eec4bdb600..589bb63fdc 100644
--- a/Documentation/git-fsck-objects.txt
+++ b/Documentation/git-fsck-objects.txt
@@ -9,7 +9,7 @@ git-fsck-objects - Verifies the connectivity and validity of the objects in the
SYNOPSIS
--------
[verse]
-'git fsck-objects' ...
+`git fsck-objects` ...
DESCRIPTION
-----------
diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt
index d9a28e278d..048a28ee50 100644
--- a/Documentation/git-fsck.txt
+++ b/Documentation/git-fsck.txt
@@ -9,7 +9,7 @@ git-fsck - Verifies the connectivity and validity of the objects in the database
SYNOPSIS
--------
[verse]
-'git fsck' [--tags] [--root] [--unreachable] [--cache] [--no-reflogs]
+`git fsck` [--tags] [--root] [--unreachable] [--cache] [--no-reflogs]
[--[no-]full] [--strict] [--verbose] [--lost-found]
[--[no-]dangling] [--[no-]progress] [--connectivity-only]
[--[no-]name-objects] [<object>*]
@@ -23,7 +23,7 @@ OPTIONS
<object>::
An object to treat as the head of an unreachability trace.
+
-If no objects are given, 'git fsck' defaults to using the
+If no objects are given, `git fsck` defaults to using the
index file, all SHA-1 references in `refs` namespace, and all reflogs
(unless `--no-reflogs` is given) as heads.
@@ -112,7 +112,7 @@ include::config/fsck.txt[]
DISCUSSION
----------
-git-fsck tests SHA-1 and general object sanity, and it does full tracking
+`git-fsck` tests SHA-1 and general object sanity, and it does full tracking
of the resulting reachability and everything else. It prints out any
corruption it finds (missing or bad objects), and if you use the
`--unreachable` flag it will also print out objects that exist but that
@@ -124,7 +124,7 @@ Any corrupt objects you will have to find in backups or other archives
the hopes that somebody else has the object you have corrupted).
If `core.commitGraph` is true, the commit-graph file will also be inspected
-using 'git commit-graph verify'. See linkgit:git-commit-graph[1].
+using `git commit-graph verify`. See linkgit:git-commit-graph[1].
Extracted Diagnostics
---------------------
diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
index 9d27c3a41e..c5c71febf5 100644
--- a/Documentation/git-gc.txt
+++ b/Documentation/git-gc.txt
@@ -9,14 +9,14 @@ git-gc - Cleanup unnecessary files and optimize the local repository
SYNOPSIS
--------
[verse]
-'git gc' [--aggressive] [--auto] [--quiet] [--prune=<date> | --no-prune] [--force] [--keep-largest-pack]
+`git gc` [--aggressive] [--auto] [--quiet] [--prune=<date> | --no-prune] [--force] [--keep-largest-pack]
DESCRIPTION
-----------
Runs a number of housekeeping tasks within the current repository,
such as compressing file revisions (to reduce disk space and increase
performance), removing unreachable objects which may have been
-created from prior invocations of 'git add', packing refs, pruning
+created from prior invocations of `git add`, packing refs, pruning
reflog, rerere metadata or stale working trees. May also update ancillary
indexes such as the commit-graph.
@@ -35,14 +35,14 @@ OPTIONS
-------
--aggressive::
- Usually 'git gc' runs very quickly while providing good disk
+ Usually `git gc` runs very quickly while providing good disk
space utilization and performance. This option will cause
- 'git gc' to more aggressively optimize the repository at the expense
+ `git gc` to more aggressively optimize the repository at the expense
of taking much more time. The effects of this optimization are
mostly persistent. See the "AGGRESSIVE" section below for details.
--auto::
- With this option, 'git gc' checks whether any housekeeping is
+ With this option, `git gc` checks whether any housekeeping is
required; if not, it exits without performing any work.
+
See the `gc.auto` option in the "CONFIGURATION" section below for how
@@ -114,19 +114,19 @@ include::config/gc.txt[]
NOTES
-----
-'git gc' tries very hard not to delete objects that are referenced
+`git gc` tries very hard not to delete objects that are referenced
anywhere in your repository. In particular, it will keep not only
objects referenced by your current set of branches and tags, but also
objects referenced by the index, remote-tracking branches, reflogs
(which may reference commits in branches that were later amended or
rewound), and anything else in the refs/* namespace. Note that a note
-(of the kind created by 'git notes') attached to an object does not
+(of the kind created by `git notes`) attached to an object does not
contribute in keeping the object alive. If you are expecting some
objects to be deleted and they aren't, check all of those locations
and decide whether it makes sense in your case to remove those
references.
-On the other hand, when 'git gc' runs concurrently with another process,
+On the other hand, when `git gc` runs concurrently with another process,
there is a risk of it deleting an object that the other process is using
but hasn't created a reference to. This may just cause the other process
to fail or may corrupt the repository if the other process later adds a
@@ -147,7 +147,7 @@ seems to be low in practice).
HOOKS
-----
-The 'git gc --auto' command will run the 'pre-auto-gc' hook. See
+The `git gc --auto` command will run the 'pre-auto-gc' hook. See
linkgit:githooks[5] for more information.
diff --git a/Documentation/git-get-tar-commit-id.txt b/Documentation/git-get-tar-commit-id.txt
index ac44d85b0b..7b7e41bf68 100644
--- a/Documentation/git-get-tar-commit-id.txt
+++ b/Documentation/git-get-tar-commit-id.txt
@@ -9,20 +9,20 @@ git-get-tar-commit-id - Extract commit ID from an archive created using git-arch
SYNOPSIS
--------
[verse]
-'git get-tar-commit-id'
+`git get-tar-commit-id`
DESCRIPTION
-----------
-Read a tar archive created by 'git archive' from the standard input
+Read a tar archive created by `git archive` from the standard input
and extract the commit ID stored in it. It reads only the first
1024 bytes of input, thus its runtime is not influenced by the size
of the tar archive very much.
-If no commit ID is found, 'git get-tar-commit-id' quietly exists with a
+If no commit ID is found, `git get-tar-commit-id` quietly exists with a
return code of 1. This can happen if the archive had not been created
-using 'git archive' or if the first parameter of 'git archive' had been
+using `git archive` or if the first parameter of `git archive` had been
a tree ID instead of a commit ID or tag.
GIT
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 88047cefad..b10a3f6bb4 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -9,7 +9,7 @@ git-grep - Print lines matching a pattern
SYNOPSIS
--------
[verse]
-'git grep' [-a | --text] [-I] [--textconv] [-i | --ignore-case] [-w | --word-regexp]
+`git grep` [-a | --text] [-I] [--textconv] [-i | --ignore-case] [-w | --word-regexp]
[-v | --invert-match] [-h|-H] [--full-name]
[-E | --extended-regexp] [-G | --basic-regexp]
[-P | --perl-regexp]
@@ -66,8 +66,8 @@ grep.fullName::
If set to true, enable `--full-name` option by default.
grep.fallbackToNoIndex::
- If set to true, fall back to git grep `--no-index` if git grep
- is executed outside of a git repository. Defaults to false.
+ If set to true, fall back to `git grep --no-index` if `git grep`
+ is executed outside of a `git` repository. Defaults to false.
OPTIONS
@@ -191,13 +191,13 @@ providing this option will cause it to die.
--files-without-match::
Instead of showing every matched line, show only the
names of files that contain (or do not contain) matches.
- For better compatibility with 'git diff', `--name-only` is a
+ For better compatibility with `git diff`, `--name-only` is a
synonym for `--files-with-matches`.
-O[<pager>]::
--open-files-in-pager[=<pager>]::
Open the matching files in the pager (not the output of 'grep').
- If the pager happens to be "less" or "vi", and the user
+ If the pager happens to be `less` or `vi`, and the user
specified only one pattern, the first file is positioned at
the first match automatically. The `pager` argument is
optional; if specified, it must be stuck to the option
diff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt
index c9d7e96214..ff66c5b1d0 100644
--- a/Documentation/git-gui.txt
+++ b/Documentation/git-gui.txt
@@ -8,23 +8,23 @@ git-gui - A portable graphical interface to Git
SYNOPSIS
--------
[verse]
-'git gui' [<command>] [arguments]
+`git gui` [<command>] [arguments]
DESCRIPTION
-----------
-A Tcl/Tk based graphical user interface to Git. 'git gui' focuses
+A Tcl/Tk based graphical user interface to Git. `git gui` focuses
on allowing users to make changes to their repository by making
new commits, amending existing ones, creating branches, performing
local merges, and fetching/pushing to remote repositories.
-Unlike 'gitk', 'git gui' focuses on commit generation
+Unlike `gitk`, `git gui` focuses on commit generation
and single file annotation and does not show project history.
-It does however supply menu actions to start a 'gitk' session from
-within 'git gui'.
+It does however supply menu actions to start a `gitk` session from
+within `git gui`.
-'git gui' is known to work on all popular UNIX systems, Mac OS X,
+`git gui` is known to work on all popular UNIX systems, Mac OS X,
and Windows (under both Cygwin and MSYS). To the extent possible
-OS specific user interface guidelines are followed, making 'git gui'
+OS specific user interface guidelines are followed, making `git gui`
a fairly native interface for users.
COMMANDS
@@ -39,13 +39,13 @@ browser::
browser are opened in the blame viewer.
citool::
- Start 'git gui' and arrange to make exactly one commit before
+ Start `git gui` and arrange to make exactly one commit before
exiting and returning to the shell. The interface is limited
to only commit actions, slightly reducing the application's
startup time and simplifying the menubar.
version::
- Display the currently running version of 'git gui'.
+ Display the currently running version of `git gui`.
Examples
@@ -103,16 +103,16 @@ SEE ALSO
--------
linkgit:gitk[1]::
The Git repository browser. Shows branches, commit history
- and file differences. gitk is the utility started by
+ and file differences. `gitk` is the utility started by
'git gui''s Repository Visualize actions.
Other
-----
-'git gui' is actually maintained as an independent project, but stable
+`git gui` is actually maintained as an independent project, but stable
versions are distributed as part of the Git suite for the convenience
of end users.
-The official repository of the 'git gui' project can be found at:
+The official repository of the `git gui` project can be found at:
https://github.com/prati0100/git-gui.git/
diff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt
index df9e2c58bd..15c2945345 100644
--- a/Documentation/git-hash-object.txt
+++ b/Documentation/git-hash-object.txt
@@ -9,8 +9,8 @@ git-hash-object - Compute object ID and optionally creates a blob from a file
SYNOPSIS
--------
[verse]
-'git hash-object' [-t <type>] [-w] [--path=<file>|--no-filters] [--stdin [--literally]] [--] <file>...
-'git hash-object' [-t <type>] [-w] --stdin-paths [--no-filters]
+`git hash-object` [-t <type>] [-w] [--path=<file>|--no-filters] [--stdin [--literally]] [--] <file>...
+`git hash-object` [-t <type>] [-w] --stdin-paths [--no-filters]
DESCRIPTION
-----------
@@ -54,7 +54,7 @@ OPTIONS
--literally::
Allow `--stdin` to hash any garbage into a loose object which might not
- otherwise pass standard object parsing or git-fsck checks. Useful for
+ otherwise pass standard object parsing or `git-fsck` checks. Useful for
stress-testing Git itself or reproducing characteristics of corrupt or
bogus objects encountered in the wild.
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 392f7be6fa..2d5660f47a 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -8,13 +8,13 @@ git-help - Display help information about Git
SYNOPSIS
--------
[verse]
-'git help' [-a|--all [--[no-]verbose]] [-g|--guides]
+`git help` [-a|--all [--[no-]verbose]] [-g|--guides]
[-i|--info|-m|--man|-w|--web] [COMMAND|GUIDE]
DESCRIPTION
-----------
-With no options and no COMMAND or GUIDE given, the synopsis of the 'git'
+With no options and no COMMAND or GUIDE given, the synopsis of the `git`
command and a list of the most commonly used Git commands are printed
on the standard output.
@@ -29,7 +29,7 @@ guide is brought up. The 'man' program is used by default for this
purpose, but this can be overridden by other options or configuration
variables.
-If an alias is given, git shows the definition of the alias on
+If an alias is given, `git` shows the definition of the alias on
standard output. To get the manual page for the aliased command, use
`git COMMAND --help`.
@@ -38,7 +38,7 @@ former is internally converted into the latter.
To display the linkgit:git[1] man page, use `git help git`.
-This page can be displayed with 'git help help' or `git help --help`
+This page can be displayed with `git help help` or `git help --help`
OPTIONS
-------
@@ -83,8 +83,8 @@ other display programs (see below).
+
The web browser can be specified using the configuration variable
`help.browser`, or `web.browser` if the former is not set. If none of
-these config variables is set, the 'git web{litdd}browse' helper script
-(called by 'git help') will pick a suitable default. See
+these config variables is set, the `git web--browse` helper script
+(called by `git help`) will pick a suitable default. See
linkgit:git-web{litdd}browse[1] for more information about this.
CONFIGURATION VARIABLES
@@ -95,7 +95,7 @@ help.format
If no command-line option is passed, the `help.format` configuration
variable will be checked. The following values are supported for this
-variable; they make 'git help' behave as their corresponding command-
+variable; they make `git help` behave as their corresponding command-
line option:
* "man" corresponds to `-m`|`--man`,
@@ -150,7 +150,7 @@ man.<tool>.path
You can explicitly provide a full path to your preferred man viewer by
setting the configuration variable `man.<tool>.path`. For example, you
can configure the absolute path to konqueror by setting
-`man.konqueror.path`. Otherwise, 'git help' assumes the tool is
+`man.konqueror.path`. Otherwise, `git help` assumes the tool is
available in PATH.
man.<tool>.cmd
@@ -185,7 +185,7 @@ the following:
cmd = A_PATH_TO/konqueror
------------------------------------------------
-Note about git config --global
+Note about `git config --global`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Note that all these configuration variables should probably be set
diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt
index 558966aa83..c97c10ba09 100644
--- a/Documentation/git-http-backend.txt
+++ b/Documentation/git-http-backend.txt
@@ -8,7 +8,7 @@ git-http-backend - Server side implementation of Git over HTTP
SYNOPSIS
--------
[verse]
-'git http-backend'
+`git http-backend`
DESCRIPTION
-----------
@@ -19,15 +19,15 @@ and the backwards-compatible dumb HTTP protocol, as well as clients
pushing using the smart HTTP protocol.
It verifies that the directory has the magic file
-"git-daemon-export-ok", and it will refuse to export any Git directory
+`git-daemon-export-ok`, and it will refuse to export any Git directory
that hasn't explicitly been marked for export this way (unless the
`GIT_HTTP_EXPORT_ALL` environmental variable is set).
By default, only the `upload-pack` service is enabled, which serves
-'git fetch-pack' and 'git ls-remote' clients, which are invoked from
-'git fetch', 'git pull', and 'git clone'. If the client is authenticated,
-the `receive-pack` service is enabled, which serves 'git send-pack'
-clients, which is invoked from 'git push'.
+`git fetch-pack` and `git ls-remote` clients, which are invoked from
+`git fetch`, `git pull`, and `git clone`. If the client is authenticated,
+the `receive-pack` service is enabled, which serves `git send-pack`
+clients, which is invoked from `git push`.
SERVICES
--------
@@ -43,12 +43,12 @@ http.getanyfile::
by setting this configuration item to `false`.
http.uploadpack::
- This serves 'git fetch-pack' and 'git ls-remote' clients.
+ This serves `git fetch-pack` and `git ls-remote` clients.
It is enabled by default, but a repository can disable it
by setting this configuration item to `false`.
http.receivepack::
- This serves 'git send-pack' clients, allowing push. It is
+ This serves `git send-pack` clients, allowing push. It is
disabled by default for anonymous users, and enabled by
default for users authenticated by the web server. It can be
disabled by setting this item to `false`, or enabled for all
@@ -56,11 +56,11 @@ http.receivepack::
URL TRANSLATION
---------------
-To determine the location of the repository on disk, 'git http-backend'
+To determine the location of the repository on disk, `git http-backend`
concatenates the environment variables PATH_INFO, which is set
automatically by the web server, and GIT_PROJECT_ROOT, which must be set
manually in the web server configuration. If GIT_PROJECT_ROOT is not
-set, 'git http-backend' reads PATH_TRANSLATED, which is also set
+set, `git http-backend` reads PATH_TRANSLATED, which is also set
automatically by the web server.
EXAMPLES
@@ -135,9 +135,9 @@ directive around the repository, or one of its parent directories:
</Location>
----------------------------------------------------------------
+
-To serve gitweb at the same url, use a ScriptAliasMatch to only
-those URLs that 'git http-backend' can handle, and forward the
-rest to gitweb:
+To serve `gitweb` at the same url, use a ScriptAliasMatch to only
+those URLs that `git http-backend` can handle, and forward the
+rest to `gitweb`:
+
----------------------------------------------------------------
ScriptAliasMatch \
@@ -174,7 +174,7 @@ AliasMatch ^/git/(.*/objects/pack/pack-[0-9a-f]{40}.(pack|idx))$ /var/www/git/$1
ScriptAlias /git/ /usr/libexec/git-core/git-http-backend/
----------------------------------------------------------------
+
-This can be combined with the gitweb configuration:
+This can be combined with the `gitweb` configuration:
+
----------------------------------------------------------------
SetEnv GIT_PROJECT_ROOT /var/www/git
@@ -241,7 +241,7 @@ $HTTP["url"] =~ "^/git/private" {
ENVIRONMENT
-----------
-'git http-backend' relies upon the `CGI` environment variables set
+`git http-backend` relies upon the `CGI` environment variables set
by the invoking web server, including:
* PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)
@@ -252,12 +252,12 @@ by the invoking web server, including:
* REQUEST_METHOD
The `GIT_HTTP_EXPORT_ALL` environmental variable may be passed to
-'git-http-backend' to bypass the check for the "git-daemon-export-ok"
+`git-http-backend` to bypass the check for the `git-daemon-export-ok`
file in each repository before allowing export of that repository.
The `GIT_HTTP_MAX_REQUEST_BUFFER` environment variable (or the
`http.maxRequestBuffer` config variable) may be set to change the
-largest ref negotiation request that git will handle during a fetch; any
+largest ref negotiation request that `git` will handle during a fetch; any
fetch requiring a larger buffer will not succeed. This value should not
normally need to be changed, but may be helpful if you are fetching from
a repository with an extremely large number of refs. The value can be
@@ -266,11 +266,11 @@ specified with a unit (e.g., `100M` for 100 megabytes). The default is
The backend process sets GIT_COMMITTER_NAME to '$REMOTE_USER' and
GIT_COMMITTER_EMAIL to '$\{REMOTE_USER}@http.$\{REMOTE_ADDR\}',
-ensuring that any reflogs created by 'git-receive-pack' contain some
+ensuring that any reflogs created by `git-receive-pack` contain some
identifying information of the remote user who performed the push.
All `CGI` environment variables are available to each of the hooks
-invoked by the 'git-receive-pack'.
+invoked by the `git-receive-pack`.
GIT
---
diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt
index 969e553e4a..87028e3312 100644
--- a/Documentation/git-http-fetch.txt
+++ b/Documentation/git-http-fetch.txt
@@ -9,7 +9,7 @@ git-http-fetch - Download from a remote Git repository via HTTP
SYNOPSIS
--------
[verse]
-'git http-fetch' [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [--stdin | --packfile=<hash> | <commit>] <url>
+`git http-fetch` [-c] [-t] [-a] [-d] [-v] [-w filename] [--recover] [--stdin | --packfile=<hash> | <commit>] <url>
DESCRIPTION
-----------
@@ -36,14 +36,14 @@ commit-id::
--stdin::
Instead of a commit id on the command line (which is not expected in this
- case), 'git http-fetch' expects lines on stdin in the format
+ case), `git http-fetch` expects lines on stdin in the format
<commit-id>['\t'<filename-as-in--w>]
--packfile=<hash>::
For internal use only. Instead of a commit id on the command
line (which is not expected in
- this case), 'git http-fetch' fetches the packfile directly at the given
+ this case), `git http-fetch` fetches the packfile directly at the given
URL and uses index-pack to generate corresponding .idx and .keep files.
The hash is used to determine the name of the temporary file and is
arbitrary. The output of index-pack is printed to stdout. Requires
diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt
index 7ba8ea2383..85c564c412 100644
--- a/Documentation/git-http-push.txt
+++ b/Documentation/git-http-push.txt
@@ -9,7 +9,7 @@ git-http-push - Push objects over HTTP/DAV to another repository
SYNOPSIS
--------
[verse]
-'git http-push' [--all] [--dry-run] [--force] [--verbose] <url> <ref> [<ref>...]
+`git http-push` [--all] [--dry-run] [--force] [--verbose] <url> <ref> [<ref>...]
DESCRIPTION
-----------
diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt
index 63cf498ce9..68b1fb19e2 100644
--- a/Documentation/git-imap-send.txt
+++ b/Documentation/git-imap-send.txt
@@ -9,12 +9,12 @@ git-imap-send - Send a collection of patches from stdin to an IMAP folder
SYNOPSIS
--------
[verse]
-'git imap-send' [-v] [-q] [--[no-]curl]
+`git imap-send` [-v] [-q] [--[no-]curl]
DESCRIPTION
-----------
-This command uploads a mailbox generated with 'git format-patch'
+This command uploads a mailbox generated with `git format-patch`
into an IMAP drafts folder. This allows patches to be sent as
other email is when using mail clients that cannot read mailbox
files directly. The command also works with any general mailbox
diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt
index bde1cf4a5c..fa859f759d 100644
--- a/Documentation/git-index-pack.txt
+++ b/Documentation/git-index-pack.txt
@@ -9,8 +9,8 @@ git-index-pack - Build pack index file for an existing packed archive
SYNOPSIS
--------
[verse]
-'git index-pack' [-v] [-o <index-file>] [--[no-]rev-index] <pack-file>
-'git index-pack' --stdin [--fix-thin] [--keep] [-v] [-o <index-file>]
+`git index-pack` [-v] [-o <index-file>] [--[no-]rev-index] <pack-file>
+`git index-pack` --stdin [--fix-thin] [--keep] [-v] [-o <index-file>]
[--[no-]rev-index] [<pack-file>]
@@ -51,7 +51,7 @@ OPTIONS
a default name determined from the pack content. If
<pack-file> is not specified consider using `--keep` to
prevent a race condition between this process and
- 'git repack'.
+ `git repack`.
--fix-thin::
Fix a "thin" pack produced by `git pack-objects --thin` (see
@@ -63,7 +63,7 @@ OPTIONS
Before moving the index into its final destination
create an empty .keep file for the associated pack file.
This option is usually necessary with `--stdin` to prevent a
- simultaneous 'git repack' process from deleting
+ simultaneous `git repack` process from deleting
the newly constructed pack and index before refs can be
updated to use objects contained in the pack.
@@ -123,7 +123,7 @@ Once the index has been created, the hash that goes into the name of
the pack/idx file is printed to stdout. If `--stdin` was
also used then this is prefixed by either "pack\t", or "keep\t" if a
new .keep file was successfully created. This is useful to remove a
-.keep file used as a lock to prevent the race with 'git repack'
+.keep file used as a lock to prevent the race with `git repack`
mentioned above.
GIT
diff --git a/Documentation/git-init-db.txt b/Documentation/git-init-db.txt
index 648a6cd78a..b62407333b 100644
--- a/Documentation/git-init-db.txt
+++ b/Documentation/git-init-db.txt
@@ -9,7 +9,7 @@ git-init-db - Creates an empty Git repository
SYNOPSIS
--------
[verse]
-'git init-db' [-q | --quiet] [--bare] [--template=<template_directory>] [--separate-git-dir <git dir>] [--shared[=<permissions>]]
+`git init-db` [-q | --quiet] [--bare] [--template=<template_directory>] [--separate-git-dir <git dir>] [--shared[=<permissions>]]
DESCRIPTION
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index 47d61fc505..2ee178a81c 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -9,7 +9,7 @@ git-init - Create an empty Git repository or reinitialize an existing one
SYNOPSIS
--------
[verse]
-'git init' [-q | --quiet] [--bare] [--template=<template_directory>]
+`git init` [-q | --quiet] [--bare] [--template=<template_directory>]
[--separate-git-dir <git dir>] [--object-format=<format>]
[-b <branch-name> | --initial-branch=<branch-name>]
[--shared[=<permissions>]] [directory]
@@ -32,9 +32,9 @@ If the object storage directory is specified via the
are created underneath - otherwise the default `$GIT_DIR/objects`
directory is used.
-Running 'git init' in an existing repository is safe. It will not
+Running `git init` in an existing repository is safe. It will not
overwrite things that are already there. The primary reason for
-rerunning 'git init' is to pick up newly added templates (or to move
+rerunning `git init` is to pick up newly added templates (or to move
the repository to another place if `--separate-git-dir` is given).
OPTIONS
@@ -99,7 +99,7 @@ specified.
'group' (or 'true')::
-Make the repository group-writable, (and g+sx, since the git group may be not
+Make the repository group-writable, (and g+sx, since the `git` group may be not
the primary group of all users). This is used to loosen the permissions of an
otherwise safe umask(2) value. Note that the umask still applies to the other
permission bits (e.g. if umask is '0022', using 'group' will not remove read
diff --git a/Documentation/git-instaweb.txt b/Documentation/git-instaweb.txt
index a54fe4401b..dfbd3a40ce 100644
--- a/Documentation/git-instaweb.txt
+++ b/Documentation/git-instaweb.txt
@@ -8,9 +8,9 @@ git-instaweb - Instantly browse your working repository in gitweb
SYNOPSIS
--------
[verse]
-'git instaweb' [--local] [--httpd=<httpd>] [--port=<port>]
+`git instaweb` [--local] [--httpd=<httpd>] [--port=<port>]
[--browser=<browser>]
-'git instaweb' [--start] [--stop] [--restart]
+`git instaweb` [--start] [--stop] [--restart]
DESCRIPTION
-----------
@@ -44,9 +44,9 @@ OPTIONS
-b::
--browser::
- The web browser that should be used to view the gitweb
- page. This will be passed to the 'git web{litdd}browse' helper
- script along with the URL of the gitweb instance. See
+ The web browser that should be used to view the `gitweb`
+ page. This will be passed to the `git web--browse` helper
+ script along with the URL of the `gitweb` instance. See
linkgit:git-web{litdd}browse[1] for more information about this. If
the script fails, the URL will be printed to stdout.
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index 1160807e0d..b687701104 100644
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -8,8 +8,8 @@ git-interpret-trailers - Add or parse structured information in commit messages
SYNOPSIS
--------
[verse]
-'git interpret-trailers' [<options>] [(--trailer <token>[(=|:)<value>])...] [<file>...]
-'git interpret-trailers' [<options>] [--parse] [<file>...]
+`git interpret-trailers` [<options>] [(--trailer <token>[(=|:)<value>])...] [<file>...]
+`git interpret-trailers` [<options>] [--parse] [<file>...]
DESCRIPTION
-----------
@@ -138,7 +138,7 @@ trailer.separators::
This option tells which characters are recognized as trailer
separators. By default only ':' is recognized as a trailer
separator, except that '=' is always accepted on the command
- line for compatibility with other git commands.
+ line for compatibility with other `git` commands.
+
The first character given by this option will be the default character
used when another separator is not specified in the config for this
@@ -358,8 +358,8 @@ See-also: fe3187489d69c4 (subject of related commit)
* Configure a commit template with some trailers with empty values
(using sed to show and keep the trailing spaces at the end of the
trailers), then configure a commit-msg hook that uses
- 'git interpret-trailers' to remove trailers with empty values and
- to add a 'git-version' trailer:
+ `git interpret-trailers` to remove trailers with empty values and
+ to add a `git-version` trailer:
+
------------
$ sed -e 's/ Z$/ /' >commit_template.txt <<EOF
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index b306dced1c..a6b3bc1611 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -9,7 +9,7 @@ git-log - Show commit logs
SYNOPSIS
--------
[verse]
-'git log' [<options>] [<revision range>] [[--] <path>...]
+`git log` [<options>] [<revision range>] [[--] <path>...]
DESCRIPTION
-----------
@@ -133,14 +133,14 @@ EXAMPLES
`git log --since="2 weeks ago" -- gitk`::
- Show the changes during the last two weeks to the file 'gitk'.
+ Show the changes during the last two weeks to the file `gitk`.
The `--` is necessary to avoid confusion with the *branch* named
- 'gitk'
+ `gitk`
`git log --name-status release..test`::
- Show the commits that are in the "test" branch but not yet
- in the "release" branch, along with the list of paths
+ Show the commits that are in the `test` branch but not yet
+ in the `release` branch, along with the list of paths
each commit modifies.
`git log --follow builtin/rev-list.c`::
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index d27a33eb22..ee435024da 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -9,7 +9,7 @@ git-ls-files - Show information about files in the index and the working tree
SYNOPSIS
--------
[verse]
-'git ls-files' [-z] [-t] [-v] [-f]
+`git ls-files` [-z] [-t] [-v] [-f]
(--[cached|deleted|others|ignored|stage|unmerged|killed|modified])*
(-[c|d|o|i|s|u|k|m])*
[--eol]
@@ -196,15 +196,15 @@ followed by the ("attr/<eolattr>").
OUTPUT
------
-'git ls-files' just outputs the filenames unless `--stage` is specified in
+`git ls-files` just outputs the filenames unless `--stage` is specified in
which case it outputs:
[<tag> ]<mode> <object> <stage> <file>
-'git ls-files --eol' will show
+`git ls-files --eol` will show
i/<eolinfo><SPACES>w/<eolinfo><SPACES>attr/<eolattr><SPACE*><TAB><file>
-'git ls-files --unmerged' and 'git ls-files --stage' can be used to examine
+`git ls-files --unmerged` and `git ls-files --stage` can be used to examine
detailed information on unmerged paths.
For an unmerged path, instead of recording a single mode/SHA-1 pair,
@@ -222,7 +222,7 @@ verbatim and the line is terminated by a NUL byte.
EXCLUDE PATTERNS
----------------
-'git ls-files' can use a list of "exclude patterns" when
+`git ls-files` can use a list of "exclude patterns" when
traversing the directory tree and finding files to show when the
flags `--others` or `--ignored` are specified. linkgit:gitignore[5]
specifies the format of exclude patterns.
@@ -238,7 +238,7 @@ These exclude patterns come from these places, in order:
in the same order they appear in the file.
3. The command-line flag `--exclude-per-directory=<name>` specifies
- a name of the file in each directory 'git ls-files'
+ a name of the file in each directory `git ls-files`
examines, normally `.gitignore`. Files in deeper
directories take precedence. Patterns are ordered in the
same order they appear in the files.
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index dbe0c69298..cc1525f487 100644
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -9,7 +9,7 @@ git-ls-remote - List references in a remote repository
SYNOPSIS
--------
[verse]
-'git ls-remote' [--heads] [--tags] [--refs] [--upload-pack=<exec>]
+`git ls-remote` [--heads] [--tags] [--refs] [--upload-pack=<exec>]
[-q | --quiet] [--exit-code] [--get-url] [--sort=<key>]
[--symref] [<repository> [<refs>...]]
@@ -30,7 +30,7 @@ OPTIONS
both, references stored in refs/heads and refs/tags are
displayed. Note that `git ls-remote -h` used without
anything else on the command line gives help, consistent
- with other git subcommands.
+ with other `git` subcommands.
--refs::
Do not show peeled tags or pseudorefs like `HEAD` in the output.
@@ -40,7 +40,7 @@ OPTIONS
Do not print remote URL to stderr.
--upload-pack=<exec>::
- Specify the full path of 'git-upload-pack' on the remote
+ Specify the full path of `git-upload-pack` on the remote
host. This allows listing references from repositories accessed via
SSH and where the SSH daemon does not use the PATH configured by the
user.
diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
index 6ed9030c1e..82c802d918 100644
--- a/Documentation/git-ls-tree.txt
+++ b/Documentation/git-ls-tree.txt
@@ -9,7 +9,7 @@ git-ls-tree - List the contents of a tree object
SYNOPSIS
--------
[verse]
-'git ls-tree' [-d] [-r] [-t] [-l] [-z]
+`git ls-tree` [-d] [-r] [-t] [-l] [-z]
[--name-only] [--name-status] [--full-name] [--full-tree] [--abbrev[=<n>]]
<tree-ish> [<path>...]
@@ -25,8 +25,8 @@ in the current working directory. Note that:
- the behaviour is similar to that of "/bin/ls" in that the '<path>' is
taken as relative to the current working directory. E.g. when you are
- in a directory 'sub' that has a directory 'dir', you can run 'git
- ls-tree -r HEAD dir' to list the contents of the tree (that is
+ in a directory 'sub' that has a directory 'dir', you can run `git
+ ls-tree -r HEAD dir` to list the contents of the tree (that is
`sub/dir` in `HEAD`). You don't want to give a tree that is not at the
root level (e.g. `git ls-tree -r HEAD:sub dir`) in this case, as that
would result in asking for `sub/sub/dir` in the `HEAD` commit.
@@ -85,7 +85,7 @@ Output Format
<mode> SP <type> SP <object> TAB <file>
This output format is compatible with what `--index-info --stdin` of
-'git update-index' expects.
+`git update-index` expects.
When the `-l` option is used, format changes to
diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt
index c54feb665b..b47e92ee57 100644
--- a/Documentation/git-mailinfo.txt
+++ b/Documentation/git-mailinfo.txt
@@ -9,7 +9,7 @@ git-mailinfo - Extracts patch and authorship from a single e-mail message
SYNOPSIS
--------
[verse]
-'git mailinfo' [-k|-b] [-u | --encoding=<encoding> | -n] [--[no-]scissors] <msg> <patch>
+`git mailinfo` [-k|-b] [-u | --encoding=<encoding> | -n] [--[no-]scissors] <msg> <patch>
DESCRIPTION
@@ -17,7 +17,7 @@ DESCRIPTION
Reads a single e-mail message from the standard input, and
writes the commit log message in <msg> file, and the patches in
<patch> file. The author name, e-mail and e-mail subject are
-written out to the standard output to be used by 'git am'
+written out to the standard output to be used by `git am`
to create a commit. It is usually not necessary to use this
command directly. See linkgit:git-am[1] instead.
@@ -28,7 +28,7 @@ OPTIONS
Usually the program removes email cruft from the Subject:
header line to extract the title line for the commit log
message. This option prevents this munging, and is most
- useful when used to read back 'git format-patch -k' output.
+ useful when used to read back `git format-patch -k` output.
+
Specifically, the following are removed until none of them remain:
+
diff --git a/Documentation/git-mailsplit.txt b/Documentation/git-mailsplit.txt
index 6e357716ec..151c4f96be 100644
--- a/Documentation/git-mailsplit.txt
+++ b/Documentation/git-mailsplit.txt
@@ -8,7 +8,7 @@ git-mailsplit - Simple UNIX mbox splitter program
SYNOPSIS
--------
[verse]
-'git mailsplit' [-b] [-f<nn>] [-d<prec>] [--keep-cr] [--mboxrd]
+`git mailsplit` [-b] [-f<nn>] [-d<prec>] [--keep-cr] [--mboxrd]
-o<directory> [--] [(<mbox>|<Maildir>)...]
DESCRIPTION
diff --git a/Documentation/git-maintenance.txt b/Documentation/git-maintenance.txt
index 80ddd33ceb..c69b3cec4f 100644
--- a/Documentation/git-maintenance.txt
+++ b/Documentation/git-maintenance.txt
@@ -9,7 +9,7 @@ git-maintenance - Run tasks to optimize Git repository data
SYNOPSIS
--------
[verse]
-'git maintenance' run [<options>]
+`git maintenance` run [<options>]
DESCRIPTION
diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt
index 2d944e0851..323bc045bf 100644
--- a/Documentation/git-merge-base.txt
+++ b/Documentation/git-merge-base.txt
@@ -9,16 +9,16 @@ git-merge-base - Find as good common ancestors as possible for a merge
SYNOPSIS
--------
[verse]
-'git merge-base' [-a|--all] <commit> <commit>...
-'git merge-base' [-a|--all] --octopus <commit>...
-'git merge-base' --is-ancestor <commit> <commit>
-'git merge-base' --independent <commit>...
-'git merge-base' --fork-point <ref> [<commit>]
+`git merge-base` [-a|--all] <commit> <commit>...
+`git merge-base` [-a|--all] --octopus <commit>...
+`git merge-base` --is-ancestor <commit> <commit>
+`git merge-base` --independent <commit>...
+`git merge-base` --fork-point <ref> [<commit>]
DESCRIPTION
-----------
-'git merge-base' finds best common ancestor(s) between two commits to use
+`git merge-base` finds best common ancestor(s) between two commits to use
in a three-way merge. One common ancestor is 'better' than another common
ancestor if the latter is an ancestor of the former. A common ancestor
that does not have any better common ancestor is a 'best common
@@ -43,14 +43,14 @@ from linkgit:git-show-branch[1] when used with the `--merge-base` option.
--octopus::
Compute the best common ancestors of all supplied commits,
in preparation for an n-way merge. This mimics the behavior
- of 'git show-branch --merge-base'.
+ of `git show-branch --merge-base`.
--independent::
Instead of printing merge bases, print a minimal subset of
the supplied commits with the same ancestors. In other words,
among the commits given, list those which cannot be reached
- from any other. This mimics the behavior of 'git show-branch
- --independent'.
+ from any other. This mimics the behavior of `git show-branch
+ --independent`.
--is-ancestor::
Check if the first <commit> is an ancestor of the second <commit>,
@@ -147,7 +147,7 @@ then
fi
....
-In modern git, you can say this in a more direct way:
+In modern `git`, you can say this in a more direct way:
....
if git merge-base --is-ancestor A B
diff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt
index f856032613..427f93cd8c 100644
--- a/Documentation/git-merge-file.txt
+++ b/Documentation/git-merge-file.txt
@@ -9,22 +9,22 @@ git-merge-file - Run a three-way file merge
SYNOPSIS
--------
[verse]
-'git merge-file' [-L <current-name> [-L <base-name> [-L <other-name>]]]
+`git merge-file` [-L <current-name> [-L <base-name> [-L <other-name>]]]
[--ours|--theirs|--union] [-p|--stdout] [-q|--quiet] [--marker-size=<n>]
[--[no-]diff3] <current-file> <base-file> <other-file>
DESCRIPTION
-----------
-'git merge-file' incorporates all changes that lead from the `<base-file>`
+`git merge-file` incorporates all changes that lead from the `<base-file>`
to `<other-file>` into `<current-file>`. The result ordinarily goes into
-`<current-file>`. 'git merge-file' is useful for combining separate changes
+`<current-file>`. `git merge-file` is useful for combining separate changes
to an original. Suppose `<base-file>` is the original, and both
`<current-file>` and `<other-file>` are modifications of `<base-file>`,
-then 'git merge-file' combines both changes.
+then `git merge-file` combines both changes.
A conflict occurs if both `<current-file>` and `<other-file>` have changes
-in a common segment of lines. If a conflict is found, 'git merge-file'
+in a common segment of lines. If a conflict is found, `git merge-file`
normally outputs a warning and brackets the conflict with lines containing
<<<<<<< and >>>>>>> markers. A typical conflict will look like this:
@@ -44,7 +44,7 @@ The exit value of this program is negative on error, and the number of
conflicts otherwise (truncated to 127 if there are more than that many
conflicts). If the merge was clean, the exit value is 0.
-'git merge-file' is designed to be a minimal clone of RCS 'merge'; that is, it
+`git merge-file` is designed to be a minimal clone of RCS 'merge'; that is, it
implements all of RCS 'merge''s functionality which is needed by
linkgit:git[1].
diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt
index 9fdfe6a31b..be978144d5 100644
--- a/Documentation/git-merge-index.txt
+++ b/Documentation/git-merge-index.txt
@@ -9,7 +9,7 @@ git-merge-index - Run a merge for files needing merging
SYNOPSIS
--------
[verse]
-'git merge-index' [-o] [-q] <merge-program> (-a | [--] <file>*)
+`git merge-index` [-o] [-q] <merge-program> (-a | [--] <file>*)
DESCRIPTION
-----------
@@ -37,14 +37,14 @@ OPTIONS
failure usually indicates conflicts during the merge). This is for
porcelains which might want to emit custom messages.
-If 'git merge-index' is called with multiple <file>s (or `-a`) then it
+If `git merge-index` is called with multiple <file>s (or `-a`) then it
processes them in turn only stopping if merge returns a non-zero exit
code.
Typically this is run with a script calling Git's imitation of
the 'merge' command from the RCS package.
-A sample script called 'git merge-one-file' is included in the
+A sample script called `git merge-one-file` is included in the
distribution.
ALERT ALERT ALERT! The Git "merge object order" is different from the
@@ -73,10 +73,10 @@ This is added AA in the branch B.
fatal: merge program failed
----
-where the latter example shows how 'git merge-index' will stop trying to
+where the latter example shows how `git merge-index` will stop trying to
merge once anything has returned an error (i.e., `cat` returned an error
for the AA file, because it didn't exist in the original, and thus
-'git merge-index' didn't even try to merge the MM thing).
+`git merge-index` didn't even try to merge the MM thing).
GIT
---
diff --git a/Documentation/git-merge-one-file.txt b/Documentation/git-merge-one-file.txt
index 04e803d5d3..a4ef1d0865 100644
--- a/Documentation/git-merge-one-file.txt
+++ b/Documentation/git-merge-one-file.txt
@@ -9,12 +9,12 @@ git-merge-one-file - The standard helper program to use with git-merge-index
SYNOPSIS
--------
[verse]
-'git merge-one-file'
+`git merge-one-file`
DESCRIPTION
-----------
-This is the standard helper program to use with 'git merge-index'
-to resolve a merge after the trivial merge done with 'git read-tree -m'.
+This is the standard helper program to use with `git merge-index`
+to resolve a merge after the trivial merge done with `git read-tree -m`.
GIT
---
diff --git a/Documentation/git-merge-tree.txt b/Documentation/git-merge-tree.txt
index 58731c1942..c688cb4def 100644
--- a/Documentation/git-merge-tree.txt
+++ b/Documentation/git-merge-tree.txt
@@ -9,13 +9,13 @@ git-merge-tree - Show three-way merge without touching index
SYNOPSIS
--------
[verse]
-'git merge-tree' <base-tree> <branch1> <branch2>
+`git merge-tree` <base-tree> <branch1> <branch2>
DESCRIPTION
-----------
Reads three tree-ish, and output trivial merge results and
conflicting stages to the standard output. This is similar to
-what three-way 'git read-tree -m' does, but instead of storing the
+what three-way `git read-tree -m` does, but instead of storing the
results in the index, the command outputs the entries to the
standard output.
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index 58fd091d73..029c7807db 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -9,17 +9,17 @@ git-merge - Join two or more development histories together
SYNOPSIS
--------
[verse]
-'git merge' [-n] [--stat] [--no-commit] [--squash] [--[no-]edit]
+`git merge` [-n] [--stat] [--no-commit] [--squash] [--[no-]edit]
[--no-verify] [-s <strategy>] [-X <strategy-option>] [-S[<keyid>]]
[--[no-]allow-unrelated-histories]
[--[no-]rerere-autoupdate] [-m <msg>] [-F <file>] [<commit>...]
-'git merge' (--continue | --abort | --quit)
+`git merge` (--continue | --abort | --quit)
DESCRIPTION
-----------
Incorporates changes from the named commits (since the time their
histories diverged from the current branch) into the current
-branch. This command is used by 'git pull' to incorporate changes
+branch. This command is used by `git pull` to incorporate changes
from another repository and can be used by hand to merge changes
from one branch into another.
@@ -45,14 +45,14 @@ a log message from the user describing the changes.
------------
The second syntax ("`git merge --abort`") can only be run after the
-merge has resulted in conflicts. 'git merge --abort' will abort the
+merge has resulted in conflicts. `git merge --abort` will abort the
merge process and try to reconstruct the pre-merge state. However,
if there were uncommitted changes when the merge started (and
especially if those changes were further modified after the merge
-was started), 'git merge --abort' will in some cases be unable to
+was started), `git merge --abort` will in some cases be unable to
reconstruct the original (pre-merge) changes. Therefore:
-*Warning*: Running 'git merge' with non-trivial uncommitted changes is
+*Warning*: Running `git merge` with non-trivial uncommitted changes is
discouraged: while possible, it may leave you in a state that is hard to
back out of in the case of a conflict.
@@ -70,8 +70,8 @@ include::merge-options.txt[]
If `--log` is specified, a shortlog of the commits being merged
will be appended to the specified message.
+
-The 'git fmt-merge-msg' command can be
-used to give a good default for automated 'git merge'
+The `git fmt-merge-msg` command can be
+used to give a good default for automated `git merge`
invocations. The automated message can include the branch description.
-F <file>::
@@ -98,14 +98,14 @@ will be appended to the specified message.
present, apply it to the worktree.
+
If there were uncommitted worktree changes present when the merge
-started, 'git merge --abort' will in some cases be unable to
+started, `git merge --abort` will in some cases be unable to
reconstruct these changes. It is therefore recommended to always
-commit or stash your changes before running 'git merge'.
+commit or stash your changes before running `git merge`.
+
-'git merge --abort' is equivalent to 'git reset --merge' when
+`git merge --abort` is equivalent to `git reset --merge` when
`MERGE_HEAD` is present unless `MERGE_AUTOSTASH` is also present in
-which case 'git merge --abort' applies the stash entry to the worktree
-whereas 'git reset --merge' will save the stashed changes in the stash
+which case `git merge --abort` applies the stash entry to the worktree
+whereas `git reset --merge` will save the stashed changes in the stash
list.
--quit::
@@ -114,8 +114,8 @@ list.
stash entry will be saved to the stash list.
--continue::
- After a 'git merge' stops due to conflicts you can conclude the
- merge by running 'git merge --continue' (see "HOW TO RESOLVE
+ After a `git merge` stops due to conflicts you can conclude the
+ merge by running `git merge --continue` (see "HOW TO RESOLVE
CONFLICTS" section below).
<commit>...::
@@ -138,25 +138,25 @@ PRE-MERGE CHECKS
Before applying outside changes, you should get your own work in
good shape and committed locally, so it will not be clobbered if
there are conflicts. See also linkgit:git-stash[1].
-'git pull' and 'git merge' will stop without doing anything when
-local uncommitted changes overlap with files that 'git pull'/'git
-merge' may need to update.
+`git pull` and `git merge` will stop without doing anything when
+local uncommitted changes overlap with files that `git pull`/`git
+merge` may need to update.
To avoid recording unrelated changes in the merge commit,
-'git pull' and 'git merge' will also abort if there are any changes
+`git pull` and `git merge` will also abort if there are any changes
registered in the index relative to the `HEAD` commit. (Special
narrow exceptions to this rule may exist depending on which merge
strategy is in use, but generally, the index must match `HEAD`.)
-If all named commits are already ancestors of `HEAD`, 'git merge'
-will exit early with the message "Already up to date."
+If all named commits are already ancestors of `HEAD`, `git merge`
+will exit early with the message Already up to date.
FAST-FORWARD MERGE
------------------
Often the current branch head is an ancestor of the named commit.
-This is the most common case especially when invoked from 'git
-pull': you are tracking an upstream repository, you have committed
+This is the most common case especially when invoked from `git
+pull`: you are tracking an upstream repository, you have committed
no local changes, and now you want to update to a newer upstream
revision. In this case, a new commit is not needed to store the
combined history; instead, the `HEAD` (along with the index) is
@@ -296,10 +296,10 @@ After seeing a conflict, you can do two things:
* Resolve the conflicts. Git will mark the conflicts in
the working tree. Edit the files into shape and
- 'git add' them to the index. Use 'git commit' or
- 'git merge --continue' to seal the deal. The latter command
+ `git add` them to the index. Use `git commit` or
+ `git merge --continue` to seal the deal. The latter command
checks whether there is a (interrupted) merge in progress
- before calling 'git commit'.
+ before calling `git commit`.
You can work through the conflict with a number of tools:
@@ -360,7 +360,7 @@ include::config/merge.txt[]
branch.<name>.mergeOptions::
Sets default options for merging into branch <name>. The syntax and
- supported options are the same as those of 'git merge', but option
+ supported options are the same as those of `git merge`, but option
values containing whitespace characters are currently not supported.
SEE ALSO
diff --git a/Documentation/git-mergetool--lib.txt b/Documentation/git-mergetool--lib.txt
index 3e8f59ac0e..8177c877e2 100644
--- a/Documentation/git-mergetool--lib.txt
+++ b/Documentation/git-mergetool--lib.txt
@@ -17,11 +17,11 @@ This is not a command the end user would want to run. Ever.
This documentation is meant for people who are studying the
Porcelain-ish scripts and/or are writing new ones.
-The 'git-mergetool{litdd}lib' scriptlet is designed to be sourced (using
+The `git-mergetool--lib` scriptlet is designed to be sourced (using
`.`) by other shell scripts to set up functions for working
with Git merge tools.
-Before sourcing 'git-mergetool{litdd}lib', your script must set `TOOL_MODE`
+Before sourcing `git-mergetool--lib`, your script must set `TOOL_MODE`
to define the operation mode for the functions listed below.
'diff' and 'merge' are valid values.
diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt
index e587c7763a..530f8a278f 100644
--- a/Documentation/git-mergetool.txt
+++ b/Documentation/git-mergetool.txt
@@ -8,18 +8,18 @@ git-mergetool - Run merge conflict resolution tools to resolve merge conflicts
SYNOPSIS
--------
[verse]
-'git mergetool' [--tool=<tool>] [-y | --[no-]prompt] [<file>...]
+`git mergetool` [--tool=<tool>] [-y | --[no-]prompt] [<file>...]
DESCRIPTION
-----------
Use `git mergetool` to run one of several merge utilities to resolve
-merge conflicts. It is typically run after 'git merge'.
+merge conflicts. It is typically run after `git merge`.
If one or more <file> parameters are given, the merge tool program will
be run to resolve differences on each file (skipping those without
conflicts). Specifying a directory will include all unresolved files in
-that path. If no <file> names are specified, 'git mergetool' will run
+that path. If no <file> names are specified, `git mergetool` will run
the merge tool program on every file with merge conflicts.
OPTIONS
@@ -31,23 +31,23 @@ OPTIONS
meld, vimdiff, and tortoisemerge. Run `git mergetool --tool-help`
for the list of valid <tool> settings.
+
-If a merge resolution program is not specified, 'git mergetool'
+If a merge resolution program is not specified, `git mergetool`
will use the configuration variable `merge.tool`. If the
-configuration variable `merge.tool` is not set, 'git mergetool'
+configuration variable `merge.tool` is not set, `git mergetool`
will pick a suitable default.
+
You can explicitly provide a full path to the tool by setting the
configuration variable `mergetool.<tool>.path`. For example, you
can configure the absolute path to kdiff3 by setting
-`mergetool.kdiff3.path`. Otherwise, 'git mergetool' assumes the
+`mergetool.kdiff3.path`. Otherwise, `git mergetool` assumes the
tool is available in PATH.
+
Instead of running one of the known merge tool programs,
-'git mergetool' can be customized to run an alternative program
+`git mergetool` can be customized to run an alternative program
by specifying the command line to invoke in a configuration
variable `mergetool.<tool>.cmd`.
+
-When 'git mergetool' is invoked with this tool (either through the
+When `git mergetool` is invoked with this tool (either through the
`-t` or `--tool` option or the `merge.tool` configuration
variable) the configured command line will be invoked with `$BASE`
set to the name of a temporary file containing the common base for
@@ -61,7 +61,7 @@ merge resolution.
If the custom merge tool correctly indicates the success of a
merge resolution with its exit code, then the configuration
variable `mergetool.<tool>.trustExitCode` can be set to `true`.
-Otherwise, 'git mergetool' will prompt the user to indicate the
+Otherwise, `git mergetool` will prompt the user to indicate the
success of the resolution after the custom tool has exited.
--tool-help::
@@ -81,7 +81,7 @@ success of the resolution after the custom tool has exited.
-g::
--gui::
- When 'git-mergetool' is invoked with the `-g` or `--gui` option
+ When `git-mergetool` is invoked with the `-g` or `--gui` option
the default merge tool will be read from the configured
`merge.guitool` variable instead of `merge.tool`. If
`merge.guitool` is not set, we will fallback to the tool
diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt
index 17a2603a60..1ba01b1a9b 100644
--- a/Documentation/git-mktag.txt
+++ b/Documentation/git-mktag.txt
@@ -9,7 +9,7 @@ git-mktag - Creates a tag object with extra validation
SYNOPSIS
--------
[verse]
-'git mktag'
+`git mktag`
OPTIONS
-------
diff --git a/Documentation/git-mktree.txt b/Documentation/git-mktree.txt
index 27fe2b32e1..709e05ab6f 100644
--- a/Documentation/git-mktree.txt
+++ b/Documentation/git-mktree.txt
@@ -9,7 +9,7 @@ git-mktree - Build a tree-object from ls-tree formatted text
SYNOPSIS
--------
[verse]
-'git mktree' [-z] [--missing] [--batch]
+`git mktree` [-z] [--missing] [--batch]
DESCRIPTION
-----------
diff --git a/Documentation/git-multi-pack-index.txt b/Documentation/git-multi-pack-index.txt
index ffd601bc17..ff56181795 100644
--- a/Documentation/git-multi-pack-index.txt
+++ b/Documentation/git-multi-pack-index.txt
@@ -9,7 +9,7 @@ git-multi-pack-index - Write and verify multi-pack-indexes
SYNOPSIS
--------
[verse]
-'git multi-pack-index' [--object-dir=<dir>] [--[no-]progress]
+`git multi-pack-index` [--object-dir=<dir>] [--[no-]progress]
[--preferred-pack=<pack>] <subcommand>
DESCRIPTION
@@ -65,7 +65,7 @@ repack::
are considered. If only one pack-file is selected, then do
nothing. If a new pack-file is created, rewrite the
multi-pack-index to reference the new pack-file. A later run of
- 'git multi-pack-index expire' will delete the pack-files that
+ `git multi-pack-index expire` will delete the pack-files that
were part of this batch.
+
If `repack.packKeptObjects` is `false`, then any pack-files with an
diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt
index ceb039a697..183e7d5770 100644
--- a/Documentation/git-mv.txt
+++ b/Documentation/git-mv.txt
@@ -9,14 +9,14 @@ git-mv - Move or rename a file, a directory, or a symlink
SYNOPSIS
--------
[verse]
-'git mv' <options>... <args>...
+`git mv` <options>... <args>...
DESCRIPTION
-----------
Move or rename a file, directory or symlink.
- git mv [-v] [-f] [-n] [-k] <source> <destination>
- git mv [-v] [-f] [-n] [-k] <source> ... <destination directory>
+ `git mv` [-v] [-f] [-n] [-k] <source> <destination>
+ `git mv` [-v] [-f] [-n] [-k] <source> ... <destination directory>
In the first form, it renames <source>, which must exist and be either
a file, symlink or directory, to <destination>.
@@ -58,7 +58,7 @@ Each time a superproject update moves a populated submodule (e.g. when
switching between commits before and after the move) a stale submodule
checkout will remain in the old location and an empty directory will
appear in the new location. To populate the submodule again in the new
-location the user will have to run "git submodule update"
+location the user will have to run `git submodule update`
afterwards. Removing the old directory is only safe when it uses a
gitfile, as otherwise the history of the submodule will be deleted
too. Both steps will be obsolete when recursive submodule update has
diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt
index 99979fe55b..c6c1f89117 100644
--- a/Documentation/git-name-rev.txt
+++ b/Documentation/git-name-rev.txt
@@ -9,13 +9,13 @@ git-name-rev - Find symbolic names for given revs
SYNOPSIS
--------
[verse]
-'git name-rev' [--tags] [--refs=<pattern>]
+`git name-rev` [--tags] [--refs=<pattern>]
( --all | --stdin | <commit-ish>... )
DESCRIPTION
-----------
Finds symbolic names suitable for human digestion for revisions given in any
-format parsable by 'git rev-parse'.
+format parsable by `git rev-parse`.
OPTIONS
@@ -69,7 +69,7 @@ wrote you about that fantastic commit 33db5f4d9027a10e477ccf054b2c1ab94f74c85a.
Of course, you look into the commit, but that only tells you what happened, but
not the context.
-Enter 'git name-rev':
+Enter `git name-rev`:
------------
% git name-rev 33db5f4d9027a10e477ccf054b2c1ab94f74c85a
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index ac1d191352..8f25b07f10 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -8,18 +8,18 @@ git-notes - Add or inspect object notes
SYNOPSIS
--------
[verse]
-'git notes' [list [<object>]]
-'git notes' add [-f] [--allow-empty] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
-'git notes' copy [-f] ( --stdin | <from-object> [<to-object>] )
-'git notes' append [--allow-empty] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
-'git notes' edit [--allow-empty] [<object>]
-'git notes' show [<object>]
-'git notes' merge [-v | -q] [-s <strategy> ] <notes-ref>
-'git notes' merge --commit [-v | -q]
-'git notes' merge --abort [-v | -q]
-'git notes' remove [--ignore-missing] [--stdin] [<object>...]
-'git notes' prune [-n] [-v]
-'git notes' get-ref
+`git notes` [list [<object>]]
+`git notes` add [-f] [--allow-empty] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
+`git notes` copy [-f] ( --stdin | <from-object> [<to-object>] )
+`git notes` append [--allow-empty] [-F <file> | -m <msg> | (-c | -C) <object>] [<object>]
+`git notes` edit [--allow-empty] [<object>]
+`git notes` show [<object>]
+`git notes` merge [-v | -q] [-s <strategy> ] <notes-ref>
+`git notes` merge --commit [-v | -q]
+`git notes` merge --abort [-v | -q]
+`git notes` remove [--ignore-missing] [--stdin] [<object>...]
+`git notes` prune [-n] [-v]
+`git notes` get-ref
DESCRIPTION
@@ -33,7 +33,7 @@ ENVIRONMENT sections below. If this ref does not exist, it will be
quietly created when it is first needed to store a note.
A typical use of notes is to supplement a commit message without
-changing the commit itself. Notes can be shown by 'git log' along with
+changing the commit itself. Notes can be shown by `git log` along with
the original commit message. To distinguish these notes from the
message stored in the commit object, the notes are indented like the
message, after an unindented line saying "Notes (<refname>):" (or
@@ -43,7 +43,7 @@ Notes can also be added to patches prepared with `git format-patch` by
using the `--notes` option. Such notes are added as a patch commentary
after a three dash separator line.
-To change which notes are shown by 'git log', see the
+To change which notes are shown by `git log`, see the
`notes.displayRef` configuration in linkgit:git-log[1].
See the `notes.rewrite.<command>` configuration for a way to carry
@@ -106,8 +106,8 @@ the "manual" resolver is used. This resolver checks out the
conflicting notes in a special worktree (`.git/NOTES_MERGE_WORKTREE`),
and instructs the user to manually resolve the conflicts there.
When done, the user can either finalize the merge with
-'git notes merge --commit', or abort the merge with
-'git notes merge --abort'.
+`git notes merge --commit`, or abort the merge with
+`git notes merge --abort`.
remove::
Remove the notes for given objects (defaults to `HEAD`). When
@@ -190,16 +190,16 @@ OPTIONS
information on each notes merge strategy.
--commit::
- Finalize an in-progress 'git notes merge'. Use this option
- when you have resolved the conflicts that 'git notes merge'
+ Finalize an in-progress `git notes merge`. Use this option
+ when you have resolved the conflicts that `git notes merge`
stored in .git/NOTES_MERGE_WORKTREE. This amends the partial
- merge commit created by 'git notes merge' (stored in
+ merge commit created by `git notes merge` (stored in
.git/NOTES_MERGE_PARTIAL) by adding the notes in
.git/NOTES_MERGE_WORKTREE. The notes ref stored in the
.git/NOTES_MERGE_REF symref is updated to the resulting commit.
--abort::
- Abort/reset an in-progress 'git notes merge', i.e. a notes merge
+ Abort/reset an in-progress `git notes merge`, i.e. a notes merge
with conflicts. This simply removes all files related to the
notes merge.
@@ -247,8 +247,8 @@ conflicting notes in a special work tree for resolving notes conflicts
(`.git/NOTES_MERGE_WORKTREE`), and instructs the user to resolve the
conflicts in that work tree.
When done, the user can either finalize the merge with
-'git notes merge --commit', or abort the merge with
-'git notes merge --abort'.
+`git notes merge --commit`, or abort the merge with
+`git notes merge --abort`.
Users may select an automated merge strategy from among the following using
either `-s`/`--strategy` option or configuring `notes.mergeStrategy` accordingly:
@@ -292,7 +292,7 @@ Notes:
In principle, a note is a regular Git blob, and any kind of
(non-)format is accepted. You can binary-safely create notes from
-arbitrary files using 'git hash-object':
+arbitrary files using `git hash-object`:
------------
$ cc *.c
@@ -303,7 +303,7 @@ $ git notes --ref=built add --allow-empty -C "$blob" HEAD
(You cannot simply use `git notes --ref=built add -F a.out HEAD`
because that is not binary-safe.)
Of course, it doesn't make much sense to display non-text-format notes
-with 'git log', so if you use such notes, you'll probably need to write
+with `git log`, so if you use such notes, you'll probably need to write
some special-purpose tools to do something useful with them.
@@ -334,14 +334,14 @@ notes.displayRef::
Which ref (or refs, if a glob or specified more than once), in
addition to the default set by `core.notesRef` or
`GIT_NOTES_REF`, to read notes from when showing commit
- messages with the 'git log' family of commands.
+ messages with the `git log` family of commands.
This setting can be overridden on the command line or by the
`GIT_NOTES_DISPLAY_REF` environment variable.
See linkgit:git-log[1].
notes.rewrite.<command>::
When rewriting commits with <command> (currently `amend` or
- `rebase`), if this variable is `false`, git will not copy
+ `rebase`), if this variable is `false`, `git` will not copy
notes from the original to the rewritten commit. Defaults to
`true`. See also "`notes.rewriteRef`" below.
+
diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index 326c553083..093f023ac5 100644
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -9,10 +9,10 @@ git-p4 - Import from and submit to Perforce repositories
SYNOPSIS
--------
[verse]
-'git p4 clone' [<sync options>] [<clone options>] <p4 depot path>...
-'git p4 sync' [<sync options>] [<p4 depot path>...]
-'git p4 rebase'
-'git p4 submit' [<submit options>] [<master branch name>]
+`git p4 clone` [<sync options>] [<clone options>] <p4 depot path>...
+`git p4 sync` [<sync options>] [<p4 depot path>...]
+`git p4 rebase`
+`git p4 submit` [<submit options>] [<master branch name>]
DESCRIPTION
@@ -21,11 +21,11 @@ This command provides a way to interact with p4 repositories
using Git.
Create a new Git repository from an existing p4 repository using
-'git p4 clone', giving it one or more p4 depot paths. Incorporate
-new commits from p4 changes with 'git p4 sync'. The 'sync' command
+`git p4 clone`, giving it one or more p4 depot paths. Incorporate
+new commits from p4 changes with `git p4 sync`. The 'sync' command
is also used to include new branches from other p4 depot paths.
-Submit Git changes back to p4 using 'git p4 submit'. The command
-'git p4 rebase' does a sync plus rebases the current branch onto
+Submit Git changes back to p4 using `git p4 submit`. The command
+`git p4 rebase` does a sync plus rebases the current branch onto
the updated p4 remote branch.
@@ -64,7 +64,7 @@ COMMANDS
Clone
~~~~~
-Generally, 'git p4 clone' is used to create a new Git directory
+Generally, `git p4 clone` is used to create a new Git directory
from an existing p4 repository:
------------
$ git p4 clone //depot/path/project
@@ -95,7 +95,7 @@ $ git p4 sync
This command finds new changes in p4 and imports them as Git commits.
P4 repositories can be added to an existing Git repository using
-'git p4 sync' too:
+`git p4 sync` too:
------------
$ mkdir repo-git
$ cd repo-git
@@ -108,11 +108,11 @@ This imports the specified depot into
be used for the p4 content.
If a Git repository includes branches 'refs/remotes/origin/p4', these
-will be fetched and consulted first during a 'git p4 sync'. Since
+will be fetched and consulted first during a `git p4 sync`. Since
importing directly from p4 is considerably slower than pulling changes
from a Git remote, this can be useful in a multi-developer environment.
-If there are multiple branches, doing 'git p4 sync' will automatically
+If there are multiple branches, doing `git p4 sync` will automatically
use the "BRANCH DETECTION" algorithm to try to partition new changes
into the right branch. This can be overridden with the `--branch`
option to specify just a single branch to update.
@@ -123,7 +123,7 @@ Rebase
A common working pattern is to fetch the latest changes from the p4 depot
and merge them with local uncommitted changes. Often, the p4 repository
is the ultimate location for all code, thus a rebase workflow makes
-sense. This command does 'git p4 sync' followed by 'git rebase' to move
+sense. This command does `git p4 sync` followed by `git rebase` to move
local commits on top of updated p4 changes.
------------
$ git p4 rebase
@@ -158,10 +158,10 @@ $ git p4 submit --commit <sha1..sha1>
The upstream reference is generally 'refs/remotes/p4/master', but can
be overridden using the `--origin=` command-line option.
-The p4 changes will be created as the user invoking 'git p4 submit'. The
+The p4 changes will be created as the user invoking `git p4 submit`. The
`--preserve-user` option will cause ownership to be modified
according to the author of the Git commit. This option requires admin
-privileges in p4, which can be granted using 'p4 protect'.
+privileges in p4, which can be granted using `p4 protect`.
To shelve changes instead of submitting, use `--shelve` and `--update-shelve`:
@@ -173,10 +173,10 @@ $ git p4 submit --update-shelve 1234 --update-shelve 2345
Unshelve
~~~~~~~~
-Unshelving will take a shelved P4 changelist, and produce the equivalent git commit
+Unshelving will take a shelved P4 changelist, and produce the equivalent `git` commit
in the branch refs/remotes/p4-unshelved/<changelist>.
-The git commit is created relative to the current origin revision (`HEAD` by default).
+The `git` commit is created relative to the current origin revision (`HEAD` by default).
A parent commit is created based on the origin, and then the unshelve commit is
created based on that.
@@ -239,7 +239,7 @@ Git repository:
--changesfile <file>::
Import exactly the p4 change numbers listed in 'file', one per
- line. Normally, 'git p4' inspects the current p4 repository
+ line. Normally, `git p4` inspects the current p4 repository
state and detects the changes it should import.
--silent::
@@ -271,9 +271,9 @@ Git repository:
--changes-block-size <n>::
The internal block size to use when converting a revision
specifier such as '@all' into a list of specific change
- numbers. Instead of using a single call to 'p4 changes' to
+ numbers. Instead of using a single call to `p4 changes` to
find the full list of changes for the conversion, there are a
- sequence of calls to 'p4 changes -m', each of which requests
+ sequence of calls to `p4 changes -m`, each of which requests
one block of changes of the given size. The default block size
is 500, which should usually be suitable.
@@ -307,7 +307,7 @@ options described above.
Submit options
~~~~~~~~~~~~~~
-These options can be used to modify 'git p4 submit' behavior.
+These options can be used to modify `git p4 submit` behavior.
--origin <commit>::
Upstream location from which commits are identified to submit to
@@ -336,7 +336,7 @@ These options can be used to modify 'git p4 submit' behavior.
--prepare-p4-only::
Apply a commit to the p4 workspace, opening, adding and deleting
files in p4 as for a normal submit operation. Do not issue the
- final "p4 submit", but instead print a message about how to
+ final `p4 submit`, but instead print a message about how to
submit manually or revert. This option always stops after the
first (oldest) commit. Git tags are not exported to p4.
@@ -370,9 +370,9 @@ These options can be used to modify 'git p4 submit' behavior.
submitted. Can also be set with `git-p4.disableRebase`.
--disable-p4sync::
- Disable the automatic sync of p4/master from Perforce after commits have
+ Disable the automatic sync of `p4/master` from Perforce after commits have
been submitted. Implies `--disable-rebase`. Can also be set with
- `git-p4.disableP4Sync`. Sync with origin/master still goes ahead if possible.
+ `git-p4.disableP4Sync`. Sync with `origin/master` still goes ahead if possible.
Hooks for submit
----------------
@@ -419,13 +419,13 @@ p4-post-changelist
The `p4-post-changelist` hook is invoked after the submit has
successfully occurred in P4. It takes no parameters and is meant
primarily for notification and cannot affect the outcome of the
-git p4 submit action.
+`git p4 submit` action.
Rebase options
~~~~~~~~~~~~~~
-These options can be used to modify 'git p4 rebase' behavior.
+These options can be used to modify `git p4 rebase` behavior.
--import-labels::
Import p4 labels.
@@ -434,12 +434,12 @@ Unshelve options
~~~~~~~~~~~~~~~~
--origin::
- Sets the git refspec against which the shelved P4 changelist is compared.
+ Sets the `git` refspec against which the shelved P4 changelist is compared.
Defaults to p4/master.
DEPOT PATH SYNTAX
-----------------
-The p4 depot path argument to 'git p4 sync' and 'git p4 clone' can
+The p4 depot path argument to `git p4 sync` and `git p4 clone` can
be one or more space-separated p4 depot paths, with an optional
p4 revision specifier on the end:
@@ -462,34 +462,34 @@ p4 revision specifier on the end:
depot paths with the same name, the path with the most recently
updated version of the file is the one that appears in Git.
-See 'p4 help revisions' for the full syntax of p4 revision specifiers.
+See `p4 help revisions` for the full syntax of p4 revision specifiers.
CLIENT SPEC
-----------
-The p4 client specification is maintained with the 'p4 client' command
+The p4 client specification is maintained with the `p4 client` command
and contains among other fields, a View that specifies how the depot
is mapped into the client repository. The 'clone' and 'sync' commands
can consult the client spec when given the `--use-client-spec` option or
-when the useClientSpec variable is true. After 'git p4 clone', the
+when the useClientSpec variable is true. After `git p4 clone`, the
useClientSpec variable is automatically set in the repository
-configuration file. This allows future 'git p4 submit' commands to
+configuration file. This allows future `git p4 submit` commands to
work properly; the submit command looks only at the variable and does
not have a command-line option.
-The full syntax for a p4 view is documented in 'p4 help views'. 'git p4'
+The full syntax for a p4 view is documented in `p4 help views`. `git p4`
knows only a subset of the view syntax. It understands multi-line
mappings, overlays with '+', exclusions with '-' and double-quotes
-around whitespace. Of the possible wildcards, 'git p4' only handles
-'...', and only when it is at the end of the path. 'git p4' will complain
+around whitespace. Of the possible wildcards, `git p4` only handles
+'...', and only when it is at the end of the path. `git p4` will complain
if it encounters an unhandled wildcard.
Bugs in the implementation of overlap mappings exist. If multiple depot
paths map through overlays to the same location in the repository,
-'git p4' can choose the wrong one. This is hard to solve without
-dedicating a client spec just for 'git p4'.
+`git p4` can choose the wrong one. This is hard to solve without
+dedicating a client spec just for `git p4`.
-The name of the client can be given to 'git p4' in multiple ways. The
+The name of the client can be given to `git p4` in multiple ways. The
variable `git-p4.client` takes precedence if it exists. Otherwise,
normal p4 mechanisms of determining the client are used: environment
variable `P4CLIENT`, a file referenced by `P4CONFIG`, or the local host name.
@@ -500,13 +500,13 @@ BRANCH DETECTION
P4 does not have the same concept of a branch as Git. Instead,
p4 organizes its content as a directory tree, where by convention
different logical branches are in different locations in the tree.
-The 'p4 branch' command is used to maintain mappings between
-different areas in the tree, and indicate related content. 'git p4'
+The `p4 branch` command is used to maintain mappings between
+different areas in the tree, and indicate related content. `git p4`
can use these mappings to determine branch relationships.
If you have a repository where all the branches of interest exist as
subdirectories of a single depot path, you can use `--detect-branches`
-when cloning or syncing to have 'git p4' automatically find
+when cloning or syncing to have `git p4` automatically find
subdirectories in p4, and to generate these as branches in Git.
For example, if the P4 repository structure is:
@@ -515,17 +515,17 @@ For example, if the P4 repository structure is:
//depot/branch1/...
----
-And "p4 branch -o branch1" shows a View line that looks like:
+And `p4 branch -o branch1` shows a View line that looks like:
----
//depot/main/... //depot/branch1/...
----
-Then this 'git p4 clone' command:
+Then this `git p4 clone` command:
----
git p4 clone --detect-branches //depot@all
----
produces a separate branch in 'refs/remotes/p4/' for //depot/main,
-called 'master', and one for //depot/branch1 called 'depot/branch1'.
+called `master`, and one for //depot/branch1 called `depot/branch1`.
However, it is not necessary to create branches in p4 to be able to use
them like branches. Because it is difficult to infer branch
@@ -546,16 +546,16 @@ git p4 clone --detect-branches //depot@all .
PERFORMANCE
-----------
-The fast-import mechanism used by 'git p4' creates one pack file for
-each invocation of 'git p4 sync'. Normally, Git garbage compression
+The fast-import mechanism used by `git p4` creates one pack file for
+each invocation of `git p4 sync`. Normally, Git garbage compression
(linkgit:git-gc[1]) automatically compresses these to fewer pack files,
-but explicit invocation of 'git repack -adf' may improve performance.
+but explicit invocation of `git repack -adf` may improve performance.
CONFIGURATION VARIABLES
-----------------------
-The following config settings can be used to modify 'git p4' behavior.
-They all are in the 'git-p4' section.
+The following config settings can be used to modify `git p4` behavior.
+They all are in the `git-p4` section.
General variables
~~~~~~~~~~~~~~~~~
@@ -584,7 +584,7 @@ git-p4.client::
git-p4.retries::
Specifies the number of times to retry a p4 command (notably,
- 'p4 sync') if the network times out. The default value is 3.
+ `p4 sync`) if the network times out. The default value is 3.
Set the value to 0 to disable retries or if your p4 version
does not support retries (pre 2012.2).
@@ -619,7 +619,7 @@ git-p4.ignoredP4Labels::
unimportable labels are discovered.
git-p4.importLabels::
- Import p4 labels into git, as per `--import-labels`.
+ Import p4 labels into `git`, as per `--import-labels`.
git-p4.labelImportRegexp::
Only p4 labels matching this regular expression will be imported. The
@@ -633,14 +633,14 @@ git-p4.useClientSpec::
git-p4.pathEncoding::
Perforce keeps the encoding of a path as given by the originating OS.
- Git expects paths encoded as UTF-8. Use this config to tell git-p4
+ Git expects paths encoded as UTF-8. Use this config to tell `git-p4`
what encoding Perforce had used for the paths. This encoding is used
to transcode the paths to UTF-8. As an example, Perforce on Windows
often uses "cp1252" to encode path names.
git-p4.largeFileSystem::
Specify the system that is used for large (binary) files. Please note
- that large file systems do not support the 'git p4 submit' command.
+ that large file systems do not support the `git p4 submit` command.
Only Git LFS is implemented right now (see https://git-lfs.github.com/
for more information). Download and install the Git LFS command line
extension to use this option and configure it like this:
@@ -687,21 +687,21 @@ Submit variables
~~~~~~~~~~~~~~~~
git-p4.detectRenames::
Detect renames. See linkgit:git-diff[1]. This can be true,
- false, or a score as expected by 'git diff -M'.
+ false, or a score as expected by `git diff -M`.
git-p4.detectCopies::
Detect copies. See linkgit:git-diff[1]. This can be true,
- false, or a score as expected by 'git diff -C'.
+ false, or a score as expected by `git diff -C`.
git-p4.detectCopiesHarder::
Detect copies harder. See linkgit:git-diff[1]. A boolean.
git-p4.preserveUser::
On submit, re-author changes to reflect the Git author,
- regardless of who invokes 'git p4 submit'.
+ regardless of who invokes `git p4 submit`.
git-p4.allowMissingP4Users::
- When 'preserveUser' is true, 'git p4' normally dies if it
+ When 'preserveUser' is true, `git p4` normally dies if it
cannot find an author in the p4 user map. This setting
submits the change regardless.
@@ -711,24 +711,24 @@ git-p4.skipSubmitEdit::
step is skipped.
git-p4.skipSubmitEditCheck::
- After editing the p4 change message, 'git p4' makes sure that
+ After editing the p4 change message, `git p4` makes sure that
the description really was changed by looking at the file
modification time. This option disables that test.
git-p4.allowSubmit::
- By default, any branch can be used as the source for a 'git p4
- submit' operation. This configuration variable, if set, permits only
+ By default, any branch can be used as the source for a `git p4
+ submit` operation. This configuration variable, if set, permits only
the named branches to be used as submit sources. Branch names
must be the short names (no "refs/heads/"), and should be
separated by commas (","), with no spaces.
git-p4.skipUserNameCheck::
- If the user running 'git p4 submit' does not exist in the p4
- user map, 'git p4' exits. This option can be used to force
+ If the user running `git p4 submit` does not exist in the p4
+ user map, `git p4` exits. This option can be used to force
submission regardless.
git-p4.attemptRCSCleanup::
- If enabled, 'git p4 submit' will attempt to cleanup RCS keywords
+ If enabled, `git p4 submit` will attempt to cleanup RCS keywords
($Header$, etc). These would otherwise cause merge conflicts and prevent
the submit going ahead. This option should be considered experimental at
present.
@@ -754,11 +754,11 @@ IMPLEMENTATION DETAILS
----------------------
* Changesets from p4 are imported using Git fast-import.
* Cloning or syncing does not require a p4 client; file contents are
- collected using 'p4 print'.
+ collected using `p4 print`.
* Submitting requires a p4 client, which is not in the same location
as the Git repository. Patches are applied, one at a time, to
this p4 client and submitted from there.
-* Each commit imported by 'git p4' has a line at the end of the log
+* Each commit imported by `git p4` has a line at the end of the log
message indicating the p4 depot location and change number. This
- line is used by later 'git p4 sync' operations to know which p4
+ line is used by later `git p4 sync` operations to know which p4
changes are new.
diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index a78721517b..e98e1f858b 100644
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -9,7 +9,7 @@ git-pack-objects - Create a packed archive of objects
SYNOPSIS
--------
[verse]
-'git pack-objects' [-q | --progress | --all-progress] [--all-progress-implied]
+`git pack-objects` [-q | --progress | --all-progress] [--all-progress-implied]
[--no-reuse-delta] [--delta-base-offset] [--non-empty]
[--local] [--incremental] [--window=<n>] [--depth=<n>]
[--revs [--unpacked | --all]] [--keep-pack=<pack-name>]
@@ -39,7 +39,7 @@ archive (.pack) in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or
any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)
enables Git to read from the pack archive.
-The 'git unpack-objects' command can read the packed archive and
+The `git unpack-objects` command can read the packed archive and
expand the objects contained in the pack into "one-file
one-object" format; this is typically done by the smart-pull
commands when a pack is created on-the-fly for efficient network
@@ -63,7 +63,7 @@ base-name::
--revs::
Read the revision arguments from the standard input, instead of
individual object names. The revision arguments are processed
- the same way as 'git rev-list' with the `--objects` flag
+ the same way as `git rev-list` with the `--objects` flag
uses its `commit` arguments to build the list of objects it
outputs. The objects on the resulting list are packed.
Besides revisions, `--not` or `--shallow <SHA-1>` lines are
@@ -236,7 +236,7 @@ self-contained. Use `git index-pack --fix-thin`
A packed archive can express the base object of a delta as
either a 20-byte object name or as an offset in the
stream, but ancient versions of Git don't understand the
- latter. By default, 'git pack-objects' only uses the
+ latter. By default, `git pack-objects` only uses the
former format for better compatibility. This option
allows the command to use the latter format for
compactness. Depending on the average delta chain
diff --git a/Documentation/git-pack-redundant.txt b/Documentation/git-pack-redundant.txt
index f2869da572..a288be2c12 100644
--- a/Documentation/git-pack-redundant.txt
+++ b/Documentation/git-pack-redundant.txt
@@ -9,7 +9,7 @@ git-pack-redundant - Find redundant pack files
SYNOPSIS
--------
[verse]
-'git pack-redundant' [ --verbose ] [ --alt-odb ] < --all | .pack filename ... >
+`git pack-redundant` [ --verbose ] [ --alt-odb ] < --all | .pack filename ... >
DESCRIPTION
-----------
@@ -17,7 +17,7 @@ This program computes which packs in your repository
are redundant. The output is suitable for piping to
`xargs rm` if you are in the root of the repository.
-'git pack-redundant' accepts a list of objects on standard input. Any objects
+`git pack-redundant` accepts a list of objects on standard input. Any objects
given will be ignored when checking which packs are required. This makes the
following command useful when wanting to remove packs which contain unreachable
objects.
diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt
index 154081f2de..7e62ff3e8d 100644
--- a/Documentation/git-pack-refs.txt
+++ b/Documentation/git-pack-refs.txt
@@ -8,7 +8,7 @@ git-pack-refs - Pack heads and tags for efficient repository access
SYNOPSIS
--------
[verse]
-'git pack-refs' [--all] [--no-prune]
+`git pack-refs` [--all] [--no-prune]
DESCRIPTION
-----------
diff --git a/Documentation/git-patch-id.txt b/Documentation/git-patch-id.txt
index fb5b194b8a..5e8747f673 100644
--- a/Documentation/git-patch-id.txt
+++ b/Documentation/git-patch-id.txt
@@ -8,7 +8,7 @@ git-patch-id - Compute unique ID for a patch
SYNOPSIS
--------
[verse]
-'git patch-id' [--stable | --unstable]
+`git patch-id` [--stable | --unstable]
DESCRIPTION
-----------
@@ -21,7 +21,7 @@ have the same "patch ID" are almost guaranteed to be the same thing.
IOW, you can use this thing to look for likely duplicate commits.
-When dealing with 'git diff-tree' output, it takes advantage of
+When dealing with `git diff-tree` output, it takes advantage of
the fact that the patch is prefixed with the object name of the
commit, and outputs two 40-byte hexadecimal strings. The first
string is the patch ID, and the second string is the commit ID.
@@ -39,19 +39,19 @@ OPTIONS
as a key to index some meta-information about the change between
the two trees;
- - Result is different from the value produced by git 1.9 and older
+ - Result is different from the value produced by `git` 1.9 and older
or produced when an "unstable" hash (see `--unstable` below) is
configured - even when used on a diff output taken without any use
of `-O<orderfile>`, thereby making existing databases storing such
"unstable" or historical patch-ids unusable.
- This is the default if patchid.stable is set to true.
+ This is the default if `patchid.stable` is set to true.
--unstable::
Use an "unstable" hash as the patch ID. With this option,
the result produced is compatible with the patch-id value produced
- by git 1.9 and older. Users with pre-existing databases storing
- patch-ids produced by git 1.9 and older (who do not deal with reordered
+ by `git` 1.9 and older. Users with pre-existing databases storing
+ patch-ids produced by `git` 1.9 and older (who do not deal with reordered
patches) may want to use this option.
This is the default.
diff --git a/Documentation/git-prune-packed.txt b/Documentation/git-prune-packed.txt
index 9fed59a317..77603fd5e2 100644
--- a/Documentation/git-prune-packed.txt
+++ b/Documentation/git-prune-packed.txt
@@ -9,7 +9,7 @@ git-prune-packed - Remove extra objects that are already in pack files
SYNOPSIS
--------
[verse]
-'git prune-packed' [-n|--dry-run] [-q|--quiet]
+`git prune-packed` [-n|--dry-run] [-q|--quiet]
DESCRIPTION
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt
index 7bad035e47..4cdd753c13 100644
--- a/Documentation/git-prune.txt
+++ b/Documentation/git-prune.txt
@@ -9,21 +9,21 @@ git-prune - Prune all unreachable objects from the object database
SYNOPSIS
--------
[verse]
-'git prune' [-n] [-v] [--progress] [--expire <time>] [--] [<head>...]
+`git prune` [-n] [-v] [--progress] [--expire <time>] [--] [<head>...]
DESCRIPTION
-----------
-NOTE: In most cases, users should run 'git gc', which calls
-'git prune'. See the section "NOTES", below.
+NOTE: In most cases, users should run `git gc`, which calls
+`git prune`. See the section "NOTES", below.
-This runs 'git fsck --unreachable' using all the refs
+This runs `git fsck --unreachable` using all the refs
available in `refs/`, optionally with additional set of
objects specified on the command line, and prunes all unpacked
objects unreachable from any of these head objects from the object database.
In addition, it
prunes the unpacked objects that are also found in packs by
-running 'git prune-packed'.
+running `git prune-packed`.
It also removes entries from .git/shallow that are not reachable by
any ref.
@@ -70,12 +70,12 @@ $ git prune $(cd ../another && git rev-parse --all)
NOTES
-----
-In most cases, users will not need to call 'git prune' directly, but
-should instead call 'git gc', which handles pruning along with
+In most cases, users will not need to call `git prune` directly, but
+should instead call `git gc`, which handles pruning along with
many other housekeeping tasks.
For a description of which objects are considered for pruning, see
-'git fsck''s `--unreachable` option.
+`git fsck`'s `--unreachable` option.
SEE ALSO
--------
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index e637686597..a64a137a89 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -9,7 +9,7 @@ git-pull - Fetch from and integrate with another repository or a local branch
SYNOPSIS
--------
[verse]
-'git pull' [<options>] [<repository> [<refspec>...]]
+`git pull` [<options>] [<repository> [<refspec>...]]
DESCRIPTION
@@ -19,10 +19,10 @@ Incorporates changes from a remote repository into the current
branch. In its default mode, `git pull` is shorthand for
`git fetch` followed by `git merge FETCH_HEAD`.
-More precisely, 'git pull' runs 'git fetch' with the given
-parameters and calls 'git merge' to merge the retrieved branch
+More precisely, `git pull` runs `git fetch` with the given
+parameters and calls `git merge` to merge the retrieved branch
heads into the current branch.
-With `--rebase`, it runs 'git rebase' instead of 'git merge'.
+With `--rebase`, it runs `git rebase` instead of `git merge`.
<repository> should be the name of a remote repository as
passed to linkgit:git-fetch[1]. <refspec> can name an
@@ -62,7 +62,7 @@ See linkgit:git-merge[1] for details, including how conflicts
are presented and handled.
In Git 1.7.0 or later, to cancel a conflicting merge, use
-`git reset --merge`. *Warning*: In older versions of Git, running 'git pull'
+`git reset --merge`. *Warning*: In older versions of Git, running `git pull`
with uncommitted changes is discouraged: while possible, it leaves you
in a state that may be hard to back out of in the case of a conflict.
@@ -76,13 +76,13 @@ OPTIONS
-q::
--quiet::
- This is passed to both underlying git-fetch to squelch reporting of
- during transfer, and underlying git-merge to squelch output during
+ This is passed to both underlying `git-fetch` to squelch reporting of
+ during transfer, and underlying `git-merge` to squelch output during
merging.
-v::
--verbose::
- Pass `--verbose` to git-fetch and git-merge.
+ Pass `--verbose` to `git-fetch` and `git-merge`.
--[no-]recurse-submodules[=yes|on-demand|no]::
This option controls if new commits of populated submodules should
@@ -232,7 +232,7 @@ $ git merge origin/next
If you tried a pull which resulted in complex conflicts and
-would want to start over, you can recover with 'git reset'.
+would want to start over, you can recover with `git reset`.
include::transfer-data-leaks.txt[]
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index aa5db3e6e5..842cbbaeca 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -9,7 +9,7 @@ git-push - Update remote refs along with associated objects
SYNOPSIS
--------
[verse]
-'git push' [--all | --mirror | --tags] [--follow-tags] [--atomic] [-n | --dry-run] [--receive-pack=<git-receive-pack>]
+`git push` [--all | --mirror | --tags] [--follow-tags] [--atomic] [-n | --dry-run] [--receive-pack=<git-receive-pack>]
[--repo=<repository>] [-f | --force] [-d | --delete] [--prune] [-v | --verbose]
[-u | --set-upstream] [-o <string> | --push-option=<string>]
[--[no-]signed|--signed=(true|false|if-asked)]
@@ -226,7 +226,7 @@ already exists on the remote side.
--receive-pack=<git-receive-pack>::
--exec=<git-receive-pack>::
- Path to the 'git-receive-pack' program on the remote
+ Path to the `git-receive-pack` program on the remote
end. Sometimes useful when pushing to a remote
repository over ssh, and you do not have the program in
a directory on the default $PATH.
@@ -234,11 +234,11 @@ already exists on the remote side.
--[no-]force-with-lease::
--force-with-lease=<refname>::
--force-with-lease=<refname>:<expect>::
- Usually, "git push" refuses to update a remote ref that is
+ Usually, `git push` refuses to update a remote ref that is
not an ancestor of the local ref used to overwrite it.
+
This option overrides this restriction if the current value of the
-remote ref is the expected value. "git push" fails otherwise.
+remote ref is the expected value. `git push` fails otherwise.
+
Imagine that you have to rebase what you have already published.
You will have to bypass the "must fast-forward" rule in order to
@@ -432,7 +432,7 @@ include::urls-remotes.txt[]
OUTPUT
------
-The output of "git push" depends on the transport method used; this
+The output of `git push` depends on the transport method used; this
section describes the output when pushing over the Git protocol (either
locally or via ssh).
@@ -547,8 +547,8 @@ the other person (history from X to A), you would need to first fetch the
history from the repository, create a history that contains changes done
by both parties, and push the result back.
-You can perform "git pull", resolve potential conflicts, and "git push"
-the result. A "git pull" will create a merge commit C between commits A
+You can perform `git pull`, resolve potential conflicts, and `git push`
+the result. A `git pull` will create a merge commit C between commits A
and B.
----------------
@@ -563,7 +563,7 @@ Updating A with the resulting merge commit will fast-forward and your
push will be accepted.
Alternatively, you can rebase your change between X and B on top of A,
-with "git pull --rebase", and push the result back. The rebase will
+with `git pull --rebase`, and push the result back. The rebase will
create a new commit D that builds the change between X and B on top of
A.
@@ -581,12 +581,12 @@ accepted.
There is another common situation where you may encounter non-fast-forward
rejection when you try to push, and it is possible even when you are
pushing into a repository nobody else pushes into. After you push commit
-A yourself (in the first picture in this section), replace it with "git
-commit --amend" to produce commit B, and you try to push it out, because
+A yourself (in the first picture in this section), replace it with `git
+commit --amend` to produce commit B, and you try to push it out, because
forgot that you have pushed A out already. In such a case, and only if
you are certain that nobody in the meantime fetched your earlier commit A
-(and started building on top of it), you can run "git push --force" to
-overwrite it. In other words, "git push --force" is a method reserved for
+(and started building on top of it), you can run `git push --force` to
+overwrite it. In other words, `git push --force` is a method reserved for
a case where you do mean to lose history.
diff --git a/Documentation/git-quiltimport.txt b/Documentation/git-quiltimport.txt
index edae01d55d..831bf55ed8 100644
--- a/Documentation/git-quiltimport.txt
+++ b/Documentation/git-quiltimport.txt
@@ -9,7 +9,7 @@ git-quiltimport - Applies a quilt patchset onto the current branch
SYNOPSIS
--------
[verse]
-'git quiltimport' [--dry-run | -n] [--author <author>] [--patches <dir>]
+`git quiltimport` [--dry-run | -n] [--author <author>] [--patches <dir>]
[--series <file>] [--keep-non-patch]
@@ -57,7 +57,7 @@ or the value of the `$QUILT_SERIES` environment
variable.
--keep-non-patch::
- Pass `-b` flag to 'git mailinfo' (see linkgit:git-mailinfo[1]).
+ Pass `-b` flag to `git mailinfo` (see linkgit:git-mailinfo[1]).
GIT
---
diff --git a/Documentation/git-range-diff.txt b/Documentation/git-range-diff.txt
index fe350d7f40..2de9ca2d08 100644
--- a/Documentation/git-range-diff.txt
+++ b/Documentation/git-range-diff.txt
@@ -8,7 +8,7 @@ git-range-diff - Compare two commit ranges (e.g. two versions of a branch)
SYNOPSIS
--------
[verse]
-'git range-diff' [--color=[<when>]] [--no-color] [<diff-options>]
+`git range-diff` [--color=[<when>]] [--no-color] [<diff-options>]
[--no-dual-color] [--creation-factor=<factor>]
[--left-only | --right-only]
( <range1> <range2> | <rev1>...<rev2> | <base> <rev1> <rev2> )
diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index d22d3855d1..380f87b6e8 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -9,7 +9,7 @@ git-read-tree - Reads tree information into the index
SYNOPSIS
--------
[verse]
-'git read-tree' [[-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>]
+`git read-tree` [[-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>]
[-u [--exclude-per-directory=<gitignore>] | -i]]
[--index-output=<file>] [--no-sparse-checkout]
(--empty | <tree-ish1> [<tree-ish2> [<tree-ish3>]])
@@ -26,8 +26,8 @@ fast-forward (i.e. 2-way) merge, or a 3-way merge, with the `-m`
flag. When used with `-m`, the `-u` flag causes it to also update
the files in the work tree with the result of the merge.
-Trivial merges are done by 'git read-tree' itself. Only conflicting paths
-will be in unmerged state when 'git read-tree' returns.
+Trivial merges are done by `git read-tree` itself. Only conflicting paths
+will be in unmerged state when `git read-tree` returns.
OPTIONS
-------
@@ -64,13 +64,13 @@ OPTIONS
Show the progress of checking files out.
--trivial::
- Restrict three-way merge by 'git read-tree' to happen
+ Restrict three-way merge by `git read-tree` to happen
only if there is no file-level merging required, instead
of resolving merge for trivial cases and leaving
conflicting files unresolved in the index.
--aggressive::
- Usually a three-way merge by 'git read-tree' resolves
+ Usually a three-way merge by `git read-tree` resolves
the merge for really trivial cases and leaves other
cases unresolved in the index, so that porcelains can
implement different merge policies. This flag makes the
@@ -139,7 +139,7 @@ OPTIONS
MERGING
-------
-If `-m` is specified, 'git read-tree' can perform 3 kinds of
+If `-m` is specified, `git read-tree` can perform 3 kinds of
merge, a single tree merge if only 1 tree is given, a
fast-forward merge with 2 trees, or a 3-way merge if 3 or more trees are
provided.
@@ -147,18 +147,18 @@ provided.
Single Tree Merge
~~~~~~~~~~~~~~~~~
-If only 1 tree is specified, 'git read-tree' operates as if the user did not
+If only 1 tree is specified, `git read-tree` operates as if the user did not
specify `-m`, except that if the original index has an entry for a
given pathname, and the contents of the path match with the tree
being read, the stat info from the index is used. (In other words, the
index's stat()s take precedence over the merged tree's).
That means that if you do a `git read-tree -m <newtree>` followed by a
-`git checkout-index -f -u -a`, the 'git checkout-index' only checks out
+`git checkout-index -f -u -a`, the `git checkout-index` only checks out
the stuff that really changed.
-This is used to avoid unnecessary false hits when 'git diff-files' is
-run after 'git read-tree'.
+This is used to avoid unnecessary false hits when `git diff-files` is
+run after `git read-tree`.
Two Tree Merge
@@ -169,7 +169,7 @@ is the head commit of the current repository, and $M is the head
of a foreign tree, which is simply ahead of $H (i.e. we are in a
fast-forward situation).
-When two trees are specified, the user is telling 'git read-tree'
+When two trees are specified, the user is telling `git read-tree`
the following:
1. The current index and work tree is derived from $H, but
@@ -226,10 +226,10 @@ refer to the presence of a path in the specified commit:
In all "keep index" cases, the index entry stays as in the
original index file. If the entry is not up to date,
-'git read-tree' keeps the copy in the work tree intact when
+`git read-tree` keeps the copy in the work tree intact when
operating under the `-u` flag.
-When this form of 'git read-tree' returns successfully, you can
+When this form of `git read-tree` returns successfully, you can
see which of the "local changes" that you made were carried forward by running
`git diff-index --cached $M`. Note that this does not
necessarily match what `git diff-index --cached $H` would have
@@ -252,7 +252,7 @@ of the path is kept as long as $H and $M are the same.
Each "index" entry has two bits worth of "stage" state. stage 0 is the
normal one, and is the only one you'd see in any kind of normal use.
-However, when you do 'git read-tree' with three trees, the "stage"
+However, when you do `git read-tree` with three trees, the "stage"
starts out at 1.
This means that you can do
@@ -268,7 +268,7 @@ branch into the current branch, we use the common ancestor tree
as <tree1>, the current branch head as <tree2>, and the other
branch head as <tree3>.
-Furthermore, 'git read-tree' has special-case logic that says: if you see
+Furthermore, `git read-tree` has special-case logic that says: if you see
a file that matches in all respects in the following states, it
"collapses" back to "stage0":
@@ -284,7 +284,7 @@ a file that matches in all respects in the following states, it
- stage 1 and stage 3 are the same and stage 2 is different take
stage 2 (we did something while they did nothing)
-The 'git write-tree' command refuses to write a nonsensical tree, and it
+The `git write-tree` command refuses to write a nonsensical tree, and it
will complain about unmerged entries if it sees a single entry that is not
stage 0.
@@ -300,7 +300,7 @@ start a 3-way merge with an index file that is already
populated. Here is an outline of how the algorithm works:
- if a file exists in identical format in all three trees, it will
- automatically collapse to "merged" state by 'git read-tree'.
+ automatically collapse to "merged" state by `git read-tree`.
- a file that has _any_ difference what-so-ever in the three trees
will stay as separate entries in the index. It's up to "porcelain
@@ -324,8 +324,8 @@ populated. Here is an outline of how the algorithm works:
matching "stage1" entry if it exists too. .. all the normal
trivial rules ..
-You would normally use 'git merge-index' with supplied
-'git merge-one-file' to do this last step. The script updates
+You would normally use `git merge-index` with supplied
+`git merge-one-file` to do this last step. The script updates
the files in the working tree as it merges each path and at the
end of a successful merge.
@@ -347,7 +347,7 @@ $ JC=`git rev-parse --verify "HEAD^0"`
$ git checkout-index -f -u -a $JC
----------------
-You do random edits, without running 'git update-index'. And then
+You do random edits, without running `git update-index`. And then
you notice that the tip of your "upstream" tree has advanced
since you pulled from him:
@@ -373,14 +373,14 @@ your work-in-progress changes, and your work tree would be
updated to the result of the merge.
However, if you have local changes in the working tree that
-would be overwritten by this merge, 'git read-tree' will refuse
+would be overwritten by this merge, `git read-tree` will refuse
to run to prevent your changes from being lost.
In other words, there is no need to worry about what exists only
in the working tree. When you have local changes in a part of
the project that is not involved in the merge, your changes do
not interfere with the merge, and are kept intact. When they
-*do* interfere, the merge does not even start ('git read-tree'
+*do* interfere, the merge does not even start (`git read-tree`
complains loudly and fails without modifying anything). In such
a case, you can simply continue doing what you were in the
middle of doing, and when your working tree is ready (i.e. you
@@ -394,10 +394,10 @@ SPARSE CHECKOUT
It uses the skip-worktree bit (see linkgit:git-update-index[1]) to tell
Git whether a file in the working directory is worth looking at.
-'git read-tree' and other merge-based commands ('git merge', 'git
-checkout'...) can help maintaining the skip-worktree bitmap and working
+`git read-tree` and other merge-based commands (`git merge`, `git
+checkout`...) can help maintaining the skip-worktree bitmap and working
directory update. `$GIT_DIR/info/sparse-checkout` is used to
-define the skip-worktree reference bitmap. When 'git read-tree' needs
+define the skip-worktree reference bitmap. When `git read-tree` needs
to update the working directory, it resets the skip-worktree bit in the index
based on this file, which uses the same syntax as .gitignore files.
If an entry matches a pattern in this file, skip-worktree will not be
@@ -427,8 +427,8 @@ follows:
/*
----------------
-Then you can disable sparse checkout. Sparse checkout support in 'git
-read-tree' and similar commands is disabled by default. You need to
+Then you can disable sparse checkout. Sparse checkout support in `git
+read-tree` and similar commands is disabled by default. You need to
turn `core.sparseCheckout` on in order to have sparse checkout
support.
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 22287372f7..ddc76ca308 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -8,15 +8,15 @@ git-rebase - Reapply commits on top of another base tip
SYNOPSIS
--------
[verse]
-'git rebase' [-i | --interactive] [<options>] [--exec <cmd>]
+`git rebase` [-i | --interactive] [<options>] [--exec <cmd>]
[--onto <newbase> | --keep-base] [<upstream> [<branch>]]
-'git rebase' [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
+`git rebase` [-i | --interactive] [<options>] [--exec <cmd>] [--onto <newbase>]
--root [<branch>]
-'git rebase' (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)
+`git rebase` (--continue | --skip | --abort | --quit | --edit-todo | --show-current-patch)
DESCRIPTION
-----------
-If <branch> is specified, 'git rebase' will perform an automatic
+If <branch> is specified, `git rebase` will perform an automatic
`git switch <branch>` before doing anything else. Otherwise
it remains on the current branch.
@@ -178,8 +178,8 @@ This is useful if F and G were flawed in some way, or should not be
part of topicA. Note that the argument to `--onto` and the <upstream>
parameter can be any valid commit-ish.
-In case of conflict, 'git rebase' will stop at the first problematic commit
-and leave conflict markers in the tree. You can use 'git diff' to locate
+In case of conflict, `git rebase` will stop at the first problematic commit
+and leave conflict markers in the tree. You can use `git diff` to locate
the markers (<<<<<<) and make edits to resolve the conflict. For each
file you edit, you need to tell Git that the conflict has been resolved,
typically this would be done with
@@ -195,7 +195,7 @@ desired resolution, you can continue the rebasing process with
git rebase --continue
-Alternatively, you can undo the 'git rebase' with
+Alternatively, you can undo the `git rebase` with
git rebase --abort
@@ -221,8 +221,8 @@ leave out at most one of A and B, in which case it defaults to `HEAD`.
--keep-base::
Set the starting point at which to create the new commits to the
merge base of <upstream> <branch>. Running
- 'git rebase --keep-base <upstream> <branch>' is equivalent to
- running 'git rebase --onto <upstream>... <upstream>'.
+ `git rebase --keep-base <upstream> <branch>` is equivalent to
+ running `git rebase --onto <upstream>... <upstream>`.
+
This option is useful in the case where one is developing a feature on
top of an upstream branch. While the feature is being worked on, the
@@ -361,10 +361,10 @@ See also INCOMPATIBLE OPTIONS below.
-s <strategy>::
--strategy=<strategy>::
Use the given merge strategy.
- If there is no `-s` option 'git merge-recursive' is used
+ If there is no `-s` option `git merge-recursive` is used
instead. This implies `--merge`.
+
-Because 'git rebase' replays each commit from the working branch
+Because `git rebase` replays each commit from the working branch
on top of the <upstream> branch using the given strategy, using
the 'ours' strategy simply empties all patches from the <branch>,
which makes little sense.
@@ -476,7 +476,7 @@ intended to modify whitespace and nothing else will be dropped, even
if the other side had no changes that conflicted.
--whitespace=<option>::
- This flag is passed to the 'git apply' program
+ This flag is passed to the `git apply` program
(see linkgit:git-apply[1]) that applies the patch.
Implies `--apply`.
+
@@ -756,7 +756,7 @@ commit of the rebase, not the intermediate commits nor the final
commit. In each case, the calling of these hooks was by accident of
implementation rather than by design (both backends were originally
implemented as shell scripts and happened to invoke other commands
-like 'git checkout' or 'git commit' that would call the hooks). Both
+like `git checkout` or `git commit` that would call the hooks). Both
backends should have the same behavior, though it is not entirely
clear which, if any, is correct. We will likely make rebase stop
calling either of these hooks in the future.
@@ -807,11 +807,11 @@ include::merge-strategies.txt[]
NOTES
-----
-You should understand the implications of using 'git rebase' on a
+You should understand the implications of using `git rebase` on a
repository that you share. See also RECOVERING FROM UPSTREAM REBASE
below.
-When the git-rebase command is run, it will first execute a "pre-rebase"
+When the `git-rebase` command is run, it will first execute a "pre-rebase"
hook if one exists. You can use this hook to do sanity checks and
reject the rebase if it isn't appropriate. Please see the template
pre-rebase hook script for an example.
@@ -866,12 +866,12 @@ pick fa1afe1 The oneline of the next commit
...
-------------------------------------------
-The oneline descriptions are purely for your pleasure; 'git rebase' will
+The oneline descriptions are purely for your pleasure; `git rebase` will
not look at them but at the commit names ("deadbee" and "fa1afe1" in this
example), so do not delete or edit the names.
By replacing the command "pick" with the command "edit", you can tell
-'git rebase' to stop after applying that commit, so that you can edit
+`git rebase` to stop after applying that commit, so that you can edit
the files and/or the commit message, amend the commit, and continue
rebasing.
@@ -900,13 +900,13 @@ commit, the message from the final one is used. You can also use
an editor.
-'git rebase' will stop when "pick" has been replaced with "edit" or
+`git rebase` will stop when "pick" has been replaced with "edit" or
when a command fails due to merge errors. When you are done editing
and/or resolving conflicts you can continue with `git rebase --continue`.
For example, if you want to reorder the last 5 commits, such that what
was `HEAD~4` becomes the new `HEAD`. To achieve that, you would call
-'git rebase' like this:
+`git rebase` like this:
----------------------
$ git rebase -i HEAD~5
@@ -979,7 +979,7 @@ SPLITTING COMMITS
-----------------
In interactive mode, you can mark commits with the action "edit". However,
-this does not necessarily mean that 'git rebase' expects the result of this
+this does not necessarily mean that `git rebase` expects the result of this
edit to be exactly one commit. Indeed, you can undo the commit, or you can
add other commits. This can be used to split a commit into two:
@@ -995,7 +995,7 @@ add other commits. This can be used to split a commit into two:
- Now add the changes to the index that you want to have in the first
commit. You can use `git add` (possibly interactively) or
- 'git gui' (or both) to do that.
+ `git gui` (or both) to do that.
- Commit the now-current index with whatever commit message is appropriate
now.
@@ -1006,7 +1006,7 @@ add other commits. This can be used to split a commit into two:
If you are not absolutely sure that the intermediate revisions are
consistent (they compile, pass the testsuite, etc.) you should use
-'git stash' to stash away the not-yet-committed changes
+`git stash` to stash away the not-yet-committed changes
after each commit, test, and amend the commit if fixes are necessary.
@@ -1082,7 +1082,7 @@ Only works if the changes (patch IDs based on the diff contents) on
`subsystem` are literally the same before and after the rebase
`subsystem` did.
-In that case, the fix is easy because 'git rebase' knows to skip
+In that case, the fix is easy because `git rebase` knows to skip
changes that are already present in the new upstream (unless
`--reapply-cherry-picks` is given). So if you say
(assuming you're on `topic`)
@@ -1110,7 +1110,7 @@ NOTE: While an "easy case recovery" sometimes appears to be successful
example, a commit that was removed via `git rebase
--interactive` will be **resurrected**!
-The idea is to manually tell 'git rebase' "where the old `subsystem`
+The idea is to manually tell `git rebase` "where the old `subsystem`
ended and your `topic` began", that is, what the old merge base
between them was. You will have to find a way to name the last commit
of the old `subsystem`, for example:
diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt
index e6136a0938..5fc47a9ebd 100644
--- a/Documentation/git-receive-pack.txt
+++ b/Documentation/git-receive-pack.txt
@@ -9,27 +9,27 @@ git-receive-pack - Receive what is pushed into the repository
SYNOPSIS
--------
[verse]
-'git-receive-pack' <directory>
+`git-receive-pack` <directory>
DESCRIPTION
-----------
-Invoked by 'git send-pack' and updates the repository with the
+Invoked by `git send-pack` and updates the repository with the
information fed from the remote end.
This command is usually not invoked directly by the end user.
-The UI for the protocol is on the 'git send-pack' side, and the
+The UI for the protocol is on the `git send-pack` side, and the
program pair is meant to be used to push updates to remote
repository. For pull operations, see linkgit:git-fetch-pack[1].
The command allows for creation and fast-forwarding of sha1 refs
(heads/tags) on the remote end (strictly speaking, it is the
-local end 'git-receive-pack' runs, but to the user who is sitting at
+local end `git-receive-pack` runs, but to the user who is sitting at
the send-pack end, it is updating the remote. Confused?)
There are other real-world examples of using update and
post-update hooks found in the Documentation/howto directory.
-'git-receive-pack' honours the `receive.denyNonFastForwards` config
+`git-receive-pack` honours the `receive.denyNonFastForwards` config
option, which tells it if updates to a ref should be denied if they
are not fast-forwards.
@@ -80,25 +80,25 @@ the following environment variables:
in the push certificate. If this does not match the value
recorded on the "nonce" header in the push certificate, it
may indicate that the certificate is a valid one that is
- being replayed from a separate "git push" session.
+ being replayed from a separate `git push` session.
`GIT_PUSH_CERT_NONCE_STATUS`::
`UNSOLICITED`;;
- "git push --signed" sent a nonce when we did not ask it to
+ `git push --signed` sent a nonce when we did not ask it to
send one.
`MISSING`;;
- "git push --signed" did not send any nonce header.
+ `git push --signed` did not send any nonce header.
`BAD`;;
- "git push --signed" sent a bogus nonce.
+ `git push --signed` sent a bogus nonce.
`OK`;;
- "git push --signed" sent the nonce we asked it to send.
+ `git push --signed` sent the nonce we asked it to send.
`SLOP`;;
- "git push --signed" sent a nonce different from what we
+ `git push --signed` sent a nonce different from what we
asked it to send now, but in a previous session. See
`GIT_PUSH_CERT_NONCE_SLOP` environment variable.
`GIT_PUSH_CERT_NONCE_SLOP`::
- "git push --signed" sent a nonce different from what we
+ `git push --signed` sent a nonce different from what we
asked it to send now, but in a different session whose
starting time is different by this many seconds from the
current session. Only meaningful when
@@ -196,7 +196,7 @@ non-zero exit code will generate an error message.
Note that it is possible for refname to not have sha1-new when this
hook runs. This can easily occur if another user modifies the ref
-after it was updated by 'git-receive-pack', but before the hook was able
+after it was updated by `git-receive-pack`, but before the hook was able
to evaluate it. It is recommended that hooks rely on sha1-new
rather than the current value of refname.
@@ -208,7 +208,7 @@ post-update will be called with the list of refs that have been updated.
This can be used to implement any repository wide cleanup tasks.
The exit code from this hook invocation is ignored; the only thing
-left for 'git-receive-pack' to do at that point is to exit itself
+left for `git-receive-pack` to do at that point is to exit itself
anyway.
This hook can be used, for example, to run `git update-server-info`
diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt
index cf1d7e0810..c33a577a00 100644
--- a/Documentation/git-reflog.txt
+++ b/Documentation/git-reflog.txt
@@ -9,7 +9,7 @@ git-reflog - Manage reflog information
SYNOPSIS
--------
[verse]
-'git reflog' <subcommand> <options>
+`git reflog` <subcommand> <options>
DESCRIPTION
-----------
@@ -17,13 +17,13 @@ The command takes various subcommands, and different options
depending on the subcommand:
[verse]
-'git reflog' ['show'] [log-options] [<ref>]
-'git reflog expire' [--expire=<time>] [--expire-unreachable=<time>]
+`git reflog` ['show'] [log-options] [<ref>]
+`git reflog expire` [--expire=<time>] [--expire-unreachable=<time>]
[--rewrite] [--updateref] [--stale-fix]
[--dry-run | -n] [--verbose] [--all [--single-worktree] | <refs>...]
-'git reflog delete' [--rewrite] [--updateref]
+`git reflog delete` [--rewrite] [--updateref]
[--dry-run | -n] [--verbose] ref@\{specifier\}...
-'git reflog exists' <ref>
+`git reflog exists` <ref>
Reference logs, or "reflogs", record when the tips of branches and
other references were updated in the local repository. Reflogs are
@@ -112,7 +112,7 @@ Options for `expire`
a missing commit, tree, or blob object.
+
This computation involves traversing all the reachable objects, i.e. it
-has the same cost as 'git prune'. It is primarily intended to fix
+has the same cost as `git prune`. It is primarily intended to fix
corruption caused by garbage collecting using older versions of Git,
which didn't protect objects referred to by reflogs.
diff --git a/Documentation/git-remote-ext.txt b/Documentation/git-remote-ext.txt
index 88ea7e1cc0..fd9b621fa2 100644
--- a/Documentation/git-remote-ext.txt
+++ b/Documentation/git-remote-ext.txt
@@ -8,7 +8,7 @@ git-remote-ext - Bridge smart transport to external command.
SYNOPSIS
--------
[verse]
-git remote add <nick> "ext::<command>[ <arguments>...]"
+`git remote` add <nick> "ext::<command>[ <arguments>...]"
DESCRIPTION
-----------
@@ -16,8 +16,8 @@ This remote helper uses the specified '<command>' to connect
to a remote Git server.
Data written to stdin of the specified '<command>' is assumed
-to be sent to a git:// server, git-upload-pack, git-receive-pack
-or git-upload-archive (depending on situation), and data read
+to be sent to a git:// server, `git-upload-pack`, `git-receive-pack`
+or `git-upload-archive` (depending on situation), and data read
from stdout of <command> is assumed to be received from
the same service.
@@ -36,8 +36,8 @@ The following sequences have a special meaning:
upload-archive) of the service Git wants to invoke.
'%S'::
- Replaced with long name (git-receive-pack,
- git-upload-pack, or git-upload-archive) of the service
+ Replaced with long name (`git-receive-pack`,
+ `git-upload-pack`, or `git-upload-archive`) of the service
Git wants to invoke.
'%G' (must be the first characters in an argument)::
@@ -65,7 +65,7 @@ ENVIRONMENT VARIABLES PASSED TO COMMAND
---------------------------------------
GIT_EXT_SERVICE::
- Set to long name (git-upload-pack, etc...) of service helper needs
+ Set to long name (`git-upload-pack`, etc...) of service helper needs
to invoke.
GIT_EXT_SERVICE_NOPREFIX::
@@ -76,8 +76,8 @@ GIT_EXT_SERVICE_NOPREFIX::
EXAMPLES
--------
This remote helper is transparently used by Git when
-you use commands such as "git fetch <URL>", "git clone <URL>",
-, "git push <URL>" or "git remote add <nick> <URL>", where <URL>
+you use commands such as `git fetch <URL>`, `git clone <URL>`,
+, `git push <URL>` or `git remote add <nick> <URL>`, where <URL>
begins with `ext::`. Examples:
"ext::ssh -i /home/foo/.ssh/somekey user@host.example %S 'foo/repo'"::
@@ -87,32 +87,32 @@ begins with `ext::`. Examples:
"ext::socat -t3600 - ABSTRACT-CONNECT:/git-server %G/somerepo"::
Represents repository with path /somerepo accessible over
- git protocol at abstract namespace address /git-server.
+ `git protocol at abstract namespace address` /git-server.
"ext::git-server-alias foo %G/repo"::
Represents a repository with path /repo accessed using the
- helper program "git-server-alias foo". The path to the
+ helper program `git-server-alias foo`. The path to the
repository and type of request are not passed on the command
line but as part of the protocol stream, as usual with git://
protocol.
"ext::git-server-alias foo %G/repo %Vfoo"::
Represents a repository with path /repo accessed using the
- helper program "git-server-alias foo". The hostname for the
+ helper program `git-server-alias foo`. The hostname for the
remote server passed in the protocol stream will be "foo"
(this allows multiple virtual Git servers to share a
link-level address).
"ext::git-server-alias foo %G/repo% with% spaces %Vfoo"::
Represents a repository with path `/repo with spaces` accessed
- using the helper program "git-server-alias foo". The hostname for
+ using the helper program `git-server-alias foo`. The hostname for
the remote server passed in the protocol stream will be "foo"
(this allows multiple virtual Git servers to share a
link-level address).
"ext::git-ssl foo.example /bar"::
Represents a repository accessed using the helper program
- "git-ssl foo.example /bar". The type of request can be
+ `git-ssl foo.example /bar`. The type of request can be
determined by the helper using environment variables (see
above).
diff --git a/Documentation/git-remote-fd.txt b/Documentation/git-remote-fd.txt
index 0451ceb8a2..14868c4678 100644
--- a/Documentation/git-remote-fd.txt
+++ b/Documentation/git-remote-fd.txt
@@ -12,12 +12,12 @@ SYNOPSIS
DESCRIPTION
-----------
This helper uses specified file descriptors to connect to a remote Git server.
-This is not meant for end users but for programs and scripts calling git
-fetch, push or archive.
+This is not meant for end users but for programs and scripts calling `git
+fetch`, `push` or `archive`.
If only <infd> is given, it is assumed to be a bidirectional socket connected
-to remote Git server (git-upload-pack, git-receive-pack or
-git-upload-archive). If both <infd> and <outfd> are given, they are assumed
+to remote Git server (`git-upload-pack`, `git-receive-pack` or
+`git-upload-archive`). If both <infd> and <outfd> are given, they are assumed
to be pipes connected to a remote Git server (<infd> being the inbound pipe
and <outfd> being the outbound pipe.
@@ -37,14 +37,14 @@ EXAMPLES
--------
`git fetch fd::17 master`::
Fetch master, using file descriptor #17 to communicate with
- git-upload-pack.
+ `git-upload-pack`.
`git fetch fd::17/foo master`::
Same as above.
`git push fd::7,8 master (as URL)`::
Push master, using file descriptor #7 to read data from
- git-receive-pack and file descriptor #8 to write data to
+ `git-receive-pack` and file descriptor #8 to write data to
same service.
`git push fd::7,8/bar master`::
diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index a28c72a9e4..4df63cad06 100644
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -9,19 +9,19 @@ git-remote - Manage set of tracked repositories
SYNOPSIS
--------
[verse]
-'git remote' [-v | --verbose]
-'git remote add' [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=(fetch|push)] <name> <url>
-'git remote rename' <old> <new>
-'git remote remove' <name>
-'git remote set-head' <name> (-a | --auto | -d | --delete | <branch>)
-'git remote set-branches' [--add] <name> <branch>...
-'git remote get-url' [--push] [--all] <name>
-'git remote set-url' [--push] <name> <newurl> [<oldurl>]
-'git remote set-url --add' [--push] <name> <newurl>
-'git remote set-url --delete' [--push] <name> <url>
-'git remote' [-v | --verbose] 'show' [-n] <name>...
-'git remote prune' [-n | --dry-run] <name>...
-'git remote' [-v | --verbose] 'update' [-p | --prune] [(<group> | <remote>)...]
+`git remote` [-v | --verbose]
+`git remote add` [-t <branch>] [-m <master>] [-f] [--[no-]tags] [--mirror=(fetch|push)] <name> <url>
+`git remote rename` <old> <new>
+`git remote remove` <name>
+`git remote set-head` <name> (-a | --auto | -d | --delete | <branch>)
+`git remote set-branches` [--add] <name> <branch>...
+`git remote get-url` [--push] [--all] <name>
+`git remote set-url` [--push] <name> <newurl> [<oldurl>]
+`git remote set-url --add` [--push] <name> <newurl>
+`git remote set-url --delete` [--push] <name> <url>
+`git remote` [-v | --verbose] 'show' [-n] <name>...
+`git remote prune` [-n | --dry-run] <name>...
+`git remote` [-v | --verbose] 'update' [-p | --prune] [(<group> | <remote>)...]
DESCRIPTION
-----------
@@ -245,7 +245,7 @@ $ git switch -c staging staging/master
...
------------
-* Imitate 'git clone' but track only selected branches
+* Imitate `git clone` but track only selected branches
+
------------
$ mkdir project.git
diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt
index 98373e4f36..c99a70e426 100644
--- a/Documentation/git-repack.txt
+++ b/Documentation/git-repack.txt
@@ -9,7 +9,7 @@ git-repack - Pack unpacked objects in a repository
SYNOPSIS
--------
[verse]
-'git repack' [-a] [-A] [-d] [-f] [-F] [-l] [-n] [-q] [-b] [--window=<n>] [--depth=<n>] [--threads=<n>] [--keep-pack=<pack-name>]
+`git repack` [-a] [-A] [-d] [-f] [-F] [-l] [-n] [-q] [-b] [--window=<n>] [--depth=<n>] [--threads=<n>] [--keep-pack=<pack-name>]
DESCRIPTION
-----------
@@ -55,16 +55,16 @@ to the new separate pack will be written.
deleted by way of being left in the old pack and then
removed. Instead, the loose unreachable objects
will be pruned according to normal expiry rules
- with the next 'git gc' invocation. See linkgit:git-gc[1].
+ with the next `git gc` invocation. See linkgit:git-gc[1].
-d::
After packing, if the newly created packs make some
existing packs redundant, remove the redundant packs.
- Also run 'git prune-packed' to remove redundant
+ Also run `git prune-packed` to remove redundant
loose object files.
-l::
- Pass the `--local` option to 'git pack-objects'. See
+ Pass the `--local` option to `git pack-objects`. See
linkgit:git-pack-objects[1].
-f::
@@ -76,12 +76,12 @@ to the new separate pack will be written.
linkgit:git-pack-objects[1].
-q::
- Pass the `-q` option to 'git pack-objects'. See
+ Pass the `-q` option to `git pack-objects`. See
linkgit:git-pack-objects[1].
-n::
Do not update the server information with
- 'git update-server-info'. This option skips
+ `git update-server-info`. This option skips
updating local catalog files needed to publish
this repository (or a direct copy of it)
over HTTP or FTP. See linkgit:git-update-server-info[1].
@@ -195,7 +195,7 @@ Various configuration variables affect packing, see
linkgit:git-config[1] (search for "pack" and "delta").
By default, the command passes `--delta-base-offset` option to
-'git pack-objects'; this typically results in slightly smaller packs,
+`git pack-objects`; this typically results in slightly smaller packs,
but the generated packs are incompatible with versions of Git older than
version 1.4.4. If you need to share your repository with such ancient Git
versions, either directly or via the dumb http protocol, then you
diff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt
index f271d758c3..3da7c4de90 100644
--- a/Documentation/git-replace.txt
+++ b/Documentation/git-replace.txt
@@ -8,12 +8,12 @@ git-replace - Create, list, delete refs to replace objects
SYNOPSIS
--------
[verse]
-'git replace' [-f] <object> <replacement>
-'git replace' [-f] --edit <object>
-'git replace' [-f] --graft <commit> [<parent>...]
-'git replace' [-f] --convert-graft-file
-'git replace' -d <object>...
-'git replace' [--format=<format>] [-l [<pattern>]]
+`git replace` [-f] <object> <replacement>
+`git replace` [-f] --edit <object>
+`git replace` [-f] --graft <commit> [<parent>...]
+`git replace` [-f] --convert-graft-file
+`git replace` -d <object>...
+`git replace` [--format=<format>] [-l [<pattern>]]
DESCRIPTION
-----------
@@ -36,7 +36,7 @@ except those doing reachability traversal (prune, pack transfer and
fsck).
It is possible to disable use of replacement references for any
-command using the `--no-replace-objects` option just after 'git'.
+command using the `--no-replace-objects` option just after `git`.
For example if commit 'foo' has been replaced by commit 'bar':
@@ -100,7 +100,7 @@ OPTIONS
--list <pattern>::
List replace refs for objects that match the given pattern (or
all if no pattern is given).
- Typing "git replace" without arguments, also lists all replace
+ Typing `git replace` without arguments, also lists all replace
refs.
--format=<format>::
@@ -124,9 +124,9 @@ CREATING REPLACEMENT OBJECTS
----------------------------
linkgit:git-hash-object[1], linkgit:git-rebase[1], and
-https://github.com/newren/git-filter-repo[git-filter-repo], among other git commands, can be used to
+https://github.com/newren/git-filter-repo[git-filter-repo], among other `git` commands, can be used to
create replacement objects from existing objects. The `--edit` option
-can also be used with 'git replace' to create a replacement object by
+can also be used with `git replace` to create a replacement object by
editing an existing object.
If you want to replace many blobs, trees or commits that are part of a
@@ -142,7 +142,7 @@ replace them will not work properly. And using `git reset --hard` to
go back to a replaced commit will move the branch to the replacement
commit instead of the replaced commit.
-There may be other problems when using 'git rev-list' related to
+There may be other problems when using `git rev-list` related to
pending objects.
SEE ALSO
diff --git a/Documentation/git-request-pull.txt b/Documentation/git-request-pull.txt
index f58164aee1..e9e703a814 100644
--- a/Documentation/git-request-pull.txt
+++ b/Documentation/git-request-pull.txt
@@ -8,7 +8,7 @@ git-request-pull - Generates a summary of pending changes
SYNOPSIS
--------
[verse]
-'git request-pull' [-p] <start> <url> [<end>]
+`git request-pull` [-p] <start> <url> [<end>]
DESCRIPTION
-----------
diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt
index 25990dc40b..687b08d56c 100644
--- a/Documentation/git-rerere.txt
+++ b/Documentation/git-rerere.txt
@@ -8,7 +8,7 @@ git-rerere - Reuse recorded resolution of conflicted merges
SYNOPSIS
--------
[verse]
-'git rerere' ['clear'|'forget' <pathspec>|'diff'|'remaining'|'status'|'gc']
+`git rerere` ['clear'|'forget' <pathspec>|'diff'|'remaining'|'status'|'gc']
DESCRIPTION
-----------
@@ -31,14 +31,14 @@ enable this command.
COMMANDS
--------
-Normally, 'git rerere' is run without arguments or user-intervention.
+Normally, `git rerere` is run without arguments or user-intervention.
However, it has several commands that allow it to interact with
its working state.
'clear'::
Reset the metadata used by rerere if a merge resolution is to be
-aborted. Calling 'git am [--skip|--abort]' or 'git rebase [--skip|--abort]'
+aborted. Calling `git am [--skip|--abort]` or `git rebase [--skip|--abort]`
will automatically invoke this command.
'forget' <pathspec>::
@@ -153,32 +153,32 @@ finally ready and merged into the `master` branch. This merge
would require you to resolve the conflict, introduced by the
commits marked with `*`. However, this conflict is often the
same conflict you resolved when you created the test merge you
-blew away. 'git rerere' helps you resolve this final
+blew away. `git rerere` helps you resolve this final
conflicted merge using the information from your earlier hand
resolve.
-Running the 'git rerere' command immediately after a conflicted
+Running the `git rerere` command immediately after a conflicted
automerge records the conflicted working tree files, with the
usual conflict markers `<<<<<<<`, `=======`, and `>>>>>>>` in
them. Later, after you are done resolving the conflicts,
-running 'git rerere' again will record the resolved state of these
+running `git rerere` again will record the resolved state of these
files. Suppose you did this when you created the test merge of
`master` into the `topic` branch.
Next time, after seeing the same conflicted automerge,
-running 'git rerere' will perform a three-way merge between the
+running `git rerere` will perform a three-way merge between the
earlier conflicted automerge, the earlier manual resolution, and
the current conflicted automerge.
If this three-way merge resolves cleanly, the result is written
out to your working tree file, so you do not have to manually
-resolve it. Note that 'git rerere' leaves the index file alone,
+resolve it. Note that `git rerere` leaves the index file alone,
so you still need to do the final sanity checks with `git diff`
-(or `git diff -c`) and 'git add' when you are satisfied.
+(or `git diff -c`) and `git add` when you are satisfied.
-As a convenience measure, 'git merge' automatically invokes
-'git rerere' upon exiting with a failed automerge and 'git rerere'
+As a convenience measure, `git merge` automatically invokes
+`git rerere` upon exiting with a failed automerge and `git rerere`
records the hand resolve when it is a new conflict, or reuses the earlier hand
-resolve when it is not. 'git commit' also invokes 'git rerere'
+resolve when it is not. `git commit` also invokes `git rerere`
when committing a merge result. What this means is that you do
not have to do anything special yourself (besides enabling
the `rerere.enabled` config variable).
@@ -188,8 +188,8 @@ resolution is recorded, and it will be reused when you do the
actual merge later with the updated `master` and `topic` branch, as long
as the recorded resolution is still applicable.
-The information 'git rerere' records is also used when running
-'git rebase'. After blowing away the test merge and continuing
+The information `git rerere` records is also used when running
+`git rebase`. After blowing away the test merge and continuing
development on the `topic` branch:
------------
@@ -208,12 +208,12 @@ you could run `git rebase master topic`, to bring yourself
up to date before your topic is ready to be sent upstream.
This would result in falling back to a three-way merge, and it
would conflict the same way as the test merge you resolved earlier.
-'git rerere' will be run by 'git rebase' to help you resolve this
+`git rerere` will be run by `git rebase` to help you resolve this
conflict.
-[NOTE] 'git rerere' relies on the conflict markers in the file to
+[NOTE] `git rerere` relies on the conflict markers in the file to
detect the conflict. If the file already contains lines that look the
-same as lines with conflict markers, 'git rerere' may fail to record a
+same as lines with conflict markers, `git rerere` may fail to record a
conflict resolution. To work around this, the `conflict-marker-size`
setting in linkgit:gitattributes[5] can be used.
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 4a55d1f1ac..58fe574e71 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -8,10 +8,10 @@ git-reset - Reset current `HEAD` to the specified state
SYNOPSIS
--------
[verse]
-'git reset' [-q] [<tree-ish>] [--] <pathspec>...
-'git reset' [-q] [--pathspec-from-file=<file> [--pathspec-file-nul]] [<tree-ish>]
-'git reset' (--patch | -p) [<tree-ish>] [--] [<pathspec>...]
-'git reset' [--soft | --mixed [-N] | --hard | --merge | --keep] [-q] [<commit>]
+`git reset` [-q] [<tree-ish>] [--] <pathspec>...
+`git reset` [-q] [--pathspec-from-file=<file> [--pathspec-file-nul]] [<tree-ish>]
+`git reset` (--patch | -p) [<tree-ish>] [--] [<pathspec>...]
+`git reset` [--soft | --mixed [-N] | --hard | --merge | --keep] [-q] [<commit>]
DESCRIPTION
-----------
@@ -20,8 +20,8 @@ In the last form, set the current branch head (`HEAD`) to `<commit>`,
optionally modifying index and working tree to match.
The `<tree-ish>`/`<commit>` defaults to `HEAD` in all forms.
-'git reset' [-q] [<tree-ish>] [--] <pathspec>...::
-'git reset' [-q] [--pathspec-from-file=<file> [--pathspec-file-nul]] [<tree-ish>]::
+`git reset` [-q] [<tree-ish>] [--] <pathspec>...::
+`git reset` [-q] [--pathspec-from-file=<file> [--pathspec-file-nul]] [<tree-ish>]::
These forms reset the index entries for all paths that match the
`<pathspec>` to their state at `<tree-ish>`. (It does not affect
the working tree or the current branch.)
@@ -37,7 +37,7 @@ and specifying a commit with `--source`, you
can copy the contents of a path out of a commit to the index and to the
working tree in one go.
-'git reset' (--patch | -p) [<tree-ish>] [--] [<pathspec>...]::
+`git reset` (--patch | -p) [<tree-ish>] [--] [<pathspec>...]::
Interactively select hunks in the difference between the index
and `<tree-ish>` (defaults to `HEAD`). The chosen hunks are applied
in reverse to the index.
@@ -46,7 +46,7 @@ This means that `git reset -p` is the opposite of `git add -p`, i.e.
you can use it to selectively reset hunks. See the ``Interactive Mode''
section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
-'git reset' [<mode>] [<commit>]::
+`git reset` [<mode>] [<commit>]::
This form resets the current branch head to `<commit>` and
possibly updates the index (resetting it to the tree of `<commit>`) and
the working tree depending on `<mode>`. If `<mode>` is omitted,
@@ -285,7 +285,7 @@ Reset a single file in the index::
+
Suppose you have added a file to your index, but later decide you do not
want to add it to your commit. You can remove the file from the index
-while keeping your changes with git reset.
+while keeping your changes with `git reset`.
+
------------
$ git reset -- frotz.c <1>
@@ -328,7 +328,7 @@ Split a commit apart into a sequence of commits::
+
Suppose that you have created lots of logically separate changes and committed
them together. Then, later you decide that it might be better to have each
-logical chunk associated with its own commit. You can use git reset to rewind
+logical chunk associated with its own commit. You can use `git reset` to rewind
history without changing the contents of your local files, and then successively
use `git add -p` to interactively select which hunks to include into each commit,
using `git commit -c` to pre-populate the commit message.
@@ -369,7 +369,7 @@ $ git commit ... <8>
no longer use the patch mode of `git add`, in order to select all remaining
uncommitted changes.
<7> Once again, check to verify that you've included what you want to. You may
- also wish to verify that git diff doesn't show any remaining changes to be
+ also wish to verify that `git diff` doesn't show any remaining changes to be
committed later.
<8> And finally create the final commit.
diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt
index 55bde91ef9..eb7d765e5d 100644
--- a/Documentation/git-restore.txt
+++ b/Documentation/git-restore.txt
@@ -8,9 +8,9 @@ git-restore - Restore working tree files
SYNOPSIS
--------
[verse]
-'git restore' [<options>] [--source=<tree>] [--staged] [--worktree] [--] <pathspec>...
-'git restore' [<options>] [--source=<tree>] [--staged] [--worktree] --pathspec-from-file=<file> [--pathspec-file-nul]
-'git restore' (-p|--patch) [<options>] [--source=<tree>] [--staged] [--worktree] [--] [<pathspec>...]
+`git restore` [<options>] [--source=<tree>] [--staged] [--worktree] [--] <pathspec>...
+`git restore` [<options>] [--source=<tree>] [--staged] [--worktree] --pathspec-from-file=<file> [--pathspec-file-nul]
+`git restore` (-p|--patch) [<options>] [--source=<tree>] [--staged] [--worktree] [--] [<pathspec>...]
DESCRIPTION
-----------
diff --git a/Documentation/git-rev-list.txt b/Documentation/git-rev-list.txt
index 20bb8e8217..c1ee42057b 100644
--- a/Documentation/git-rev-list.txt
+++ b/Documentation/git-rev-list.txt
@@ -9,7 +9,7 @@ git-rev-list - Lists commit objects in reverse chronological order
SYNOPSIS
--------
[verse]
-'git rev-list' [<options>] <commit>... [[--] <path>...]
+`git rev-list` [<options>] <commit>... [[--] <path>...]
DESCRIPTION
-----------
@@ -20,8 +20,8 @@ include::rev-list-description.txt[]
'rev-list' is a very essential Git command, since it
provides the ability to build and traverse commit ancestry graphs. For
this reason, it has a lot of different options that enables it to be
-used by commands as different as 'git bisect' and
-'git repack'.
+used by commands as different as `git bisect` and
+`git repack`.
OPTIONS
-------
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index 5f6224847e..9908f3020f 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -9,16 +9,16 @@ git-rev-parse - Pick out and massage parameters
SYNOPSIS
--------
[verse]
-'git rev-parse' [<options>] <args>...
+`git rev-parse` [<options>] <args>...
DESCRIPTION
-----------
Many Git porcelainish commands take mixture of flags
(i.e. parameters that begin with a dash '-') and parameters
-meant for the underlying 'git rev-list' command they use internally
+meant for the underlying `git rev-list` command they use internally
and flags and parameters for the other commands they use
-downstream of 'git rev-list'. This command is used to
+downstream of `git rev-list`. This command is used to
distinguish between them.
@@ -31,10 +31,10 @@ Operation Modes
Each of these options must appear first on the command line.
--parseopt::
- Use 'git rev-parse' in option parsing mode (see PARSEOPT section below).
+ Use `git rev-parse` in option parsing mode (see PARSEOPT section below).
--sq-quote::
- Use 'git rev-parse' in shell quoting mode (see SQ-QUOTE
+ Use `git rev-parse` in shell quoting mode (see SQ-QUOTE
section below). In contrast to the `--sq` option below, this
mode does only quoting. Nothing else is done to command input.
@@ -59,11 +59,11 @@ Options for Filtering
--revs-only::
Do not output flags and parameters not meant for
- 'git rev-list' command.
+ `git rev-list` command.
--no-revs::
Do not output flags and parameters meant for
- 'git rev-list' command.
+ `git rev-list` command.
--flags::
Do not output non-flag parameters.
@@ -79,7 +79,7 @@ Options for Output
instead.
--prefix <arg>::
- Behave as if 'git rev-parse' was invoked from the `<arg>`
+ Behave as if `git rev-parse` was invoked from the `<arg>`
subdirectory of the working tree. Any relative filenames are
resolved as if they are prefixed by `<arg>` and will be printed
in that form.
@@ -127,7 +127,7 @@ for another option.
properly quoted for consumption by shell. Useful when
you expect your parameter to contain whitespaces and
newlines (e.g. when using pickaxe `-S` with
- 'git diff-{asterisk}'). In contrast to the `--sq-quote` option,
+ `git diff-*`). In contrast to the `--sq-quote` option,
the command input is still interpreted as usual.
--short[=length]::
@@ -246,8 +246,8 @@ print a message to stderr and exit with nonzero status.
Resolve "$GIT_DIR/<path>" and takes other path relocation
variables such as $GIT_OBJECT_DIRECTORY,
$GIT_INDEX_FILE... into account. For example, if
- $GIT_OBJECT_DIRECTORY is set to /foo/bar then "git rev-parse
- --git-path objects/abc" returns /foo/bar/abc.
+ $GIT_OBJECT_DIRECTORY is set to /foo/bar then `git rev-parse
+ --git-path objects/abc` returns /foo/bar/abc.
--show-toplevel::
Show the (by default, absolute) path of the top-level directory
@@ -306,12 +306,12 @@ Other Options
--since=datestring::
--after=datestring::
Parse the date string, and output the corresponding
- `--max-age=` parameter for 'git rev-list'.
+ `--max-age`= parameter for `git rev-list`.
--until=datestring::
--before=datestring::
Parse the date string, and output the corresponding
- `--min-age=` parameter for 'git rev-list'.
+ `--min-age`= parameter for `git rev-list`.
<args>...::
Flags and parameters to be parsed.
@@ -322,7 +322,7 @@ include::revisions.txt[]
PARSEOPT
--------
-In `--parseopt` mode, 'git rev-parse' helps massaging options to bring to shell
+In `--parseopt` mode, `git rev-parse` helps massaging options to bring to shell
scripts the same facilities C builtins have. It works as an option normalizer
(e.g. splits single switches aggregate values), a bit like `getopt(1)` does.
@@ -337,7 +337,7 @@ below for an example.
Input Format
~~~~~~~~~~~~
-'git rev-parse --parseopt' input format is fully text based. It has two parts,
+`git rev-parse --parseopt` input format is fully text based. It has two parts,
separated by a line that contains only `--`. The lines before the separator
(should be one or more) are used for the usage.
The lines after the separator describe the options.
@@ -428,13 +428,13 @@ An option group Header
SQ-QUOTE
--------
-In `--sq-quote` mode, 'git rev-parse' echoes on the standard output a
+In `--sq-quote` mode, `git rev-parse` echoes on the standard output a
single line suitable for `sh(1)` `eval`. This line is made by
normalizing the arguments following `--sq-quote`. Nothing other than
quoting the arguments is done.
If you want command input to still be interpreted as usual by
-'git rev-parse' before the output is shell quoted, see the `--sq`
+`git rev-parse` before the output is shell quoted, see the `--sq`
option.
Example
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index a232db1d98..0ebe45153e 100644
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -8,8 +8,8 @@ git-revert - Revert some existing commits
SYNOPSIS
--------
[verse]
-'git revert' [--[no-]edit] [-n] [-m parent-number] [-s] [-S[<keyid>]] <commit>...
-'git revert' (--continue | --skip | --abort | --quit)
+`git revert` [--[no-]edit] [-n] [-m parent-number] [-s] [-S[<keyid>]] <commit>...
+`git revert` (--continue | --skip | --abort | --quit)
DESCRIPTION
-----------
@@ -19,7 +19,7 @@ related patches introduce, and record some new commits that record
them. This requires your working tree to be clean (no modifications
from the `HEAD` commit).
-Note: 'git revert' is used to record some new commits to reverse the
+Note: `git revert` is used to record some new commits to reverse the
effect of some earlier commits (often only a faulty one). If you want to
throw away all uncommitted changes in your working directory, you
should see linkgit:git-reset[1], particularly the `--hard` option. If
@@ -43,7 +43,7 @@ OPTIONS
-e::
--edit::
- With this option, 'git revert' will let you edit the commit
+ With this option, `git revert` will let you edit the commit
message prior to committing the revert. This is the default if
you run the command from a terminal.
@@ -64,7 +64,7 @@ See the link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for
more details.
--no-edit::
- With this option, 'git revert' will not start the commit
+ With this option, `git revert` will not start the commit
message editor.
--cleanup=<mode>::
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt
index 56d9b0627f..24eb799d6e 100644
--- a/Documentation/git-rm.txt
+++ b/Documentation/git-rm.txt
@@ -8,7 +8,7 @@ git-rm - Remove files from the working tree and from the index
SYNOPSIS
--------
[verse]
-'git rm' [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch]
+`git rm` [-f | --force] [-n] [-r] [--cached] [--ignore-unmatch]
[--quiet] [--pathspec-from-file=<file> [--pathspec-file-nul]]
[--] [<pathspec>...]
@@ -148,7 +148,7 @@ with a Git version 1.7.8 or newer) will be removed from the work
tree, as their repository lives inside the .git directory of the
superproject. If a submodule (or one of those nested inside it)
still uses a .git directory, `git rm` will move the submodules
-git directory into the superprojects git directory to protect
+`git` directory into the superprojects `git` directory to protect
the submodule's history. If it exists the `submodule.<name>` section
in the linkgit:gitmodules[5] file will also be removed and that file
will be staged (unless `--cached` or `-n` are used).
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 9d9ef3d945..916bd441d4 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -9,8 +9,8 @@ git-send-email - Send a collection of patches as emails
SYNOPSIS
--------
[verse]
-'git send-email' [<options>] <file|directory|rev-list options>...
-'git send-email' --dump-aliases
+`git send-email` [<options>] <file|directory|rev-list options>...
+`git send-email` --dump-aliases
DESCRIPTION
@@ -19,7 +19,7 @@ Takes the patches given on the command line and emails them out.
Patches can be specified as files, directories (which will send all
files in the directory), or directly as a revision list. In the
last case, any format accepted by linkgit:git-format-patch[1] can
-be passed to git send-email.
+be passed to `git send-email`.
The header of the email is configurable via command-line options. If not
specified on the command line, the user will be prompted with a ReadLine
@@ -66,7 +66,7 @@ This option may be specified multiple times.
Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
to edit an introductory message for the patch series.
+
-When `--compose` is used, git send-email will use the From, Subject, and
+When `--compose` is used, `git send-email` will use the From, Subject, and
In-Reply-To headers specified in the message. If the body of the message
(what you type after the headers and a blank line) only contains blank
(or Git: prefixed) lines, the summary won't be sent, but From, Subject,
@@ -82,7 +82,7 @@ See the CONFIGURATION section for `sendemail.multiEdit`.
neither the command-line option nor `sendemail.from` are set, then the
user will be prompted for the value. The default for the prompt will be
the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
- set, as returned by "git var -l".
+ set, as returned by `git var -l`.
--reply-to=<address>::
Specify the address where replies from recipients should go to.
@@ -175,7 +175,7 @@ Sending
--smtp-domain=<FQDN>::
Specifies the Fully Qualified Domain Name (FQDN) used in the
HELO/EHLO command to the SMTP server. Some servers require the
- FQDN to match your IP address. If not set, git send-email attempts
+ FQDN to match your IP address. If not set, `git send-email` attempts
to determine your FQDN automatically. Default is the value of
`sendemail.smtpDomain`.
@@ -204,7 +204,7 @@ Furthermore, passwords need not be specified in configuration files
or on the command line. If a username has been specified (with
`--smtp-user` or a `sendemail.smtpUser`), but no password has been
specified (with `--smtp-pass` or `sendemail.smtpPass`), then
-a password is obtained using 'git-credential'.
+a password is obtained using `git-credential`.
--no-smtp-auth::
Disable SMTP authentication. Short hand for `--smtp-auth=none`
@@ -362,7 +362,7 @@ specified, as well as 'body' if `--no-signed-off-cc` is specified.
--[no-]thread::
If this is set, the In-Reply-To and References headers will be
added to each email sent. Whether each mail refers to the
- previous email (`deep` threading per 'git format-patch'
+ previous email (`deep` threading per `git format-patch`
wording) or to the first email (`shallow` threading) is
governed by "--[no-]chain-reply-to".
+
@@ -372,8 +372,8 @@ If disabled with `--no-thread`, those headers will not be added
default to `--thread`.
+
It is up to the user to ensure that no In-Reply-To header already
-exists when 'git send-email' is asked to add it (especially note that
-'git format-patch' can be configured to do the threading itself).
+exists when `git send-email` is asked to add it (especially note that
+`git format-patch` can be configured to do the threading itself).
Failure to do so may not produce the expected result in the
recipient's MUA.
@@ -404,10 +404,10 @@ have been specified, in which case default to 'compose'.
When an argument may be understood either as a reference or as a file name,
choose to understand it as a format-patch argument (`--format-patch`)
or as a file name (`--no-format-patch`). By default, when such a conflict
- occurs, git send-email will fail.
+ occurs, `git send-email` will fail.
--quiet::
- Make git-send-email less verbose. One line per email should be
+ Make `git-send-email` less verbose. One line per email should be
all that is output.
--[no-]validate::
@@ -483,7 +483,7 @@ EXAMPLES
--------
Use gmail as the smtp server
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-To use 'git send-email' to send your patches through the GMail SMTP server,
+To use `git send-email` to send your patches through the GMail SMTP server,
edit ~/.gitconfig to specify your account settings:
----
@@ -495,7 +495,7 @@ edit ~/.gitconfig to specify your account settings:
----
If you have multi-factor authentication set up on your Gmail account, you will
-need to generate an app-specific password for use with 'git send-email'. Visit
+need to generate an app-specific password for use with `git send-email`. Visit
https://security.google.com/settings/security/apppasswords to create it.
If you do not have multi-factor authentication set up on your Gmail account,
diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt
index 2cd2d823b3..46f7757b9a 100644
--- a/Documentation/git-send-pack.txt
+++ b/Documentation/git-send-pack.txt
@@ -9,24 +9,24 @@ git-send-pack - Push objects over Git protocol to another repository
SYNOPSIS
--------
[verse]
-'git send-pack' [--all] [--dry-run] [--force] [--receive-pack=<git-receive-pack>]
+`git send-pack` [--all] [--dry-run] [--force] [--receive-pack=<git-receive-pack>]
[--verbose] [--thin] [--atomic]
[--[no-]signed|--signed=(true|false|if-asked)]
[<host>:]<directory> [<ref>...]
DESCRIPTION
-----------
-Usually you would want to use 'git push', which is a
+Usually you would want to use `git push`, which is a
higher-level wrapper of this command, instead. See linkgit:git-push[1].
-Invokes 'git-receive-pack' on a possibly remote repository, and
+Invokes `git-receive-pack` on a possibly remote repository, and
updates it from the current repository, sending named refs.
OPTIONS
-------
--receive-pack=<git-receive-pack>::
- Path to the 'git-receive-pack' program on the remote
+ Path to the `git-receive-pack` program on the remote
end. Sometimes useful when pushing to a remote
repository over ssh, and you do not have the program in
a directory on the default $PATH.
@@ -89,7 +89,7 @@ be in a separate packet, and the list must end with a flush packet.
<host>::
A remote host to house the repository. When this
- part is specified, 'git-receive-pack' is invoked via
+ part is specified, `git-receive-pack` is invoked via
ssh.
<directory>::
@@ -123,7 +123,7 @@ and the destination side (after the colon). The ref to be
pushed is determined by finding a match that matches the source
side, and where it is pushed is determined by using the
destination side. The rules used to match a ref are the same
-rules used by 'git rev-parse' to resolve a symbolic ref
+rules used by `git rev-parse` to resolve a symbolic ref
name. See linkgit:git-rev-parse[1].
- It is an error if <src> does not match exactly one of the
diff --git a/Documentation/git-sh-i18n--envsubst.txt b/Documentation/git-sh-i18n--envsubst.txt
index 2ffaf9392e..6e0c3ffdc0 100644
--- a/Documentation/git-sh-i18n--envsubst.txt
+++ b/Documentation/git-sh-i18n--envsubst.txt
@@ -22,7 +22,7 @@ This is not a command the end user would want to run. Ever.
This documentation is meant for people who are studying the
plumbing scripts and/or are writing new ones.
-'git sh-i18n{litdd}envsubst' is Git's stripped-down copy of the GNU
+`git sh-i18n--envsubst` is Git's stripped-down copy of the GNU
`envsubst(1)` program that comes with the GNU gettext package. It's
used internally by linkgit:git-sh-i18n[1] to interpolate the variables
passed to the `eval_gettext` function.
diff --git a/Documentation/git-sh-i18n.txt b/Documentation/git-sh-i18n.txt
index 60cf49cb2a..23c504bbd8 100644
--- a/Documentation/git-sh-i18n.txt
+++ b/Documentation/git-sh-i18n.txt
@@ -17,7 +17,7 @@ This is not a command the end user would want to run. Ever.
This documentation is meant for people who are studying the
Porcelain-ish scripts and/or are writing new ones.
-The 'git sh-i18n scriptlet is designed to be sourced (using
+The `git-sh-i18n` scriptlet is designed to be sourced (using
`.`) by Git's porcelain programs implemented in shell
script. It provides wrappers for the GNU `gettext` and
`eval_gettext` functions accessible through the `gettext.sh`
diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt
index 8632612c31..ed33a46a77 100644
--- a/Documentation/git-sh-setup.txt
+++ b/Documentation/git-sh-setup.txt
@@ -17,7 +17,7 @@ This is not a command the end user would want to run. Ever.
This documentation is meant for people who are studying the
Porcelain-ish scripts and/or are writing new ones.
-The 'git sh-setup' scriptlet is designed to be sourced (using
+The `git-sh-setup` scriptlet is designed to be sourced (using
`.`) by other shell scripts to set up some variables pointing at
the normal Git directories and a few helper shell functions.
diff --git a/Documentation/git-shell.txt b/Documentation/git-shell.txt
index 11361f33e9..5b72dc53d6 100644
--- a/Documentation/git-shell.txt
+++ b/Documentation/git-shell.txt
@@ -9,9 +9,9 @@ git-shell - Restricted login shell for Git-only SSH access
SYNOPSIS
--------
[verse]
-'chsh' -s $(command -v git-shell) <user>
-'git clone' <user>`@localhost:/path/to/repo.git`
-'ssh' <user>`@localhost`
+`chsh` -s $(command -v git-shell) <user>
+`git clone` <user>`@localhost:/path/to/repo.git`
+`ssh` <user>`@localhost`
DESCRIPTION
-----------
@@ -24,18 +24,18 @@ named `git-shell-commands` in the user's home directory.
COMMANDS
--------
-'git shell' accepts the following commands after the `-c` option:
+`git shell` accepts the following commands after the `-c` option:
-'git receive-pack <argument>'::
-'git upload-pack <argument>'::
-'git upload-archive <argument>'::
+`git receive-pack <argument>`::
+`git upload-pack <argument>`::
+`git upload-archive <argument>`::
Call the corresponding server-side command to support
- the client's 'git push', 'git fetch', or 'git archive --remote'
+ the client's `git push`, `git fetch`, or `git archive --remote`
request.
'cvs server'::
Imitate a CVS server. See linkgit:git-cvsserver[1].
-If a `~/git-shell-commands` directory is present, 'git shell' will
+If a `~/git-shell-commands` directory is present, `git shell` will
also handle other, custom commands by running
"`git-shell-commands/<command> <arguments>`" from the user's home
directory.
@@ -46,7 +46,7 @@ INTERACTIVE USE
By default, the commands above can be executed only with the `-c`
option; the shell is not interactive.
-If a `~/git-shell-commands` directory is present, 'git shell'
+If a `~/git-shell-commands` directory is present, `git shell`
can also be run interactively (with no arguments). If a `help`
command is present in the `git-shell-commands` directory, it is
run to provide the user with an overview of allowed actions. Then a
@@ -79,9 +79,9 @@ EOF
$ chmod +x $HOME/git-shell-commands/no-interactive-login
----------------
-To enable git-cvsserver access (which should generally have the
+To enable `git-cvsserver` access (which should generally have the
`no-interactive-login` example above as a prerequisite, as creating
-the git-shell-commands directory allows interactive logins):
+the `git-shell`-commands directory allows interactive logins):
----------------
$ cat >$HOME/git-shell-commands/cvs <<\EOF
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index c9c7f3065c..d9226b63da 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -8,18 +8,18 @@ git-shortlog - Summarize 'git log' output
SYNOPSIS
--------
[verse]
-'git shortlog' [<options>] [<revision range>] [[--] <path>...]
-git log --pretty=short | 'git shortlog' [<options>]
+`git shortlog` [<options>] [<revision range>] [[--] <path>...]
+`git log` --pretty=short | `git shortlog` [<options>]
DESCRIPTION
-----------
-Summarizes 'git log' output in a format suitable for inclusion
+Summarizes `git log` output in a format suitable for inclusion
in release announcements. Each commit will be grouped by author and title.
Additionally, "[PATCH]" will be stripped from the commit description.
If no revisions are passed on the command line and either standard input
-is not a terminal or there is no current branch, 'git shortlog' will
+is not a terminal or there is no current branch, `git shortlog` will
output a summary of the log read from standard input, without
reference to the current repository.
@@ -42,7 +42,7 @@ OPTIONS
--format[=<format>]::
Instead of the commit subject, use some other information to
describe each commit. '<format>' can be any string accepted
- by the `--format` option of 'git log', such as '* [%h] %s'.
+ by the `--format` option of `git log`, such as '* [%h] %s'.
(See the "PRETTY FORMATS" section of linkgit:git-log[1].)
Each pretty-printed commit will be rewrapped before it is shown.
diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index 0ce603646f..5531c435b0 100644
--- a/Documentation/git-show-branch.txt
+++ b/Documentation/git-show-branch.txt
@@ -8,12 +8,12 @@ git-show-branch - Show branches and their commits
SYNOPSIS
--------
[verse]
-'git show-branch' [-a|--all] [-r|--remotes] [--topo-order | --date-order]
+`git show-branch` [-a|--all] [-r|--remotes] [--topo-order | --date-order]
[--current] [--color[=<when>] | --no-color] [--sparse]
[--more=<n> | --list | --independent | --merge-base]
[--no-name | --sha1-name] [--topics]
[(<rev> | <glob>)...]
-'git show-branch' (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]
+`git show-branch` (-g|--reflog)[=<n>[,<base>]] [--list] [<ref>]
DESCRIPTION
-----------
@@ -104,9 +104,9 @@ OPTIONS
Shows only commits that are NOT on the first branch given.
This helps track topic branches by hiding any commit that
is already in the main line of development. When given
- "git show-branch --topics master topic1 topic2", this
- will show the revisions given by "git rev-list {caret}master
- topic1 topic2"
+ `git show-branch --topics master topic1 topic2`, this
+ will show the revisions given by `git rev-list {caret}master
+ topic1 topic2`
-g::
--reflog[=<n>[,<base>]] [<ref>]::
@@ -144,8 +144,8 @@ otherwise it shows a space. Merge commits are denoted by
a `-` sign. Each commit shows a short name that
can be used as an extended SHA-1 to name that commit.
-The following example shows three branches, "master", "fixes"
-and "mhf":
+The following example shows three branches, `master`, `fixes`
+and `mhf`:
------------------------------------------------
$ git show-branch master fixes mhf
@@ -167,10 +167,10 @@ $ git show-branch master fixes mhf
------------------------------------------------
These three branches all forked from a common commit, [master],
-whose commit message is "Add \'git show-branch'".
-The "fixes" branch adds one commit "Introduce "reset type" flag to
-"git reset"". The "mhf" branch adds many other commits.
-The current branch is "master".
+whose commit message is "Add `git show-branch`".
+The `fixes` branch adds one commit "Introduce "reset type" flag to
+`git reset`". The `mhf` branch adds many other commits.
+The current branch is `master`.
EXAMPLES
diff --git a/Documentation/git-show-index.txt b/Documentation/git-show-index.txt
index e49318a5a0..0d4b36859d 100644
--- a/Documentation/git-show-index.txt
+++ b/Documentation/git-show-index.txt
@@ -9,7 +9,7 @@ git-show-index - Show packed archive index
SYNOPSIS
--------
[verse]
-'git show-index' [--object-format=<hash-algorithm>]
+`git show-index` [--object-format=<hash-algorithm>]
DESCRIPTION
diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index 9d7ba22603..28be080b96 100644
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -8,10 +8,10 @@ git-show-ref - List references in a local repository
SYNOPSIS
--------
[verse]
-'git show-ref' [-q|--quiet] [--verify] [--head] [-d|--dereference]
+`git show-ref` [-q|--quiet] [--verify] [--head] [-d|--dereference]
[-s|--hash[=<n>]] [--abbrev[=<n>]] [--tags]
[--heads] [--] [<pattern>...]
-'git show-ref' --exclude-existing[=<pattern>]
+`git show-ref` --exclude-existing[=<pattern>]
DESCRIPTION
-----------
@@ -75,7 +75,7 @@ OPTIONS
--exclude-existing[=<pattern>]::
- Make 'git show-ref' act as a filter that reads refs from stdin of the
+ Make `git show-ref` act as a filter that reads refs from stdin of the
form "`^(?:<anything>\s)?<refname>(?:\^{})?$`"
and performs the following actions on each:
(1) strip "{caret}{}" at the end of line if any;
@@ -142,7 +142,7 @@ When using the `--verify` flag, the command requires an exact path:
will only match the exact branch called "master".
-If nothing matches, 'git show-ref' will return an error code of 1,
+If nothing matches, `git show-ref` will return an error code of 1,
and in the case of verification, it will show an error message.
For scripting, you can ask it to be quiet with the `--quiet` flag, which
diff --git a/Documentation/git-show.txt b/Documentation/git-show.txt
index b7a6f9b544..02f854940f 100644
--- a/Documentation/git-show.txt
+++ b/Documentation/git-show.txt
@@ -9,7 +9,7 @@ git-show - Show various types of objects
SYNOPSIS
--------
[verse]
-'git show' [<options>] [<object>...]
+`git show` [<options>] [<object>...]
DESCRIPTION
-----------
@@ -17,16 +17,16 @@ Shows one or more objects (blobs, trees, tags and commits).
For commits it shows the log message and textual diff. It also
presents the merge commit in a special format as produced by
-'git diff-tree --cc'.
+`git diff-tree --cc`.
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).
+For trees, it shows the names (equivalent to `git ls-tree`
+with `--name-only`).
For plain blobs, it shows the plain contents.
-The command takes options applicable to the 'git diff-tree' command to
+The command takes options applicable to the `git diff-tree` command to
control how the changes the commit introduces are shown.
This manual page describes only the most frequently used options.
diff --git a/Documentation/git-sparse-checkout.txt b/Documentation/git-sparse-checkout.txt
index a0eeaeb02e..efadc656e8 100644
--- a/Documentation/git-sparse-checkout.txt
+++ b/Documentation/git-sparse-checkout.txt
@@ -11,7 +11,7 @@ given by a list of patterns.
SYNOPSIS
--------
[verse]
-'git sparse-checkout <subcommand> [options]'
+`git sparse-checkout <subcommand> [options]`
DESCRIPTION
@@ -83,7 +83,7 @@ C-style quoted strings.
'disable'::
Disable the `core.sparseCheckout` config setting, and restore the
working directory to include all files. Leaves the sparse-checkout
- file intact so a later 'git sparse-checkout init' command may
+ file intact so a later `git sparse-checkout init` command may
return the working directory to the same state.
SPARSE CHECKOUT
@@ -193,7 +193,7 @@ A/B/C
If `core.ignoreCase=true`, then the pattern-matching algorithm will use a
case-insensitive check. This corrects for case mismatched filenames in the
-'git sparse-checkout set' command to reflect the expected cone in the working
+`git sparse-checkout set` command to reflect the expected cone in the working
directory.
diff --git a/Documentation/git-stage.txt b/Documentation/git-stage.txt
index 25bcda936d..523772c45a 100644
--- a/Documentation/git-stage.txt
+++ b/Documentation/git-stage.txt
@@ -9,7 +9,7 @@ git-stage - Add file contents to the staging area
SYNOPSIS
--------
[verse]
-'git stage' args...
+`git stage` args...
DESCRIPTION
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index a2b69ae00f..142e5f3751 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -8,18 +8,18 @@ git-stash - Stash the changes in a dirty working directory away
SYNOPSIS
--------
[verse]
-'git stash' list [<log-options>]
-'git stash' show [-u|--include-untracked|--only-untracked] [<diff-options>] [<stash>]
-'git stash' drop [-q|--quiet] [<stash>]
-'git stash' ( pop | apply ) [--index] [-q|--quiet] [<stash>]
-'git stash' branch <branchname> [<stash>]
-'git stash' [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
+`git stash` list [<log-options>]
+`git stash` show [-u|--include-untracked|--only-untracked] [<diff-options>] [<stash>]
+`git stash` drop [-q|--quiet] [<stash>]
+`git stash` ( pop | apply ) [--index] [-q|--quiet] [<stash>]
+`git stash` branch <branchname> [<stash>]
+`git stash` [push [-p|--patch] [-k|--[no-]keep-index] [-q|--quiet]
[-u|--include-untracked] [-a|--all] [-m|--message <message>]
[--pathspec-from-file=<file> [--pathspec-file-nul]]
[--] [<pathspec>...]]
-'git stash' clear
-'git stash' create [<message>]
-'git stash' store [-m|--message <message>] [-q|--quiet] <commit>
+`git stash` clear
+`git stash` create [<message>]
+`git stash` store [-m|--message <message>] [-q|--quiet] <commit>
DESCRIPTION
-----------
@@ -62,7 +62,7 @@ which are allowed after a double hyphen `--` for disambiguation.
save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q|--quiet] [<message>]::
- This option is deprecated in favour of 'git stash push'. It
+ This option is deprecated in favour of `git stash push`. It
differs from "stash push" in that it cannot take pathspec.
Instead, all non-option arguments are concatenated to form the stash
message.
@@ -80,7 +80,7 @@ stash@{0}: WIP on submit: 6ebd0e2... Update git-stash documentation
stash@{1}: On master: 9cc0589... Add git-stash
----------------------------------------------------------------
+
-The command takes options applicable to the 'git log'
+The command takes options applicable to the `git log`
command to control what is shown and how. See linkgit:git-log[1].
show [-u|--include-untracked|--only-untracked] [<diff-options>] [<stash>]::
@@ -89,7 +89,7 @@ show [-u|--include-untracked|--only-untracked] [<diff-options>] [<stash>]::
stashed contents and the commit back when the stash entry was first
created.
By default, the command shows the diffstat, but it will accept any
- format known to 'git diff' (e.g., `git stash show -p stash@{1}`
+ format known to `git diff` (e.g., `git stash show -p stash@{1}`
to view the second most recent entry in patch form).
You can use stash.showIncludeUntracked, stash.showStat, and
stash.showPatch config variables to change the default behavior.
@@ -144,7 +144,7 @@ create::
store::
- Store a given stash created via 'git stash create' (which is a
+ Store a given stash created via `git stash create` (which is a
dangling merge commit) in the stash ref, updating the stash
reflog. This is intended to be useful for scripts. It is
probably not the command you want to use; see "push" above.
@@ -310,7 +310,7 @@ $ git reset --soft HEAD^
# ... continue hacking ...
----------------------------------------------------------------
+
-You can use 'git stash' to simplify the above, like this:
+You can use `git stash` to simplify the above, like this:
+
----------------------------------------------------------------
# ... hack hack hack ...
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 0c9b68e981..2abb6d69f5 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -9,7 +9,7 @@ git-status - Show the working tree status
SYNOPSIS
--------
[verse]
-'git status' [<options>...] [--] [<pathspec>...]
+`git status` [<options>...] [--] [<pathspec>...]
DESCRIPTION
-----------
@@ -18,7 +18,7 @@ current `HEAD` commit, paths that have differences between the working
tree and the index file, and paths in the working tree that are not
tracked by Git (and are not ignored by linkgit:gitignore[5]). The first
are what you _would_ commit by running `git commit`; the second and
-third are what you _could_ commit by running 'git add' before running
+third are what you _could_ commit by running `git add` before running
`git commit`.
OPTIONS
@@ -430,7 +430,7 @@ that the summary output from the status command will be suppressed for all
submodules when `diff.ignoreSubmodules` is set to 'all' or only for those
submodules where `submodule.<name>.ignore=all`. To also view the summary for
ignored submodules you can either use the `--ignore-submodules=dirty` command
-line option or the 'git submodule summary' command, which shows a similar
+line option or the `git submodule summary` command, which shows a similar
output but does not honor these settings.
BACKGROUND REFRESH
diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt
index 2438f76da0..6397de9cb3 100644
--- a/Documentation/git-stripspace.txt
+++ b/Documentation/git-stripspace.txt
@@ -9,8 +9,8 @@ git-stripspace - Remove unnecessary whitespace
SYNOPSIS
--------
[verse]
-'git stripspace' [-s | --strip-comments]
-'git stripspace' [-c | --comment-lines]
+`git stripspace` [-s | --strip-comments]
+`git stripspace` [-c | --comment-lines]
DESCRIPTION
-----------
@@ -64,7 +64,7 @@ Given the following noisy input with '$' indicating the end of a line:
| $
---------
-Use 'git stripspace' with no arguments to obtain:
+Use `git stripspace` with no arguments to obtain:
---------
|A brief introduction$
@@ -78,7 +78,7 @@ Use 'git stripspace' with no arguments to obtain:
|The end.$
---------
-Use 'git stripspace --strip-comments' to obtain:
+Use `git stripspace --strip-comments` to obtain:
---------
|A brief introduction$
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index e68d91a406..b97531f808 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -9,18 +9,18 @@ git-submodule - Initialize, update or inspect submodules
SYNOPSIS
--------
[verse]
-'git submodule' [--quiet] [--cached]
-'git submodule' [--quiet] add [<options>] [--] <repository> [<path>]
-'git submodule' [--quiet] status [--cached] [--recursive] [--] [<path>...]
-'git submodule' [--quiet] init [--] [<path>...]
-'git submodule' [--quiet] deinit [-f|--force] (--all|[--] <path>...)
-'git submodule' [--quiet] update [<options>] [--] [<path>...]
-'git submodule' [--quiet] set-branch [<options>] [--] <path>
-'git submodule' [--quiet] set-url [--] <path> <newurl>
-'git submodule' [--quiet] summary [<options>] [--] [<path>...]
-'git submodule' [--quiet] foreach [--recursive] <command>
-'git submodule' [--quiet] sync [--recursive] [--] [<path>...]
-'git submodule' [--quiet] absorbgitdirs [--] [<path>...]
+`git submodule` [--quiet] [--cached]
+`git submodule` [--quiet] add [<options>] [--] <repository> [<path>]
+`git submodule` [--quiet] status [--cached] [--recursive] [--] [<path>...]
+`git submodule` [--quiet] init [--] [<path>...]
+`git submodule` [--quiet] deinit [-f|--force] (--all|[--] <path>...)
+`git submodule` [--quiet] update [<options>] [--] [<path>...]
+`git submodule` [--quiet] set-branch [<options>] [--] <path>
+`git submodule` [--quiet] set-url [--] <path> <newurl>
+`git submodule` [--quiet] summary [<options>] [--] [<path>...]
+`git submodule` [--quiet] foreach [--recursive] <command>
+`git submodule` [--quiet] sync [--recursive] [--] [<path>...]
+`git submodule` [--quiet] absorbgitdirs [--] [<path>...]
DESCRIPTION
@@ -69,13 +69,13 @@ cloning the superproject. If the URL is given relative to the
superproject's repository, the presumption is the superproject and
submodule repositories will be kept together in the same relative
location, and only the superproject's URL needs to be provided.
-git-submodule will correctly locate the submodule using the relative
+`git-submodule` will correctly locate the submodule using the relative
URL in `.gitmodules`.
status [--cached] [--recursive] [--] [<path>...]::
Show the status of the submodules. This will print the SHA-1 of the
currently checked out commit for each submodule, along with the
- submodule path and the output of 'git describe' for the
+ submodule path and the output of `git describe` for the
SHA-1. Each SHA-1 will possibly be prefixed with `-` if the submodule is
not initialized, `+` if the currently checked out submodule commit
does not match the SHA-1 found in the index of the containing
@@ -247,16 +247,16 @@ If `--recursive` is specified, this command will recurse into the
registered submodules, and sync any nested submodules within.
absorbgitdirs::
- If a git directory of a submodule is inside the submodule,
- move the git directory of the submodule into its superproject's
- `$GIT_DIR/modules` path and then connect the git directory and
+ If a `git` directory of a submodule is inside the submodule,
+ move the `git` directory of the submodule into its superproject's
+ `$GIT_DIR/modules` path and then connect the `git` directory and
its working directory by setting the `core.worktree` and adding
- a .git file pointing to the git directory embedded in the
- superprojects git directory.
+ a .git file pointing to the `git` directory embedded in the
+ superprojects `git` directory.
+
A repository that was cloned independently and later added as a submodule or
-old setups have the submodules git directory inside the submodule instead of
-embedded into the superprojects git directory.
+old setups have the submodules `git` directory inside the submodule instead of
+embedded into the superprojects `git` directory.
+
This command is recursive by default.
@@ -383,7 +383,7 @@ the submodule itself.
--init::
This option is only valid for the update command.
- Initialize all submodules for which "git submodule init" has not been
+ Initialize all submodules for which `git submodule init` has not been
called so far before updating.
--name::
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 91495cfa01..3097f4f1c5 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -8,15 +8,15 @@ git-svn - Bidirectional operation between a Subversion repository and Git
SYNOPSIS
--------
[verse]
-'git svn' <command> [<options>] [<arguments>]
+`git svn` <command> [<options>] [<arguments>]
DESCRIPTION
-----------
-'git svn' is a simple conduit for changesets between Subversion and Git.
+`git svn` is a simple conduit for changesets between Subversion and Git.
It provides a bidirectional flow of changes between a Subversion and a Git
repository.
-'git svn' can track a standard Subversion repository,
+`git svn` can track a standard Subversion repository,
following the common "trunk/branches/tags" layout, with the `--stdlayout` option.
It can also follow branches and tags in any layout with the `-T`/`-t`/`-b` options
(see options to 'init' below, and also the 'clone' command).
@@ -30,7 +30,7 @@ COMMANDS
'init'::
Initializes an empty Git repository with additional
- metadata directories for 'git svn'. The Subversion URL
+ metadata directories for `git svn`. The Subversion URL
may be specified as a command-line argument, or as full
URL arguments to `-T`/`-t`/`-b`. Optionally, the target
directory to operate on can be specified as a second
@@ -109,12 +109,12 @@ your Perl's Getopt::Long is < v2.37).
of `--include-paths`.
--no-minimize-url;;
When tracking multiple directories (using `--stdlayout`,
- `--branches`, or `--tags` options), git svn will attempt to connect
+ `--branches`, or `--tags` options), `git svn` will attempt to connect
to the root (or highest allowed level) of the Subversion
repository. This default allows better tracking of history if
entire projects are moved within a repository, but may cause
issues on repositories where read access restrictions are in
- place. Passing `--no-minimize-url` will allow git svn to
+ place. Passing `--no-minimize-url` will allow `git svn` to
accept URLs as-is without attempting to connect to a higher
level directory. This option is off by default when only
one URL/branch is tracked (it would do little good).
@@ -130,7 +130,7 @@ This automatically updates the rev_map if needed (see
--localtime;;
Store Git commit times in the local time zone instead of UTC. This
- makes 'git log' (even without `--date=local`) show the same times
+ makes `git log` (even without `--date=local`) show the same times
that `svn log` would in the local time zone.
+
This doesn't interfere with interoperating with the Subversion
@@ -227,15 +227,15 @@ config key: `svn-remote.<name>.include-paths`
This fetches revisions from the SVN parent of the current `HEAD`
and rebases the current (uncommitted to SVN) work against it.
+
-This works similarly to `svn update` or 'git pull' except that
-it preserves linear history with 'git rebase' instead of
-'git merge' for ease of dcommitting with 'git svn'.
+This works similarly to `svn update` or `git pull` except that
+it preserves linear history with `git rebase` instead of
+`git merge` for ease of dcommitting with `git svn`.
+
-This accepts all options that 'git svn fetch' and 'git rebase'
+This accepts all options that `git svn fetch` and `git rebase`
accept. However, `--fetch-all` only fetches from the current
[svn-remote], and not all [svn-remote] definitions.
+
-Like 'git rebase'; this requires that the working tree be clean
+Like `git rebase`; this requires that the working tree be clean
and have no uncommitted changes.
+
This automatically updates the rev_map if needed (see
@@ -243,7 +243,7 @@ This automatically updates the rev_map if needed (see
-l;;
--local;;
- Do not fetch remotely; only run 'git rebase' against the
+ Do not fetch remotely; only run `git rebase` against the
last fetched commit from the upstream SVN.
'dcommit'::
@@ -262,7 +262,7 @@ Use of 'dcommit' is preferred to 'set-tree' (below).
After committing, do not rebase or reset.
--commit-url <URL>;;
Commit to this SVN URL (the full path). This is intended to
- allow existing 'git svn' repositories created with one transport
+ allow existing `git svn` repositories created with one transport
method (e.g. `svn://` or `http://` for anonymous read) to be
reused if a user is later given access to an alternate transport
method (e.g. `svn+ssh://` or `https://`) for commit.
@@ -289,7 +289,7 @@ discouraged.
[verse]
config key: `svn.pushmergeinfo`
+
-This option will cause git-svn to attempt to automatically populate the
+This option will cause `git-svn` to attempt to automatically populate the
svn:mergeinfo property in the SVN repository when possible. Currently, this can
only be done when dcommitting non-fast-forward merges where all parents but the
first have already been pushed into SVN.
@@ -299,7 +299,7 @@ first have already been pushed into 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
+`git svn dcommit` returns immediately if answer is "no" or "quit", without
committing anything to SVN.
'branch'::
@@ -312,7 +312,7 @@ committing anything to SVN.
-t;;
--tag;;
Create a tag by using the tags_subdir instead of the branches_subdir
- specified during git svn init.
+ specified during `git svn` init.
-d<path>;;
--destination=<path>;;
@@ -387,7 +387,7 @@ NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
client converts the UTC time to the local time (or based on the TZ=
environment). This command has the same behaviour.
+
-Any other arguments are passed directly to 'git log'
+Any other arguments are passed directly to `git log`
'blame'::
Show what revision and author last modified each line of a file. The
@@ -395,10 +395,10 @@ Any other arguments are passed directly to 'git log'
`svn blame' by default. Like the SVN blame command,
local uncommitted changes in the working tree are ignored;
the version of the file in the `HEAD` revision is annotated. Unknown
- arguments are passed directly to 'git blame'.
+ arguments are passed directly to `git blame`.
+
--git-format;;
- Produce output in the same format as 'git blame', but with
+ Produce output in the same format as `git blame`, but with
SVN revision numbers instead of Git commit hashes. In this mode,
changes that haven't been committed to SVN (including local
working-copy edits) are shown as revision 0.
@@ -428,7 +428,7 @@ Any other arguments are passed directly to 'git log'
absolutely no attempts to do patching when committing to SVN, it
simply overwrites files with those specified in the tree or
commit. All merging is assumed to have taken place
- independently of 'git svn' functions.
+ independently of `git svn` functions.
'create-ignore'::
Recursively finds the svn:ignore property on directories and
@@ -445,8 +445,8 @@ Any other arguments are passed directly to 'git log'
Attempts to recreate empty directories that core Git cannot track
based on information in $GIT_DIR/svn/<refname>/unhandled.log files.
Empty directories are automatically recreated when using
- "git svn clone" and "git svn rebase", so "mkdirs" is intended
- for use after commands like "git checkout" or "git reset".
+ `git svn clone` and `git svn rebase`, so "mkdirs" is intended
+ for use after commands like `git checkout` or `git reset`.
(See the `svn-remote.<name>.automkdirs` config file option for
more information.)
@@ -456,8 +456,8 @@ Any other arguments are passed directly to 'git log'
init`-ed repository. This command takes three arguments, (a) the
original tree to diff against, (b) the new tree result, (c) the
URL of the target Subversion repository. The final argument
- (URL) may be omitted if you are working from a 'git svn'-aware
- repository (that has been `init`-ed with 'git svn').
+ (URL) may be omitted if you are working from a `git svn`-aware
+ repository (that has been `init`-ed with `git svn`).
The `-r<revision>` option is required for this.
+
The commit message is supplied either directly with the `-m` or `-F`
@@ -525,7 +525,7 @@ This will set the property 'svn:keywords' to 'FreeBSD=%H' for the file
+
Only the rev_map and refs/remotes/git-svn are changed (see
'$GIT_DIR/svn/\**/.rev_map.*' in the FILES section below for details).
-Follow 'reset' with a 'fetch' and then 'git reset' or 'git rebase' to
+Follow 'reset' with a 'fetch' and then `git reset` or `git rebase` to
move local branches onto the new tree.
-r <n>;;
@@ -558,8 +558,8 @@ git svn fetch
r2---r3---A---B master
------------
+
-Then fixup `master` with 'git rebase'.
-Do NOT use 'git merge' or your history will not be compatible with a
+Then fixup `master` with `git rebase`.
+Do NOT use `git merge` or your history will not be compatible with a
future 'dcommit'!
+
[verse]
@@ -577,7 +577,7 @@ OPTIONS
--shared[=(false|true|umask|group|all|world|everybody)]::
--template=<template_directory>::
Only used with the 'init' command.
- These are passed directly to 'git init'.
+ These are passed directly to `git init`.
-r <arg>::
--revision <arg>::
@@ -597,7 +597,7 @@ and lost.
+
Read a list of commits from stdin and commit them in reverse
order. Only the leading sha1 is read from each line, so
-'git rev-list --pretty=oneline' output can be used.
+`git rev-list --pretty=oneline` output can be used.
--rmdir::
Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
@@ -626,7 +626,7 @@ config key: `svn.edit`
--find-copies-harder::
Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
+
-They are both passed directly to 'git diff-tree'; see
+They are both passed directly to `git diff-tree`; see
linkgit:git-diff-tree[1] for more information.
+
[verse]
@@ -635,17 +635,17 @@ config key: `svn.findcopiesharder`
-A<filename>::
--authors-file=<filename>::
- Syntax is compatible with the file used by 'git cvsimport' but
+ Syntax is compatible with the file used by `git cvsimport` but
an empty email address can be supplied with '<>':
+
------------------------------------------------------------------------
loginname = Joe User <user@example.com>
------------------------------------------------------------------------
+
-If this option is specified and 'git svn' encounters an SVN
-committer name that does not exist in the authors-file, 'git svn'
+If this option is specified and `git svn` encounters an SVN
+committer name that does not exist in the authors-file, `git svn`
will abort operation. The user will then have to add the
-appropriate entry. Re-running the previous 'git svn' command
+appropriate entry. Re-running the previous `git svn` command
after the authors-file is modified should continue operation.
+
[verse]
@@ -669,7 +669,7 @@ config key: `svn.authorsProg`
-q::
--quiet::
- Make 'git svn' less verbose. Specify a second time to make it
+ Make `git svn` less verbose. Specify a second time to make it
even less verbose.
-m::
@@ -681,8 +681,8 @@ config key: `svn.authorsProg`
--preserve-merges (DEPRECATED)::
These are only used with the 'dcommit' and 'rebase' commands.
+
-Passed directly to 'git rebase' when using 'dcommit' if a
-'git reset' cannot be used (see 'dcommit').
+Passed directly to `git rebase` when using 'dcommit' if a
+`git reset` cannot be used (see 'dcommit').
-n::
--dry-run::
@@ -741,7 +741,7 @@ ADVANCED OPTIONS
a suitable parent in the first Git commit for the branch.
This is especially helpful when we're tracking a directory
that has been moved around within the repository. If this
- feature is disabled, the branches created by 'git svn' will all
+ feature is disabled, the branches created by `git svn` will all
be linear and not share any history, meaning that there will be
no information on where branches were branched off or merged.
However, following long/convoluted histories can take a long
@@ -759,12 +759,12 @@ svn.noMetadata::
svn-remote.<name>.noMetadata::
This gets rid of the 'git-svn-id:' lines at the end of every commit.
+
-This option can only be used for one-shot imports as 'git svn'
+This option can only be used for one-shot imports as `git svn`
will not be able to fetch again without metadata. Additionally,
-if you lose your '$GIT_DIR/svn/\**/.rev_map.*' files, 'git svn' will not
+if you lose your '$GIT_DIR/svn/\**/.rev_map.*' files, `git svn` will not
be able to rebuild them.
+
-The 'git svn log' command will not work on repositories using
+The `git svn log` command will not work on repositories using
this, either. Using this conflicts with the 'useSvmProps'
option for (hopefully) obvious reasons.
+
@@ -778,7 +778,7 @@ and rewriting authorship info for non-`svn.authorsFile` users.
svn.useSvmProps::
svn-remote.<name>.useSvmProps::
- This allows 'git svn' to re-map repository URLs and UUIDs from
+ This allows `git svn` to re-map repository URLs and UUIDs from
mirrors created using SVN::Mirror (or svk) for metadata.
+
If an SVN revision has a property, "svm:headrev", it is likely
@@ -797,7 +797,7 @@ svn-remote.<name>.useSvnsyncprops::
svn-remote.<name>.rewriteRoot::
This allows users to create repositories from alternate
- URLs. For example, an administrator could run 'git svn' on the
+ URLs. For example, an administrator could run `git svn` on the
server locally (accessing via file://) but wish to distribute
the repository with a public http:// or svn:// URL in the
metadata so users of it will see the public URL.
@@ -823,26 +823,26 @@ svn.brokenSymlinkWorkaround::
broken symlinks checked into SVN by broken clients. Set this
option to "false" if you track a SVN repository with many
empty blobs that are not symlinks. This option may be changed
- while 'git svn' is running and take effect on the next
- revision fetched. If unset, 'git svn' assumes this option to
+ while `git svn` is running and take effect on the next
+ revision fetched. If unset, `git svn` assumes this option to
be "true".
svn.pathnameencoding::
- This instructs git svn to recode pathnames to a given encoding.
+ This instructs `git svn` to recode pathnames to a given encoding.
It can be used by windows users and by those who work in non-utf8
locales to avoid corrupted file names with non-ASCII characters.
Valid encodings are the ones supported by Perl's Encode module.
svn-remote.<name>.automkdirs::
- Normally, the "git svn clone" and "git svn rebase" commands
+ Normally, the `git svn clone` and `git svn rebase` commands
attempt to recreate empty directories that are in the
Subversion repository. If this option is set to "false", then
- empty directories will only be created if the "git svn mkdirs"
- command is run explicitly. If unset, 'git svn' assumes this
+ empty directories will only be created if the `git svn mkdirs`
+ command is run explicitly. If unset, `git svn` assumes this
option to be "true".
Since the noMetadata, rewriteRoot, rewriteUUID, useSvnsyncProps and useSvmProps
-options all affect the metadata generated and used by 'git svn'; they
+options all affect the metadata generated and used by `git svn`; they
*must* be set in the configuration file before any history is imported
and these settings should never be changed once they are set.
@@ -895,12 +895,12 @@ Tracking and contributing to an entire Subversion-managed project
# of dcommit/rebase/show-ignore should be the same as above.
------------------------------------------------------------------------
-The initial 'git svn clone' can be quite time-consuming
+The initial `git svn clone` can be quite time-consuming
(especially for large Subversion repositories). If multiple
people (or one person with multiple machines) want to use
-'git svn' to interact with the same Subversion repository, you can
-do the initial 'git svn clone' to a repository on a server and
-have each person clone that repository with 'git clone':
+`git svn` to interact with the same Subversion repository, you can
+do the initial `git svn clone` to a repository on a server and
+have each person clone that repository with `git clone`:
------------------------------------------------------------------------
# Do the initial import on a server
@@ -926,23 +926,23 @@ have each person clone that repository with 'git clone':
REBASE VS. PULL/MERGE
---------------------
-Prefer to use 'git svn rebase' or 'git rebase', rather than
-'git pull' or 'git merge' to synchronize unintegrated commits with a 'git svn'
+Prefer to use `git svn rebase` or `git rebase`, rather than
+`git pull` or `git merge` to synchronize unintegrated commits with a `git svn`
branch. Doing so will keep the history of unintegrated commits linear with
respect to the upstream SVN repository and allow the use of the preferred
-'git svn dcommit' subcommand to push unintegrated commits back into SVN.
+`git svn dcommit` subcommand to push unintegrated commits back into SVN.
-Originally, 'git svn' recommended that developers pulled or merged from
-the 'git svn' branch. This was because the author favored
+Originally, `git svn` recommended that developers pulled or merged from
+the `git svn` branch. This was because the author favored
`git svn set-tree B` to commit a single head rather than the
`git svn set-tree A..B` notation to commit multiple commits. Use of
-'git pull' or 'git merge' with `git svn set-tree A..B` will cause non-linear
+`git pull` or `git merge` with `git svn set-tree A..B` will cause non-linear
history to be flattened when committing into SVN and this can lead to merge
commits unexpectedly reversing previous commits in SVN.
MERGE TRACKING
--------------
-While 'git svn' can track
+While `git svn` can track
copy history (including branches and tags) for repositories adopting a
standard layout, it cannot yet represent merge history that happened
inside git back upstream to SVN users. Therefore it is advised that
@@ -951,25 +951,25 @@ compatibility with SVN (see the CAVEATS section below).
HANDLING OF SVN BRANCHES
------------------------
-If 'git svn' is configured to fetch branches (and `--follow-branches`
+If `git svn` is configured to fetch branches (and `--follow-branches`
is in effect), it sometimes creates multiple Git branches for one
SVN branch, where the additional branches have names of the form
`branchname@nnn` (with nnn an SVN revision number). These additional
-branches are created if 'git svn' cannot find a parent commit for the
+branches are created if `git svn` cannot find a parent commit for the
first commit in an SVN branch, to connect the branch to the history of
the other branches.
Normally, the first commit in an SVN branch consists
-of a copy operation. 'git svn' will read this commit to get the SVN
+of a copy operation. `git svn` will read this commit to get the SVN
revision the branch was created from. It will then try to find the
Git commit that corresponds to this SVN revision, and use that as the
parent of the branch. However, it is possible that there is no suitable
Git commit to serve as parent. This will happen, among other reasons,
-if the SVN branch is a copy of a revision that was not fetched by 'git
-svn' (e.g. because it is an old revision that was skipped with
+if the SVN branch is a copy of a revision that was not fetched by `git
+svn` (e.g. because it is an old revision that was skipped with
`--revision`), or if in SVN a directory was copied that is not tracked
-by 'git svn' (such as a branch that is not tracked at all, or a
-subdirectory of a tracked branch). In these cases, 'git svn' will still
+by `git svn` (such as a branch that is not tracked at all, or a
+subdirectory of a tracked branch). In these cases, `git svn` will still
create a Git branch, but instead of using an existing Git commit as the
parent of the branch, it will read the SVN history of the directory the
branch was copied from and create appropriate Git commits. This is
@@ -987,8 +987,8 @@ single SVN revision.
An example: in an SVN repository with a standard
trunk/tags/branches layout, a directory trunk/sub is created in r.100.
-In r.200, trunk/sub is branched by copying it to branches/. 'git svn
-clone -s' will then create a branch `sub`. It will also create new Git
+In r.200, trunk/sub is branched by copying it to branches/. `git svn
+clone -s` will then create a branch `sub`. It will also create new Git
commits for r.100 through r.199 and use these as the history of branch
`sub`. Thus there will be two Git commits for each revision from r.100
to r.199 (one containing trunk/, one containing trunk/sub/). Finally,
@@ -999,19 +999,19 @@ CAVEATS
-------
For the sake of simplicity and interoperating with Subversion,
-it is recommended that all 'git svn' users clone, fetch and dcommit
-directly from the SVN server, and avoid all 'git clone'/'pull'/'merge'/'push'
+it is recommended that all `git svn` users clone, fetch and dcommit
+directly from the SVN server, and avoid all `git clone`/`pull`/`merge`/`push`
operations between Git repositories and branches. The recommended
method of exchanging code between Git branches and users is
-'git format-patch' and 'git am', or just 'dcommit'ing to the SVN repository.
+`git format-patch` and `git am`, or just 'dcommit'ing to the SVN repository.
-Running 'git merge' or 'git pull' is NOT recommended on a branch you
+Running `git merge` or `git pull` is NOT recommended on a branch you
plan to 'dcommit' from because Subversion users cannot see any
merges you've made. Furthermore, if you merge or pull from a Git branch
that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
branch.
-If you do merge, note the following rule: 'git svn dcommit' will
+If you do merge, note the following rule: `git svn dcommit` will
attempt to commit on top of the SVN commit named in
------------------------------------------------------------------------
git log --grep=^git-svn-id: --first-parent -1
@@ -1021,12 +1021,12 @@ you want to dcommit to is the 'first' parent of the merge. Chaos will
ensue otherwise, especially if the first parent is an older commit on
the same SVN branch.
-'git clone' does not clone branches under the refs/remotes/ hierarchy or
-any 'git svn' metadata, or config. So repositories created and managed with
-using 'git svn' should use 'rsync' for cloning, if cloning is to be done
+`git clone` does not clone branches under the refs/remotes/ hierarchy or
+any `git svn` metadata, or config. So repositories created and managed with
+using `git svn` should use 'rsync' for cloning, if cloning is to be done
at all.
-Since 'dcommit' uses rebase internally, any Git branches you 'git push' to
+Since 'dcommit' uses rebase internally, any Git branches you `git push` to
before 'dcommit' on will require forcing an overwrite of the existing ref
on the remote repository. This is generally considered bad practice,
see the linkgit:git-push[1] documentation for details.
@@ -1038,7 +1038,7 @@ dcommit with SVN is analogous to that.
When cloning an SVN repository, if none of the options for describing
the repository layout is used (`--trunk`, `--tags`, `--branches`,
-`--stdlayout`), 'git svn clone' will create a Git repository with
+`--stdlayout`), `git svn clone` will create a Git repository with
completely linear history, where branches and tags appear as separate
directories in the working copy. While this is the easiest way to get a
copy of a complete repository, for projects with many branches it will
@@ -1051,7 +1051,7 @@ without giving any repository layout options. If the full history with
branches and tags is required, the options `--trunk` / `--branches` /
`--tags` must be used.
-When using multiple `--branches` or `--tags`, 'git svn' does not automatically
+When using multiple `--branches` or `--tags`, `git svn` does not automatically
handle name collisions (for example, if two branches from different paths have
the same name, or if a branch and a tag have the same name). In these cases,
use 'init' to set up your Git repository then, before your first 'fetch', edit
@@ -1076,14 +1076,14 @@ for Git to detect them.
In SVN, it is possible (though discouraged) to commit changes to a tag
(because a tag is just a directory copy, thus technically the same as a
-branch). When cloning an SVN repository, 'git svn' cannot know if such a
+branch). When cloning an SVN repository, `git svn` cannot know if such a
commit to a tag will happen in the future. Thus it acts conservatively
and imports all SVN tags as branches, prefixing the tag name with 'tags/'.
CONFIGURATION
-------------
-'git svn' stores [svn-remote] configuration information in the
+`git svn` stores [svn-remote] configuration information in the
repository $GIT_DIR/config file. It is similar the core Git
[remote] sections except 'fetch' keys do not accept glob
arguments; but they are instead handled by the 'branches'
@@ -1106,7 +1106,7 @@ Keep in mind that the `*` (asterisk) wildcard of the local ref
however the remote wildcard may be anywhere as long as it's an
independent path component (surrounded by `/` or EOL). This
type of configuration is not automatically created by 'init' and
-should be manually entered with a text-editor or using 'git config'.
+should be manually entered with a text-editor or using `git config`.
Also note that only one asterisk is allowed per word. For example:
@@ -1148,7 +1148,7 @@ location to use using the `-d` or `--destination` flag:
$ git svn branch -d branches/server release-2-3-0
------------------------------------------------------------------------
-Note that git-svn keeps track of the highest revision in which a branch
+Note that `git-svn` keeps track of the highest revision in which a branch
or tag has appeared. If the subset of branches or tags is changed after
fetching, then $GIT_DIR/svn/.metadata must be manually edited to remove
(or reset) branches-maxRev and/or tags-maxRev as appropriate.
@@ -1162,8 +1162,8 @@ $GIT_DIR/svn/\**/.rev_map.*::
end of every commit (see the `svn.noMetadata` section above for
details).
+
-'git svn fetch' and 'git svn rebase' automatically update the rev_map
-if it is missing or not up to date. 'git svn reset' automatically
+`git svn fetch` and `git svn rebase` automatically update the rev_map
+if it is missing or not up to date. `git svn reset` automatically
rewinds it.
SEE ALSO
diff --git a/Documentation/git-switch.txt b/Documentation/git-switch.txt
index 5737f25cf6..da16df9efa 100644
--- a/Documentation/git-switch.txt
+++ b/Documentation/git-switch.txt
@@ -8,10 +8,10 @@ git-switch - Switch branches
SYNOPSIS
--------
[verse]
-'git switch' [<options>] [--no-guess] <branch>
-'git switch' [<options>] --detach [<start-point>]
-'git switch' [<options>] (-c|-C) <new-branch> [<start-point>]
-'git switch' [<options>] --orphan <new-branch>
+`git switch` [<options>] [--no-guess] <branch>
+`git switch` [<options>] --detach [<start-point>]
+`git switch` [<options>] (-c|-C) <new-branch> [<start-point>]
+`git switch` [<options>] --orphan <new-branch>
DESCRIPTION
-----------
@@ -47,7 +47,7 @@ OPTIONS
from some other point.)
+
You can use the `@{-N}` syntax to refer to the N-th last
-branch/commit switched to using "git switch" or "git checkout"
+branch/commit switched to using `git switch` or `git checkout`
operation. You may also specify `-` which is synonymous to `@{-1}`.
This is often used to switch quickly between two branches, or to undo
a branch switch by mistake.
diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt
index 2cbec2d033..0c19b1e70e 100644
--- a/Documentation/git-symbolic-ref.txt
+++ b/Documentation/git-symbolic-ref.txt
@@ -8,9 +8,9 @@ git-symbolic-ref - Read, modify and delete symbolic refs
SYNOPSIS
--------
[verse]
-'git symbolic-ref' [-m <reason>] <name> <ref>
-'git symbolic-ref' [-q] [--short] <name>
-'git symbolic-ref' --delete [-q] <name>
+`git symbolic-ref` [-m <reason>] <name> <ref>
+`git symbolic-ref` [-q] [--short] <name>
+`git symbolic-ref` --delete [-q] <name>
DESCRIPTION
-----------
@@ -60,7 +60,7 @@ But symbolic links are not entirely portable, so they are now
deprecated and symbolic refs (as described above) are used by
default.
-'git symbolic-ref' will exit with status 0 if the contents of the
+`git symbolic-ref` will exit with status 0 if the contents of the
symbolic ref were printed correctly, with status 1 if the requested
name is not a symbolic ref, or 128 if another error occurs.
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 13a0d2abbb..6de16cec54 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -9,14 +9,14 @@ git-tag - Create, list, delete or verify a tag object signed with GPG
SYNOPSIS
--------
[verse]
-'git tag' [-a | -s | -u <keyid>] [-f] [-m <msg> | -F <file>] [-e]
+`git tag` [-a | -s | -u <keyid>] [-f] [-m <msg> | -F <file>] [-e]
<tagname> [<commit> | <object>]
-'git tag' -d <tagname>...
-'git tag' [-n[<num>]] -l [--contains <commit>] [--no-contains <commit>]
+`git tag` -d <tagname>...
+`git tag` [-n[<num>]] -l [--contains <commit>] [--no-contains <commit>]
[--points-at <object>] [--column[=<options>] | --no-column]
[--create-reflog] [--sort=<key>] [--format=<format>]
[--merged <commit>] [--no-merged <commit>] [<pattern>...]
-'git tag' -v [--format=<format>] <tagname>...
+`git tag` -v [--format=<format>] <tagname>...
DESCRIPTION
-----------
@@ -50,7 +50,7 @@ tagging message, and an optional GnuPG signature. Whereas a
object).
Annotated tags are meant for release while lightweight tags are meant
-for private or temporary object labels. For this reason, some git
+for private or temporary object labels. For this reason, some `git`
commands for naming objects (like `git describe`) will ignore
lightweight tags by default.
@@ -101,7 +101,7 @@ If the tag is not annotated, the commit message is displayed instead.
List tags. With optional `<pattern>...`, e.g. `git tag --list
'v-*'`, list only the tags that match the pattern(s).
+
-Running "git tag" without arguments also lists all tags. The pattern
+Running `git tag` without arguments also lists all tags. The pattern
is a shell wildcard (i.e., matched using fnmatch(3)). Multiple
patterns may be given; if any of them matches, the tag is shown.
+
@@ -213,7 +213,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
+By default, `git tag` in sign-with-default mode (-s) will use your
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:
@@ -252,12 +252,12 @@ the old tag. In that case you can do one of two things:
. The insane thing.
You really want to call the new version "X" too, 'even though'
- others have already seen the old one. So just use 'git tag -f'
+ others have already seen the old one. So just use `git tag -f`
again, as if you hadn't already published the old one.
However, Git does *not* (and it should not) change tags behind
users back. So if somebody already got the old tag, doing a
-'git pull' on your tree shouldn't just make them overwrite the old
+`git pull` on your tree shouldn't just make them overwrite the old
one.
If somebody got a release tag from you, you cannot just change
@@ -309,7 +309,7 @@ private anchor point tags from the other person.
Often, "please pull" messages on the mailing list just provide
two pieces of information: a repo URL and a branch name; this
-is designed to be easily cut&pasted at the end of a 'git fetch'
+is designed to be easily cut&pasted at the end of a `git fetch`
command line:
------------
@@ -363,7 +363,7 @@ If you have imported some changes from another VCS and would like
to add tags for major releases of your work, it is useful to be able
to specify the date to embed inside of the tag object; such data in
the tag object affects, for example, the ordering of tags in the
-gitweb interface.
+`gitweb` interface.
To set the date used in future tag objects, set the environment
variable GIT_COMMITTER_DATE (see the later discussion of possible
diff --git a/Documentation/git-unpack-file.txt b/Documentation/git-unpack-file.txt
index e9f148a00d..85c5f120e5 100644
--- a/Documentation/git-unpack-file.txt
+++ b/Documentation/git-unpack-file.txt
@@ -10,7 +10,7 @@ git-unpack-file - Creates a temporary file with a blob's contents
SYNOPSIS
--------
[verse]
-'git unpack-file' <blob>
+`git unpack-file` <blob>
DESCRIPTION
-----------
diff --git a/Documentation/git-unpack-objects.txt b/Documentation/git-unpack-objects.txt
index b3de50d710..ad10299337 100644
--- a/Documentation/git-unpack-objects.txt
+++ b/Documentation/git-unpack-objects.txt
@@ -9,7 +9,7 @@ git-unpack-objects - Unpack objects from a packed archive
SYNOPSIS
--------
[verse]
-'git unpack-objects' [-n] [-q] [-r] [--strict]
+`git unpack-objects` [-n] [-q] [-r] [--strict]
DESCRIPTION
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index 4eae32e711..ec501232ad 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -9,7 +9,7 @@ git-update-index - Register file contents in the working tree to the index
SYNOPSIS
--------
[verse]
-'git update-index'
+`git update-index`
[--add] [--remove | --force-remove] [--replace]
[--refresh] [-q] [--unmerged] [--ignore-missing]
[(--cacheinfo <mode>,<object>,<file>)...]
@@ -36,7 +36,7 @@ any 'unmerged' or 'needs updating' state is cleared.
See also linkgit:git-add[1] for a more user-friendly way to do some of
the most common operations on the index.
-The way 'git update-index' handles files it is told about can be modified
+The way `git update-index` handles files it is told about can be modified
using the various options:
OPTIONS
@@ -58,7 +58,7 @@ OPTIONS
-q::
Quiet. If `--refresh` finds that the index needs an update, the
default behavior is to error out. This option makes
- 'git update-index' continue anyway.
+ `git update-index` continue anyway.
--ignore-submodules::
Do not try to update submodules. This option is only respected
@@ -66,7 +66,7 @@ OPTIONS
--unmerged::
If `--refresh` finds unmerged changes in the index, the default
- behavior is to error out. This option makes 'git update-index'
+ behavior is to error out. This option makes `git update-index`
continue anyway.
--ignore-missing::
@@ -126,7 +126,7 @@ you will need to handle the situation manually.
-g::
--again::
- Runs 'git update-index' itself on the paths whose index
+ Runs `git update-index` itself on the paths whose index
entries are different from those from the `HEAD` commit.
--unresolve::
@@ -144,7 +144,7 @@ you will need to handle the situation manually.
--replace::
By default, when a file `path` exists in the index,
- 'git update-index' refuses an attempt to add `path/file`.
+ `git update-index` refuses an attempt to add `path/file`.
Similarly if a file `path/file` exists, a file `path`
cannot be added. With `--replace` flag, existing entries
that conflict with the entry being added are
@@ -241,7 +241,7 @@ up to date for mode/content changes. But what it *does* do is to
can refresh the index for a file that hasn't been changed but where
the stat entry is out of date.
-For example, you'd want to do this after doing a 'git read-tree', to link
+For example, you'd want to do this after doing a `git read-tree`, to link
up the stat index details with the proper files.
USING --CACHEINFO OR --INFO-ONLY
@@ -280,7 +280,7 @@ This format is to stuff `git ls-tree` output into the index.
. mode SP sha1 SP stage TAB path
+
This format is to put higher order stages into the
-index file and matches 'git ls-files --stage' output.
+index file and matches `git ls-files --stage` output.
. mode SP sha1 TAB path
+
@@ -344,8 +344,8 @@ have the "assume unchanged" bit set, use `git ls-files -v`
The command looks at `core.ignorestat` configuration variable. When
this is true, paths updated with `git update-index paths...` and
paths updated with other Git commands that update both index and
-working tree (e.g. 'git apply --index', 'git checkout-index -u',
-and 'git read-tree -u') are automatically marked as "assume
+working tree (e.g. `git apply --index`, `git checkout-index -u`,
+and `git read-tree -u`) are automatically marked as "assume
unchanged". Note that "assume unchanged" bit is *not* set if
`git update-index --refresh` finds the working tree file matches
the index (use `git update-index --really-refresh` if you want
@@ -468,8 +468,8 @@ the index.
Before 2.17, the untracked cache had a bug where replacing a directory
with a symlink to another directory could cause it to incorrectly show
-files tracked by git as untracked. See the "status: add a failing test
-showing a core.untrackedCache bug" commit to git.git. A workaround for
+files tracked by `git` as untracked. See the "status: add a failing test
+showing a `core.untrackedCache` bug" commit to git.git. A workaround for
that is (and this might work for other undiscovered bugs in the
future):
@@ -480,27 +480,27 @@ $ git -c core.untrackedCache=false status
This bug has also been shown to affect non-symlink cases of replacing
a directory with a file when it comes to the internal structures of
the untracked cache, but no case has been reported where this resulted in
-wrong "git status" output.
+wrong `git status` output.
-There are also cases where existing indexes written by git versions
+There are also cases where existing indexes written by `git` versions
before 2.17 will reference directories that don't exist anymore,
potentially causing many "could not open directory" warnings to be
-printed on "git status". These are new warnings for existing issues
+printed on `git status`. These are new warnings for existing issues
that were previously silently discarded.
-As with the bug described above the solution is to one-off do a "git
-status" run with `core.untrackedCache=false` to flush out the leftover
+As with the bug described above the solution is to one-off do a `git
+status` run with `core.untrackedCache=false` to flush out the leftover
bad data.
FILE SYSTEM MONITOR
-------------------
-This feature is intended to speed up git operations for repos that have
+This feature is intended to speed up `git` operations for repos that have
large working directories.
-It enables git to work together with a file system monitor (see the
+It enables `git` to work together with a file system monitor (see the
"fsmonitor-watchman" section of linkgit:githooks[5]) that can
-inform it as to what files have been modified. This enables git to avoid
+inform it as to what files have been modified. This enables `git` to avoid
having to lstat() every file to find modified files.
When used in conjunction with the untracked cache, it can further improve
@@ -529,7 +529,7 @@ unreliable, this should be set to 'false' (see linkgit:git-config[1]).
This causes the command to ignore differences in file modes recorded
in the index and the file mode on the filesystem if they differ only on
executable bit. On such an unfortunate filesystem, you may
-need to use 'git update-index --chmod='.
+need to use `git update-index --chmod=`.
Quite similarly, if `core.symlinks` configuration variable is set
to 'false' (see linkgit:git-config[1]), symbolic links are checked out
diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index f8aeea4cb4..3ad7771676 100644
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -8,7 +8,7 @@ git-update-ref - Update the object name stored in a ref safely
SYNOPSIS
--------
[verse]
-'git update-ref' [-m <reason>] [--no-deref] (-d <ref> [<oldvalue>] | [--create-reflog] <ref> <newvalue> [<oldvalue>] | --stdin [-z])
+`git update-ref` [-m <reason>] [--no-deref] (-d <ref> [<oldvalue>] | [--create-reflog] <ref> <newvalue> [<oldvalue>] | --stdin [-z])
DESCRIPTION
-----------
diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt
index 969bb2e15f..8dbb1a6172 100644
--- a/Documentation/git-update-server-info.txt
+++ b/Documentation/git-update-server-info.txt
@@ -9,7 +9,7 @@ git-update-server-info - Update auxiliary info file to help dumb servers
SYNOPSIS
--------
[verse]
-'git update-server-info'
+`git update-server-info`
DESCRIPTION
-----------
diff --git a/Documentation/git-upload-archive.txt b/Documentation/git-upload-archive.txt
index fba0f1c1b2..36f7901adb 100644
--- a/Documentation/git-upload-archive.txt
+++ b/Documentation/git-upload-archive.txt
@@ -9,15 +9,15 @@ git-upload-archive - Send archive back to git-archive
SYNOPSIS
--------
[verse]
-'git upload-archive' <directory>
+`git upload-archive` <directory>
DESCRIPTION
-----------
-Invoked by 'git archive --remote' and sends a generated archive to the
+Invoked by `git archive --remote` and sends a generated archive to the
other end over the Git protocol.
This command is usually not invoked directly by the end user. The UI
-for the protocol is on the 'git archive' side, and the program pair
+for the protocol is on the `git archive` side, and the program pair
is meant to be used to get an archive from a remote repository.
SECURITY
@@ -43,7 +43,7 @@ but easier-to-check set of rules:
Note that rule 3 disallows many cases that do not have any privacy
implications. These rules are subject to change in future versions of
-git, and the server accessed by `git archive --remote` may or may not
+`git`, and the server accessed by `git archive --remote` may or may not
follow these exact rules.
If the config option `uploadArchive.allowUnreachable` is true, these
diff --git a/Documentation/git-upload-pack.txt b/Documentation/git-upload-pack.txt
index 9822c1eb1a..f4b9dab02e 100644
--- a/Documentation/git-upload-pack.txt
+++ b/Documentation/git-upload-pack.txt
@@ -9,18 +9,18 @@ git-upload-pack - Send objects packed back to git-fetch-pack
SYNOPSIS
--------
[verse]
-'git-upload-pack' [--[no-]strict] [--timeout=<n>] [--stateless-rpc]
+`git-upload-pack` [--[no-]strict] [--timeout=<n>] [--stateless-rpc]
[--advertise-refs] <directory>
DESCRIPTION
-----------
-Invoked by 'git fetch-pack', learns what
+Invoked by `git fetch-pack`, learns what
objects the other side is missing, and sends them after packing.
This command is usually not invoked directly by the end user.
-The UI for the protocol is on the 'git fetch-pack' side, and the
+The UI for the protocol is on the `git fetch-pack` side, and the
program pair is meant to be used to pull updates from a remote
-repository. For push operations, see 'git send-pack'.
+repository. For push operations, see `git send-pack`.
OPTIONS
-------
diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt
index 6072f936ab..3e356129cd 100644
--- a/Documentation/git-var.txt
+++ b/Documentation/git-var.txt
@@ -9,7 +9,7 @@ git-var - Show a Git logical variable
SYNOPSIS
--------
[verse]
-'git var' ( -l | <variable> )
+`git var` ( -l | <variable> )
DESCRIPTION
-----------
diff --git a/Documentation/git-verify-commit.txt b/Documentation/git-verify-commit.txt
index 92097f6673..87ed1cae5d 100644
--- a/Documentation/git-verify-commit.txt
+++ b/Documentation/git-verify-commit.txt
@@ -8,11 +8,11 @@ git-verify-commit - Check the GPG signature of commits
SYNOPSIS
--------
[verse]
-'git verify-commit' <commit>...
+`git verify-commit` <commit>...
DESCRIPTION
-----------
-Validates the GPG signature created by 'git commit -S'.
+Validates the GPG signature created by `git commit -S`.
OPTIONS
-------
diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt
index e1e537fcfb..8163a86940 100644
--- a/Documentation/git-verify-pack.txt
+++ b/Documentation/git-verify-pack.txt
@@ -9,13 +9,13 @@ git-verify-pack - Validate packed Git archive files
SYNOPSIS
--------
[verse]
-'git verify-pack' [-v|--verbose] [-s|--stat-only] [--] <pack>.idx ...
+`git verify-pack` [-v|--verbose] [-s|--stat-only] [--] <pack>.idx ...
DESCRIPTION
-----------
Reads given idx file for packed Git archive created with the
-'git pack-objects' command and verifies idx file and the
+`git pack-objects` command and verifies idx file and the
corresponding pack file.
OPTIONS
diff --git a/Documentation/git-verify-tag.txt b/Documentation/git-verify-tag.txt
index 0b8075dad9..343e209fc5 100644
--- a/Documentation/git-verify-tag.txt
+++ b/Documentation/git-verify-tag.txt
@@ -8,11 +8,11 @@ git-verify-tag - Check the GPG signature of tags
SYNOPSIS
--------
[verse]
-'git verify-tag' [--format=<format>] <tag>...
+`git verify-tag` [--format=<format>] <tag>...
DESCRIPTION
-----------
-Validates the gpg signature created by 'git tag'.
+Validates the gpg signature created by `git tag`.
OPTIONS
-------
diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt
index 6fbe8d5583..0e788b1208 100644
--- a/Documentation/git-web--browse.txt
+++ b/Documentation/git-web--browse.txt
@@ -8,7 +8,7 @@ git-web--browse - Git helper script to launch a web browser
SYNOPSIS
--------
[verse]
-'git web{litdd}browse' [<options>] <url|file>...
+`git web--browse` [<options>] <url|file>...
DESCRIPTION
-----------
@@ -71,7 +71,7 @@ browser.<tool>.path
You can explicitly provide a full path to your preferred browser by
setting the configuration variable `browser.<tool>.path`. For example,
you can configure the absolute path to firefox by setting
-`browser.firefox.path`. Otherwise, 'git web{litdd}browse' assumes the tool
+`browser.firefox.path`. Otherwise, `git web--browse` assumes the tool
is available in PATH.
browser.<tool>.cmd
@@ -80,7 +80,7 @@ browser.<tool>.cmd
When the browser, specified by options or configuration variables, is
not among the supported ones, then the corresponding
`browser.<tool>.cmd` configuration variable will be looked up. If this
-variable exists then 'git web{litdd}browse' will treat the specified tool
+variable exists then `git web--browse` will treat the specified tool
as a custom command and will use a shell eval to run the command with
the URLs passed as arguments.
@@ -106,7 +106,7 @@ the following:
cmd = A_PATH_TO/konqueror
------------------------------------------------
-Note about git-config --global
+Note about `git-config --global`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Note that these configuration variables should probably be set using
diff --git a/Documentation/git-whatchanged.txt b/Documentation/git-whatchanged.txt
index 798a43965b..5557c288f4 100644
--- a/Documentation/git-whatchanged.txt
+++ b/Documentation/git-whatchanged.txt
@@ -9,7 +9,7 @@ git-whatchanged - Show logs with difference each commit introduces
SYNOPSIS
--------
[verse]
-'git whatchanged' <option>...
+`git whatchanged` <option>...
DESCRIPTION
-----------
@@ -34,9 +34,9 @@ Examples
`git whatchanged --since="2 weeks ago" -- gitk`::
- Show the changes during the last two weeks to the file 'gitk'.
+ Show the changes during the last two weeks to the file `gitk`.
The `--` is necessary to avoid confusion with the *branch* named
- 'gitk'
+ `gitk`
GIT
---
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 35bb1bb120..95fa3b673c 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -9,21 +9,21 @@ git-worktree - Manage multiple working trees
SYNOPSIS
--------
[verse]
-'git worktree add' [-f] [--detach] [--checkout] [--lock] [-b <new-branch>] <path> [<commit-ish>]
-'git worktree list' [--porcelain]
-'git worktree lock' [--reason <string>] <worktree>
-'git worktree move' <worktree> <new-path>
-'git worktree prune' [-n] [-v] [--expire <expire>]
-'git worktree remove' [-f] <worktree>
-'git worktree repair' [<path>...]
-'git worktree unlock' <worktree>
+`git worktree add` [-f] [--detach] [--checkout] [--lock] [-b <new-branch>] <path> [<commit-ish>]
+`git worktree list` [--porcelain]
+`git worktree lock` [--reason <string>] <worktree>
+`git worktree move` <worktree> <new-path>
+`git worktree prune` [-n] [-v] [--expire <expire>]
+`git worktree remove` [-f] <worktree>
+`git worktree repair` [<path>...]
+`git worktree unlock` <worktree>
DESCRIPTION
-----------
Manage multiple working trees attached to the same repository.
-A git repository can support multiple working trees, allowing you to check
+A `git` repository can support multiple working trees, allowing you to check
out more than one branch at a time. With `git worktree add` a new working
tree is associated with the repository. This new working tree is called a
"linked working tree" as opposed to the "main working tree" prepared by
diff --git a/Documentation/git-write-tree.txt b/Documentation/git-write-tree.txt
index f22041a9dc..295a8715cb 100644
--- a/Documentation/git-write-tree.txt
+++ b/Documentation/git-write-tree.txt
@@ -9,7 +9,7 @@ git-write-tree - Create a tree object from the current index
SYNOPSIS
--------
[verse]
-'git write-tree' [--missing-ok] [--prefix=<prefix>/]
+`git write-tree` [--missing-ok] [--prefix=<prefix>/]
DESCRIPTION
-----------
@@ -18,17 +18,17 @@ tree object is printed to standard output.
The index must be in a fully merged state.
-Conceptually, 'git write-tree' sync()s the current index contents
+Conceptually, `git write-tree` sync()s the current index contents
into a set of tree files.
In order to have that match what is actually in your directory right
-now, you need to have done a 'git update-index' phase before you did the
-'git write-tree'.
+now, you need to have done a `git update-index` phase before you did the
+`git write-tree`.
OPTIONS
-------
--missing-ok::
- Normally 'git write-tree' ensures that the objects referenced by the
+ Normally `git write-tree` ensures that the objects referenced by the
directory exist in the object database. This option disables this
check.
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 6aafa3a15c..6486abdd4d 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -9,7 +9,7 @@ git - the stupid content tracker
SYNOPSIS
--------
[verse]
-'git' [--version] [--help] [-C <path>] [-c <name>=<value>]
+`git` [--version] [--help] [-C <path>] [-c <name>=<value>]
[--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
[-p|--paginate|-P|--no-pager] [--no-replace-objects] [--bare]
[--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
@@ -29,7 +29,7 @@ in-depth introduction.
After you mastered the basic concepts, you can come back to this
page to learn what commands Git offers. You can learn more about
-individual Git commands with "git help command". linkgit:gitcli[7]
+individual Git commands with `git help command`. linkgit:gitcli[7]
manual page gives you an overview of the command-line command syntax.
A formatted and hyperlinked copy of the latest Git documentation
@@ -40,7 +40,7 @@ or https://git-scm.com/docs.
OPTIONS
-------
--version::
- Prints the Git suite version that the 'git' program came from.
+ Prints the Git suite version that the `git` program came from.
--help::
Prints the synopsis and a list of the most commonly used
@@ -54,7 +54,7 @@ because `git --help ...` is converted internally into `git
help ...`.
-C <path>::
- Run as if git was started in '<path>' instead of the current working
+ Run as if `git` was started in '<path>' instead of the current working
directory. When multiple `-C` options are given, each subsequent
non-absolute `-C <path>` is interpreted relative to the preceding `-C
<path>`. If '<path>' is present but empty, e.g. `-C ""`, then the
@@ -72,7 +72,7 @@ example the following invocations are equivalent:
Pass a configuration parameter to the command. The value
given will override values from configuration files.
The <name> is expected in the same format as listed by
- 'git config' (subkeys separated by dots).
+ `git config` (subkeys separated by dots).
+
Note that omitting the `=` in `git -c foo.bar ...` is allowed and sets
`foo.bar` to the boolean true value (just like `[foo]bar` would in a
@@ -91,7 +91,7 @@ foo.bar= ...`) sets `foo.bar` to the empty string which `git config
to avoid ambiguity with `<name>` containing one.
+
This is useful for cases where you want to pass transitory
-configuration options to git, but are doing so on OS's where
+configuration options to `git`, but are doing so on OS's where
other processes might be able to read your cmdline
(e.g. `/proc/self/cmdline`), but not your environ
(e.g. `/proc/self/environ`). That behavior is the default on
@@ -105,7 +105,7 @@ sensitive information can be part of the key.
--exec-path[=<path>]::
Path to wherever your core Git programs are installed.
This can also be controlled by setting the GIT_EXEC_PATH
- environment variable. If no path is given, 'git' will print
+ environment variable. If no path is given, `git` will print
the current setting and then exit.
--html-path::
@@ -147,7 +147,7 @@ should tell Git where the top-level of the working tree is,
with the `--work-tree=<path>` option (or `GIT_WORK_TREE`
environment variable)
+
-If you just want to run git as if it was started in `<path>` then use
+If you just want to run `git` as if it was started in `<path>` then use
`git -C <path>`.
--work-tree=<path>::
@@ -207,7 +207,7 @@ If you just want to run git as if it was started in `<path>` then use
option and may change or be removed in the future. Supported
groups are: builtins, parseopt (builtin commands that use
parse-options), main (all commands in libexec directory),
- others (all other commands in `$PATH` that have git- prefix),
+ others (all other commands in `$PATH` that have `git`- prefix),
list-<category> (see categories in command-list.txt),
nohelpers (exclude helper commands), alias and config
(retrieve command list from config variable `completion.commands`)
@@ -588,7 +588,7 @@ where:
<old|new>-mode:: are the octal representation of the file modes.
+
The file parameters can point at the user's working file
-(e.g. `new-file` in "git-diff-files"), `/dev/null` (e.g. `old-file`
+(e.g. `new-file` in `git-diff-files`), `/dev/null` (e.g. `old-file`
when a new file is added), or a temporary file (e.g. `old-file` in the
index). `GIT_EXTERNAL_DIFF` should not worry about unlinking the
temporary file --- it is removed when `GIT_EXTERNAL_DIFF` exits.
@@ -636,8 +636,8 @@ other
`GIT_SSH`::
`GIT_SSH_COMMAND`::
- If either of these environment variables is set then 'git fetch'
- and 'git push' will use the specified command instead of 'ssh'
+ If either of these environment variables is set then `git fetch`
+ and `git push` will use the specified command instead of 'ssh'
when they need to connect to a remote system.
The command-line parameters passed to the configured command are
determined by the ssh variant. See `ssh.variant` option in
@@ -667,7 +667,7 @@ for further details.
option in linkgit:git-config[1].
`GIT_TERMINAL_PROMPT`::
- If this environment variable is set to `0`, git will not prompt
+ If this environment variable is set to `0`, `git` will not prompt
on the terminal (e.g., when asking for HTTP authentication).
`GIT_CONFIG_NOSYSTEM`::
@@ -680,8 +680,8 @@ for further details.
`GIT_FLUSH`::
If this environment variable is set to "1", then commands such
- as 'git blame' (in incremental mode), 'git rev-list', 'git log',
- 'git check-attr' and 'git check-ignore' will
+ as `git blame` (in incremental mode), `git rev-list`, `git log`,
+ `git check-attr` and `git check-ignore` will
force a flush of the output stream after each record have been
flushed. If this
variable is set to "0", the output of these commands will be done
@@ -760,7 +760,7 @@ of clones and fetches.
`GIT_TRACE_CURL`::
Enables a curl full trace dump of all incoming and outgoing data,
- including descriptive information, of the git transport protocol.
+ including descriptive information, of the `git` transport protocol.
This is similar to doing curl `--trace-ascii` on the command line.
See `GIT_TRACE` for available trace output options.
@@ -855,7 +855,7 @@ for full details.
`GIT_REF_PARANOIA`::
If set to `1`, include broken or badly named refs when iterating
over lists of refs. In a normal, non-corrupted repository, this
- does nothing. However, enabling it may help git to detect and
+ does nothing. However, enabling it may help `git` to detect and
abort some operations in the presence of broken refs. Git sets
this variable automatically when performing destructive
operations like linkgit:git-prune[1]. You should not need to set
@@ -876,7 +876,7 @@ for full details.
Set to 0 to prevent protocols used by fetch/push/clone which are
configured to the `user` state. This is useful to restrict recursive
submodule initialization from an untrusted repository or for programs
- which feed potentially-untrusted URLS to git commands. See
+ which feed potentially-untrusted URLS to `git` commands. See
linkgit:git-config[1] for more details.
`GIT_PROTOCOL`::
diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
index f77d8487bd..2ce7365ec6 100644
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt
@@ -112,10 +112,10 @@ Checking-out and checking-in
These attributes affect how the contents stored in the
repository are copied to the working tree files when commands
-such as 'git switch', 'git checkout' and 'git merge' run.
+such as `git switch`, `git checkout` and `git merge` run.
They also affect how
Git stores the contents you prepare in the working tree in the
-repository upon 'git add' and 'git commit'.
+repository upon `git add` and `git commit`.
`text`
^^^^^^
@@ -247,8 +247,8 @@ $ git status # Show files that will be normalized
$ git commit -m "Introduce end-of-line normalization"
-------------------------------------------------
-If any files that should not be normalized show up in 'git status',
-unset their `text` attribute before running 'git add -u'.
+If any files that should not be normalized show up in `git status`,
+unset their `text` attribute before running `git add -u`.
------------------------
manual.pdf -text
@@ -269,16 +269,16 @@ an irreversible conversion. The safety triggers to prevent such
a conversion done to the files in the work tree, but there are a
few exceptions. Even though...
-- 'git add' itself does not touch the files in the work tree, the
+- `git add` itself does not touch the files in the work tree, the
next checkout would, so the safety triggers;
-- 'git apply' to update a text file with a patch does touch the files
+- `git apply` to update a text file with a patch does touch the files
in the work tree, but the operation is about text files and CRLF
conversion is about fixing the line ending inconsistencies, so the
safety does not trigger;
-- 'git diff' itself does not touch the files in the work tree, it is
- often run to inspect the changes you intend to next 'git add'. To
+- `git diff` itself does not touch the files in the work tree, it is
+ often run to inspect the changes you intend to next `git add`. To
catch potential problems early, safety triggers.
@@ -288,7 +288,7 @@ few exceptions. Even though...
Git recognizes files encoded in ASCII or one of its supersets (e.g.
UTF-8, ISO-8859-1, ...) as text files. Files encoded in certain other
encodings (e.g. UTF-16) are interpreted as binary and consequently
-built-in Git text processing tools (e.g. 'git diff') as well as most Git
+built-in Git text processing tools (e.g. `git diff`) as well as most Git
web front ends do not visualize the contents of these files by default.
In these cases you can tell Git the encoding of a file in the working
@@ -331,7 +331,7 @@ That operation will fail and cause an error.
default.
- Reencoding content requires resources that might slow down certain
- Git operations (e.g 'git checkout' or 'git add').
+ Git operations (e.g `git checkout` or `git add`).
Use the `working-tree-encoding` attribute only if you cannot store a file
in UTF-8 encoding and if you want Git to be able to process the content
@@ -497,7 +497,7 @@ command. This is achieved by using the long-running process protocol
When Git encounters the first file that needs to be cleaned or smudged,
it starts the filter and performs the handshake. In the handshake, the
-welcome message sent by Git is "git-filter-client", only version 2 is
+welcome message sent by Git is `git-filter-client`, only version 2 is
supported, and the supported capabilities are "clean", "smudge", and
"delay".
diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
index d1d81cbe15..aa11b4562b 100644
--- a/Documentation/gitcore-tutorial.txt
+++ b/Documentation/gitcore-tutorial.txt
@@ -50,9 +50,9 @@ one for a totally new project, or an existing working tree that you want
to import into Git.
For our first example, we're going to start a totally new repository from
-scratch, with no pre-existing files, and we'll call it 'git-tutorial'.
+scratch, with no pre-existing files, and we'll call it `git-tutorial`.
To start up, create a subdirectory for it, change into that
-subdirectory, and initialize the Git infrastructure with 'git init':
+subdirectory, and initialize the Git infrastructure with `git init`:
------------------------------------------------
$ mkdir git-tutorial
@@ -147,7 +147,7 @@ but to actually check in your hard work, you will have to go through two steps:
- commit that index file as an object.
The first step is trivial: when you want to tell Git about any changes
-to your working tree, you use the 'git update-index' program. That
+to your working tree, you use the `git update-index` program. That
program normally just takes a list of filenames you want to update, but
to avoid trivial mistakes, it refuses to add new entries to the index
(or remove existing ones) unless you explicitly tell it that you're
@@ -181,14 +181,14 @@ and see two files:
which correspond with the objects with names of `557db...` and
`f24c7...` respectively.
-If you want to, you can use 'git cat-file' to look at those objects, but
+If you want to, you can use `git cat-file` to look at those objects, but
you'll have to use the object name, not the filename of the object:
----------------
$ git cat-file -t 557db03de997c86a4a028e1ebd3a1ceb225be238
----------------
-where the `-t` tells 'git cat-file' to tell you what the "type" of the
+where the `-t` tells `git cat-file` to tell you what the "type" of the
object is. Git will tell you that you have a "blob" object (i.e., just a
regular file), and you can see the contents with
@@ -213,7 +213,7 @@ hexadecimal digits in most places.
Anyway, as we mentioned previously, you normally never actually take a
look at the objects themselves, and typing long 40-character hex
names is not something you'd normally want to do. The above digression
-was just to show that 'git update-index' did something magical, and
+was just to show that `git update-index` did something magical, and
actually saved away the contents of your files into the Git object
database.
@@ -236,7 +236,7 @@ $ echo "It's a new day for git" >>hello
and you can now, since you told Git about the previous state of `hello`, ask
Git what has changed in the tree compared to your old index, using the
-'git diff-files' command:
+`git diff-files` command:
------------
$ git diff-files
@@ -247,7 +247,7 @@ version of a 'diff', but that internal version really just tells you
that it has noticed that "hello" has been modified, and that the old object
contents it had have been replaced with something else.
-To make it readable, we can tell 'git diff-files' to output the
+To make it readable, we can tell `git diff-files` to output the
differences as a patch, using the `-p` flag:
------------
@@ -263,7 +263,7 @@ index 557db03..263414f 100644
i.e. the diff of the change we caused by adding another line to `hello`.
-In other words, 'git diff-files' always shows us the difference between
+In other words, `git diff-files` always shows us the difference between
what is recorded in the index, and what is currently in the working
tree. That's very useful.
@@ -291,7 +291,7 @@ that in two phases: creating a 'tree' object, and committing that 'tree'
object as a 'commit' object together with an explanation of what the
tree was all about, along with information of how we came to that state.
-Creating a tree object is trivial, and is done with 'git write-tree'.
+Creating a tree object is trivial, and is done with `git write-tree`.
There are no options or other input: `git write-tree` will take the
current index state, and write an object that describes that whole
index. In other words, we're now tying together all the different
@@ -315,23 +315,23 @@ is not a "blob" object, but a "tree" object (you can also use
`git cat-file` to actually output the raw object contents, but you'll see
mainly a binary mess, so that's less interesting).
-However -- normally you'd never use 'git write-tree' on its own, because
+However -- normally you'd never use `git write-tree` on its own, because
normally you always commit a tree into a commit object using the
-'git commit-tree' command. In fact, it's easier to not actually use
-'git write-tree' on its own at all, but to just pass its result in as an
-argument to 'git commit-tree'.
+`git commit-tree` command. In fact, it's easier to not actually use
+`git write-tree` on its own at all, but to just pass its result in as an
+argument to `git commit-tree`.
-'git commit-tree' normally takes several arguments -- it wants to know
+`git commit-tree` normally takes several arguments -- it wants to know
what the 'parent' of a commit was, but since this is the first commit
ever in this new repository, and it has no parents, we only need to pass in
-the object name of the tree. However, 'git commit-tree' also wants to get a
+the object name of the tree. However, `git commit-tree` also wants to get a
commit message on its standard input, and it will write out the resulting
object name for the commit to its standard output.
And this is where we create the `.git/refs/heads/master` file
which is pointed at by `HEAD`. This file is supposed to contain
the reference to the top-of-tree of the `master` branch, and since
-that's exactly what 'git commit-tree' spits out, we can do this
+that's exactly what `git commit-tree` spits out, we can do this
all with a sequence of simple shell commands:
------------------------------------------------
@@ -353,11 +353,11 @@ instead, and it would have done the above magic scripting for you.
Making a change
---------------
-Remember how we did the 'git update-index' on file `hello` and then we
+Remember how we did the `git update-index` on file `hello` and then we
changed `hello` afterward, and could compare the new state of `hello` with the
state we saved in the index file?
-Further, remember how I said that 'git write-tree' writes the contents
+Further, remember how I said that `git write-tree` writes the contents
of the *index* file to the tree, and thus what we just committed was in
fact the *original* contents of the file `hello`, not the new ones. We did
that on purpose, to show the difference between the index state, and the
@@ -368,12 +368,12 @@ As before, if we do `git diff-files -p` in our git-tutorial project,
we'll still see the same difference we saw last time: the index file
hasn't changed by the act of committing anything. However, now that we
have committed something, we can also learn to use a new command:
-'git diff-index'.
+`git diff-index`.
-Unlike 'git diff-files', which showed the difference between the index
-file and the working tree, 'git diff-index' shows the differences
+Unlike `git diff-files`, which showed the difference between the index
+file and the working tree, `git diff-index` shows the differences
between a committed *tree* and either the index file or the working
-tree. In other words, 'git diff-index' wants a tree to be diffed
+tree. In other words, `git diff-index` wants a tree to be diffed
against, and before we did the commit, we couldn't do that, because we
didn't have anything to diff against.
@@ -383,7 +383,7 @@ But now we can do
$ git diff-index -p HEAD
----------------
-(where `-p` has the same meaning as it did in 'git diff-files'), and it
+(where `-p` has the same meaning as it did in `git diff-files`), and it
will show us the same difference, but for a totally different reason.
Now we're comparing the working tree not against the index file,
but against the tree we just wrote. It just so happens that those two
@@ -398,7 +398,7 @@ $ git diff HEAD
which ends up doing the above for you.
-In other words, 'git diff-index' normally compares a tree against the
+In other words, `git diff-index` normally compares a tree against the
working tree, but when given the `--cached` flag, it is told to
instead compare against just the index cache contents, and ignore the
current working tree state entirely. Since we just wrote the index
@@ -407,7 +407,7 @@ an empty set of differences, and that's exactly what it does.
[NOTE]
================
-'git diff-index' really always uses the index for its
+`git diff-index` really always uses the index for its
comparisons, and saying that it compares a tree against the working
tree is thus not strictly accurate. In particular, the list of
files to compare (the "meta-data") *always* comes from the index file,
@@ -436,11 +436,11 @@ $ git update-index hello
(note how we didn't need the `--add` flag this time, since Git knew
about the file already).
-Note what happens to the different 'git diff-{asterisk}' versions here.
+Note what happens to the different `git diff-*` versions here.
After we've updated `hello` in the index, `git diff-files -p` now shows no
differences, but `git diff-index -p HEAD` still *does* show that the
current state is different from the state we committed. In fact, now
-'git diff-index' shows the same difference whether we use the `--cached`
+`git diff-index` shows the same difference whether we use the `--cached`
flag or not, since now the index is coherent with the working tree.
Now, since we've updated `hello` in the index, we can commit the new
@@ -476,9 +476,9 @@ Inspecting Changes
While creating changes is useful, it's even more useful if you can tell
later what changed. The most useful command for this is another of the
-'diff' family, namely 'git diff-tree'.
+'diff' family, namely `git diff-tree`.
-'git diff-tree' can be given two arbitrary trees, and it will tell you the
+`git diff-tree` can be given two arbitrary trees, and it will tell you the
differences between them. Perhaps even more commonly, though, you can
give it just a single commit object, and it will figure out the parent
of that commit itself, and show the difference directly. Thus, to get
@@ -526,14 +526,14 @@ various 'diff-{asterisk}' commands compare things.
+-----------+
============
-More interestingly, you can also give 'git diff-tree' the `--pretty` flag,
+More interestingly, you can also give `git diff-tree` the `--pretty` flag,
which tells it to also show the commit message and author and date of the
commit, and you can tell it to show a whole series of diffs.
Alternatively, you can tell it to be "silent", and not show the diffs at
all, but just show the actual commit message.
-In fact, together with the 'git rev-list' program (which generates a
-list of revisions), 'git diff-tree' ends up being a veritable fount of
+In fact, together with the `git rev-list` program (which generates a
+list of revisions), `git diff-tree` ends up being a veritable fount of
changes. You can emulate `git log`, `git log -p`, etc. with a trivial
script that pipes the output of `git rev-list` to `git diff-tree --stdin`,
which was exactly how early versions of `git log` were implemented.
@@ -570,7 +570,7 @@ pointer to the state you want to tag, but also a small tag name and
message, along with optionally a PGP signature that says that yes,
you really did
that tag. You create these annotated tags with either the `-a` or
-`-s` flag to 'git tag':
+`-s` flag to `git tag`:
----------------
$ git tag -s <tagname>
@@ -617,7 +617,7 @@ and it will be gone. There's no external repository, and there's no
history outside the project you created.
- if you want to move or duplicate a Git repository, you can do so. There
- is 'git clone' command, but if all you want to do is just to
+ is `git clone` command, but if all you want to do is just to
create a copy of your repository (with all the full history that
went along with it), you can do so with a regular
`cp -a git-tutorial new-git-tutorial`.
@@ -641,7 +641,7 @@ When copying a remote repository, you'll want to at a minimum update the
index cache when you do this, and especially with other peoples'
repositories you often want to make sure that the index cache is in some
known state (you don't know *what* they've done and not yet checked in),
-so usually you'll precede the 'git update-index' with a
+so usually you'll precede the `git update-index` with a
----------------
$ git read-tree --reset HEAD
@@ -649,7 +649,7 @@ $ git update-index --refresh
----------------
which will force a total index re-build from the tree pointed to by `HEAD`.
-It resets the index contents to `HEAD`, and then the 'git update-index'
+It resets the index contents to `HEAD`, and then the `git update-index`
makes sure to match up all index entries with the checked-out files.
If the original repository had uncommitted changes in its
working tree, `git update-index --refresh` notices them and
@@ -663,9 +663,9 @@ $ git reset
and in fact a lot of the common Git command combinations can be scripted
with the `git xyz` interfaces. You can learn things by just looking
-at what the various git scripts do. For example, `git reset` used to be
-the above two lines implemented in 'git reset', but some things like
-'git status' and 'git commit' are slightly more complex scripts around
+at what the various `git` scripts do. For example, `git reset` used to be
+the above two lines implemented in `git reset`, but some things like
+`git status` and `git commit` are slightly more complex scripts around
the basic Git commands.
Many (most?) public remote repositories will not contain any of
@@ -704,7 +704,7 @@ where the `-u` flag means that you want the checkout to keep the index
up to date (so that you don't have to refresh it afterward), and the
`-a` flag means "check out all files" (if you have a stale copy or an
older version of a checked out tree you may also need to add the `-f`
-flag first, to tell 'git checkout-index' to *force* overwriting of any old
+flag first, to tell `git checkout-index` to *force* overwriting of any old
files).
Again, this can all be simplified with
@@ -751,7 +751,7 @@ to it.
================================================
If you make the decision to start your new branch at some
other point in the history than the current `HEAD`, you can do so by
-just telling 'git switch' what the base of the checkout would be.
+just telling `git switch` what the base of the checkout would be.
In other words, if you have an earlier tag or branch, you'd just do
------------
@@ -794,7 +794,7 @@ $ git branch <branchname> [startingpoint]
which will simply _create_ the branch, but will not do anything further.
You can then later -- once you decide that you want to actually develop
-on that branch -- switch to that branch with a regular 'git switch'
+on that branch -- switch to that branch with a regular `git switch`
with the branchname as the argument.
@@ -853,10 +853,10 @@ means: normally it will just show you your current `HEAD`) and their
histories. You can also see exactly how they came to be from a common
source.
-Anyway, let's exit 'gitk' (`^Q` or the File menu), and decide that we want
+Anyway, let's exit `gitk` (`^Q` or the File menu), and decide that we want
to merge the work we did on the `mybranch` branch into the `master`
branch (which is currently our `HEAD` too). To do that, there's a nice
-script called 'git merge', which wants to know which branches you want
+script called `git merge`, which wants to know which branches you want
to resolve and what the merge is all about:
------------
@@ -900,7 +900,7 @@ $ git commit -i hello
which will very loudly warn you that you're now committing a merge
(which is correct, so never mind), and you can write a small merge
-message about your adventures in 'git merge'-land.
+message about your adventures in `git merge`-land.
After you're done, start up `gitk --all` to see graphically what the
history looks like. Notice that `mybranch` still exists, and you can
@@ -941,21 +941,21 @@ branch head. Please see linkgit:gitrevisions[7] if you want to
see more complex cases.
[NOTE]
-Without the `--more=1` option, 'git show-branch' would not output the
+Without the `--more=1` option, `git show-branch` would not output the
'[master^]' commit, as '[mybranch]' commit is a common ancestor of
both `master` and `mybranch` tips. Please see linkgit:git-show-branch[1]
for details.
[NOTE]
If there were more commits on the `master` branch after the merge, the
-merge commit itself would not be shown by 'git show-branch' by
+merge commit itself would not be shown by `git show-branch` by
default. You would need to provide `--sparse` option to make the
merge commit visible in this case.
Now, let's pretend you are the one who did all the work in
`mybranch`, and the fruit of your hard work has finally been merged
to the `master` branch. Let's go back to `mybranch`, and run
-'git merge' to get the "upstream changes" back to your branch.
+`git merge` to get the "upstream changes" back to your branch.
------------
$ git switch mybranch
@@ -997,12 +997,12 @@ Merging external work
It's usually much more common that you merge with somebody else than
merging with your own branches, so it's worth pointing out that Git
makes that very easy too, and in fact, it's not that different from
-doing a 'git merge'. In fact, a remote merge ends up being nothing
+doing a `git merge`. In fact, a remote merge ends up being nothing
more than "fetch the work from a remote repository into a temporary tag"
-followed by a 'git merge'.
+followed by a `git merge`.
Fetching from a remote repository is done by, unsurprisingly,
-'git fetch':
+`git fetch`:
----------------
$ git fetch <remote-repository>
@@ -1055,7 +1055,7 @@ The 'commit walkers' are sometimes also called 'dumb
transports', because they do not require any Git aware smart
server like Git Native transport does. Any stock HTTP server
that does not even support directory index would suffice. But
-you must prepare your repository with 'git update-server-info'
+you must prepare your repository with `git update-server-info`
to help dumb transport downloaders.
Once you fetch from the remote repository, you `merge` that
@@ -1075,7 +1075,7 @@ argument.
[NOTE]
You could do without using any branches at all, by
keeping as many local repositories as you would like to have
-branches, and merging between them with 'git pull', just like
+branches, and merging between them with `git pull`, just like
you merge between branches. The advantage of this approach is
that it lets you keep a set of files for each `branch` checked
out and you may find it easier to switch back and forth if you
@@ -1092,7 +1092,7 @@ like this:
$ git config remote.linus.url http://www.kernel.org/pub/scm/git/git.git/
------------------------------------------------
-and use the "linus" keyword with 'git pull' instead of the full URL.
+and use the "linus" keyword with `git pull` instead of the full URL.
Examples.
@@ -1128,7 +1128,7 @@ $ git show-branch --more=2 master mybranch
+* [master^] Some fun.
------------
-Remember, before running 'git merge', our `master` head was at
+Remember, before running `git merge`, our `master` head was at
"Some fun." commit, while our `mybranch` head was at "Some
work." commit.
@@ -1154,7 +1154,7 @@ Now we are ready to experiment with the merge by hand.
`git merge` command, when merging two branches, uses 3-way merge
algorithm. First, it finds the common ancestor between them.
-The command it uses is 'git merge-base':
+The command it uses is `git merge-base`:
------------
$ mb=$(git merge-base HEAD mybranch)
@@ -1178,7 +1178,7 @@ this:
$ git read-tree -m -u $mb HEAD mybranch
------------
-This is the same 'git read-tree' command we have already seen,
+This is the same `git read-tree` command we have already seen,
but it takes three trees, unlike previous examples. This reads
the contents of each tree into different 'stage' in the index
file (the first tree goes to stage 1, the second to stage 2,
@@ -1219,8 +1219,8 @@ $ git ls-files --unmerged
The next step of merging is to merge these three versions of the
file, using 3-way merge. This is done by giving
-'git merge-one-file' command as one of the arguments to
-'git merge-index' command:
+`git merge-one-file` command as one of the arguments to
+`git merge-index` command:
------------
$ git merge-index git-merge-one-file hello
@@ -1229,7 +1229,7 @@ ERROR: Merge conflict in hello
fatal: merge program failed
------------
-'git merge-one-file' script is called with parameters to
+`git merge-one-file` script is called with parameters to
describe those three versions, and is responsible to leave the
merge results in the working tree.
It is a fairly straightforward shell script, and
@@ -1248,9 +1248,9 @@ $ git ls-files --stage
------------
This is the state of the index file and the working file after
-'git merge' returns control back to you, leaving the conflicting
+`git merge` returns control back to you, leaving the conflicting
merge for you to resolve. Notice that the path `hello` is still
-unmerged, and what you see with 'git diff' at this point is
+unmerged, and what you see with `git diff` at this point is
differences since stage 2 (i.e. your version).
@@ -1278,7 +1278,7 @@ how Git repositories at `kernel.org` are managed.
Publishing the changes from your local (private) repository to
your remote (public) repository requires a write privilege on
the remote machine. You need to have an SSH account there to
-run a single command, 'git-receive-pack'.
+run a single command, `git-receive-pack`.
First, you need to create an empty repository on the remote
machine that will house your public repository. This empty
@@ -1287,8 +1287,8 @@ into it later. Obviously, this repository creation needs to be
done only once.
[NOTE]
-'git push' uses a pair of commands,
-'git send-pack' on your local machine, and 'git-receive-pack'
+`git push` uses a pair of commands,
+`git send-pack` on your local machine, and `git-receive-pack`
on the remote machine. The communication between the two over
the network internally uses an SSH connection.
@@ -1303,7 +1303,7 @@ $ mkdir my-git.git
------------
Then, make that directory into a Git repository by running
-'git init', but this time, since its name is not the usual
+`git init`, but this time, since its name is not the usual
`.git`, we do things slightly differently:
------------
@@ -1312,7 +1312,7 @@ $ GIT_DIR=my-git.git git init
Make sure this directory is available for others you want your
changes to be pulled via the transport of your choice. Also
-you need to make sure that you have the 'git-receive-pack'
+you need to make sure that you have the `git-receive-pack`
program on the `$PATH`.
[NOTE]
@@ -1320,7 +1320,7 @@ Many installations of sshd do not invoke your shell as the login
shell when you directly run programs; what this means is that if
your login shell is 'bash', only `.bashrc` is read and not
`.bash_profile`. As a workaround, make sure `.bashrc` sets up
-`$PATH` so that you can run 'git-receive-pack' program.
+`$PATH` so that you can run `git-receive-pack` program.
[NOTE]
If you plan to publish this repository to be accessed over http,
@@ -1366,7 +1366,7 @@ $ git repack
will do it for you. If you followed the tutorial examples, you
would have accumulated about 17 objects in `.git/objects/??/`
-directories by now. 'git repack' tells you how many objects it
+directories by now. `git repack` tells you how many objects it
packed, and stores the packed file in the `.git/objects/pack`
directory.
@@ -1379,7 +1379,7 @@ them together. The former holds all the data from the objects
in the pack, and the latter holds the index for random
access.
-If you are paranoid, running 'git verify-pack' command would
+If you are paranoid, running `git verify-pack` command would
detect if you have a corrupt pack, but do not worry too much.
Our programs are always perfect ;-).
@@ -1446,17 +1446,17 @@ If other people are pulling from your repository over dumb
transport protocols (HTTP), you need to keep this repository
'dumb transport friendly'. After `git init`,
`$GIT_DIR/hooks/post-update.sample` copied from the standard templates
-would contain a call to 'git update-server-info'
+would contain a call to `git update-server-info`
but you need to manually enable the hook with
`mv post-update.sample post-update`. This makes sure
-'git update-server-info' keeps the necessary files up to date.
+`git update-server-info` keeps the necessary files up to date.
3. Push into the public repository from your primary
repository.
-4. 'git repack' the public repository. This establishes a big
+4. `git repack` the public repository. This establishes a big
pack that contains the initial set of objects as the
- baseline, and possibly 'git prune' if the transport
+ baseline, and possibly `git prune` if the transport
used for pulling from your repository supports packed
repositories.
@@ -1470,14 +1470,14 @@ You can repack this private repository whenever you feel like.
6. Push your changes to the public repository, and announce it
to the public.
-7. Every once in a while, 'git repack' the public repository.
+7. Every once in a while, `git repack` the public repository.
Go back to step 5. and continue working.
A recommended work cycle for a "subsystem maintainer" who works
on that project and has an own "public repository" goes like this:
-1. Prepare your work repository, by running 'git clone' on the public
+1. Prepare your work repository, by running `git clone` on the public
repository of the "project lead". The URL used for the
initial cloning is stored in the `remote.origin.url`
configuration variable.
@@ -1492,7 +1492,7 @@ on that project and has an own "public repository" goes like this:
point at the repository you are borrowing from.
4. Push into the public repository from your primary
- repository. Run 'git repack', and possibly 'git prune' if the
+ repository. Run `git repack`, and possibly `git prune` if the
transport used for pulling from your repository supports
packed repositories.
@@ -1509,7 +1509,7 @@ like.
"project lead" and possibly your "sub-subsystem
maintainers" to pull from it.
-7. Every once in a while, 'git repack' the public repository.
+7. Every once in a while, `git repack` the public repository.
Go back to step 5. and continue working.
@@ -1517,7 +1517,7 @@ A recommended work cycle for an "individual developer" who does
not have a "public" repository is somewhat different. It goes
like this:
-1. Prepare your work repository, by 'git clone' the public
+1. Prepare your work repository, by `git clone` the public
repository of the "project lead" (or a "subsystem
maintainer", if you work on a subsystem). The URL used for
the initial cloning is stored in the `remote.origin.url`
@@ -1615,8 +1615,8 @@ $ git reset --hard master~2
------------
You can make sure `git show-branch` matches the state before
-those two 'git merge' you just did. Then, instead of running
-two 'git merge' commands in a row, you would merge these two
+those two `git merge` you just did. Then, instead of running
+two `git merge` commands in a row, you would merge these two
branch heads (this is known as 'making an Octopus'):
------------
diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt
index dffbdfbd0b..a11e72ca4c 100644
--- a/Documentation/gitcredentials.txt
+++ b/Documentation/gitcredentials.txt
@@ -8,8 +8,8 @@ gitcredentials - Providing usernames and passwords to Git
SYNOPSIS
--------
------------------
-git config credential.https://example.com.username myusername
-git config credential.helper "$helper $options"
+`git config` credential.https://example.com.username myusername
+`git config` credential.helper "$helper $options"
------------------
DESCRIPTION
@@ -206,7 +206,7 @@ these rules:
2. Otherwise, if the helper string begins with an absolute path, the
verbatim helper string becomes the command.
- 3. Otherwise, the string "git credential-" is prepended to the helper
+ 3. Otherwise, the string `git credential-` is prepended to the helper
string, and the result becomes the command.
The resulting command then has an "operation" argument appended to it
@@ -240,7 +240,7 @@ Here are some example specifications:
Generally speaking, rule (3) above is the simplest for users to specify.
Authors of credential helpers should make an effort to assist their
-users by naming their program "git-credential-$NAME", and putting it in
+users by naming their program `git-credential-$NAME`, and putting it in
the `$PATH` or `$GIT_EXEC_PATH` during installation, which will allow a
user to enable it with `git config credential.helper $NAME`.
diff --git a/Documentation/gitcvs-migration.txt b/Documentation/gitcvs-migration.txt
index 1cd1283d0f..4d4a70ae4b 100644
--- a/Documentation/gitcvs-migration.txt
+++ b/Documentation/gitcvs-migration.txt
@@ -8,7 +8,7 @@ gitcvs-migration - Git for CVS users
SYNOPSIS
--------
[verse]
-'git cvsimport' *
+`git cvsimport` *
DESCRIPTION
-----------
@@ -43,30 +43,30 @@ $ git pull origin
which merges in any work that others might have done since the clone
operation. If there are uncommitted changes in your working tree, commit
-them first before running git pull.
+them first before running `git pull`.
[NOTE]
================================
The 'pull' command knows where to get updates from because of certain
-configuration variables that were set by the first 'git clone'
+configuration variables that were set by the first `git clone`
command; see `git config -l` and the linkgit:git-config[1] man
page for details.
================================
You can update the shared repository with your changes by first committing
-your changes, and then using the 'git push' command:
+your changes, and then using the `git push` command:
------------------------------------------------
$ git push origin master
------------------------------------------------
to "push" those commits to the shared repository. If someone else has
-updated the repository more recently, 'git push', like 'cvs commit', will
+updated the repository more recently, `git push`, like 'cvs commit', will
complain, in which case you must pull any changes before attempting the
push again.
-In the 'git push' command above we specify the name of the remote branch
-to update (`master`). If we leave that out, 'git push' tries to update
+In the `git push` command above we specify the name of the remote branch
+to update (`master`). If we leave that out, `git push` tries to update
any branches in the remote repository that have the same name as a branch
in the local repository. So the last 'push' can be done with either of:
diff --git a/Documentation/gitdiffcore.txt b/Documentation/gitdiffcore.txt
index fbc458c3e5..2a157dba2f 100644
--- a/Documentation/gitdiffcore.txt
+++ b/Documentation/gitdiffcore.txt
@@ -8,12 +8,12 @@ gitdiffcore - Tweaking diff output
SYNOPSIS
--------
[verse]
-'git diff' *
+`git diff` *
DESCRIPTION
-----------
-The diff commands 'git diff-index', 'git diff-files', and 'git diff-tree'
+The diff commands `git diff-index`, `git diff-files`, and `git diff-tree`
can be told to manipulate differences they find in
unconventional ways before showing 'diff' output. The manipulation
is collectively called "diffcore transformation". This short note
@@ -24,18 +24,18 @@ that is easier to understand than the conventional kind.
The chain of operation
----------------------
-The 'git diff-{asterisk}' family works by first comparing two sets of
+The `git diff-*` family works by first comparing two sets of
files:
- - 'git diff-index' compares contents of a "tree" object and the
+ - `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
used);
- - 'git diff-files' compares contents of the index file and the
+ - `git diff-files` compares contents of the index file and the
working directory;
- - 'git diff-tree' compares contents of two "tree" objects;
+ - `git diff-tree` compares contents of two "tree" objects;
In all of these cases, the commands themselves first optionally limit
the two sets of files by any pathspecs given on their command-lines,
@@ -76,12 +76,12 @@ into another list. There are currently 5 such transformations:
- diffcore-order
- diffcore-rotate
-These are applied in sequence. The set of filepairs 'git diff-{asterisk}'
+These are applied in sequence. The set of filepairs `git diff-*`
commands find are used as the input to diffcore-break, and
the output from diffcore-break is used as the input to the
next transformation. The final result is then passed to the
output routine and generates either diff-raw format (see Output
-format sections of the manual for 'git diff-{asterisk}' commands) or
+format sections of the manual for `git diff-*` commands) or
diff-patch format.
@@ -89,7 +89,7 @@ diffcore-break: For Splitting Up Complete Rewrites
--------------------------------------------------
The second transformation in the chain is diffcore-break, and is
-controlled by the `-B` option to the 'git diff-{asterisk}' commands. This is
+controlled by the `-B` option to the `git diff-*` commands. This is
used to detect a filepair that represents "complete rewrite" and
break such filepair into two filepairs that represent delete and
create. E.g. If the input contained this filepair:
@@ -125,7 +125,7 @@ diffcore-rename: For Detecting Renames and Copies
This transformation is used to detect renames and copies, and is
controlled by the `-M` option (to detect renames) and the `-C` option
-(to detect copies as well) to the 'git diff-{asterisk}' commands. If the
+(to detect copies as well) to the `git diff-*` commands. If the
input contained these filepairs:
------------------------------------------------
@@ -190,11 +190,11 @@ throughout the directory hierarchy after exact rename detection, this
preliminary step may be skipped for those files.
Note. When the `-C` option is used with `--find-copies-harder`
-option, 'git diff-{asterisk}' commands feed unmodified filepairs to
+option, `git diff-*` commands feed unmodified filepairs to
diffcore mechanism as well as modified ones. This lets the copy
detector consider unmodified files as copy source candidates at
the expense of making it slower. Without `--find-copies-harder`,
-'git diff-{asterisk}' commands can detect copies only if the file that was
+`git diff-*` commands can detect copies only if the file that was
copied happened to have been modified in the same changeset.
@@ -278,7 +278,7 @@ diffcore-order: For Sorting the Output Based on Filenames
This is used to reorder the filepairs according to the user's
(or project's) taste, and is controlled by the `-O` option to the
-'git diff-{asterisk}' commands.
+`git diff-*` commands.
This takes a text file each of whose lines is a shell glob
pattern. Filepairs that match a glob pattern on an earlier line
@@ -305,10 +305,10 @@ filepairs so that the filepair for the given pathname comes first,
optionally discarding the paths that come before it. This is used
to implement the `--skip-to` and the `--rotate-to` options. It is
an error when the specified pathname is not in the set of filepairs,
-but it is not useful to error out when used with "git log" family of
+but it is not useful to error out when used with `git log` family of
commands, because it is unreasonable to expect that a given path
-would be modified by each and every commit shown by the "git log"
-command. For this reason, when used with "git log", the filepair
+would be modified by each and every commit shown by the `git log`
+command. For this reason, when used with `git log`, the filepair
that sorts the same as, or the first one that sorts after, the given
pathname is where the output starts.
diff --git a/Documentation/giteveryday.txt b/Documentation/giteveryday.txt
index 03c9e5e8d5..770e29d34f 100644
--- a/Documentation/giteveryday.txt
+++ b/Documentation/giteveryday.txt
@@ -363,7 +363,7 @@ $ grep 9418 /etc/services
git 9418/tcp # Git Version Control System
------------
-Run git-daemon to serve /pub/scm from inetd.::
+Run `git-daemon` to serve /pub/scm from inetd.::
+
------------
$ grep git /etc/inetd.conf
@@ -373,7 +373,7 @@ git stream tcp nowait nobody \
+
The actual configuration line should be on one line.
-Run git-daemon to serve /pub/scm from xinetd.::
+Run `git-daemon` to serve /pub/scm from xinetd.::
+
------------
$ cat /etc/xinetd.d/git-daemon
@@ -396,7 +396,7 @@ service git
Check your xinetd(8) documentation and setup, this is from a Fedora system.
Others might be different.
-Give push/pull only access to developers using git-over-ssh.::
+Give push/pull only access to developers using `git-over-ssh`.::
e.g. those using:
`$ git push/pull ssh://host.xz/pub/scm/project`
@@ -442,7 +442,7 @@ refs/heads/doc-update bob
refs/tags/v[0-9]* david
------------
+
-<1> place the developers into the same git group.
+<1> place the developers into the same `git` group.
<2> and make the shared repository writable by the group.
<3> use update-hook example by Carl from Documentation/howto/
for branch policy control.
diff --git a/Documentation/gitfaq.txt b/Documentation/gitfaq.txt
index afdaeab850..92e8106af4 100644
--- a/Documentation/gitfaq.txt
+++ b/Documentation/gitfaq.txt
@@ -349,7 +349,7 @@ See the following entry for information about normalizing line endings as well,
and see linkgit:gitattributes[5] for more information about attribute files.
[[windows-diff-control-m]]
-I'm on Windows and git diff shows my files as having a `^M` at the end.::
+I'm on Windows and `git diff` shows my files as having a `^M` at the end.::
By default, Git expects files to be stored with Unix line endings. As such,
the carriage return (`^M`) that is part of a Windows line ending is shown
because it is considered to be trailing whitespace. Git defaults to showing
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index 5e87987882..8cee030fbd 100644
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -321,11 +321,11 @@ does not know the entire set of branches, so it would end up
firing one e-mail per ref when used naively, though. The
<<post-receive,'post-receive'>> hook is more suited to that.
-In an environment that restricts the users' access only to git
+In an environment that restricts the users' access only to `git`
commands over the wire, this hook can be used to implement access
control without relying on filesystem ownership and group
membership. See linkgit:git-shell[1] for how you might use the login
-shell to restrict the user's access to only git commands.
+shell to restrict the user's access to only `git` commands.
Both standard output and standard error output are forwarded to
`git send-pack` on the other end, so you can simply `echo` messages
@@ -617,10 +617,10 @@ Git will limit what files it checks for changes as well as which
directories are checked for untracked files based on the path names
given.
-An optimized way to tell git "all files have changed" is to return
+An optimized way to tell `git` "all files have changed" is to return
the filename `/`.
-The exit status determines whether git will use the data from the
+The exit status determines whether `git` will use the data from the
hook to limit its search. On error, it will fall back to verifying
all files and folders.
@@ -666,7 +666,7 @@ This hook is invoked by `git-p4 submit`.
The `p4-post-changelist` hook is invoked after the submit has
successfully occurred in P4. It takes no parameters and is meant
primarily for notification and cannot affect the outcome of the
-git p4 submit action.
+`git p4 submit` action.
Run `git-p4 submit --help` for details.
diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
index 5751603b13..379db07326 100644
--- a/Documentation/gitignore.txt
+++ b/Documentation/gitignore.txt
@@ -61,10 +61,10 @@ be used.
empty, $HOME/.config/git/ignore is used instead.
The underlying Git plumbing tools, such as
-'git ls-files' and 'git read-tree', read
+`git ls-files` and `git read-tree`, read
`gitignore` patterns specified by command-line options, or from
files specified by command-line options. Higher-level Git
-tools, such as 'git status' and 'git add',
+tools, such as `git status` and `git add`,
use patterns from the sources specified above.
PATTERN FORMAT
@@ -147,7 +147,7 @@ The purpose of gitignore files is to ensure that certain files
not tracked by Git remain untracked.
To stop tracking a file that is currently tracked, use
-'git rm --cached'.
+`git rm --cached`.
EXAMPLES
--------
diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index 29bd307bb9..41eb7a6577 100644
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -8,7 +8,7 @@ gitk - The Git repository browser
SYNOPSIS
--------
[verse]
-'gitk' [<options>] [<revision range>] [--] [<path>...]
+`gitk` [<options>] [<revision range>] [--] [<path>...]
DESCRIPTION
-----------
@@ -19,13 +19,13 @@ the files in the trees of each revision.
OPTIONS
-------
-To control which revisions to show, gitk supports most options
-applicable to the 'git rev-list' command. It also supports a few
-options applicable to the 'git diff-*' commands to control how the
+To control which revisions to show, `gitk` supports most options
+applicable to the `git rev-list` command. It also supports a few
+options applicable to the `git diff-*` commands to control how the
changes each commit introduces are shown. Finally, it supports some
-gitk-specific options.
+`gitk`-specific options.
-gitk generally only understands options with arguments in the
+`gitk` generally only understands options with arguments in the
'sticked' form (see linkgit:gitcli[7]) due to limitations in the
command-line parser.
@@ -115,12 +115,12 @@ include::line-range-options.txt[]
avoid ambiguity with respect to revision names use `--` to separate the paths
from any preceding options.
-gitk-specific options
+`gitk`-specific options
~~~~~~~~~~~~~~~~~~~~~
--argscmd=<command>::
- Command to be run each time gitk has to determine the revision
+ Command to be run each time `gitk` has to determine the revision
range to show. The command is expected to print on its
standard output a list of additional revisions to be shown,
one per line. Use this instead of explicitly specifying a
@@ -141,9 +141,9 @@ gitk v2.6.12.. include/scsi drivers/scsi::
gitk --since="2 weeks ago" \-- gitk::
- Show the changes during the last two weeks to the file 'gitk'.
+ Show the changes during the last two weeks to the file `gitk`.
The `--` is necessary to avoid confusion with the *branch* named
- 'gitk'
+ `gitk`
gitk --max-count=100 --all \-- Makefile::
@@ -166,11 +166,11 @@ History
Gitk was the first graphical repository browser. It's written in
tcl/tk.
-'gitk' is actually maintained as an independent project, but stable
+`gitk` is actually maintained as an independent project, but stable
versions are distributed as part of the Git suite for the convenience
of end users.
-gitk-git/ comes from Paul Mackerras's gitk project:
+gitk-git/ comes from Paul Mackerras's `gitk` project:
git://ozlabs.org/~paulus/gitk
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index 8e333dde1b..2c1e847076 100644
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -20,7 +20,7 @@ of linkgit:git-config[1].
The file contains one subsection per submodule, and the subsection value
is the name of the submodule. The name is set to the path where the
submodule has been added unless it was customized with the `--name`
-option of 'git submodule add'. Each submodule section also contains the
+option of `git submodule add`. Each submodule section also contains the
following required keys:
submodule.<name>.path::
diff --git a/Documentation/gitnamespaces.txt b/Documentation/gitnamespaces.txt
index 29bac9e1bf..6a273464a4 100644
--- a/Documentation/gitnamespaces.txt
+++ b/Documentation/gitnamespaces.txt
@@ -8,8 +8,8 @@ gitnamespaces - Git namespaces
SYNOPSIS
--------
[verse]
-GIT_NAMESPACE=<namespace> 'git upload-pack'
-GIT_NAMESPACE=<namespace> 'git receive-pack'
+GIT_NAMESPACE=<namespace> `git upload-pack`
+GIT_NAMESPACE=<namespace> `git receive-pack`
DESCRIPTION
@@ -46,8 +46,8 @@ which could otherwise generate directory/file conflicts within the `refs`
directory.
linkgit:git-upload-pack[1] and linkgit:git-receive-pack[1] rewrite the
-names of refs as specified by `GIT_NAMESPACE`. git-upload-pack and
-git-receive-pack will ignore all references outside the specified
+names of refs as specified by `GIT_NAMESPACE`. `git-upload-pack` and
+`git-receive-pack` will ignore all references outside the specified
namespace.
The smart HTTP server, linkgit:git-http-backend[1], will pass
diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
index f5ac7ae7ca..6e75d45382 100644
--- a/Documentation/gitremote-helpers.txt
+++ b/Documentation/gitremote-helpers.txt
@@ -8,7 +8,7 @@ gitremote-helpers - Helper programs to interact with remote repositories
SYNOPSIS
--------
[verse]
-'git remote-<transport>' <repository> [<URL>]
+`git remote-<transport>` <repository> [<URL>]
DESCRIPTION
-----------
@@ -31,8 +31,8 @@ transport objects between the object database and the remote repository,
and update the local object store.
Git comes with a "curl" family of remote helpers, that handle various
-transport protocols, such as 'git-remote-http', 'git-remote-https',
-'git-remote-ftp' and 'git-remote-ftps'. They implement the capabilities
+transport protocols, such as `git-remote-http`, `git-remote-https`,
+`git-remote-ftp` and `git-remote-ftps`. They implement the capabilities
'fetch', 'option', and 'push'.
INVOCATION
@@ -49,20 +49,20 @@ which directory to invoke auxiliary Git commands.
When Git encounters a URL of the form '<transport>://<address>', where
'<transport>' is a protocol that it cannot handle natively, it
-automatically invokes 'git remote-<transport>' with the full URL as
+automatically invokes `git remote-<transport>` with the full URL as
the second argument. If such a URL is encountered directly on the
command line, the first argument is the same as the second, and if it
is encountered in a configured remote, the first argument is the name
of that remote.
A URL of the form '<transport>::<address>' explicitly instructs Git to
-invoke 'git remote-<transport>' with '<address>' as the second
+invoke `git remote-<transport>` with '<address>' as the second
argument. If such a URL is encountered directly on the command line,
the first argument is '<address>', and if it is encountered in a
configured remote, the first argument is the name of that remote.
Additionally, when a configured remote has `remote.<name>.vcs` set to
-'<transport>', Git explicitly invokes 'git remote-<transport>' with
+'<transport>', Git explicitly invokes `git remote-<transport>` with
'<name>' as the first argument. If set, the second argument is
`remote.<name>.url`; otherwise, the second argument is omitted.
@@ -95,8 +95,8 @@ must provide.
Capabilities for Pushing
^^^^^^^^^^^^^^^^^^^^^^^^
'connect'::
- Can attempt to connect to 'git receive-pack' (for pushing),
- 'git upload-pack', etc for communication using
+ Can attempt to connect to `git receive-pack` (for pushing),
+ `git upload-pack`, etc for communication using
git's native packfile protocol. This
requires a bidirectional, full-duplex connection.
+
@@ -129,7 +129,7 @@ When choosing between 'push' and 'export', Git prefers 'push'.
Other frontends may have some other order of preference.
'no-private-update'::
- When using the 'refspec' capability, git normally updates the
+ When using the 'refspec' capability, `git` normally updates the
private ref on successful push. This update is disabled when
the remote-helper declares the capability 'no-private-update'.
@@ -137,8 +137,8 @@ Other frontends may have some other order of preference.
Capabilities for Fetching
^^^^^^^^^^^^^^^^^^^^^^^^^
'connect'::
- Can try to connect to 'git upload-pack' (for fetching),
- 'git receive-pack', etc for communication using the
+ Can try to connect to `git upload-pack` (for fetching),
+ `git receive-pack`, etc for communication using the
Git's native packfile protocol. This
requires a bidirectional, full-duplex connection.
+
@@ -372,15 +372,15 @@ Supported if the helper has the "import" capability.
'export'::
Instructs the remote helper that any subsequent input is
- part of a fast-import stream (generated by 'git fast-export')
+ part of a fast-import stream (generated by `git fast-export`)
containing objects which should be pushed to the remote.
+
Especially useful for interoperability with a foreign versioning
system.
+
The 'export-marks' and 'import-marks' capabilities, if specified,
-affect this command in so far as they are passed on to 'git
-fast-export', which then will load/store a table of marks for
+affect this command in so far as they are passed on to `git
+fast-export`, which then will load/store a table of marks for
local objects. This can be used to implement for incremental
operations.
+
@@ -388,8 +388,8 @@ Supported if the helper has the "export" capability.
'connect' <service>::
Connects to given service. Standard input and standard output
- of helper are connected to specified service (git prefix is
- included in service name so e.g. fetching uses 'git-upload-pack'
+ of helper are connected to specified service (`git` prefix is
+ included in service name so e.g. fetching uses `git-upload-pack`
as service) on remote side. Valid replies to this command are
empty line (connection established), 'fallback' (no smart
transport support, fall back to dumb transports) and just
diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt
index e174a28360..39cfebccf3 100644
--- a/Documentation/gitrepository-layout.txt
+++ b/Documentation/gitrepository-layout.txt
@@ -72,7 +72,7 @@ objects/info/packs::
are available in this object store. Whenever a pack is
added or removed, `git update-server-info` should be run
to keep this file up to date if the repository is
- published for dumb transports. 'git repack' does this
+ published for dumb transports. `git repack` does this
by default.
objects/info/alternates::
@@ -93,7 +93,7 @@ objects/info/http-alternates::
refs::
References are stored in subdirectories of this
- directory. The 'git prune' command knows to preserve
+ directory. The `git prune` command knows to preserve
objects reachable from refs found in this directory and
its subdirectories.
This directory is ignored (except refs/bisect,
@@ -152,7 +152,7 @@ config.worktree::
branches::
A slightly deprecated way to store shorthands to be used
- to specify a URL to 'git fetch', 'git pull' and 'git push'.
+ to specify a URL to `git fetch`, `git pull` and `git push`.
A file can be stored as `branches/<name>` and then
'name' can be given to these commands in place of
'repository' argument. See the REMOTES section in
@@ -165,7 +165,7 @@ branches::
hooks::
Hooks are customization scripts used by various Git
commands. A handful of sample hooks are installed when
- 'git init' is run, but all of them are disabled by
+ `git init` is run, but all of them are disabled by
default. To enable, the `.sample` suffix has to be
removed from the filename by renaming.
Read linkgit:githooks[5] for more details about
@@ -195,10 +195,10 @@ info/refs::
This file helps dumb transports discover what refs are
available in this repository. If the repository is
published for dumb transports, this file should be
- regenerated by 'git update-server-info' every time a tag
+ regenerated by `git update-server-info` every time a tag
or branch is created or modified. This is normally done
from the `hooks/update` hook, which is run by the
- 'git-receive-pack' command when you 'git push' into the
+ `git-receive-pack` command when you `git push` into the
repository.
info/grafts::
@@ -216,8 +216,8 @@ for a more flexible and robust system to do the same thing.
info/exclude::
This file, by convention among Porcelains, stores the
exclude pattern list. `.gitignore` is the per-directory
- ignore file. 'git status', 'git add', 'git rm' and
- 'git clean' look at it but the core Git commands do not look
+ ignore file. `git status`, `git add`, `git rm` and
+ `git clean` look at it but the core Git commands do not look
at it. See also: linkgit:gitignore[5].
info/attributes::
@@ -230,8 +230,8 @@ info/sparse-checkout::
remotes::
Stores shorthands for URL and default refnames for use
- when interacting with remote repositories via 'git fetch',
- 'git pull' and 'git push' commands. See the REMOTES section
+ when interacting with remote repositories via `git fetch`,
+ `git pull` and `git push` commands. See the REMOTES section
in linkgit:git-fetch[1] for details. This mechanism is legacy
and not likely to be found in modern repositories. This
directory is ignored if $GIT_COMMON_DIR is set and
@@ -264,7 +264,7 @@ commondir::
incomplete without the repository pointed by "commondir".
modules::
- Contains the git-repositories of the submodules.
+ Contains the `git`-repositories of the submodules.
worktrees::
Contains administrative data for linked
diff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt
index 2b3cba8ae3..65bc1453d6 100644
--- a/Documentation/gittutorial-2.txt
+++ b/Documentation/gittutorial-2.txt
@@ -261,7 +261,7 @@ index a042389..513feba 100644
+hello world, again
------------------------------------------------
-So 'git diff' is comparing against something other than the head.
+So `git diff` is comparing against something other than the head.
The thing that it's comparing against is actually the index file,
which is stored in .git/index in a binary format, but whose contents
we can examine with ls-files:
@@ -276,9 +276,9 @@ hello world!
hello world, again
------------------------------------------------
-So what our 'git add' did was store a new blob and then put
+So what our `git add` did was store a new blob and then put
a reference to it in the index file. If we modify the file again,
-we'll see that the new modifications are reflected in the 'git diff'
+we'll see that the new modifications are reflected in the `git diff`
output:
------------------------------------------------
@@ -293,7 +293,7 @@ index 513feba..ba3da7b 100644
+again?
------------------------------------------------
-With the right arguments, 'git diff' can also show us the difference
+With the right arguments, `git diff` can also show us the difference
between the working directory and the last commit, or between the
index and the last commit:
@@ -317,7 +317,7 @@ index a042389..513feba 100644
+hello world, again
------------------------------------------------
-At any time, we can create a new commit using 'git commit' (without
+At any time, we can create a new commit using `git commit` (without
the `-a` option), and verify that the state committed only includes the
changes stored in the index file, not the additional change that is
still only in our working tree:
@@ -335,11 +335,11 @@ index 513feba..ba3da7b 100644
+again?
------------------------------------------------
-So by default 'git commit' uses the index to create the commit, not
+So by default `git commit` uses the index to create the commit, not
the working tree; the `-a` option to commit tells it to first update
the index with all changes in the working tree.
-Finally, it's worth looking at the effect of 'git add' on the index
+Finally, it's worth looking at the effect of `git add` on the index
file:
------------------------------------------------
@@ -347,7 +347,7 @@ $ echo "goodbye, world" >closing.txt
$ git add closing.txt
------------------------------------------------
-The effect of the 'git add' was to add one entry to the index file:
+The effect of the `git add` was to add one entry to the index file:
------------------------------------------------
$ git ls-files --stage
@@ -385,8 +385,8 @@ Changes not staged for commit:
Since the current state of closing.txt is cached in the index file,
it is listed as "Changes to be committed". Since file.txt has
changes in the working directory that aren't reflected in the index,
-it is marked "changed but not updated". At this point, running "git
-commit" would create a commit that added closing.txt (with its new
+it is marked "changed but not updated". At this point, running `git
+commit` would create a commit that added closing.txt (with its new
contents), but that didn't modify file.txt.
Also, note that a bare `git diff` shows the changes to file.txt, but
@@ -403,7 +403,7 @@ What next?
----------
At this point you should know everything necessary to read the man
-pages for any of the git commands; one good place to start would be
+pages for any of the `git` commands; one good place to start would be
with the commands mentioned in linkgit:giteveryday[7]. You
should be able to find any unknown jargon in linkgit:gitglossary[7].
diff --git a/Documentation/gittutorial.txt b/Documentation/gittutorial.txt
index 089a89f776..da3b218e22 100644
--- a/Documentation/gittutorial.txt
+++ b/Documentation/gittutorial.txt
@@ -68,7 +68,7 @@ You've now initialized the working directory--you may notice a new
directory created, named ".git".
Next, tell Git to take a snapshot of the contents of all files under the
-current directory (note the '.'), with 'git add':
+current directory (note the '.'), with `git add`:
------------------------------------------------
$ git add .
@@ -76,7 +76,7 @@ $ git add .
This snapshot is now stored in a temporary staging area which Git calls
the "index". You can permanently store the contents of the index in the
-repository with 'git commit':
+repository with `git commit`:
------------------------------------------------
$ git commit
@@ -95,15 +95,15 @@ $ git add file1 file2 file3
------------------------------------------------
You are now ready to commit. You can see what is about to be committed
-using 'git diff' with the `--cached` option:
+using `git diff` with the `--cached` option:
------------------------------------------------
$ git diff --cached
------------------------------------------------
-(Without `--cached`, 'git diff' will show you any changes that
+(Without `--cached`, `git diff` will show you any changes that
you've made but not yet added to the index.) You can also get a brief
-summary of the situation with 'git status':
+summary of the situation with `git status`:
------------------------------------------------
$ git status
@@ -128,7 +128,7 @@ $ git commit
This will again prompt you for a message describing the change, and then
record a new version of the project.
-Alternatively, instead of running 'git add' beforehand, you can use
+Alternatively, instead of running `git add` beforehand, you can use
------------------------------------------------
$ git commit -a
@@ -151,7 +151,7 @@ Git tracks content not files
Many revision control systems provide an `add` command that tells the
system to start tracking changes to a new file. Git's `add` command
-does something simpler and more powerful: 'git add' is used both for new
+does something simpler and more powerful: `git add` is used both for new
and newly modified files, and in both cases it takes a snapshot of the
given files and stages that content in the index, ready for inclusion in
the next commit.
@@ -349,7 +349,7 @@ she can issue the following command:
$ gitk HEAD..FETCH_HEAD
------------------------------------------------
-This uses the same two-dot range notation we saw earlier with 'git log'.
+This uses the same two-dot range notation we saw earlier with `git log`.
Alice may want to view what both of them did since they forked.
She can use three-dot form instead of the two-dot form:
@@ -361,8 +361,8 @@ $ gitk HEAD...FETCH_HEAD
This means "show everything that is reachable from either one, but
exclude anything that is reachable from both of them".
-Please note that these range notation can be used with both gitk
-and "git log".
+Please note that these range notation can be used with both `gitk`
+and `git log`.
After inspecting what Bob did, if there is nothing urgent, Alice may
decide to continue working without pulling from Bob. If Bob's history
@@ -380,7 +380,7 @@ alice$ git remote add bob /home/bob/myrepo
------------------------------------------------
With this, Alice can perform the first part of the "pull" operation
-alone using the 'git fetch' command without merging them with her own
+alone using the `git fetch` command without merging them with her own
branch, using:
-------------------------------------
@@ -388,7 +388,7 @@ alice$ git fetch bob
-------------------------------------
Unlike the longhand form, when Alice fetches from Bob using a
-remote repository shorthand set up with 'git remote', what was
+remote repository shorthand set up with `git remote`, what was
fetched is stored in a remote-tracking branch, in this case
`bob/master`. So after this:
@@ -413,7 +413,7 @@ branch', like this:
alice$ git pull . remotes/bob/master
-------------------------------------
-Note that git pull always merges into the current branch,
+Note that `git pull` always merges into the current branch,
regardless of what else is given on the command line.
Later, Bob can update his repo with Alice's latest changes using
@@ -432,7 +432,7 @@ bob$ git config --get remote.origin.url
/home/alice/project
-------------------------------------
-(The complete configuration created by 'git clone' is visible using
+(The complete configuration created by `git clone` is visible using
`git config -l`, and the linkgit:git-config[1] man page
explains the meaning of each option.)
@@ -462,8 +462,8 @@ Exploring history
-----------------
Git history is represented as a series of interrelated commits. We
-have already seen that the 'git log' command can list those commits.
-Note that first line of each git log entry also gives a name for the
+have already seen that the `git log` command can list those commits.
+Note that first line of each `git log` entry also gives a name for the
commit:
-------------------------------------
@@ -475,7 +475,7 @@ Date: Tue May 16 17:18:22 2006 -0700
merge-base: Clarify the comments on post processing.
-------------------------------------
-We can give this name to 'git show' to see the details about this
+We can give this name to `git show` to see the details about this
commit.
-------------------------------------
@@ -533,13 +533,13 @@ $ git reset --hard HEAD^ # reset your current branch and working
Be careful with that last command: in addition to losing any changes
in the working directory, it will also remove all later commits from
this branch. If this branch is the only branch containing those
-commits, they will be lost. Also, don't use 'git reset' on a
+commits, they will be lost. Also, don't use `git reset` on a
publicly-visible branch that other developers pull from, as it will
force needless merges on other developers to clean up the history.
-If you need to undo changes that you have pushed, use 'git revert'
+If you need to undo changes that you have pushed, use `git revert`
instead.
-The 'git grep' command can search for strings in any version of your
+The `git grep` command can search for strings in any version of your
project, so
-------------------------------------
@@ -548,7 +548,7 @@ $ git grep "hello" v2.5
searches for all occurrences of "hello" in v2.5.
-If you leave out the commit name, 'git grep' will search any of the
+If you leave out the commit name, `git grep` will search any of the
files it manages in your current directory. So
-------------------------------------
@@ -558,7 +558,7 @@ $ git grep "hello"
is a quick way to search just the files that are tracked by Git.
Many Git commands also take sets of commits, which can be specified
-in a number of ways. Here are some examples with 'git log':
+in a number of ways. Here are some examples with `git log`:
-------------------------------------
$ git log v2.5..v2.6 # commits between v2.5 and v2.6
@@ -568,7 +568,7 @@ $ git log v2.5.. Makefile # commits since v2.5 which modify
# Makefile
-------------------------------------
-You can also give 'git log' a "range" of commits where the first is not
+You can also give `git log` a "range" of commits where the first is not
necessarily an ancestor of the second; for example, if the tips of
the branches `stable` and `master` diverged from a common
commit some time ago, then
@@ -587,13 +587,13 @@ $ git log master..stable
will show the list of commits made on the `stable` branch but not
the `master` branch.
-The 'git log' command has a weakness: it must present commits in a
+The `git log` command has a weakness: it must present commits in a
list. When the history has lines of development that diverged and
-then merged back together, the order in which 'git log' presents
+then merged back together, the order in which `git log` presents
those commits is meaningless.
Most projects with multiple contributors (such as the Linux kernel,
-or Git itself) have frequent merges, and 'gitk' does a better job of
+or Git itself) have frequent merges, and `gitk` does a better job of
visualizing their history. For example,
-------------------------------------
@@ -613,7 +613,7 @@ of the file:
$ git diff v2.5:Makefile HEAD:Makefile.in
-------------------------------------
-You can also use 'git show' to see any such file:
+You can also use `git show` to see any such file:
-------------------------------------
$ git show v2.5:Makefile
@@ -643,7 +643,7 @@ If you don't want to continue with that right away, a few other
digressions that may be interesting at this point are:
* linkgit:git-format-patch[1], linkgit:git-am[1]: These convert
- series of git commits into emailed patches, and vice versa,
+ series of `git` commits into emailed patches, and vice versa,
useful for projects such as the Linux kernel which rely heavily
on emailed patches.
diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt
index 181c543a64..5c74907da9 100644
--- a/Documentation/gitweb.conf.txt
+++ b/Documentation/gitweb.conf.txt
@@ -12,7 +12,7 @@ SYNOPSIS
DESCRIPTION
-----------
-The gitweb CGI script for viewing Git repositories over the web uses a
+The `gitweb` CGI script for viewing Git repositories over the web uses a
perl script fragment as its configuration file. You can set variables
using "`our $variable = value`"; text from a "#" character until the
end of a line is ignored. See *perlsyn*(1) for details.
@@ -28,17 +28,17 @@ our $site_name = 'Example.org >> Repos';
The configuration file is used to override the default settings that
-were built into gitweb at the time the 'gitweb.cgi' script was generated.
+were built into `gitweb` at the time the 'gitweb.cgi' script was generated.
-While one could just alter the configuration settings in the gitweb
+While one could just alter the configuration settings in the `gitweb`
CGI itself, those changes would be lost upon upgrade. Configuration
settings might also be placed into a file in the same directory as the
CGI script with the default name 'gitweb_config.perl' -- allowing
-one to have multiple gitweb instances with different configurations by
+one to have multiple `gitweb` instances with different configurations by
the use of symlinks.
Note that some configuration can be controlled on per-repository rather than
-gitweb-wide basis: see "Per-repository gitweb configuration" subsection on
+`gitweb`-wide basis: see "Per-repository `gitweb` configuration" subsection on
linkgit:gitweb[1] manpage.
@@ -53,7 +53,7 @@ following order:
`/etc/gitweb-common.conf`),
* either per-instance configuration file (defaults to 'gitweb_config.perl'
- in the same directory as the installed gitweb), or if it does not exists
+ in the same directory as the installed `gitweb`), or if it does not exists
then fallback system-wide configuration file (defaults to `/etc/gitweb.conf`).
Values obtained in later configuration files override values obtained earlier
@@ -65,7 +65,7 @@ are defined at compile time using build-time Makefile configuration
variables, respectively `GITWEB_CONFIG_COMMON`, `GITWEB_CONFIG_SYSTEM`
and `GITWEB_CONFIG`.
-You can also override locations of gitweb configuration files during
+You can also override locations of `gitweb` configuration files during
runtime by setting the following environment variables:
`GITWEB_CONFIG_COMMON`, `GITWEB_CONFIG_SYSTEM` and `GITWEB_CONFIG`
to a non-empty value.
@@ -73,13 +73,13 @@ to a non-empty value.
The syntax of the configuration files is that of Perl, since these files are
handled by sourcing them as fragments of Perl code (the language that
-gitweb itself is written in). Variables are typically set using the
+`gitweb` itself is written in). Variables are typically set using the
`our` qualifier (as in "`our $variable = <value>;`") to avoid syntax
-errors if a new version of gitweb no longer uses a variable and therefore
+errors if a new version of `gitweb` no longer uses a variable and therefore
stops declaring it.
You can include other configuration file using read_config_file()
-subroutine. For example, one might want to put gitweb configuration
+subroutine. For example, one might want to put `gitweb` configuration
related to access control for viewing repositories via Gitolite (one
of Git repository management tools) in a separate file, e.g. in
`/etc/gitweb-gitolite.conf`. To include it, put
@@ -88,31 +88,31 @@ of Git repository management tools) in a separate file, e.g. in
read_config_file("/etc/gitweb-gitolite.conf");
--------------------------------------------------
-somewhere in gitweb configuration file used, e.g. in per-installation
-gitweb configuration file. Note that read_config_file() checks itself
+somewhere in `gitweb` configuration file used, e.g. in per-installation
+`gitweb` configuration file. Note that read_config_file() checks itself
that the file it reads exists, and does nothing if it is not found.
It also handles errors in included file.
The default configuration with no configuration file at all may work
perfectly well for some installations. Still, a configuration file is
-useful for customizing or tweaking the behavior of gitweb in many ways, and
+useful for customizing or tweaking the behavior of `gitweb` in many ways, and
some optional features will not be present unless explicitly enabled using
-the configurable `%features` variable (see also "Configuring gitweb
+the configurable `%features` variable (see also "Configuring `gitweb`
features" section below).
CONFIGURATION VARIABLES
-----------------------
Some configuration variables have their default values (embedded in the CGI
-script) set during building gitweb -- if that is the case, this fact is put
+script) set during building `gitweb` -- if that is the case, this fact is put
in their description. See gitweb's 'INSTALL' file for instructions on building
-and installing gitweb.
+and installing `gitweb`.
Location of repositories
~~~~~~~~~~~~~~~~~~~~~~~~
-The configuration variables described below control how gitweb finds
+The configuration variables described below control how `gitweb` finds
Git repositories, and how repositories are displayed and accessed.
See also "Repositories" and later subsections in linkgit:gitweb[1] manpage.
@@ -121,10 +121,10 @@ $projectroot::
Absolute filesystem path which will be prepended to project path;
the path to repository is `$projectroot/$project`. Set to
`$GITWEB_PROJECTROOT` during installation. This variable has to be
- set correctly for gitweb to find repositories.
+ set correctly for `gitweb` to find repositories.
+
For example, if `$projectroot` is set to "/srv/git" by putting the following
-in gitweb config file:
+in `gitweb` config file:
+
----------------------------------------------------------------------------
our $projectroot = "/srv/git";
@@ -156,11 +156,11 @@ having the following format
-----------------------------------------------------------------------------
+
The default value of this variable is determined by the `GITWEB_LIST`
-makefile variable at installation time. If this variable is empty, gitweb
+makefile variable at installation time. If this variable is empty, `gitweb`
will fall back to scanning the `$projectroot` directory for repositories.
$project_maxdepth::
- If `$projects_list` variable is unset, gitweb will recursively
+ If `$projects_list` variable is unset, `gitweb` will recursively
scan filesystem for Git repositories. The `$project_maxdepth`
is used to limit traversing depth, relative to `$projectroot`
(starting point); it means that directories which are further
@@ -177,8 +177,8 @@ configuration variable `GITWEB_PROJECT_MAXDEPTH`, which defaults to
$export_ok::
Show repository only if this file exists (in repository). Only
effective if this variable evaluates to true. Can be set when
- building gitweb by setting `GITWEB_EXPORT_OK`. This path is
- relative to `GIT_DIR`. git-daemon[1] uses 'git-daemon-export-ok',
+ building `gitweb` by setting `GITWEB_EXPORT_OK`. This path is
+ relative to `GIT_DIR`. `git-daemon`[1] uses `git-daemon-export-ok`,
unless started with `--export-all`. By default this variable is
not set, which means that this feature is turned off.
@@ -186,7 +186,7 @@ $export_auth_hook::
Function used to determine which repositories should be shown.
This subroutine should take one parameter, the full path to
a project, and if it returns true, that project will be included
- in the projects list and can be accessed through gitweb as long
+ in the projects list and can be accessed through `gitweb` as long
as it fulfills the other requirements described by $export_ok,
$projects_list, and $projects_maxdepth. Example:
+
@@ -210,7 +210,7 @@ $strict_export::
This for example makes `$export_ok` file decide if repository is
available and not only if it is shown. If `$projects_list` points to
file with list of project, only those repositories listed would be
- available for gitweb. Can be set during building gitweb via
+ available for `gitweb`. Can be set during building `gitweb` via
`GITWEB_STRICT_EXPORT`. By default this variable is not set, which
means that you can directly access those repositories that are hidden
from projects list page (e.g. the are not listed in the $projects_list
@@ -219,17 +219,17 @@ $strict_export::
Finding files
~~~~~~~~~~~~~
-The following configuration variables tell gitweb where to find files.
+The following configuration variables tell `gitweb` where to find files.
The values of these variables are paths on the filesystem.
$GIT::
- Core git executable to use. By default set to `$GIT_BINDIR/git`, which
+ Core `git` executable to use. By default set to `$GIT_BINDIR/git`, which
in turn is by default set to `$(bindir)/git`. If you use Git installed
from a binary package, you should usually set this to "/usr/bin/git".
- This can just be "git" if your web server has a sensible PATH; from
- security point of view it is better to use absolute path to git binary.
+ This can just be `git` if your web server has a sensible PATH; from
+ security point of view it is better to use absolute path to `git` binary.
If you have multiple Git versions installed it can be used to choose
- which one to use. Must be (correctly) set for gitweb to be able to
+ which one to use. Must be (correctly) set for `gitweb` to be able to
work.
$mimetypes_file::
@@ -245,7 +245,7 @@ $highlight_bin::
http://www.andre-simon.de[] due to assumptions about parameters and output).
By default set to 'highlight'; set it to full path to highlight
executable if it is not installed on your web server's PATH.
- Note that 'highlight' feature must be set for gitweb to actually
+ Note that 'highlight' feature must be set for `gitweb` to actually
use syntax highlighting.
+
*NOTE*: for a file to be highlighted, its syntax type must be detected
@@ -265,7 +265,7 @@ the highlight documentation and the default config at
+
For example if repositories you are hosting use "phtml" extension for
PHP files, and you want to have correct syntax-highlighting for those
-files, you can add the following to gitweb configuration:
+files, you can add the following to `gitweb` configuration:
+
---------------------------------------------------------
our %highlight_ext;
@@ -275,7 +275,7 @@ $highlight_ext{'phtml'} = 'php';
Links and their targets
~~~~~~~~~~~~~~~~~~~~~~~
-The configuration variables described below configure some of gitweb links:
+The configuration variables described below configure some of `gitweb` links:
their target and their look (text or image), and where to find page
prerequisites (stylesheet, favicon, images, scripts). Usually they are left
at their default values, with the possible exception of `@stylesheets`
@@ -285,32 +285,32 @@ variable.
List of URIs of stylesheets (relative to the base URI of a page). You
might specify more than one stylesheet, for example to use "gitweb.css"
as base with site specific modifications in a separate stylesheet
- to make it easier to upgrade gitweb. For example, you can add
+ to make it easier to upgrade `gitweb`. For example, you can add
a `site` stylesheet by putting
+
----------------------------------------------------------------------------
push @stylesheets, "gitweb-site.css";
----------------------------------------------------------------------------
+
-in the gitweb config file. Those values that are relative paths are
-relative to base URI of gitweb.
+in the `gitweb` config file. Those values that are relative paths are
+relative to base URI of `gitweb`.
+
This list should contain the URI of gitweb's standard stylesheet. The default
-URI of gitweb stylesheet can be set at build time using the `GITWEB_CSS`
+URI of `gitweb` stylesheet can be set at build time using the `GITWEB_CSS`
makefile variable. Its default value is `static/gitweb.css`
(or `static/gitweb.min.css` if the `CSSMIN` variable is defined,
i.e. if CSS minifier is used during build).
+
*Note*: there is also a legacy `$stylesheet` configuration variable, which was
-used by older gitweb. If `$stylesheet` variable is defined, only CSS stylesheet
-given by this variable is used by gitweb.
+used by older `gitweb`. If `$stylesheet` variable is defined, only CSS stylesheet
+given by this variable is used by `gitweb`.
$logo::
Points to the location where you put 'git-logo.png' on your web
server, or to be more the generic URI of logo, 72x27 size). This image
- is displayed in the top right corner of each gitweb page and used as
- a logo for the Atom feed. Relative to the base URI of gitweb (as a path).
- Can be adjusted when building gitweb using `GITWEB_LOGO` variable
+ is displayed in the top right corner of each `gitweb` page and used as
+ a logo for the Atom feed. Relative to the base URI of `gitweb` (as a path).
+ Can be adjusted when building `gitweb` using `GITWEB_LOGO` variable
By default set to `static/git-logo.png`.
$favicon::
@@ -318,14 +318,14 @@ $favicon::
server, or to be more the generic URI of favicon, which will be served
as "image/png" type. Web browsers that support favicons (website icons)
may display them in the browser's URL bar and next to the site name in
- bookmarks. Relative to the base URI of gitweb. Can be adjusted at
+ bookmarks. Relative to the base URI of `gitweb`. Can be adjusted at
build time using `GITWEB_FAVICON` variable.
By default set to `static/git-favicon.png`.
$javascript::
Points to the location where you put 'gitweb.js' on your web server,
- or to be more generic the URI of JavaScript code used by gitweb.
- Relative to the base URI of gitweb. Can be set at build time using
+ or to be more generic the URI of JavaScript code used by `gitweb`.
+ Relative to the base URI of `gitweb`. Can be set at build time using
the `GITWEB_JS` build-time configuration variable.
+
The default value is either `static/gitweb.js`, or `static/gitweb.min.js` if
@@ -341,7 +341,7 @@ $home_link::
$home_link_str::
Label for the "home link" at the top of all pages, leading to `$home_link`
- (usually the main gitweb page, which contains the projects list). It is
+ (usually the main `gitweb` page, which contains the projects list). It is
used as the first component of gitweb's "breadcrumb trail":
`<home link> / <project> / <action>`. Can be set at build time using
the `GITWEB_HOME_LINK_STR` variable. By default it is set to "projects",
@@ -351,8 +351,8 @@ $home_link_str::
@extra_breadcrumbs::
Additional links to be added to the start of the breadcrumb trail before
- the home link, to pages that are logically "above" the gitweb projects
- list, such as the organization and department which host the gitweb
+ the home link, to pages that are logically "above" the `gitweb` projects
+ list, such as the organization and department which host the `gitweb`
server. Each element of the list is a reference to an array, in which
element 0 is the link text (equivalent to `$home_link_str`) and element
1 is the target URL (equivalent to `$home_link`).
@@ -377,17 +377,17 @@ $logo_label::
Changing gitweb's look
~~~~~~~~~~~~~~~~~~~~~~
-You can adjust how pages generated by gitweb look using the variables described
+You can adjust how pages generated by `gitweb` look using the variables described
below. You can change the site name, add common headers and footers for all
-pages, and add a description of this gitweb installation on its main page
+pages, and add a description of this `gitweb` installation on its main page
(which is the projects list page), etc.
$site_name::
Name of your site or organization, to appear in page titles. Set it
to something descriptive for clearer bookmarks etc. If this variable
- is not set or is, then gitweb uses the value of the `SERVER_NAME`
+ is not set or is, then `gitweb` uses the value of the `SERVER_NAME`
`CGI` environment variable, setting site name to "$SERVER_NAME Git",
- or "Untitled Git" if this variable is not set (e.g. if running gitweb
+ or "Untitled Git" if this variable is not set (e.g. if running `gitweb`
as standalone script).
+
Can be set using the `GITWEB_SITENAME` at build time. Unset by default.
@@ -411,7 +411,7 @@ $site_footer::
$home_text::
Name of a HTML file which, if it exists, is included on the
- gitweb projects overview page ("projects_list" view). Relative to
+ `gitweb` projects overview page ("projects_list" view). Relative to
the directory containing the gitweb.cgi script. Default value
can be adjusted during build time using `GITWEB_HOMETEXT` variable.
By default set to 'indextext.html'.
@@ -437,7 +437,7 @@ Default value is "project". Unknown value means unsorted.
Changing gitweb's behavior
~~~~~~~~~~~~~~~~~~~~~~~~~~
-These configuration variables control _internal_ gitweb behavior.
+These configuration variables control _internal_ `gitweb` behavior.
$default_blob_plain_mimetype::
Default mimetype for the blob_plain (raw) view, if mimetype checking
@@ -445,7 +445,7 @@ $default_blob_plain_mimetype::
Gitweb guesses mimetype of a file to display based on extension
of its filename, using `$mimetypes_file` (if set and file exists)
and `/etc/mime.types` files (see *mime.types*(5) manpage; only
- filename extension rules are supported by gitweb).
+ filename extension rules are supported by `gitweb`).
$default_text_plain_charset::
Default charset for text files. If this is not set, the web server
@@ -458,7 +458,7 @@ $fallback_encoding::
man page for a list. The default is "latin1", aka. "iso-8859-1".
@diff_opts::
- Rename detection options for git-diff and git-diff-tree. The default is
+ Rename detection options for `git-diff` and `git-diff-tree`. The default is
`('-M')`; set it to `('-C')` or `('-C', '-C')` to also detect copies,
or set it to `()` i.e. empty list if you don't want to have renames
detection.
@@ -472,9 +472,9 @@ involve file copies `('-C')` or criss-cross renames `('-B')`.
Some optional features and policies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Most of features are configured via `%feature` hash; however some of extra
-gitweb features can be turned on and configured using variables described
-below. This list beside configuration variables that control how gitweb
-looks does contain variables configuring administrative side of gitweb
+`gitweb` features can be turned on and configured using variables described
+below. This list beside configuration variables that control how `gitweb`
+looks does contain variables configuring administrative side of `gitweb`
(e.g. cross-site scripting prevention; admittedly this as side effect
affects how "summary" pages look like, or load limiting).
@@ -493,7 +493,7 @@ composed from `@git_base_url_list` elements and project name.
+
You can setup one single value (single entry/item in this list) at build
time by setting the `GITWEB_BASE_URL` build-time configuration variable.
-By default it is set to (), i.e. an empty list. This means that gitweb
+By default it is set to (), i.e. an empty list. This means that `gitweb`
would not try to create project URL (to fetch) from project name.
$projects_list_group_categories::
@@ -510,16 +510,16 @@ $project_list_default_category::
is true. By default set to "" (empty string).
$prevent_xss::
- If true, some gitweb features are disabled to prevent content in
+ If true, some `gitweb` features are disabled to prevent content in
repositories from launching cross-site scripting (XSS) attacks. Set this
to true if you don't trust the content of your repositories.
False by default (set to 0).
$maxload::
- Used to set the maximum load that we will still respond to gitweb queries.
- If the server load exceeds this value then gitweb will return
+ Used to set the maximum load that we will still respond to `gitweb` queries.
+ If the server load exceeds this value then `gitweb` will return
"503 Service Unavailable" error. The server load is taken to be 0
- if gitweb cannot determine its value. Currently it works only on Linux,
+ if `gitweb` cannot determine its value. Currently it works only on Linux,
where it uses `/proc/loadavg`; the load there is the number of active
tasks on the system -- processes that are actually running -- averaged
over the last minute.
@@ -537,7 +537,7 @@ $omit_owner::
$per_request_config::
If this is set to code reference, it will be run once for each request.
You can set parts of configuration that change per session this way.
- For example, one might use the following code in a gitweb configuration
+ For example, one might use the following code in a `gitweb` configuration
file
+
--------------------------------------------------------------------------------
@@ -547,8 +547,8 @@ our $per_request_config = sub {
--------------------------------------------------------------------------------
+
If `$per_request_config` is not a code reference, it is interpreted as boolean
-value. If it is true gitweb will process config files once per request,
-and if it is false gitweb will process config files only once, each time it
+value. If it is true `gitweb` will process config files once per request,
+and if it is false `gitweb` will process config files only once, each time it
is executed. True by default (set to 1).
+
*NOTE*: `$my_url`, `$my_uri`, and `$base_url` are overwritten with their default
@@ -556,50 +556,50 @@ values before every request, so if you want to change them, be sure to set
this variable to true or a code reference effecting the desired changes.
+
This variable matters only when using persistent web environments that
-serve multiple requests using single gitweb instance, like mod_perl,
+serve multiple requests using single `gitweb` instance, like mod_perl,
FastCGI or Plackup.
Other variables
~~~~~~~~~~~~~~~
Usually you should not need to change (adjust) any of configuration
-variables described below; they should be automatically set by gitweb to
+variables described below; they should be automatically set by `gitweb` to
correct value.
$version::
Gitweb version, set automatically when creating gitweb.cgi from
gitweb.perl. You might want to modify it if you are running modified
- gitweb, for example
+ `gitweb`, for example
+
---------------------------------------------------
our $version .= " with caching";
---------------------------------------------------
+
-if you run modified version of gitweb with caching support. This variable
+if you run modified version of `gitweb` with caching support. This variable
is purely informational, used e.g. in the "generator" meta header in HTML
header.
$my_url::
$my_uri::
- Full URL and absolute URL of the gitweb script;
- in earlier versions of gitweb you might have need to set those
+ Full URL and absolute URL of the `gitweb` script;
+ in earlier versions of `gitweb` you might have need to set those
variables, but now there should be no need to do it. See
`$per_request_config` if you need to set them still.
$base_url::
- Base URL for relative URLs in pages generated by gitweb,
+ Base URL for relative URLs in pages generated by `gitweb`,
(e.g. `$logo`, `$favicon`, `@stylesheets` if they are relative URLs),
needed and used '<base href="$base_url">' only for URLs with nonempty
- PATH_INFO. Usually gitweb sets its value correctly,
+ PATH_INFO. Usually `gitweb` sets its value correctly,
and there is no need to set this variable, e.g. to $my_uri or "/".
See `$per_request_config` if you need to override it anyway.
CONFIGURING GITWEB FEATURES
---------------------------
-Many gitweb features can be enabled (or disabled) and configured using the
-`%feature` hash. Names of gitweb features are keys of this hash.
+Many `gitweb` features can be enabled (or disabled) and configured using the
+`%feature` hash. Names of `gitweb` features are keys of this hash.
Each `%feature` hash element is a hash reference and has the following
structure:
@@ -653,12 +653,12 @@ sub::
if this field is not present then per-repository override for
given feature is not supported.
+
-You wouldn't need to ever change it in gitweb config file.
+You wouldn't need to ever change it in `gitweb` config file.
Features in `%feature`
~~~~~~~~~~~~~~~~~~~~~~
-The gitweb features that are configurable via `%feature` hash are listed
+The `gitweb` features that are configurable via `%feature` hash are listed
below. This should be a complete list, but ultimately the authoritative
and complete list is in gitweb.cgi source code, with features described
in the comments.
@@ -680,7 +680,7 @@ snapshot::
The value of \'default' is a list of names of snapshot formats,
defined in `%known_snapshot_formats` hash, that you wish to offer.
Supported formats include "tgz", "tbz2", "txz" (gzip/bzip2/xz
-compressed tar archive) and "zip"; please consult gitweb sources for
+compressed tar archive) and "zip"; please consult `gitweb` sources for
a definitive list. By default only "tgz" is offered.
+
This feature can be configured on a per-repository basis via
@@ -782,7 +782,7 @@ search::
Project specific override is not supported.
forks::
- If this feature is enabled, gitweb considers projects in
+ If this feature is enabled, `gitweb` considers projects in
subdirectories of project root (basename) to be forks of existing
projects. For each project +$projname.git+, projects in the
+$projname/+ directory and its subdirectories will not be
@@ -799,15 +799,15 @@ Project specific override is not supported.
actions::
Insert custom links to the action bar of all project pages. This
- allows you to link to third-party scripts integrating into gitweb.
+ allows you to link to third-party scripts integrating into `gitweb`.
+
The "default" value consists of a list of triplets in the form
`("<label>", "<link>", "<position>")` where "position" is the label
after which to insert the link, "link" is a format string where `%n`
expands to the project name, `%f` to the project path within the
filesystem (i.e. "$projectroot/$project"), `%h` to the current hash
-(\'h' gitweb parameter) and `%b` to the current hash base
-(\'hb' gitweb parameter); `%%` expands to \'%'.
+(\'h' `gitweb` parameter) and `%b` to the current hash base
+(\'hb' `gitweb` parameter); `%%` expands to \'%'.
+
For example, at the time this page was written, the http://repo.or.cz[]
Git hosting site set it to the following to enable graphical log
@@ -833,7 +833,7 @@ Project specific override is not supported.
javascript-timezone::
Enable and configure the ability to change a common time zone for dates
- in gitweb output via JavaScript. Dates in gitweb output include
+ in `gitweb` output via JavaScript. Dates in `gitweb` output include
authordate and committerdate in "commit", "commitdiff" and "log"
views, and taggerdate in "tag" view. Enabled by default.
+
@@ -843,7 +843,7 @@ where to store selected time zone, and a CSS class used to mark up
dates for manipulation. If you want to turn this feature off, set "default"
to empty list: `[]`.
+
-Typical gitweb config files will only change starting (default) time zone,
+Typical `gitweb` config files will only change starting (default) time zone,
and leave other elements at their default values:
+
---------------------------------------------------------------------------
@@ -854,7 +854,7 @@ The example configuration presented here is guaranteed to be backwards
and forward compatible.
+
Time zone values can be "local" (for local time zone that browser uses), "utc"
-(what gitweb uses when JavaScript or this feature is disabled), or numerical
+(what `gitweb` uses when JavaScript or this feature is disabled), or numerical
time zones in the form of "+/-HHMM", such as "+0200".
+
Project specific override is not supported.
@@ -883,7 +883,7 @@ space separated list of refs. An example:
extraBranchRefs = sandbox wip other
--------------------------------------------------------------------------------
+
-The gitweb.extraBranchRefs is actually a multi-valued configuration
+The `gitweb.extraBranchRefs` is actually a multi-valued configuration
variable, so following example is also correct and the result is the
same as of the snippet above:
+
@@ -893,7 +893,7 @@ same as of the snippet above:
extraBranchRefs = wip other
--------------------------------------------------------------------------------
+
-It is an error to specify a ref that does not pass "git check-ref-format"
+It is an error to specify a ref that does not pass `git check-ref-format`
scrutiny. Duplicated values are filtered.
@@ -919,7 +919,7 @@ If you allow overriding for the snapshot feature, you can specify which
snapshot formats are globally disabled. You can also add any command-line
options you want (such as setting the compression level). For instance, you
can disable Zip compressed snapshots and set *gzip*(1) to run at level 6 by
-adding the following lines to your gitweb configuration file:
+adding the following lines to your `gitweb` configuration file:
$known_snapshot_formats{'zip'}{'disabled'} = 1;
$known_snapshot_formats{'tgz'}{'compressor'} = ['gzip','-6'];
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index ee6e6a30fd..1feb9c2b08 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -7,9 +7,9 @@ gitweb - Git web interface (web frontend to Git repositories)
SYNOPSIS
--------
-To get started with gitweb, run linkgit:git-instaweb[1] from a Git repository.
+To get started with `gitweb`, run linkgit:git-instaweb[1] from a Git repository.
This would configure and start your web server, and run web browser pointing to
-gitweb.
+`gitweb`.
DESCRIPTION
@@ -28,8 +28,8 @@ Gitweb provides a web interface to Git repositories. Its features include:
revisions one at a time, viewing the history of the repository.
* Finding commits which commit messages matches given search term.
-See http://repo.or.cz/w/git.git/tree/HEAD:/gitweb/[] for gitweb source code,
-browsed using gitweb itself.
+See http://repo.or.cz/w/git.git/tree/HEAD:/gitweb/[] for `gitweb` source code,
+browsed using `gitweb` itself.
CONFIGURATION
@@ -51,22 +51,22 @@ our $projectroot = '/path/to/parent/directory';
-----------------------------------------------------------------------
The default value for `$projectroot` is `/pub/git`. You can change it during
-building gitweb via `GITWEB_PROJECTROOT` build configuration variable.
+building `gitweb` via `GITWEB_PROJECTROOT` build configuration variable.
By default all Git repositories under `$projectroot` are visible and available
to gitweb. The list of projects is generated by default by scanning the
`$projectroot` directory for Git repositories (for object databases to be
-more exact; gitweb is not interested in a working area, and is best suited
+more exact; `gitweb` is not interested in a working area, and is best suited
to showing "bare" repositories).
-The name of the repository in gitweb is the path to its `$GIT_DIR` (its object
+The name of the repository in `gitweb` is the path to its `$GIT_DIR` (its object
database) relative to `$projectroot`. Therefore the repository $repo can be
found at "$projectroot/$repo".
Projects list file format
~~~~~~~~~~~~~~~~~~~~~~~~~
-Instead of having gitweb find repositories by scanning filesystem
+Instead of having `gitweb` find repositories by scanning filesystem
starting from $projectroot, you can provide a pre-generated list of
visible projects by setting `$projects_list` to point to a plain text
file with a list of projects (with some additional info).
@@ -113,13 +113,13 @@ By default this file controls only which projects are *visible* on projects
list page (note that entries that do not point to correctly recognized Git
repositories won't be displayed by gitweb). Even if a project is not
visible on projects list page, you can view it nevertheless by hand-crafting
-a gitweb URL. By setting `$strict_export` configuration variable (see
+a `gitweb` URL. By setting `$strict_export` configuration variable (see
linkgit:gitweb.conf[5]) to true value you can allow viewing only of
repositories also shown on the overview page (i.e. only projects explicitly
listed in projects list file will be accessible).
-Generating projects list using gitweb
+Generating projects list using `gitweb`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
We assume that GITWEB_CONFIG has its default Makefile value, namely
@@ -131,7 +131,7 @@ $projects_list = $projectroot;
Then create the following script to get list of project in the format
suitable for GITWEB_LIST build configuration variable (or
-`$projects_list` variable in gitweb config):
+`$projects_list` variable in `gitweb` config):
----------------------------------------------------------------------------
#!/bin/sh
@@ -153,18 +153,18 @@ filename.
Controlling access to Git repositories
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
By default all Git repositories under `$projectroot` are visible and
-available to gitweb. You can however configure how gitweb controls access
+available to gitweb. You can however configure how `gitweb` controls access
to repositories.
* As described in "Projects list file format" section, you can control which
projects are *visible* by selectively including repositories in projects
-list file, and setting `$projects_list` gitweb configuration variable to
+list file, and setting `$projects_list` `gitweb` configuration variable to
point to it. With `$strict_export` set, projects list file can be used to
control which repositories are *available* as well.
-* You can configure gitweb to only list and allow viewing of the explicitly
-exported repositories, via `$export_ok` variable in gitweb config file; see
-linkgit:gitweb.conf[5] manpage. If it evaluates to true, gitweb shows
+* You can configure `gitweb` to only list and allow viewing of the explicitly
+exported repositories, via `$export_ok` variable in `gitweb` config file; see
+linkgit:gitweb.conf[5] manpage. If it evaluates to true, `gitweb` shows
repositories only if this file named by `$export_ok` exists in its object
database (if directory has the magic file named `$export_ok`).
+
@@ -176,7 +176,7 @@ is used) allows pulling only for those repositories that have
our $export_ok = "git-daemon-export-ok";
--------------------------------------------------------------------------
+
-makes gitweb show and allow access only to those repositories that can be
+makes `gitweb` show and allow access only to those repositories that can be
fetched from via `git://` protocol.
* Finally, it is possible to specify an arbitrary perl subroutine that will
@@ -202,16 +202,16 @@ $export_auth_hook = sub {
--------------------------------------------------------------------------
-Per-repository gitweb configuration
+Per-repository `gitweb` configuration
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-You can configure individual repositories shown in gitweb by creating file
+You can configure individual repositories shown in `gitweb` by creating file
in the `GIT_DIR` of Git repository, or by setting some repo configuration
variable (in `GIT_DIR/config`, see linkgit:git-config[1]).
You can use the following files in repository:
README.html::
- A html file (HTML fragment) which is included on the gitweb project
+ A html file (HTML fragment) which is included on the `gitweb` project
"summary" page inside `<div>` block element. You can use it for longer
description of a project, to provide links (for example to project's
homepage), etc. This is recognized only if XSS prevention is off
@@ -251,7 +251,7 @@ cloneurl (or multiple-valued `gitweb.url`)::
takes precedence.
+
This is per-repository enhancement / version of global prefix-based
-`@git_base_url_list` gitweb configuration variable (see
+`@git_base_url_list` `gitweb` configuration variable (see
linkgit:gitweb.conf[5]).
gitweb.owner::
@@ -267,13 +267,13 @@ value from this file for given repository.
various `gitweb.*` config variables (in config)::
Read description of `%feature` hash for detailed list, and descriptions.
- See also "Configuring gitweb features" section in linkgit:gitweb.conf[5]
+ See also "Configuring `gitweb` features" section in linkgit:gitweb.conf[5]
ACTIONS, AND URLS
-----------------
Gitweb can use path_info (component) based URLs, or it can pass all necessary
-information via query parameters. The typical gitweb URLs are broken down in to
+information via query parameters. The typical `gitweb` URLs are broken down in to
five components:
-----------------------------------------------------------------------
@@ -301,7 +301,7 @@ arguments::
Any arguments that control the behaviour of the action.
Some actions require or allow to specify two revisions, and sometimes even two
-pathnames. In most general form such path_info (component) based gitweb URL
+pathnames. In most general form such path_info (component) based `gitweb` URL
looks like this:
-----------------------------------------------------------------------
@@ -311,7 +311,7 @@ looks like this:
Each action is implemented as a subroutine, and must be present in %actions
hash. Some actions are disabled by default, and must be turned on via feature
-mechanism. For example to enable 'blame' view add the following to gitweb
+mechanism. For example to enable 'blame' view add the following to `gitweb`
configuration file:
-----------------------------------------------------------------------
@@ -398,7 +398,7 @@ WEBSERVER CONFIGURATION
-----------------------
This section explains how to configure some common webservers to run gitweb. In
all cases, `/path/to/gitweb` in the examples is the directory you ran installed
-gitweb in, and contains `gitweb_config.perl`.
+`gitweb` in, and contains `gitweb_config.perl`.
If you've configured a web server that isn't listed here for gitweb, please send
in the instructions so they can be included in a future release.
@@ -406,7 +406,7 @@ in the instructions so they can be included in a future release.
Apache as CGI
~~~~~~~~~~~~~
Apache must be configured to support CGI scripts in the directory in
-which gitweb is installed. Let's assume that it is `/var/www/cgi-bin`
+which `gitweb` is installed. Let's assume that it is `/var/www/cgi-bin`
directory.
-----------------------------------------------------------------------
@@ -430,7 +430,7 @@ You can use mod_perl with gitweb. You must install Apache::Registry
(for mod_perl 1.x) or ModPerl::Registry (for mod_perl 2.x) to enable
this support.
-Assuming that gitweb is installed to `/var/www/perl`, the following
+Assuming that `gitweb` is installed to `/var/www/perl`, the following
Apache configuration (for mod_perl 2.x) is suitable.
-----------------------------------------------------------------------
@@ -454,7 +454,7 @@ With that configuration the full path to browse repositories would be:
Apache with FastCGI
~~~~~~~~~~~~~~~~~~~
Gitweb works with Apache and FastCGI. First you need to rename, copy
-or symlink gitweb.cgi to gitweb.fcgi. Let's assume that gitweb is
+or symlink gitweb.cgi to gitweb.fcgi. Let's assume that `gitweb` is
installed in `/usr/share/gitweb` directory. The following Apache
configuration is suitable (UNTESTED!)
@@ -478,9 +478,9 @@ ADVANCED WEB SERVER SETUP
All of those examples use request rewriting, and need `mod_rewrite`
(or equivalent; examples below are written for Apache).
-Single URL for gitweb and for fetching
+Single URL for `gitweb` and for fetching
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you want to have one URL for both gitweb and your `http://`
+If you want to have one URL for both `gitweb` and your `http://`
repositories, you can configure Apache like this:
-----------------------------------------------------------------------
@@ -503,11 +503,11 @@ repositories, you can configure Apache like this:
The above configuration expects your public repositories to live under
`/pub/git` and will serve them as `http://git.domain.org/dir-under-pub-git`,
-both as clonable Git URL and as browseable gitweb interface. If you then
+both as clonable Git URL and as browseable `gitweb` interface. If you then
start your linkgit:git-daemon[1] with `--base-path=/pub/git --export-all`
then you can even use the `git://` URL with exactly the same path.
-Setting the environment variable `GITWEB_CONFIG` will tell gitweb to use the
+Setting the environment variable `GITWEB_CONFIG` will tell `gitweb` to use the
named file (i.e. in this example `/etc/gitweb.conf`) as a configuration for
gitweb. You don't really need it in above example; it is required only if
your configuration file is in different place than built-in (during
@@ -516,7 +516,7 @@ linkgit:gitweb.conf[5] for details, especially information about precedence
rules.
If you use the rewrite rules from the example you *might* also need
-something like the following in your gitweb configuration file
+something like the following in your `gitweb` configuration file
(`/etc/gitweb.conf` following example):
----------------------------------------------------------------------------
@stylesheets = ("/some/absolute/path/gitweb.css");
@@ -524,14 +524,14 @@ $my_uri = "/";
$home_link = "/";
$per_request_config = 1;
----------------------------------------------------------------------------
-Nowadays though gitweb should create HTML base tag when needed (to set base
+Nowadays though `gitweb` should create HTML base tag when needed (to set base
URI for relative links), so it should work automatically.
Webserver configuration with multiple projects' root
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-If you want to use gitweb with several project roots you can edit your
-Apache virtual host and gitweb configuration files in the following way.
+If you want to use `gitweb` with several project roots you can edit your
+Apache virtual host and `gitweb` configuration files in the following way.
The virtual host configuration (in Apache configuration file) should look
like this:
@@ -572,9 +572,9 @@ like this:
</VirtualHost>
--------------------------------------------------------------------------
-Here actual project root is passed to gitweb via `GITWEB_PROJECT_ROOT`
+Here actual project root is passed to `gitweb` via `GITWEB_PROJECT_ROOT`
environment variable from a web server, so you need to put the following
-line in gitweb configuration file (`/etc/gitweb.conf` in above example):
+line in `gitweb` configuration file (`/etc/gitweb.conf` in above example):
--------------------------------------------------------------------------
$projectroot = $ENV{'GITWEB_PROJECTROOT'} || "/pub/git";
--------------------------------------------------------------------------
@@ -583,7 +583,7 @@ $projectroot = $ENV{'GITWEB_PROJECTROOT'} || "/pub/git";
referenced by `$per_request_config`;
These configurations enable two things. First, each unix user (`<user>`) of
-the server will be able to browse through gitweb Git repositories found in
+the server will be able to browse through `gitweb` Git repositories found in
`~/public_git/` with the following url:
http://git.example.org/~<user>/
@@ -603,11 +603,11 @@ the third and the fourth.
PATH_INFO usage
~~~~~~~~~~~~~~~
-If you enable PATH_INFO usage in gitweb by putting
+If you enable PATH_INFO usage in `gitweb` by putting
----------------------------------------------------------------------------
$feature{'pathinfo'}{'default'} = [1];
----------------------------------------------------------------------------
-in your gitweb configuration file, it is possible to set up your server so
+in your `gitweb` configuration file, it is possible to set up your server so
that it consumes and produces URLs in the form
http://git.example.com/project.git/shortlog/sometag
@@ -637,12 +637,12 @@ complementary static files (stylesheet, favicon, JavaScript):
</VirtualHost>
----------------------------------------------------------------------------
The rewrite rule guarantees that existing static files will be properly
-served, whereas any other URL will be passed to gitweb as PATH_INFO
+served, whereas any other URL will be passed to `gitweb` as PATH_INFO
parameter.
*Notice* that in this case you don't need special settings for
`@stylesheets`, `$my_uri` and `$home_link`, but you lose "dumb client"
-access to your project .git dirs (described in "Single URL for gitweb and
+access to your project .git dirs (described in "Single URL for `gitweb` and
for fetching" section). A possible workaround for the latter is the
following: in your project root dir (e.g. `/pub/git`) have the projects
named *without* a .git extension (e.g. `/pub/git/project` instead of
@@ -677,7 +677,7 @@ cloned), while
http://git.example.com/project
-will provide human-friendly gitweb access.
+will provide human-friendly `gitweb` access.
This solution is not 100% bulletproof, in the sense that if some project has
a named ref (branch, tag) starting with `git/`, then paths such as
diff --git a/Documentation/gitworkflows.txt b/Documentation/gitworkflows.txt
index 07344bf85a..fca6becf21 100644
--- a/Documentation/gitworkflows.txt
+++ b/Documentation/gitworkflows.txt
@@ -360,7 +360,7 @@ There are three main tools that can be used for this:
* linkgit:git-pull[1] that does fetch and merge in one go.
-Note the last point. Do 'not' use 'git pull' unless you actually want
+Note the last point. Do 'not' use `git pull` unless you actually want
to merge the remote branch.
Getting changes out is easy:
@@ -397,7 +397,7 @@ Please pull from
<url> <branch>
-------------------------------------
-In that case, 'git pull' can do the fetch and merge in one go, as
+In that case, `git pull` can do the fetch and merge in one go, as
follows.
.Push/pull: Merging remote topics
@@ -449,7 +449,7 @@ problem.
If you receive such a patch series (as maintainer, or perhaps as a
reader of the mailing list it was sent to), save the mails to files,
-create a new topic branch and use 'git am' to import the commits:
+create a new topic branch and use `git am` to import the commits:
.format-patch/am: Importing patches
[caption="Recipe: "]
diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index 5d719b4140..8fef8db89d 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -53,7 +53,7 @@
In <<def_SCM,SCM>> jargon, "cherry pick" means to choose a subset of
changes out of a series of changes (typically commits) and record them
as a new series of changes on top of a different codebase. In Git, this is
- performed by the "git cherry-pick" command to extract the change introduced
+ performed by the `git cherry-pick` command to extract the change introduced
by an existing <<def_commit,commit>> and to record it based on the tip
of the current <<def_branch,branch>> as a new commit.
@@ -308,8 +308,8 @@ This commit is referred to as a "merge commit", or sometimes just a
[[def_pathspec]]pathspec::
Pattern used to limit paths in Git commands.
+
-Pathspecs are used on the command line of "git ls-files", "git
-ls-tree", "git add", "git grep", "git diff", "git checkout",
+Pathspecs are used on the command line of `git ls-files`, `git
+ls-tree`, `git add`, `git grep`, `git diff`, `git checkout`,
and many other commands to
limit the scope of operations to some subset of the tree or
worktree. See the documentation of each command for whether
@@ -454,7 +454,7 @@ exclude;;
[[def_pseudoref]]pseudoref::
Pseudorefs are a class of files under `$GIT_DIR` which behave
like refs for the purposes of rev-parse, but which are treated
- specially by git. Pseudorefs both have names that are all-caps,
+ specially by `git`. Pseudorefs both have names that are all-caps,
and always start with a line consisting of a
<<def_SHA1,SHA-1>> followed by whitespace. So, `HEAD` is not a
pseudoref, because it is sometimes a symbolic ref. They might
diff --git a/Documentation/i18n.txt b/Documentation/i18n.txt
index 6c6baeeeb7..a6ef7155b8 100644
--- a/Documentation/i18n.txt
+++ b/Documentation/i18n.txt
@@ -34,7 +34,7 @@ project find it more convenient to use legacy encodings, Git
does not forbid it. However, there are a few things to keep in
mind.
-. 'git commit' and 'git commit-tree' issues
+. `git commit` and `git commit-tree` issues
a warning if the commit log message given to it does not look
like a valid UTF-8 string, unless you explicitly say your
project uses a legacy encoding. The way to say this is to
@@ -50,7 +50,7 @@ of `i18n.commitEncoding` in its `encoding` header. This is to
help other people who look at them later. Lack of this header
implies that the commit log message is encoded in UTF-8.
-. 'git log', 'git show', 'git blame' and friends look at the
+. `git log`, `git show`, `git blame` and friends look at the
`encoding` header of a commit object, and try to re-code the
log message into UTF-8 unless otherwise specified. You can
specify the desired output encoding with
diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
index bf43c33d27..6f6f31874b 100644
--- a/Documentation/merge-options.txt
+++ b/Documentation/merge-options.txt
@@ -112,8 +112,8 @@ With `--squash`, `--commit` is not allowed, and will fail.
Use the given merge strategy; can be supplied more than
once to specify them in the order they should be tried.
If there is no `-s` option, a built-in list of strategies
- is used instead ('git merge-recursive' when merging a single
- head, 'git merge-octopus' otherwise).
+ is used instead (`git merge-recursive` when merging a single
+ head, `git merge-octopus` otherwise).
-X <option>::
--strategy-option=<option>::
diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt
index bbf418e48c..b062400072 100644
--- a/Documentation/pull-fetch-param.txt
+++ b/Documentation/pull-fetch-param.txt
@@ -58,7 +58,7 @@ namespace it's being fetched to, the type of object being fetched, and
whether the update is considered to be a fast-forward. Generally, the
same rules apply for fetching as when pushing, see the `<refspec>...`
section of linkgit:git-push[1] for what those are. Exceptions to those
-rules particular to 'git fetch' are noted below.
+rules particular to `git fetch` are noted below.
+
Until Git version 2.20, and unlike when pushing with
linkgit:git-push[1], any updates to `refs/tags/*` would be accepted
@@ -100,15 +100,15 @@ ifdef::git-pull[]
+
[NOTE]
There is a difference between listing multiple <refspec>
-directly on 'git pull' command line and having multiple
+directly on `git pull` command line and having multiple
`remote.<repository>.fetch` entries in your configuration
for a <repository> and running a
-'git pull' command without any explicit <refspec> parameters.
+`git pull` command without any explicit <refspec> parameters.
<refspec>s listed explicitly on the command line are always
merged into the current branch after fetching. In other words,
-if you list more than one remote ref, 'git pull' will create
+if you list more than one remote ref, `git pull` will create
an Octopus merge. On the other hand, if you do not list any
-explicit <refspec> parameter on the command line, 'git pull'
+explicit <refspec> parameter on the command line, `git pull`
will fetch all the <refspec>s it finds in the
`remote.<repository>.fetch` configuration and merge
only the first <refspec> found into the current branch.
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index 33f30b62eb..f1bb9d0877 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -7,7 +7,7 @@ syntax. Here are various ways to spell object names. The
ones listed near the end of this list name trees and
blobs contained in a commit.
-NOTE: This document shows the "raw" syntax as seen by git. The shell
+NOTE: This document shows the "raw" syntax as seen by `git`. The shell
and other UIs might require additional quoting to protect special
characters and to avoid word splitting.
diff --git a/Documentation/urls-remotes.txt b/Documentation/urls-remotes.txt
index bd184cd653..25f89fa09a 100644
--- a/Documentation/urls-remotes.txt
+++ b/Documentation/urls-remotes.txt
@@ -11,7 +11,7 @@ of a URL as `<repository>` argument:
* a file in the `$GIT_DIR/branches` directory.
All of these also allow you to omit the refspec from the command line
-because they each contain a refspec which git will use by default.
+because they each contain a refspec which `git` will use by default.
Named remote in configuration file
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -52,8 +52,8 @@ following format:
------------
-`Push:` lines are used by 'git push' and
-`Pull:` lines are used by 'git pull' and 'git fetch'.
+`Push:` lines are used by `git push` and
+`Pull:` lines are used by `git pull` and `git fetch`.
Multiple `Push:` and `Pull:` lines may
be specified for additional branch mappings.
@@ -72,18 +72,18 @@ This file should have the following format:
`<url>` is required; `#<head>` is optional.
-Depending on the operation, git will use one of the following
+Depending on the operation, `git` will use one of the following
refspecs, if you don't provide one on the command line.
`<branch>` is the name of this file in `$GIT_DIR/branches` and
`<head>` defaults to `master`.
-git fetch uses:
+`git fetch` uses:
------------
refs/heads/<head>:refs/heads/<branch>
------------
-git push uses:
+`git push` uses:
------------
HEAD:refs/heads/<head>
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index c50ddd3120..68ab4fbcc3 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -53,7 +53,7 @@ These two syntaxes are mostly equivalent, except the former implies
`--local` option.
endif::git-clone[]
-'git clone', 'git fetch' and 'git pull', but not 'git push', will also
+`git clone`, `git fetch` and `git pull`, but not `git push`, will also
accept a suitable bundle file. See linkgit:git-bundle[1].
When Git doesn't know how to handle a certain transport protocol, it
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 82b20b80df..4459d74ec2 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -6,7 +6,7 @@ This manual is designed to be readable by someone with basic UNIX
command-line skills, but no previous knowledge of Git.
<<repositories-and-branches>> and <<exploring-git-history>> explain how
-to fetch and study a project using git--read these chapters to learn how
+to fetch and study a project using `git`--read these chapters to learn how
to build and test a particular version of a software project, search for
regressions, and so on.
@@ -212,7 +212,7 @@ each parent representing the most recent commit on one of the lines
of development leading to that point.
The best way to see how this works is using the linkgit:gitk[1]
-command; running gitk now on a Git repository and looking for merge
+command; running `gitk` now on a Git repository and looking for merge
commits will help understand how Git organizes history.
In the following, we say that commit X is "reachable" from commit Y
@@ -313,7 +313,7 @@ do so (now or later) by using `-c` with the switch command again. Example:
------------------------------------------------
The `HEAD` then refers to the SHA-1 of the commit instead of to a branch,
-and git branch shows that you are no longer on a branch:
+and `git branch` shows that you are no longer on a branch:
------------------------------------------------
$ cat .git/HEAD
@@ -401,7 +401,7 @@ references with the same shorthand name, see the "SPECIFYING
REVISIONS" section of linkgit:gitrevisions[7].
[[Updating-a-repository-With-git-fetch]]
-=== Updating a repository with git fetch
+=== Updating a repository with `git fetch`
After you clone a repository and commit a few changes of your own, you
may wish to check the original repository for updates.
@@ -663,7 +663,7 @@ commits since v2.5 which touch the `Makefile` or any file under `fs`:
$ git log v2.5.. Makefile fs/
-------------------------------------------------
-You can also ask git log to show patches:
+You can also ask `git log` to show patches:
-------------------------------------------------
$ git log -p
@@ -672,7 +672,7 @@ $ git log -p
See the `--pretty` option in the linkgit:git-log[1] man page for more
display options.
-Note that git log starts with the most recent commit and works
+Note that `git log` starts with the most recent commit and works
backwards through the parents; however, since Git history can contain
multiple independent lines of development, the particular order that
commits are listed in may be somewhat arbitrary.
@@ -1214,7 +1214,7 @@ you resolve the conflicts manually, you can update the index
with the contents and run Git commit, as you normally would when
creating a new file.
-If you examine the resulting commit using gitk, you will see that it
+If you examine the resulting commit using `gitk`, you will see that it
has two parents, one pointing to the top of the current branch, and
one to the top of the other branch.
@@ -1668,7 +1668,7 @@ dangling objects can arise in other situations.
== Sharing development with others
[[getting-updates-With-git-pull]]
-=== Getting updates with git pull
+=== Getting updates with `git pull`
After you clone a repository and commit a few changes of your own, you
may wish to check the original repository for updates and merge them
@@ -1857,7 +1857,7 @@ $ git clone --bare ~/proj proj.git
$ touch proj.git/git-daemon-export-ok
-------------------------------------------------
-The resulting directory proj.git contains a "bare" git repository--it is
+The resulting directory proj.git contains a "bare" `git` repository--it is
just the contents of the `.git` directory, without any files checked out
around it.
@@ -1879,7 +1879,7 @@ repository>>", below.
Otherwise, all you need to do is start linkgit:git-daemon[1]; it will
listen on port 9418. By default, it will allow access to any directory
that looks like a Git directory and contains the magic file
-git-daemon-export-ok. Passing some directory paths as `git daemon`
+`git-daemon-export-ok`. Passing some directory paths as `git daemon`
arguments will further restrict the exports to those paths.
You can also run `git daemon` as an inetd service; see the
@@ -1887,7 +1887,7 @@ linkgit:git-daemon[1] man page for details. (See especially the
examples section.)
[[exporting-via-http]]
-==== Exporting a git repository via HTTP
+==== Exporting a `git` repository via HTTP
The Git protocol gives better performance and reliability, but on a
host with a web server set up, HTTP exports may be simpler to set up.
@@ -2064,13 +2064,13 @@ advantages over the central shared repository:
[[setting-up-gitweb]]
==== Allowing web browsing of a repository
-The gitweb cgi script provides users an easy way to browse your
+The `gitweb` cgi script provides users an easy way to browse your
project's revisions, file contents and logs without having to install
Git. Features like RSS/Atom feeds and blame/annotation details may
optionally be enabled.
The linkgit:git-instaweb[1] command provides a simple way to start
-browsing the repository using gitweb. The default server when using
+browsing the repository using `gitweb`. The default server when using
instaweb is lighttpd.
See the file gitweb/INSTALL in the Git source tree and
@@ -2438,7 +2438,7 @@ use them, and then explain some of the problems that can arise because
you are rewriting history.
[[using-git-rebase]]
-=== Keeping a patch series up to date using git rebase
+=== Keeping a patch series up to date using `git rebase`
Suppose that you create a branch `mywork` on a remote-tracking branch
`origin`, and create some commits on top of it:
@@ -3132,7 +3132,7 @@ to a "pack file", which stores a group of objects in an efficient
compressed format; the details of how pack files are formatted can be
found in link:technical/pack-format.html[pack format].
-To put the loose objects into a pack, just run git repack:
+To put the loose objects into a pack, just run `git repack`:
------------------------------------------------
$ git repack
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 05/13] doc: typeset git-svn subcommands in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
` (3 preceding siblings ...)
2021-04-09 4:02 ` [RFC PATCH v1 04/13] doc: typeset git-related commands " Firmin Martin
@ 2021-04-09 4:02 ` Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 06/13] doc: typeset dummy URLs and protocols " Firmin Martin
` (8 subsequent siblings)
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Wrap git-svn subcommands with backticks as indicated in the
CodingGuidelines.
The following regex assisted the interactive substitution in emacs (evil mode).
%s/\(^\|[[:space:]]+\)['"]?\(init\|fetch\|clone\|rebase\|dcommit\|branch\|tag\|log\|blame\|find-rev\|set-tree\|create-ignore\|show-ignore\|mkdirs\|commit-diff\|info\|proplist\|propget\|propset\|show-externals\|gc\|reset\)['"]?\([[:punct:]]\|[[:space:]]+\|$\)/\1`\2`\3/gc
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/git-svn.txt | 176 +++++++++++++++++++-------------------
1 file changed, 88 insertions(+), 88 deletions(-)
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 3097f4f1c5..f42cf6b189 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -19,16 +19,16 @@ repository.
`git svn` can track a standard Subversion repository,
following the common "trunk/branches/tags" layout, with the `--stdlayout` option.
It can also follow branches and tags in any layout with the `-T`/`-t`/`-b` options
-(see options to 'init' below, and also the 'clone' command).
+(see options to `init` below, and also the `clone` command).
Once tracking a Subversion repository (with any of the above methods), the Git
-repository can be updated from Subversion by the 'fetch' command and
-Subversion updated from Git by the 'dcommit' command.
+repository can be updated from Subversion by the `fetch` command and
+Subversion updated from Git by the `dcommit` command.
COMMANDS
--------
-'init'::
+`init`::
Initializes an empty Git repository with additional
metadata directories for `git svn`. The Subversion URL
may be specified as a command-line argument, or as full
@@ -45,7 +45,7 @@ COMMANDS
--branches=<branches_subdir>;;
-s;;
--stdlayout;;
- These are optional command-line options for init. Each of
+ These are optional command-line options for `init`. Each of
these flags can point to a relative repository path
(`--tags=project/tags`) or a full url
(`--tags=https://foo.org/project/tags`).
@@ -96,16 +96,16 @@ If you still want the old default, you can get it by passing
your Perl's Getopt::Long is < v2.37).
--ignore-refs=<regex>;;
- When passed to 'init' or 'clone' this regular expression will
- be preserved as a config key. See 'fetch' for a description
+ When passed to `init` or `clone` this regular expression will
+ be preserved as a config key. See `fetch` for a description
of `--ignore-refs`.
--ignore-paths=<regex>;;
- When passed to 'init' or 'clone' this regular expression will
- be preserved as a config key. See 'fetch' for a description
+ When passed to `init` or `clone` this regular expression will
+ be preserved as a config key. See `fetch` for a description
of `--ignore-paths`.
--include-paths=<regex>;;
- When passed to 'init' or 'clone' this regular expression will
- be preserved as a config key. See 'fetch' for a description
+ When passed to `init` or `clone` this regular expression will
+ be preserved as a config key. See `fetch` for a description
of `--include-paths`.
--no-minimize-url;;
When tracking multiple directories (using `--stdlayout`,
@@ -119,7 +119,7 @@ your Perl's Getopt::Long is < v2.37).
level directory. This option is off by default when only
one URL/branch is tracked (it would do little good).
-'fetch'::
+`fetch`::
Fetch unfetched revisions from the Subversion remote we are
tracking. The name of the [svn-remote "..."] section in the
$GIT_DIR/config file may be specified as an optional
@@ -157,9 +157,9 @@ option is also given, both regular expressions will be used.
--ignore-paths=<regex>;;
This allows one to specify a Perl regular expression that will
cause skipping of all matching paths from checkout from SVN.
- The `--ignore-paths` option should match for every 'fetch'
- (including automatic fetches due to 'clone', 'dcommit',
- 'rebase', etc) on a given repository.
+ The `--ignore-paths` option should match for every `fetch`
+ (including automatic fetches due to `clone`, `dcommit`,
+ `rebase`, etc) on a given repository.
+
[verse]
config key: `svn-remote.<name>.ignore-paths`
@@ -186,9 +186,9 @@ Skip "branches" and "tags" of first level directories;;
--include-paths=<regex>;;
This allows one to specify a Perl regular expression that will
cause the inclusion of only matching paths from checkout from SVN.
- The `--include-paths` option should match for every 'fetch'
- (including automatic fetches due to 'clone', 'dcommit',
- 'rebase', etc) on a given repository. `--ignore-paths` takes
+ The `--include-paths` option should match for every `fetch`
+ (including automatic fetches due to `clone`, `dcommit`,
+ `rebase`, etc) on a given repository. `--ignore-paths` takes
precedence over `--include-paths`.
+
[verse]
@@ -197,19 +197,19 @@ config key: `svn-remote.<name>.include-paths`
--log-window-size=<n>;;
Fetch <n> log entries per request when scanning Subversion history.
The default is 100. For very large Subversion repositories, larger
- values may be needed for 'clone'/'fetch' to complete in reasonable
+ values may be needed for `clone`/'fetch' to complete in reasonable
time. But overly large values may lead to higher memory usage and
request timeouts.
-'clone'::
- Runs 'init' and 'fetch'. It will automatically create a
+`clone`::
+ Runs `init` and `fetch`. It will automatically create a
directory based on the basename of the URL passed to it;
or if a second argument is passed; it will create a directory
and work within that. It accepts all arguments that the
- 'init' and 'fetch' commands accept; with the exception of
+ `init` and `fetch` commands accept; with the exception of
`--fetch-all` and `--parent`. After a repository is cloned,
- the 'fetch' command will be able to update revisions without
- affecting the working tree; and the 'rebase' command will be
+ the `fetch` command will be able to update revisions without
+ affecting the working tree; and the `rebase` command will be
able to update the working tree with the latest changes.
--preserve-empty-dirs;;
@@ -223,7 +223,7 @@ config key: `svn-remote.<name>.include-paths`
Set the name of placeholder files created by `--preserve-empty-dirs`.
Default: ".gitignore"
-'rebase'::
+`rebase`::
This fetches revisions from the SVN parent of the current `HEAD`
and rebases the current (uncommitted to SVN) work against it.
+
@@ -243,10 +243,10 @@ This automatically updates the rev_map if needed (see
-l;;
--local;;
- Do not fetch remotely; only run `git rebase` against the
+ Do not `fetch` remotely; only run `git rebase` against the
last fetched commit from the upstream SVN.
-'dcommit'::
+`dcommit`::
Commit each diff from the current branch directly to the SVN
repository, and then rebase or reset (depending on whether or
not there is a diff between SVN and head). This will create
@@ -256,7 +256,7 @@ When an optional Git branch name (or a Git commit object name)
is specified as an argument, the subcommand works on the specified
branch, not on the current branch.
+
-Use of 'dcommit' is preferred to 'set-tree' (below).
+Use of `dcommit` is preferred to `set-tree` (below).
+
--no-rebase;;
After committing, do not rebase or reset.
@@ -279,7 +279,7 @@ Using this option for any other purpose (don't ask) is very strongly
discouraged.
--mergeinfo=<mergeinfo>;;
- Add the given merge information during the dcommit
+ Add the given merge information during the `dcommit`
(e.g. `--mergeinfo="/branches/foo:1-10"`). All svn server versions can
store this information (as a property), and svn clients starting from
version 1.5 can make use of it. To specify merge information from multiple
@@ -302,7 +302,7 @@ first have already been pushed into SVN.
`git svn dcommit` returns immediately if answer is "no" or "quit", without
committing anything to SVN.
-'branch'::
+`branch`::
Create a branch in the SVN repository.
-m;;
@@ -317,8 +317,8 @@ committing anything to SVN.
-d<path>;;
--destination=<path>;;
- If more than one `--branches` (or `--tags`) option was given to the 'init'
- or 'clone' command, you must provide the location of the branch (or
+ If more than one `--branches` (or `--tags`) option was given to the `init`
+ or `clone` command, you must provide the location of the branch (or
tag) you wish to create in the SVN repository. <path> specifies which
path to use to create the branch or tag and should match the pattern
on the left-hand side of one of the configured branches or tags
@@ -328,7 +328,7 @@ committing anything to SVN.
git config --get-all svn-remote.<name>.tags
+
where <name> is the name of the SVN repository as specified by the `-R` option to
-'init' (or "svn" by default).
+`init` (or "svn" by default).
--username;;
Specify the SVN username to perform the commit as. This option overrides
@@ -348,11 +348,11 @@ where <name> is the name of the SVN repository as specified by the `-R` option t
`--parents` on svn cp commands and is useful for non-standard repository
layouts.
-'tag'::
+`tag`::
Create a tag in the SVN repository. This is a shorthand for
'branch -t'.
-'log'::
+`log`::
This should make it easy to look up svn log messages when svn
users refer to `-r`/`--revision` numbers.
+
@@ -389,7 +389,7 @@ environment). This command has the same behaviour.
+
Any other arguments are passed directly to `git log`
-'blame'::
+`blame`::
Show what revision and author last modified each line of a file. The
output of this mode is format-compatible with the output of
`svn blame' by default. Like the SVN blame command,
@@ -421,8 +421,8 @@ Any other arguments are passed directly to `git log`
not an exact match return the closest match searching forward in the
history.
-'set-tree'::
- You should consider using 'dcommit' instead of this command.
+`set-tree`::
+ You should consider using `dcommit` instead of this command.
Commit specified commit or tree objects to SVN. This relies on
your imported fetch data being up to date. This makes
absolutely no attempts to do patching when committing to SVN, it
@@ -430,27 +430,27 @@ Any other arguments are passed directly to `git log`
commit. All merging is assumed to have taken place
independently of `git svn` functions.
-'create-ignore'::
+`create-ignore`::
Recursively finds the svn:ignore property on directories and
creates matching .gitignore files. The resulting files are staged to
be committed, but are not committed. Use `-r`/`--revision` to refer to a
specific revision.
-'show-ignore'::
+`show-ignore`::
Recursively finds and lists the svn:ignore property on
directories. The output is suitable for appending to
the $GIT_DIR/info/exclude file.
-'mkdirs'::
+`mkdirs`::
Attempts to recreate empty directories that core Git cannot track
based on information in $GIT_DIR/svn/<refname>/unhandled.log files.
Empty directories are automatically recreated when using
- `git svn clone` and `git svn rebase`, so "mkdirs" is intended
+ `git svn clone` and `git svn rebase`, so `mkdirs` is intended
for use after commands like `git checkout` or `git reset`.
(See the `svn-remote.<name>.automkdirs` config file option for
more information.)
-'commit-diff'::
+`commit-diff`::
Commits the diff of two tree-ish arguments from the
command-line. This command does not rely on being inside a `git svn
init`-ed repository. This command takes three arguments, (a) the
@@ -475,22 +475,22 @@ denotes such an object, or it is requested by invoking an editor (see
Take the commit message from the given file. This option
disables the `--edit` option.
-'info'::
+`info`::
Shows information about a file or directory similar to what
`svn info' provides. Does not currently support a `-r`/`--revision`
argument. Use the `--url` option to output only the value of the
'URL:' field.
-'proplist'::
+`proplist`::
Lists the properties stored in the Subversion repository about a
given file or directory. Use `-r`/`--revision` to refer to a specific
Subversion revision.
-'propget'::
+`propget`::
Gets the Subversion property given as the first argument, for a
file. A specific revision can be specified with `-r`/`--revision`.
-'propset'::
+`propset`::
Sets the Subversion property given as the first argument, to the
value given as the second argument for the file given as the
third argument.
@@ -504,28 +504,28 @@ git svn propset svn:keywords "FreeBSD=%H" devel/py-tipper/Makefile
This will set the property 'svn:keywords' to 'FreeBSD=%H' for the file
'devel/py-tipper/Makefile'.
-'show-externals'::
+`show-externals`::
Shows the Subversion externals. Use `-r`/`--revision` to specify a
specific revision.
-'gc'::
+`gc`::
Compress $GIT_DIR/svn/<refname>/unhandled.log files and remove
$GIT_DIR/svn/<refname>/index files.
-'reset'::
- Undoes the effects of 'fetch' back to the specified revision.
+`reset`::
+ Undoes the effects of `fetch` back to the specified revision.
This allows you to re-'fetch' an SVN revision. Normally the
- contents of an SVN revision should never change and 'reset'
+ contents of an SVN revision should never change and `reset`
should not be necessary. However, if SVN permissions change,
- or if you alter your `--ignore-paths` option, a 'fetch' may fail
+ or if you alter your `--ignore-paths` option, a `fetch` may fail
with "not found in commit" (file not previously visible) or
"checksum mismatch" (missed a modification). If the problem
file cannot be ignored forever (with `--ignore-paths`) the only
- way to repair the repo is to use 'reset'.
+ way to repair the repo is to use `reset`.
+
Only the rev_map and refs/remotes/git-svn are changed (see
'$GIT_DIR/svn/\**/.rev_map.*' in the FILES section below for details).
-Follow 'reset' with a 'fetch' and then `git reset` or `git rebase` to
+Follow 'reset' with a `fetch` and then `git reset` or `git rebase` to
move local branches onto the new tree.
-r <n>;;
@@ -560,7 +560,7 @@ git svn fetch
+
Then fixup `master` with `git rebase`.
Do NOT use `git merge` or your history will not be compatible with a
-future 'dcommit'!
+future `dcommit`!
+
[verse]
git rebase --onto remotes/git-svn A^ master
@@ -576,31 +576,31 @@ OPTIONS
--shared[=(false|true|umask|group|all|world|everybody)]::
--template=<template_directory>::
- Only used with the 'init' command.
+ Only used with the `init` command.
These are passed directly to `git init`.
-r <arg>::
--revision <arg>::
- Used with the 'fetch' command.
+ Used with the `fetch` command.
+
This allows revision ranges for partial/cauterized history
to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges),
$NUMBER:HEAD, and BASE:$NUMBER are all supported.
+
-This can allow you to make partial mirrors when running fetch;
+This can allow you to make partial mirrors when running `fetch`;
but is generally not recommended because history will be skipped
and lost.
-::
--stdin::
- Only used with the 'set-tree' command.
+ Only used with the `set-tree` command.
+
Read a list of commits from stdin and commit them in reverse
order. Only the leading sha1 is read from each line, so
`git rev-list --pretty=oneline` output can be used.
--rmdir::
- Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
+ Only used with the `dcommit`, `set-tree` and `commit-diff` commands.
+
Remove directories from the SVN tree if there are no files left
behind. SVN can version empty directories, and they are not
@@ -613,7 +613,7 @@ config key: `svn.rmdir`
-e::
--edit::
- Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
+ Only used with the `dcommit`, `set-tree` and `commit-diff` commands.
+
Edit the commit message before committing to SVN. This is off by
default for objects that are commits, and forced on when committing
@@ -624,7 +624,7 @@ config key: `svn.edit`
-l<num>::
--find-copies-harder::
- Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
+ Only used with the `dcommit`, `set-tree` and `commit-diff` commands.
+
They are both passed directly to `git diff-tree`; see
linkgit:git-diff-tree[1] for more information.
@@ -660,8 +660,8 @@ config key: `svn.authorsfile`
file.
+
Due to historical reasons a relative 'filename' is first searched
-relative to the current directory for 'init' and 'clone' and relative
-to the root of the working tree for 'fetch'. If 'filename' is
+relative to the current directory for `init` and `clone` and relative
+to the root of the working tree for `fetch`. If 'filename' is
not found, it is searched like any other command in '$PATH'.
+
[verse]
@@ -679,36 +679,36 @@ config key: `svn.authorsProg`
-p::
--rebase-merges::
--preserve-merges (DEPRECATED)::
- These are only used with the 'dcommit' and 'rebase' commands.
+ These are only used with the `dcommit` and `rebase` commands.
+
-Passed directly to `git rebase` when using 'dcommit' if a
-`git reset` cannot be used (see 'dcommit').
+Passed directly to `git rebase` when using `dcommit` if a
+`git reset` cannot be used (see `dcommit`).
-n::
--dry-run::
- This can be used with the 'dcommit', 'rebase', 'branch' and
- 'tag' commands.
+ This can be used with the `dcommit`, `rebase`, `branch` and
+ `tag` commands.
+
-For 'dcommit', print out the series of Git arguments that would show
+For `dcommit`, print out the series of Git arguments that would show
which diffs would be committed to SVN.
+
-For 'rebase', display the local branch associated with the upstream svn
+For `rebase`, display the local branch associated with the upstream svn
repository associated with the current branch and the URL of svn
repository that will be fetched from.
+
-For 'branch' and 'tag', display the urls that will be used for copying when
+For `branch` and `tag`, display the urls that will be used for copying when
creating the branch or tag.
--use-log-author::
- When retrieving svn commits into Git (as part of 'fetch', 'rebase', or
- 'dcommit' operations), look for the first `From:` line or `Signed-off-by` trailer
+ When retrieving svn commits into Git (as part of `fetch`, `rebase`, or
+ `dcommit` operations), look for the first `From:` line or `Signed-off-by` trailer
in the log message and use that as the author string.
+
[verse]
config key: `svn.useLogAuthor`
--add-author-from::
- When committing to svn from Git (as part of 'set-tree' or 'dcommit'
+ When committing to svn from Git (as part of `set-tree` or `dcommit`
operations), if the existing log message doesn't already have a
`From:` or `Signed-off-by` trailer, append a `From:` line based on the
Git commit's author string. If you use this, then `--use-log-author`
@@ -724,7 +724,7 @@ ADVANCED OPTIONS
--id <GIT_SVN_ID>::
This sets GIT_SVN_ID (instead of using the environment). This
allows the user to override the default refname to fetch from
- when tracking a single URL. The 'log' and 'dcommit' commands
+ when tracking a single URL. The `log` and `dcommit` commands
no longer require this switch as an argument.
-R<remote name>::
@@ -999,16 +999,16 @@ CAVEATS
-------
For the sake of simplicity and interoperating with Subversion,
-it is recommended that all `git svn` users clone, fetch and dcommit
+it is recommended that all `git svn` users `clone`, `fetch` and `dcommit`
directly from the SVN server, and avoid all `git clone`/`pull`/`merge`/`push`
operations between Git repositories and branches. The recommended
method of exchanging code between Git branches and users is
-`git format-patch` and `git am`, or just 'dcommit'ing to the SVN repository.
+`git format-patch` and `git am`, or just `dcommit`ing to the SVN repository.
Running `git merge` or `git pull` is NOT recommended on a branch you
-plan to 'dcommit' from because Subversion users cannot see any
+plan to `dcommit` from because Subversion users cannot see any
merges you've made. Furthermore, if you merge or pull from a Git branch
-that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
+that is a mirror of an SVN branch, `dcommit` may commit to the wrong
branch.
If you do merge, note the following rule: `git svn dcommit` will
@@ -1017,7 +1017,7 @@ attempt to commit on top of the SVN commit named in
git log --grep=^git-svn-id: --first-parent -1
------------------------------------------------------------------------
You 'must' therefore ensure that the most recent commit of the branch
-you want to dcommit to is the 'first' parent of the merge. Chaos will
+you want to `dcommit` to is the 'first' parent of the merge. Chaos will
ensue otherwise, especially if the first parent is an older commit on
the same SVN branch.
@@ -1026,15 +1026,15 @@ any `git svn` metadata, or config. So repositories created and managed with
using `git svn` should use 'rsync' for cloning, if cloning is to be done
at all.
-Since 'dcommit' uses rebase internally, any Git branches you `git push` to
-before 'dcommit' on will require forcing an overwrite of the existing ref
+Since `dcommit` uses rebase internally, any Git branches you `git push` to
+before `dcommit` on will require forcing an overwrite of the existing ref
on the remote repository. This is generally considered bad practice,
see the linkgit:git-push[1] documentation for details.
Do not use the `--amend` option of linkgit:git-commit[1] on a change you've
already dcommitted. It is considered bad practice to `--amend` commits
you've already pushed to a remote repository for other users, and
-dcommit with SVN is analogous to that.
+`dcommit` with SVN is analogous to that.
When cloning an SVN repository, if none of the options for describing
the repository layout is used (`--trunk`, `--tags`, `--branches`,
@@ -1054,7 +1054,7 @@ branches and tags is required, the options `--trunk` / `--branches` /
When using multiple `--branches` or `--tags`, `git svn` does not automatically
handle name collisions (for example, if two branches from different paths have
the same name, or if a branch and a tag have the same name). In these cases,
-use 'init' to set up your Git repository then, before your first 'fetch', edit
+use `init` to set up your Git repository then, before your first `fetch`, edit
the $GIT_DIR/config file so that the branches and tags are associated
with different name spaces. For example:
@@ -1085,7 +1085,7 @@ CONFIGURATION
`git svn` stores [svn-remote] configuration information in the
repository $GIT_DIR/config file. It is similar the core Git
-[remote] sections except 'fetch' keys do not accept glob
+[remote] sections except `fetch` keys do not accept glob
arguments; but they are instead handled by the 'branches'
and 'tags' keys. Since some SVN repositories are oddly
configured with multiple projects glob expansions such those
@@ -1105,7 +1105,7 @@ Keep in mind that the `*` (asterisk) wildcard of the local ref
(right of the `:`) *must* be the farthest right path component;
however the remote wildcard may be anywhere as long as it's an
independent path component (surrounded by `/` or EOL). This
-type of configuration is not automatically created by 'init' and
+type of configuration is not automatically created by `init` and
should be manually entered with a text-editor or using `git config`.
Also note that only one asterisk is allowed per word. For example:
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 06/13] doc: typeset dummy URLs and protocols in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
` (4 preceding siblings ...)
2021-04-09 4:02 ` [RFC PATCH v1 05/13] doc: typeset git-svn subcommands " Firmin Martin
@ 2021-04-09 4:02 ` Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 07/13] doc: typeset git dotfiles " Firmin Martin
` (7 subsequent siblings)
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Wrap dummy URLs and protocols names with backticks as indicated in the
CodingGuidelines. Note that some asciidoc predefined attributes are
replaced by their corresponding characters as they are made literal:
{tilde} => ~
{startsb} => [
{endsb} => ]
Remove backticks of two URLs as they prevent them to be clickable.
Reflect this in the CodingGuidelines: only dummy URLs should be wrapped
with backticks.
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/CodingGuidelines | 2 +-
Documentation/git-archimport.txt | 2 +-
Documentation/git-cvsimport.txt | 2 +-
Documentation/git-daemon.txt | 6 +++---
Documentation/git-http-backend.txt | 2 +-
Documentation/git-remote-ext.txt | 10 ++++-----
Documentation/git-remote-fd.txt | 2 +-
Documentation/git-svn.txt | 4 ++--
Documentation/gitfaq.txt | 4 ++--
Documentation/gitweb.txt | 10 ++++-----
Documentation/urls.txt | 34 +++++++++++++++---------------
11 files changed, 39 insertions(+), 39 deletions(-)
diff --git a/Documentation/CodingGuidelines b/Documentation/CodingGuidelines
index 45465bc0c9..554fba1a47 100644
--- a/Documentation/CodingGuidelines
+++ b/Documentation/CodingGuidelines
@@ -607,7 +607,7 @@ Writing Documentation:
or commands:
Literal examples (e.g. use of command-line options, command names,
- branch names, URLs, pathnames (files and directories), configuration and
+ branch names, dummy URLs, pathnames (files and directories), configuration and
environment variables) must be typeset in monospace (i.e. wrapped with
backticks):
`--pretty=oneline`
diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt
index b5c9e500ca..72237659d9 100644
--- a/Documentation/git-archimport.txt
+++ b/Documentation/git-archimport.txt
@@ -97,7 +97,7 @@ OPTIONS
pruned.
-a::
- Attempt to auto-register archives at `http://mirrors.sourcecontrol.net`
+ Attempt to auto-register archives at http://mirrors.sourcecontrol.net
This is particularly useful with the `-D` option.
-t <tmpdir>::
diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt
index 586184bbd4..ead844944e 100644
--- a/Documentation/git-cvsimport.txt
+++ b/Documentation/git-cvsimport.txt
@@ -221,7 +221,7 @@ Problems related to tags:
If you suspect that any of these issues may apply to the repository you
want to import, consider using cvs2git:
-* cvs2git (part of cvs2svn), `http://subversion.apache.org/`
+* cvs2git (part of cvs2svn), http://subversion.apache.org/
GIT
---
diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index e9cce4e468..1298ceb723 100644
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -55,8 +55,8 @@ OPTIONS
--base-path=<path>::
Remap all the path requests as relative to the given path.
This is sort of "Git root" - if you run `git daemon` with
- `--base-path=/srv/git` on example.com, then if you later try to pull
- 'git://example.com/hello.git', `git daemon` will interpret the path
+ `--base-path=/srv/git` on `example.com`, then if you later try to pull
+ `git://example.com/hello.git`, `git daemon` will interpret the path
as `/srv/git/hello.git`.
--base-path-relaxed::
@@ -139,7 +139,7 @@ otherwise `stderr`.
--user-path=<path>::
Allow {tilde}user notation to be used in requests. When
specified with no parameter, requests to
- git://host/{tilde}alice/foo is taken as a request to access
+ `git://host/~alice/foo` is taken as a request to access
'foo' repository in the home directory of user `alice`.
If `--user-path=path` is specified, the same request is
taken as a request to access `path/foo` repository in
diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt
index c97c10ba09..e63816e430 100644
--- a/Documentation/git-http-backend.txt
+++ b/Documentation/git-http-backend.txt
@@ -13,7 +13,7 @@ SYNOPSIS
DESCRIPTION
-----------
A simple CGI program to serve the contents of a Git repository to Git
-clients accessing the repository over http:// and https:// protocols.
+clients accessing the repository over `http://` and `https://` protocols.
The program supports clients fetching using both the smart HTTP protocol
and the backwards-compatible dumb HTTP protocol, as well as clients
pushing using the smart HTTP protocol.
diff --git a/Documentation/git-remote-ext.txt b/Documentation/git-remote-ext.txt
index fd9b621fa2..49057434cd 100644
--- a/Documentation/git-remote-ext.txt
+++ b/Documentation/git-remote-ext.txt
@@ -16,7 +16,7 @@ This remote helper uses the specified '<command>' to connect
to a remote Git server.
Data written to stdin of the specified '<command>' is assumed
-to be sent to a git:// server, `git-upload-pack`, `git-receive-pack`
+to be sent to a `git://` server, `git-upload-pack`, `git-receive-pack`
or `git-upload-archive` (depending on situation), and data read
from stdout of <command> is assumed to be received from
the same service.
@@ -42,17 +42,17 @@ The following sequences have a special meaning:
'%G' (must be the first characters in an argument)::
This argument will not be passed to '<command>'. Instead, it
- will cause the helper to start by sending git:// service requests to
+ will cause the helper to start by sending `git://` service requests to
the remote side with the service field set to an appropriate value and
the repository field set to rest of the argument. Default is not to send
such a request.
+
-This is useful if remote side is git:// server accessed over
+This is useful if remote side is `git://` server accessed over
some tunnel.
'%V' (must be first characters in argument)::
This argument will not be passed to '<command>'. Instead it sets
- the vhost field in the git:// service request (to rest of the argument).
+ the vhost field in the `git://` service request (to rest of the argument).
Default is not to send vhost in such request (if sent).
ENVIRONMENT VARIABLES
@@ -93,7 +93,7 @@ begins with `ext::`. Examples:
Represents a repository with path /repo accessed using the
helper program `git-server-alias foo`. The path to the
repository and type of request are not passed on the command
- line but as part of the protocol stream, as usual with git://
+ line but as part of the protocol stream, as usual with `git://`
protocol.
"ext::git-server-alias foo %G/repo %Vfoo"::
diff --git a/Documentation/git-remote-fd.txt b/Documentation/git-remote-fd.txt
index 14868c4678..239844f827 100644
--- a/Documentation/git-remote-fd.txt
+++ b/Documentation/git-remote-fd.txt
@@ -22,7 +22,7 @@ to be pipes connected to a remote Git server (<infd> being the inbound pipe
and <outfd> being the outbound pipe.
It is assumed that any handshaking procedures have already been completed
-(such as sending service request for git://) before this helper is started.
+(such as sending service request for `git://`) before this helper is started.
<anything> can be any string. It is ignored. It is meant for providing
information to user in the URL in case that URL is displayed in some
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index f42cf6b189..93868c9226 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -798,8 +798,8 @@ svn-remote.<name>.useSvnsyncprops::
svn-remote.<name>.rewriteRoot::
This allows users to create repositories from alternate
URLs. For example, an administrator could run `git svn` on the
- server locally (accessing via file://) but wish to distribute
- the repository with a public http:// or svn:// URL in the
+ server locally (accessing via `file://`) but wish to distribute
+ the repository with a public `http://` or `svn://` URL in the
metadata so users of it will see the public URL.
svn-remote.<name>.rewriteUUID::
diff --git a/Documentation/gitfaq.txt b/Documentation/gitfaq.txt
index 92e8106af4..01d6a27cf6 100644
--- a/Documentation/gitfaq.txt
+++ b/Documentation/gitfaq.txt
@@ -140,8 +140,8 @@ How do I use multiple accounts with the same hosting provider using HTTP?::
Usually the easiest way to distinguish between these accounts is to use
the username in the URL. For example, if you have the accounts `author`
and `committer` on `git.example.org`, you can use the URLs
- https://author@git.example.org/org1/project1.git and
- https://committer@git.example.org/org2/project2.git. This way, when you
+ `https://author@git.example.org/org1/project1.git` and
+ `https://committer@git.example.org/org2/project2.git`. This way, when you
use a credential helper, it will automatically try to look up the
correct credentials for your account. If you already have a remote set
up, you can change the URL with something like `git remote set-url
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index 1feb9c2b08..689afb38c0 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -586,7 +586,7 @@ These configurations enable two things. First, each unix user (`<user>`) of
the server will be able to browse through `gitweb` Git repositories found in
`~/public_git/` with the following url:
- http://git.example.org/~<user>/
+ `http://git.example.org/~<user>/`
If you do not want this feature on your server just remove the second
rewrite rule.
@@ -610,7 +610,7 @@ $feature{'pathinfo'}{'default'} = [1];
in your `gitweb` configuration file, it is possible to set up your server so
that it consumes and produces URLs in the form
- http://git.example.com/project.git/shortlog/sometag
+ `http://git.example.com/project.git/shortlog/sometag`
i.e. without 'gitweb.cgi' part, by using a configuration such as the
following. This configuration assumes that `/var/www/gitweb` is the
@@ -670,19 +670,19 @@ named *without* a .git extension (e.g. `/pub/git/project` instead of
The additional AliasMatch makes it so that
- http://git.example.com/project.git
+ `http://git.example.com/project.git`
will give raw access to the project's Git dir (so that the project can be
cloned), while
- http://git.example.com/project
+ `http://git.example.com/project`
will provide human-friendly `gitweb` access.
This solution is not 100% bulletproof, in the sense that if some project has
a named ref (branch, tag) starting with `git/`, then paths such as
- http://git.example.com/project/command/abranch..git/abranch
+ `http://git.example.com/project/command/abranch..git/abranch`
will fail with a 404 error.
diff --git a/Documentation/urls.txt b/Documentation/urls.txt
index 68ab4fbcc3..b0aa97823b 100644
--- a/Documentation/urls.txt
+++ b/Documentation/urls.txt
@@ -6,23 +6,23 @@ address of the remote server, and the path to the repository.
Depending on the transport protocol, some of this information may be
absent.
-Git supports ssh, git, http, and https protocols (in addition, ftp,
-and ftps can be used for fetching, but this is inefficient and
+Git supports `ssh`, `git`, `http`, and `https` protocols (in addition, `ftp`,
+and `ftps` can be used for fetching, but this is inefficient and
deprecated; do not use it).
-The native transport (i.e. git:// URL) does no authentication and
+The native transport (i.e. `git://` URL) does no authentication and
should be used with caution on unsecured networks.
The following syntaxes may be used with them:
-- ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/path/to/repo.git/
-- git://host.xz{startsb}:port{endsb}/path/to/repo.git/
-- http{startsb}s{endsb}://host.xz{startsb}:port{endsb}/path/to/repo.git/
-- ftp{startsb}s{endsb}://host.xz{startsb}:port{endsb}/path/to/repo.git/
+- `ssh://[user@]host.xz[:port]/path/to/repo.git/`
+- `git://host.xz[:port]/path/to/repo.git/`
+- `http[s]://host.xz[:port]/path/to/repo.git/`
+- `ftp[s]://host.xz[:port]/path/to/repo.git/`
An alternative scp-like syntax may also be used with the ssh protocol:
-- {startsb}user@{endsb}host.xz:path/to/repo.git/
+- `[user@]host.xz:path/to/repo.git/`
This syntax is only recognized if there are no slashes before the
first colon. This helps differentiate a local path that contains a
@@ -32,15 +32,15 @@ url.
The ssh and git protocols additionally support ~username expansion:
-- ssh://{startsb}user@{endsb}host.xz{startsb}:port{endsb}/~{startsb}user{endsb}/path/to/repo.git/
-- git://host.xz{startsb}:port{endsb}/~{startsb}user{endsb}/path/to/repo.git/
-- {startsb}user@{endsb}host.xz:/~{startsb}user{endsb}/path/to/repo.git/
+- `ssh://[user@]host.xz[:port]/~[user]/path/to/repo.git/`
+- `git://host.xz[:port]/~[user]/path/to/repo.git/`
+- `[user@]host.xz:/~[user]/path/to/repo.git/`
For local repositories, also supported by Git natively, the following
syntaxes may be used:
-- /path/to/repo.git/
-- \file:///path/to/repo.git/
+- `/path/to/repo.git/`
+- `file:///path/to/repo.git/`
ifndef::git-clone[]
These two syntaxes are mostly equivalent, except when cloning, when
@@ -85,8 +85,8 @@ For example, with this:
insteadOf = work:
------------
-a URL like "work:repo.git" or like "host.xz:/path/to/repo.git" will be
-rewritten in any context that takes a URL to be "git://git.host.xz/repo.git".
+a URL like `work:repo.git` or like `host.xz:/path/to/repo.git` will be
+rewritten in any context that takes a URL to be `git://git.host.xz/repo.git`.
If you want to rewrite URLs for push only, you can create a
configuration section of the form:
@@ -103,6 +103,6 @@ For example, with this:
pushInsteadOf = git://example.org/
------------
-a URL like "git://example.org/path/to/repo.git" will be rewritten to
-"ssh://example.org/path/to/repo.git" for pushes, but pulls will still
+a URL like `git://example.org/path/to/repo.git` will be rewritten to
+`ssh://example.org/path/to/repo.git` for pushes, but pulls will still
use the original URL.
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 07/13] doc: typeset git dotfiles in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
` (5 preceding siblings ...)
2021-04-09 4:02 ` [RFC PATCH v1 06/13] doc: typeset dummy URLs and protocols " Firmin Martin
@ 2021-04-09 4:02 ` Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 08/13] doc: typeset filepath and $variables " Firmin Martin
` (6 subsequent siblings)
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Wrap git dotfiles with backticks as indicated in the CodingGuidelines.
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/config.txt | 12 ++++++------
Documentation/fetch-options.txt | 2 +-
Documentation/git-config.txt | 8 ++++----
Documentation/git-fast-import.txt | 2 +-
Documentation/git-format-patch.txt | 2 +-
Documentation/git-fsck.txt | 4 ++--
Documentation/git-instaweb.txt | 2 +-
Documentation/git-ls-files.txt | 2 +-
Documentation/git-notes.txt | 8 ++++----
Documentation/git-pack-refs.txt | 4 ++--
Documentation/git-prune.txt | 2 +-
Documentation/git-rebase.txt | 4 ++--
Documentation/git-submodule.txt | 12 ++++++------
Documentation/git-svn.txt | 4 ++--
Documentation/git-upload-pack.txt | 2 +-
Documentation/git-var.txt | 2 +-
Documentation/gitattributes.txt | 8 ++++----
Documentation/gitignore.txt | 4 ++--
Documentation/gitremote-helpers.txt | 2 +-
Documentation/gittutorial-2.txt | 10 +++++-----
Documentation/gitweb.txt | 2 +-
Documentation/user-manual.txt | 2 +-
22 files changed, 50 insertions(+), 50 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 05bcf1bf2b..1747307621 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -114,14 +114,14 @@ are:
`gitdir`::
The data that follows the keyword `gitdir:` is used as a glob
- pattern. If the location of the .git directory matches the
+ pattern. If the location of the `.git` directory matches the
pattern, the include condition is met.
+
-The .git location may be auto-discovered, or come from `$GIT_DIR`
-environment variable. If the repository is auto discovered via a .git
-file (e.g. from submodules, or a linked worktree), the .git location
-would be the final location where the .git directory is, not where the
-.git file is.
+The `.git` location may be auto-discovered, or come from `$GIT_DIR`
+environment variable. If the repository is auto discovered via a `.git`
+file (e.g. from submodules, or a linked worktree), the `.git` location
+would be the final location where the `.git` directory is, not where the
+`.git` file is.
+
The pattern can contain standard globbing wildcards and two additional
ones, `**/` and `/**`, that can match multiple path components. Please
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 6aa07a54b9..94de13eec8 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -43,7 +43,7 @@ the current repository has the same history as the source repository.
--update-shallow::
By default when fetching from a shallow repository,
`git fetch` refuses refs that require updating
- .git/shallow. This option updates .git/shallow and accept such
+ `.git/shallow`. This option updates `.git/shallow` and accept such
refs.
--negotiation-tip=<commit|glob>::
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 85e02aff92..afb14bcafe 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -148,7 +148,7 @@ See also <<FILES>>.
--blob blob::
Similar to `--file` but use the given blob instead of a file. E.g.
you can use 'master:.gitmodules' to read values from the file
- '.gitmodules' in the `master` branch. See "SPECIFYING REVISIONS"
+ `.gitmodules` in the `master` branch. See "SPECIFYING REVISIONS"
section in linkgit:gitrevisions[7] for a more complete list of
ways to spell blob names.
@@ -336,8 +336,8 @@ ENVIRONMENT
-----------
GIT_CONFIG::
- Take the configuration from the given file instead of .git/config.
- Using the `--global` option forces this to ~/.gitconfig. Using the
+ Take the configuration from the given file instead of `.git/config`.
+ Using the `--global` option forces this to `~/.gitconfig`. Using the
`--system` option forces this to $(prefix)/etc/gitconfig.
GIT_CONFIG_NOSYSTEM::
@@ -367,7 +367,7 @@ for example when writing scripts.
EXAMPLES
--------
-Given a .git/config like this:
+Given a `.git/config` like this:
------------
#
diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt
index eeac242732..7b801de61a 100644
--- a/Documentation/git-fast-import.txt
+++ b/Documentation/git-fast-import.txt
@@ -116,7 +116,7 @@ Locations of Marks Files
with `--import-marks`= and `--export-marks`= are relative
to an internal directory in the current repository.
In `git-fast-import` this means that the paths are relative
- to the .git/info/fast-import directory. However, other
+ to the `.git/info/fast-import` directory. However, other
importers may use a different location.
+
Relative and non-relative marks may be combined by interweaving
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 2009a048a9..3b10a6f7ea 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -503,7 +503,7 @@ If it does not apply correctly, there can be various reasons.
this case.
* The MUA corrupted your patch; "am" would complain that
- the patch does not apply. Look in the .git/rebase-apply/ subdirectory and
+ the patch does not apply. Look in the `.git/rebase-apply/` subdirectory and
see what 'patch' file contains and check for the common
corruption patterns mentioned above.
diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt
index 048a28ee50..a680caa365 100644
--- a/Documentation/git-fsck.txt
+++ b/Documentation/git-fsck.txt
@@ -86,8 +86,8 @@ care about this output and want to speed it up further.
Be chatty.
--lost-found::
- Write dangling objects into .git/lost-found/commit/ or
- .git/lost-found/other/, depending on type. If the object is
+ Write dangling objects into `.git/lost-found/commit/` or
+ `.git/lost-found/other/`, depending on type. If the object is
a blob, the contents are written into the file, rather than
its object name.
diff --git a/Documentation/git-instaweb.txt b/Documentation/git-instaweb.txt
index dfbd3a40ce..a8876b74ca 100644
--- a/Documentation/git-instaweb.txt
+++ b/Documentation/git-instaweb.txt
@@ -69,7 +69,7 @@ restart::
CONFIGURATION
-------------
-You may specify configuration in your .git/config
+You may specify configuration in your `.git/config`
-----------------------------------------------------------------------
[instaweb]
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index ee435024da..3557823de9 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -103,7 +103,7 @@ OPTIONS
directory and its subdirectories in <file>.
--exclude-standard::
- Add the standard Git exclusions: .git/info/exclude, .gitignore
+ Add the standard Git exclusions: `.git/info/exclude`, `.gitignore`
in each directory, and the user's global exclusion file.
--error-unmatch::
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 8f25b07f10..ffc6fc51a7 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -192,11 +192,11 @@ OPTIONS
--commit::
Finalize an in-progress `git notes merge`. Use this option
when you have resolved the conflicts that `git notes merge`
- stored in .git/NOTES_MERGE_WORKTREE. This amends the partial
+ stored in `.git/NOTES_MERGE_WORKTREE`. This amends the partial
merge commit created by `git notes merge` (stored in
- .git/NOTES_MERGE_PARTIAL) by adding the notes in
- .git/NOTES_MERGE_WORKTREE. The notes ref stored in the
- .git/NOTES_MERGE_REF symref is updated to the resulting commit.
+ `.git/NOTES_MERGE_PARTIAL`) by adding the notes in
+ `.git/NOTES_MERGE_WORKTREE`. The notes ref stored in the
+ `.git/NOTES_MERGE_REF` symref is updated to the resulting commit.
--abort::
Abort/reset an in-progress `git notes merge`, i.e. a notes merge
diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt
index 7e62ff3e8d..169bcfb07f 100644
--- a/Documentation/git-pack-refs.txt
+++ b/Documentation/git-pack-refs.txt
@@ -64,8 +64,8 @@ BUGS
----
Older documentation written before the packed-refs mechanism was
-introduced may still say things like ".git/refs/heads/<branch> file
-exists" when it means "branch <branch> exists".
+introduced may still say things like "`.git/refs/heads/<branch>` file
+exists" when it means branch <branch> exists.
GIT
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt
index 4cdd753c13..382e5f70f4 100644
--- a/Documentation/git-prune.txt
+++ b/Documentation/git-prune.txt
@@ -24,7 +24,7 @@ objects unreachable from any of these head objects from the object database.
In addition, it
prunes the unpacked objects that are also found in packs by
running `git prune-packed`.
-It also removes entries from .git/shallow that are not reachable by
+It also removes entries from `.git/shallow` that are not reachable by
any ref.
Note that unreachable, packed objects will remain. If this is
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index ddc76ca308..1c5eaf8cf7 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -48,7 +48,7 @@ It is possible that a merge failure will prevent this process from being
completely automatic. You will have to resolve any such merge failure
and run `git rebase --continue`. Another option is to bypass the commit
that caused the merge failure with `git rebase --skip`. To check out the
-original <branch> and remove the .git/rebase-apply working files, use the
+original <branch> and remove the `.git/rebase-apply` working files, use the
command `git rebase --abort` instead.
Assume the following history exists and the current branch is `topic`:
@@ -800,7 +800,7 @@ completeness:
them to stderr.
* State directories: The two backends keep their state in different
- directories under .git/
+ directories under `.git/`
include::merge-strategies.txt[]
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index b97531f808..0a691b1df0 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -95,7 +95,7 @@ too (and can also report changes to a submodule's work tree).
init [--] [<path>...]::
Initialize the submodules recorded in the index (which were
added and committed elsewhere) by setting `submodule.$name.url`
- in .git/config. It uses the same setting from `.gitmodules` as
+ in `.git/config`. It uses the same setting from `.gitmodules` as
a template. If the URL is relative, it will be resolved using
the default remote. If there is no default remote, the current
repository will be assumed to be upstream.
@@ -106,8 +106,8 @@ configured to be active will be initialized, otherwise all submodules are
initialized.
+
When present, it will also copy the value of `submodule.$name.update`.
-This command does not alter existing information in .git/config.
-You can then customize the submodule clone URLs in .git/config
+This command does not alter existing information in `.git/config`.
+You can then customize the submodule clone URLs in `.git/config`
for your local setup and proceed to `git submodule update`;
you can also just use `git submodule update --init` without
the explicit 'init' step if you do not intend to customize
@@ -117,7 +117,7 @@ See the add subcommand for the definition of default remote.
deinit [-f|--force] (--all|[--] <path>...)::
Unregister the given submodules, i.e. remove the whole
- `submodule.$name` section from .git/config together with their work
+ `submodule.$name` section from `.git/config` together with their work
tree. Further calls to `git submodule update`, `git submodule foreach`
and `git submodule sync` will skip any unregistered submodules until
they are initialized again, so use this command if you don't want to
@@ -235,7 +235,7 @@ git submodule foreach 'echo $sm_path `git rev-parse HEAD`'
sync [--recursive] [--] [<path>...]::
Synchronizes submodules' remote URL configuration setting
to the value specified in `.gitmodules`. It will only affect those
- submodules which already have a URL entry in .git/config (that is the
+ submodules which already have a URL entry in `.git/config` (that is the
case when they are initialized or freshly added). This is useful when
submodule URLs change upstream and you need to update your local
repositories accordingly.
@@ -251,7 +251,7 @@ absorbgitdirs::
move the `git` directory of the submodule into its superproject's
`$GIT_DIR/modules` path and then connect the `git` directory and
its working directory by setting the `core.worktree` and adding
- a .git file pointing to the `git` directory embedded in the
+ a `.git` file pointing to the `git` directory embedded in the
superprojects `git` directory.
+
A repository that was cloned independently and later added as a submodule or
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 93868c9226..2e1e3348c7 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -221,7 +221,7 @@ config key: `svn-remote.<name>.include-paths`
--placeholder-filename=<filename>;;
Set the name of placeholder files created by `--preserve-empty-dirs`.
- Default: ".gitignore"
+ Default: "`.gitignore`"
`rebase`::
This fetches revisions from the SVN parent of the current `HEAD`
@@ -432,7 +432,7 @@ Any other arguments are passed directly to `git log`
`create-ignore`::
Recursively finds the svn:ignore property on directories and
- creates matching .gitignore files. The resulting files are staged to
+ creates matching `.gitignore` files. The resulting files are staged to
be committed, but are not committed. Use `-r`/`--revision` to refer to a
specific revision.
diff --git a/Documentation/git-upload-pack.txt b/Documentation/git-upload-pack.txt
index f4b9dab02e..fdb7edc727 100644
--- a/Documentation/git-upload-pack.txt
+++ b/Documentation/git-upload-pack.txt
@@ -26,7 +26,7 @@ OPTIONS
-------
--[no-]strict::
- Do not try <directory>/.git/ if <directory> is no Git directory.
+ Do not try `<directory>/.git/` if <directory> is no Git directory.
--timeout=<n>::
Interrupt transfer after <n> seconds of inactivity.
diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt
index 3e356129cd..1105e8a1cc 100644
--- a/Documentation/git-var.txt
+++ b/Documentation/git-var.txt
@@ -19,7 +19,7 @@ OPTIONS
-------
-l::
Cause the logical variables to be listed. In addition, all the
- variables of the Git configuration file .git/config are listed
+ variables of the Git configuration file `.git/config` are listed
as well. (However, the configuration variables listing functionality
is deprecated in favor of `git config -l`.)
diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
index 2ce7365ec6..bd1cd2629c 100644
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt
@@ -7,7 +7,7 @@ gitattributes - Defining attributes per path
SYNOPSIS
--------
-$GIT_DIR/info/attributes, .gitattributes
+$GIT_DIR/info/attributes, `.gitattributes`
DESCRIPTION
@@ -430,7 +430,7 @@ variable to `true`.
Note: Whenever the clean filter is changed, the repo should be renormalized:
$ git add --renormalize .
-For example, in .gitattributes, you would assign the `filter`
+For example, in `.gitattributes`, you would assign the `filter`
attribute for paths.
------------------------
@@ -438,7 +438,7 @@ attribute for paths.
------------------------
Then you would define a `filter.indent.clean` and `filter.indent.smudge`
-configuration in your .git/config to specify a pair of commands to
+configuration in your `.git/config` to specify a pair of commands to
modify the contents of C programs when the source files are checked
in ("clean" is run) and checked out (no change is made because the
command is "cat").
@@ -771,7 +771,7 @@ matches what GNU 'diff -p' output uses. This default selection however
is not suited for some contents, and you can use a customized pattern
to make a selection.
-First, in .gitattributes, you would assign the `diff` attribute
+First, in `.gitattributes`, you would assign the `diff` attribute
for paths.
------------------------
diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
index 379db07326..7488cdb585 100644
--- a/Documentation/gitignore.txt
+++ b/Documentation/gitignore.txt
@@ -7,7 +7,7 @@ gitignore - Specifies intentionally untracked files to ignore
SYNOPSIS
--------
-$XDG_CONFIG_HOME/git/ignore, $GIT_DIR/info/exclude, .gitignore
+$XDG_CONFIG_HOME/git/ignore, $GIT_DIR/info/exclude, `.gitignore`
DESCRIPTION
-----------
@@ -211,7 +211,7 @@ Another example:
$ echo '!/vmlinux*' >arch/foo/kernel/.gitignore
--------------------------------------------------------------
-The second .gitignore prevents Git from ignoring
+The second `.gitignore` prevents Git from ignoring
`arch/foo/kernel/vmlinux.lds.S`.
Example to exclude everything except a specific directory `foo/bar`
diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
index 6e75d45382..e92b9113f2 100644
--- a/Documentation/gitremote-helpers.txt
+++ b/Documentation/gitremote-helpers.txt
@@ -512,7 +512,7 @@ set by Git if the remote helper has the 'option' capability.
repository is guaranteed empty).
'option update-shallow' {'true'|'false'}::
- Allow to extend .git/shallow if the new refs require it.
+ Allow to extend `.git/shallow` if the new refs require it.
'option pushcert' {'true'|'false'}::
GPG sign pushes.
diff --git a/Documentation/gittutorial-2.txt b/Documentation/gittutorial-2.txt
index 65bc1453d6..ef11670768 100644
--- a/Documentation/gittutorial-2.txt
+++ b/Documentation/gittutorial-2.txt
@@ -133,7 +133,7 @@ header identifying their length and their type. The type is either a
blob, a tree, a commit, or a tag.
The simplest commit to find is the `HEAD` commit, which we can find
-from .git/HEAD:
+from `.git/HEAD`:
------------------------------------------------
$ cat .git/HEAD
@@ -141,7 +141,7 @@ ref: refs/heads/master
------------------------------------------------
As you can see, this tells us which branch we're currently on, and it
-tells us this by naming a file under the .git directory, which itself
+tells us this by naming a file under the `.git` directory, which itself
contains a SHA-1 name referring to a commit object, which we can
examine with cat-file:
@@ -203,8 +203,8 @@ project's history:
data and "tree" objects containing subdirectory information.
* "blob" objects contain file data without any other structure.
* References to commit objects at the head of each branch are
- stored in files under .git/refs/heads/.
- * The name of the current branch is stored in .git/HEAD.
+ stored in files under `.git/refs/heads/`.
+ * The name of the current branch is stored in `.git/HEAD`.
Note, by the way, that lots of commands take a tree as an argument.
But as we can see above, a tree can be referred to in many different
@@ -263,7 +263,7 @@ index a042389..513feba 100644
So `git diff` is comparing against something other than the head.
The thing that it's comparing against is actually the index file,
-which is stored in .git/index in a binary format, but whose contents
+which is stored in `.git/index` in a binary format, but whose contents
we can examine with ls-files:
------------------------------------------------
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index 689afb38c0..14abdb843f 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -642,7 +642,7 @@ parameter.
*Notice* that in this case you don't need special settings for
`@stylesheets`, `$my_uri` and `$home_link`, but you lose "dumb client"
-access to your project .git dirs (described in "Single URL for `gitweb` and
+access to your project `.git` dirs (described in "Single URL for `gitweb` and
for fetching" section). A possible workaround for the latter is the
following: in your project root dir (e.g. `/pub/git`) have the projects
named *without* a .git extension (e.g. `/pub/git/project` instead of
diff --git a/Documentation/user-manual.txt b/Documentation/user-manual.txt
index 4459d74ec2..998875fc2b 100644
--- a/Documentation/user-manual.txt
+++ b/Documentation/user-manual.txt
@@ -3143,7 +3143,7 @@ Writing objects: 100% (6020/6020), done.
Total 6020 (delta 4070), reused 0 (delta 0)
------------------------------------------------
-This creates a single "pack file" in .git/objects/pack/
+This creates a single "pack file" in `.git/objects/pack/`
containing all currently unpacked objects. You can then run
------------------------------------------------
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 08/13] doc: typeset filepath and $variables in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
` (6 preceding siblings ...)
2021-04-09 4:02 ` [RFC PATCH v1 07/13] doc: typeset git dotfiles " Firmin Martin
@ 2021-04-09 4:02 ` Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 09/13] doc: typeset command/option/value entries " Firmin Martin
` (5 subsequent siblings)
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Wrap filepaths and $-prefixed environment or Perl variables with
backticks as indicated in the CodingGuidelines.
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/config.txt | 12 ++--
Documentation/git-bisect-lk2009.txt | 12 ++--
Documentation/git-bugreport.txt | 2 +-
Documentation/git-bundle.txt | 2 +-
Documentation/git-checkout.txt | 2 +-
Documentation/git-config.txt | 18 ++---
Documentation/git-credential-store.txt | 6 +-
Documentation/git-daemon.txt | 2 +-
Documentation/git-describe.txt | 8 +--
Documentation/git-fast-export.txt | 2 +-
Documentation/git-fetch-pack.txt | 14 ++--
Documentation/git-fetch.txt | 2 +-
Documentation/git-filter-branch.txt | 6 +-
Documentation/git-for-each-ref.txt | 2 +-
Documentation/git-fsck.txt | 8 +--
Documentation/git-http-backend.txt | 4 +-
Documentation/git-http-fetch.txt | 2 +-
Documentation/git-http-push.txt | 2 +-
Documentation/git-log.txt | 4 +-
Documentation/git-mergetool--lib.txt | 4 +-
Documentation/git-p4.txt | 18 ++---
Documentation/git-pack-objects.txt | 4 +-
Documentation/git-pack-refs.txt | 2 +-
Documentation/git-push.txt | 2 +-
Documentation/git-read-tree.txt | 22 +++---
Documentation/git-receive-pack.txt | 18 ++---
Documentation/git-remote.txt | 4 +-
Documentation/git-restore.txt | 2 +-
Documentation/git-rev-parse.txt | 16 ++---
Documentation/git-send-email.txt | 2 +-
Documentation/git-send-pack.txt | 4 +-
Documentation/git-show-branch.txt | 2 +-
Documentation/git-show-ref.txt | 12 ++--
Documentation/git-submodule.txt | 16 ++---
Documentation/git-svn.txt | 36 +++++-----
Documentation/git-update-index.txt | 8 +--
Documentation/git-update-ref.txt | 10 +--
Documentation/git-update-server-info.txt | 4 +-
Documentation/git.txt | 6 +-
Documentation/gitattributes.txt | 6 +-
Documentation/githooks.txt | 6 +-
Documentation/gitignore.txt | 6 +-
Documentation/gitk.txt | 2 +-
Documentation/gitmailmap.txt | 2 +-
Documentation/gitmodules.txt | 2 +-
Documentation/gitrepository-layout.txt | 52 +++++++-------
Documentation/gitsubmodules.txt | 2 +-
Documentation/gitweb.conf.txt | 92 ++++++++++++------------
Documentation/gitweb.txt | 8 +--
Documentation/glossary-content.txt | 2 +-
Documentation/pretty-formats.txt | 4 +-
Documentation/pretty-options.txt | 6 +-
Documentation/rev-list-options.txt | 2 +-
Documentation/revisions.txt | 22 +++---
54 files changed, 258 insertions(+), 258 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 1747307621..68529ad9db 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -164,8 +164,8 @@ A few more notes on matching via `gitdir` and `gitdir/i`:
* Symlinks in `$GIT_DIR` are not resolved before matching.
* Both the symlink & realpath versions of paths will be matched
- outside of `$GIT_DIR`. E.g. if ~/git is a symlink to
- /mnt/storage/git, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
+ outside of `$GIT_DIR`. E.g. if `~/git` is a symlink to
+ `/mnt/storage/git`, both `gitdir:~/git` and `gitdir:/mnt/storage/git`
will match.
+
This was not the case in the initial release of this feature in
@@ -173,7 +173,7 @@ v2.13.0, which only matched the realpath version. Configuration that
wants to be compatible with the initial release of this feature needs
to either specify only the realpath version, or both versions.
- * Note that "../" is not special and will match literally, which is
+ * Note that `../` is not special and will match literally, which is
unlikely what you want.
Example
@@ -204,15 +204,15 @@ Example
path = foo.inc ; find "foo.inc" relative to the current file
path = ~/foo.inc ; find "foo.inc" in your `$HOME` directory
-; include if $GIT_DIR is /path/to/foo/.git
+; include if `$GIT_DIR` is /path/to/foo/.git
[includeIf "gitdir:/path/to/foo/.git"]
path = /path/to/foo.inc
-; include for all repositories inside /path/to/group
+; include for all repositories inside `/path/to/group`
[includeIf "gitdir:/path/to/group/"]
path = /path/to/foo.inc
-; include for all repositories inside $HOME/to/group
+; include for all repositories inside `$HOME/to/group`
[includeIf "gitdir:~/to/group/"]
path = /path/to/foo.inc
diff --git a/Documentation/git-bisect-lk2009.txt b/Documentation/git-bisect-lk2009.txt
index b919b3ea42..de5f221613 100644
--- a/Documentation/git-bisect-lk2009.txt
+++ b/Documentation/git-bisect-lk2009.txt
@@ -1218,9 +1218,9 @@ With the example above that would give:
-------------
That's why the `git replace` command was created. Technically it
-stores replacements "refs" in the "refs/replace/" hierarchy. These
-"refs" are like branches (that are stored in "refs/heads/") or tags
-(that are stored in "refs/tags"), and that means that they can
+stores replacements `refs` in the `refs/replace/` hierarchy. These
+`refs` are like branches (that are stored in `refs/heads/`) or tags
+(that are stored in `refs/tags`), and that means that they can
automatically be shared like branches or tags among developers.
`git replace` is a very powerful mechanism. It can be used to fix
@@ -1233,10 +1233,10 @@ it is now in the `master` branch of Git's Git repository and it should
be released in Git 1.6.5 in October or November 2009.
One problem with `git replace` is that currently it stores all the
-replacements refs in "refs/replace/", but it would be perhaps better
+replacements refs in `refs/replace/`, but it would be perhaps better
if the replacement refs that are useful only for bisecting would be in
-"refs/replace/bisect/". This way the replacement refs could be used
-only for bisecting, while other refs directly in "refs/replace/" would
+`refs/replace/bisect/`. This way the replacement refs could be used
+only for bisecting, while other refs directly in `refs/replace/` would
be used nearly all the time.
Bisecting sporadic bugs
diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt
index bb1355248e..0d5ef36f90 100644
--- a/Documentation/git-bugreport.txt
+++ b/Documentation/git-bugreport.txt
@@ -29,7 +29,7 @@ The following information is captured automatically:
- uname sysname, release, version, and machine strings
- Compiler-specific info string
- A list of enabled hooks
- - $SHELL
+ - `$SHELL`
This tool is invoked via the typical Git setup process, which means that in some
cases, it might not be able to launch - for example, if a relevant config file
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index fb0ebe1257..51f8dd463f 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -168,7 +168,7 @@ machineB$ git clone -b master /home/me/tmp/file.bundle R2
----------------
This will define a remote called `origin` in the resulting repository that
-lets you fetch and pull from the bundle. The $GIT_DIR/config file in R2 will
+lets you fetch and pull from the bundle. The `$GIT_DIR/config` file in R2 will
have an entry like this:
------------------------
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index c3fc807d91..15f9690e37 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -327,7 +327,7 @@ Note that this option uses the no overlay mode by default (see also
<branch>::
Branch to checkout; if it refers to a branch (i.e., a name that,
- when prepended with "refs/heads/", is a valid ref), then that
+ when prepended with `refs/heads/`, is a valid ref), then that
branch is checked out. Otherwise, if it refers to a valid
commit, your `HEAD` becomes "detached" and you are no longer on
any branch (see below for details).
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index afb14bcafe..80b646b895 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -286,27 +286,27 @@ FILES
If not set explicitly with `--file`, there are four files where
`git config` will search for configuration options:
-$(prefix)/etc/gitconfig::
+`$(prefix)/etc/gitconfig`::
System-wide configuration file.
-$XDG_CONFIG_HOME/git/config::
- Second user-specific configuration file. If $XDG_CONFIG_HOME is not set
+`$XDG_CONFIG_HOME/git/config`::
+ Second user-specific configuration file. If `$XDG_CONFIG_HOME` is not set
or empty, `$HOME/.config/git/config` will be used. Any single-valued
variable set in this file will be overwritten by whatever is in
`~/.gitconfig`. It is a good idea not to create this file if
you sometimes use older versions of Git, as support for this
file was added fairly recently.
-~/.gitconfig::
+`~/.gitconfig`::
User-specific configuration file. Also called "global"
configuration file.
-$GIT_DIR/config::
+`$GIT_DIR/config`::
Repository specific configuration file.
-$GIT_DIR/config.worktree::
+`$GIT_DIR/config.worktree`::
This is optional and is only searched when
- `extensions.worktreeConfig` is present in $GIT_DIR/config.
+ `extensions.worktreeConfig` is present in `$GIT_DIR/config`.
If no further options are given, all reading options will read all of these
files that are available. If the global or the system-wide configuration
@@ -338,11 +338,11 @@ ENVIRONMENT
GIT_CONFIG::
Take the configuration from the given file instead of `.git/config`.
Using the `--global` option forces this to `~/.gitconfig`. Using the
- `--system` option forces this to $(prefix)/etc/gitconfig.
+ `--system` option forces this to `$(prefix)/etc/gitconfig`.
GIT_CONFIG_NOSYSTEM::
Whether to skip reading settings from the system-wide
- $(prefix)/etc/gitconfig file. See linkgit:git[1] for details.
+ `$(prefix)/etc/gitconfig` file. See linkgit:git[1] for details.
See also <<FILES>>.
diff --git a/Documentation/git-credential-store.txt b/Documentation/git-credential-store.txt
index 376b0d6c5f..3d83420f0a 100644
--- a/Documentation/git-credential-store.txt
+++ b/Documentation/git-credential-store.txt
@@ -47,11 +47,11 @@ FILES
If not set explicitly with `--file`, there are two files where
`git-credential-store` will search for credentials in order of precedence:
-~/.git-credentials::
+`~/.git-credentials`::
User-specific credentials file.
-$XDG_CONFIG_HOME/git/credentials::
- Second user-specific credentials file. If '$XDG_CONFIG_HOME' is not set
+`$XDG_CONFIG_HOME/git/credentials`::
+ Second user-specific credentials file. If `$XDG_CONFIG_HOME` is not set
or empty, `$HOME/.config/git/credentials` will be used. Any credentials
stored in this file will not be used if `~/.git-credentials` has a
matching credential as well. It is a good idea not to create this file
diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index 1298ceb723..3f684378f4 100644
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -209,7 +209,7 @@ Git configuration files in that directory are readable by `<user>`.
(%CH), IP address (%IP), and TCP port (%P) as its command-line
arguments. The external command can decide to decline the
service by exiting with a non-zero status (or to allow it by
- exiting with a zero status). It can also look at the $REMOTE_ADDR
+ exiting with a zero status). It can also look at the `$REMOTE_ADDR`
and `$REMOTE_PORT` environment variables to learn about the
requestor when making this decision.
+
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index 6cfb444444..a21eafa025 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -95,9 +95,9 @@ OPTIONS
--match <pattern>::
Only consider tags matching the given `glob(7)` pattern,
- excluding the "refs/tags/" prefix. If used with `--all`, it also
+ excluding the `refs/tags/` prefix. If used with `--all`, it also
considers local branches and remote-tracking references matching the
- pattern, excluding respectively "refs/heads/" and "refs/remotes/"
+ pattern, excluding respectively `refs/heads/` and `refs/remotes/`
prefix; references of other types are never considered. If given
multiple times, a list of patterns will be accumulated, and tags
matching any of the patterns will be considered. Use `--no-match` to
@@ -105,9 +105,9 @@ OPTIONS
--exclude <pattern>::
Do not consider tags matching the given `glob(7)` pattern, excluding
- the "refs/tags/" prefix. If used with `--all`, it also does not consider
+ the `refs/tags/` prefix. If used with `--all`, it also does not consider
local branches and remote-tracking references matching the pattern,
- excluding respectively "refs/heads/" and "refs/remotes/" prefix;
+ excluding respectively `refs/heads/` and `refs/remotes/` prefix;
references of other types are never considered. If given multiple times,
a list of patterns will be accumulated and tags matching any of the
patterns will be excluded. When combined with `--match` a tag will be
diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt
index 24b10d4ad1..0e1db78aee 100644
--- a/Documentation/git-fast-export.txt
+++ b/Documentation/git-fast-export.txt
@@ -185,7 +185,7 @@ This makes a new branch called `other` from `master~5`..`master`
Note that this assumes that none of the blobs and commit messages
referenced by that revision range contains the string
-'refs/heads/master'.
+`refs/heads/master`.
ANONYMIZING
diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt
index eaca893ac8..3d829538b0 100644
--- a/Documentation/git-fetch-pack.txt
+++ b/Documentation/git-fetch-pack.txt
@@ -69,15 +69,15 @@ be in a separate packet, and the list must end with a flush packet.
--upload-pack=<git-upload-pack>::
Use this to specify the path to `git-upload-pack` on the
- remote side, if is not found on your $PATH.
+ remote side, if is not found on your `$PATH`.
Installations of sshd ignores the user's environment
- setup scripts for login shells (e.g. .bash_profile) and
+ setup scripts for login shells (e.g. `.bash_profile`) and
your privately installed `git` may not be found on the system
- default $PATH. Another workaround suggested is to set
- up your $PATH in ".bashrc", but this flag is for people
+ default `$PATH`. Another workaround suggested is to set
+ up your `$PATH` in `.bashrc`, but this flag is for people
who do not want to pay the overhead for non-interactive
- shells by having a lean .bashrc file (they set most of
- the things up in .bash_profile).
+ shells by having a lean `.bashrc` file (they set most of
+ the things up in `.bash_profile`).
--exec=<git-upload-pack>::
Same as `--upload-pack`=<git-upload-pack>.
@@ -116,7 +116,7 @@ be in a separate packet, and the list must end with a flush packet.
<refs>...::
The remote heads to update from. This is relative to
- $GIT_DIR (e.g. `HEAD`, "refs/heads/master"). When
+ `$GIT_DIR` (e.g. `HEAD`, `refs/heads/master`). When
unspecified, update from all heads the remote side has.
+
If the remote has enabled the options `uploadpack.allowTipSHA1InWant`,
diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt
index b0b5d06aad..11ee865969 100644
--- a/Documentation/git-fetch.txt
+++ b/Documentation/git-fetch.txt
@@ -17,7 +17,7 @@ SYNOPSIS
DESCRIPTION
-----------
-Fetch branches and/or tags (collectively, "refs") from one or more
+Fetch branches and/or tags (collectively, `refs`) from one or more
other repositories, along with the objects necessary to complete their
histories. Remote-tracking branches are updated (see the description
of <refspec> below for ways to control this behavior).
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index b21205d265..8b19805695 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -61,7 +61,7 @@ rewriting published history.)
Always verify that the rewritten version is correct: The original refs,
if different from the rewritten ones, will be stored in the namespace
-'refs/original/'.
+`refs/original/`.
Note that since this operation is very I/O expensive, it might
be a good idea to redirect the temporary directory off-disk with the
@@ -195,7 +195,7 @@ to other tags will be rewritten to point to the underlying commit.
--original <namespace>::
Use this option to set the namespace where the original commits
- will be stored. The default value is 'refs/original'.
+ will be stored. The default value is `refs/original`.
-d <directory>::
Use this option to set the path to the temporary directory used for
@@ -209,7 +209,7 @@ to other tags will be rewritten to point to the underlying commit.
--force::
`git filter-branch` refuses to start with an existing temporary
directory or when there are already refs starting with
- 'refs/original/', unless forced.
+ `refs/original/`, unless forced.
--state-branch <branch>::
This option will cause the mapping from old to new objects to
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 33fb379df4..518f040fcd 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -103,7 +103,7 @@ keys.
For all objects, the following names can be used:
refname::
- The name of the ref (the part after $GIT_DIR/).
+ The name of the ref (the part after `$GIT_DIR`/).
For a non-ambiguous short name of the ref append `:short`.
The option `core.warnAmbiguousRefs` is used to select the strict
abbreviation mode. If `lstrip=<N>` (`rstrip=<N>`) is appended, strips `<N>`
diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt
index a680caa365..2d90384355 100644
--- a/Documentation/git-fsck.txt
+++ b/Documentation/git-fsck.txt
@@ -53,10 +53,10 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs
--full::
Check not just objects in GIT_OBJECT_DIRECTORY
- ($GIT_DIR/objects), but also the ones found in alternate
+ (`$GIT_DIR/objects`), but also the ones found in alternate
object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES
- or $GIT_DIR/objects/info/alternates,
- and in packed Git archives found in $GIT_DIR/objects/pack
+ or `$GIT_DIR/objects/info/alternates`,
+ and in packed Git archives found in `$GIT_DIR/objects/pack`
and corresponding pack subdirectories in alternate
object pools. This is now default; you can turn it off
with `--no-full`.
@@ -154,7 +154,7 @@ Environment Variables
---------------------
GIT_OBJECT_DIRECTORY::
- used to specify the object database root (usually $GIT_DIR/objects)
+ used to specify the object database root (usually `$GIT_DIR/objects`)
GIT_INDEX_FILE::
used to specify the index file of the index
diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt
index e63816e430..4bbf4811c0 100644
--- a/Documentation/git-http-backend.txt
+++ b/Documentation/git-http-backend.txt
@@ -264,8 +264,8 @@ a repository with an extremely large number of refs. The value can be
specified with a unit (e.g., `100M` for 100 megabytes). The default is
10 megabytes.
-The backend process sets GIT_COMMITTER_NAME to '$REMOTE_USER' and
-GIT_COMMITTER_EMAIL to '$\{REMOTE_USER}@http.$\{REMOTE_ADDR\}',
+The backend process sets `GIT_COMMITTER_NAME` to `$REMOTE_USER` and
+`GIT_COMMITTER_EMAIL` to '$\{REMOTE_USER}@http.$\{REMOTE_ADDR\}',
ensuring that any reflogs created by `git-receive-pack` contain some
identifying information of the remote user who performed the push.
diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt
index 87028e3312..58e92f22c6 100644
--- a/Documentation/git-http-fetch.txt
+++ b/Documentation/git-http-fetch.txt
@@ -31,7 +31,7 @@ commit-id::
Report what is downloaded.
-w <filename>::
- Writes the commit-id into the filename under $GIT_DIR/refs/<filename> on
+ Writes the commit-id into the filename under `$GIT_DIR/refs/<filename>` on
the local end after the transfer is complete.
--stdin::
diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt
index 85c564c412..a2932ba27f 100644
--- a/Documentation/git-http-push.txt
+++ b/Documentation/git-http-push.txt
@@ -74,7 +74,7 @@ destination side.
- If <dst> does not match any remote ref, either
- * it has to start with "refs/"; <dst> is used as the
+ * it has to start with `refs/`; <dst> is used as the
destination literally in this case.
* <src> == <dst> and the ref that matched the <src> must not
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index a6b3bc1611..43f9a5c69e 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -34,8 +34,8 @@ OPTIONS
--no-decorate::
--decorate[=short|full|auto|no]::
Print out the ref names of any commits that are shown. If 'short' is
- specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and
- 'refs/remotes/' will not be printed. If 'full' is specified, the
+ specified, the ref name prefixes `refs/heads/`, `refs/tags/` and
+ `refs/remotes/` will not be printed. If 'full' is specified, the
full ref name (including prefix) will be printed. If 'auto' is
specified, then if the output is going to a terminal, the ref names
are shown as if 'short' were given, otherwise no ref names are
diff --git a/Documentation/git-mergetool--lib.txt b/Documentation/git-mergetool--lib.txt
index 8177c877e2..7adf8f797b 100644
--- a/Documentation/git-mergetool--lib.txt
+++ b/Documentation/git-mergetool--lib.txt
@@ -29,7 +29,7 @@ FUNCTIONS
---------
get_merge_tool::
returns a merge tool. the return code is 1 if we returned a guessed
- merge tool, else 0. '$GIT_MERGETOOL_GUI' may be set to 'true' to
+ merge tool, else 0. `$GIT_MERGETOOL_GUI` may be set to 'true' to
search for the appropriate guitool.
get_merge_tool_cmd::
@@ -45,7 +45,7 @@ initialize_merge_tool::
run_merge_tool::
launches a merge tool given the tool name and a true/false
flag to indicate whether a merge base is present.
- '$MERGED', '$LOCAL', '$REMOTE', and '$BASE' must be defined
+ `$MERGED`, `$LOCAL`, `$REMOTE`, and `$BASE` must be defined
for use by the merge tool.
GIT
diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index 093f023ac5..a74866d84f 100644
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -74,7 +74,7 @@ This:
1. Creates an empty Git repository in a subdirectory called 'project'.
+
2. Imports the full contents of the head revision from the given p4
- depot path into a single commit in the Git branch 'refs/remotes/p4/master'.
+ depot path into a single commit in the Git branch `refs/remotes/p4/master`.
+
3. Creates a local branch, `master` from this remote and checks it out.
@@ -103,11 +103,11 @@ $ git init
$ git p4 sync //path/in/your/perforce/depot
------------
This imports the specified depot into
-'refs/remotes/p4/master' in an existing Git repository. The
+`refs/remotes/p4/master` in an existing Git repository. The
`--branch` option can be used to specify a different branch to
be used for the p4 content.
-If a Git repository includes branches 'refs/remotes/origin/p4', these
+If a Git repository includes branches `refs/remotes/origin/p4`, these
will be fetched and consulted first during a `git p4 sync`. Since
importing directly from p4 is considerably slower than pulling changes
from a Git remote, this can be useful in a multi-developer environment.
@@ -155,7 +155,7 @@ $ git p4 submit --commit <sha1>
$ git p4 submit --commit <sha1..sha1>
------------
-The upstream reference is generally 'refs/remotes/p4/master', but can
+The upstream reference is generally `refs/remotes/p4/master`, but can
be overridden using the `--origin=` command-line option.
The p4 changes will be created as the user invoking `git p4 submit`. The
@@ -254,10 +254,10 @@ Git repository:
Import labels from p4 into Git.
--import-local::
- By default, p4 branches are stored in 'refs/remotes/p4/',
+ By default, p4 branches are stored in `refs/remotes/p4/`,
where they will be treated as remote-tracking branches by
linkgit:git-branch[1] and other commands. This option instead
- puts p4 branches in 'refs/heads/p4/'. Note that future
+ puts p4 branches in `refs/heads/p4/`. Note that future
sync operations must specify `--import-local` as well so that
they can find the p4 branches in refs/heads.
@@ -524,7 +524,7 @@ Then this `git p4 clone` command:
----
git p4 clone --detect-branches //depot@all
----
-produces a separate branch in 'refs/remotes/p4/' for //depot/main,
+produces a separate branch in `refs/remotes/p4/` for //depot/main,
called `master`, and one for //depot/branch1 called `depot/branch1`.
However, it is not necessary to create branches in p4 to be able to use
@@ -593,7 +593,7 @@ Clone and sync variables
git-p4.syncFromOrigin::
Because importing commits from other Git repositories is much faster
than importing them from p4, a mechanism exists to find p4 changes
- first in Git remotes. If branches exist under 'refs/remote/origin/p4',
+ first in Git remotes. If branches exist under `refs/remote/origin/p4`,
those will be fetched and used when syncing from p4. This
variable can be set to 'false' to disable this behavior.
@@ -719,7 +719,7 @@ git-p4.allowSubmit::
By default, any branch can be used as the source for a `git p4
submit` operation. This configuration variable, if set, permits only
the named branches to be used as submit sources. Branch names
- must be the short names (no "refs/heads/"), and should be
+ must be the short names (no `refs/heads/`), and should be
separated by commas (","), with no spaces.
git-p4.skipUserNameCheck::
diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index e98e1f858b..118fdeac35 100644
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -35,8 +35,8 @@ each object that a delta depends upon must be present within the pack.
A pack index file (.idx) is generated for fast, random access to the
objects in the pack. Placing both the index file (.idx) and the packed
-archive (.pack) in the pack/ subdirectory of $GIT_OBJECT_DIRECTORY (or
-any of the directories on $GIT_ALTERNATE_OBJECT_DIRECTORIES)
+archive (.pack) in the pack/ subdirectory of `$GIT_OBJECT_DIRECTORY` (or
+any of the directories on `$GIT_ALTERNATE_OBJECT_DIRECTORIES`)
enables Git to read from the pack archive.
The `git unpack-objects` command can read the packed archive and
diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt
index 169bcfb07f..f77bd0e27f 100644
--- a/Documentation/git-pack-refs.txt
+++ b/Documentation/git-pack-refs.txt
@@ -14,7 +14,7 @@ DESCRIPTION
-----------
Traditionally, tips of branches and tags (collectively known as
-'refs') were stored one file per ref in a (sub)directory
+`refs`) were stored one file per ref in a (sub)directory
under `$GIT_DIR/refs`
directory. While many branch tips tend to be updated often,
most tags and some branch tips are never updated. When a
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index 842cbbaeca..7811e2c73b 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -229,7 +229,7 @@ already exists on the remote side.
Path to the `git-receive-pack` program on the remote
end. Sometimes useful when pushing to a remote
repository over ssh, and you do not have the program in
- a directory on the default $PATH.
+ a directory on the default `$PATH`.
--[no-]force-with-lease::
--force-with-lease=<refname>::
diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index 380f87b6e8..2b2bd665e0 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -164,18 +164,18 @@ run after `git read-tree`.
Two Tree Merge
~~~~~~~~~~~~~~
-Typically, this is invoked as `git read-tree -m $H $M`, where $H
-is the head commit of the current repository, and $M is the head
-of a foreign tree, which is simply ahead of $H (i.e. we are in a
+Typically, this is invoked as `git read-tree -m $H $M`, where `$H`
+is the head commit of the current repository, and `$M` is the head
+of a foreign tree, which is simply ahead of `$H` (i.e. we are in a
fast-forward situation).
When two trees are specified, the user is telling `git read-tree`
the following:
- 1. The current index and work tree is derived from $H, but
- the user may have local changes in them since $H.
+ 1. The current index and work tree is derived from `$H`, but
+ the user may have local changes in them since `$H`.
- 2. The user wants to fast-forward to $M.
+ 2. The user wants to fast-forward to `$M`.
In this case, the `git read-tree -m $H $M` command makes sure
that no local change is lost as the result of this "merge".
@@ -234,7 +234,7 @@ see which of the "local changes" that you made were carried forward by running
`git diff-index --cached $M`. Note that this does not
necessarily match what `git diff-index --cached $H` would have
produced before such a two tree merge. This is because of cases
-18 and 19 --- if you already had the changes in $M (e.g. maybe
+18 and 19 --- if you already had the changes in `$M` (e.g. maybe
you picked it up via e-mail in a patch form), `git diff-index
--cached $H` would have told you about the change before this
merge, but it would not show in `git diff-index --cached $M`
@@ -245,7 +245,7 @@ rule logically should be to remove the path if the user staged the removal
of the path and then switching to a new branch. That however will prevent
the initial checkout from happening, so the rule is modified to use M (new
tree) only when the content of the index is empty. Otherwise the removal
-of the path is kept as long as $H and $M are the same.
+of the path is kept as long as `$H` and `$M` are the same.
3-Way Merge
~~~~~~~~~~~
@@ -356,9 +356,9 @@ $ git fetch git://.... linus
$ LT=`git rev-parse FETCH_HEAD`
----------------
-Your work tree is still based on your `HEAD` ($JC), but you have
+Your work tree is still based on your `HEAD` (`$JC`), but you have
some edits since. Three-way merge makes sure that you have not
-added or modified index entries since $JC, and if you haven't,
+added or modified index entries since `$JC`, and if you haven't,
then does the right thing. So with the following sequence:
----------------
@@ -368,7 +368,7 @@ $ echo "Merge with Linus" | \
git commit-tree `git write-tree` -p $JC -p $LT
----------------
-what you would commit is a pure merge between $JC and $LT without
+what you would commit is a pure merge between `$JC` and `$LT` without
your work-in-progress changes, and your work tree would be
updated to the result of the merge.
diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt
index 5fc47a9ebd..921f658bd8 100644
--- a/Documentation/git-receive-pack.txt
+++ b/Documentation/git-receive-pack.txt
@@ -43,14 +43,14 @@ OPTIONS
PRE-RECEIVE HOOK
----------------
-Before any ref is updated, if $GIT_DIR/hooks/pre-receive file exists
+Before any ref is updated, if `$GIT_DIR/hooks/pre-receive` file exists
and is executable, it will be invoked once with no parameters. The
standard input of the hook will be one line per ref to be updated:
sha1-old SP sha1-new SP refname LF
-The refname value is relative to $GIT_DIR; e.g. for the master
-head this is "refs/heads/master". The two sha1 values before
+The refname value is relative to `$GIT_DIR`; e.g. for the master
+head this is `refs/heads/master`. The two sha1 values before
each refname are the object names for the refname before and after
the update. Refs to be created will have sha1-old equal to 0\{40},
while refs to be deleted will have sha1-new equal to 0\{40}, otherwise
@@ -118,13 +118,13 @@ See the notes on the quarantine environment below.
UPDATE HOOK
-----------
-Before each ref is updated, if $GIT_DIR/hooks/update file exists
+Before each ref is updated, if `$GIT_DIR/hooks/update` file exists
and is executable, it is invoked once per ref, with three parameters:
$GIT_DIR/hooks/update refname sha1-old sha1-new
-The refname parameter is relative to $GIT_DIR; e.g. for the master
-head this is "refs/heads/master". The two sha1 arguments are
+The refname parameter is relative to `$GIT_DIR`; e.g. for the master
+head this is `refs/heads/master`. The two sha1 arguments are
the object names for the refname before and after the update.
Note that the hook is called before the refname is updated,
so either sha1-old is 0\{40} (meaning there is no such ref yet),
@@ -141,15 +141,15 @@ this hook. Consider using the post-receive hook instead.
POST-RECEIVE HOOK
-----------------
After all refs were updated (or attempted to be updated), if any
-ref update was successful, and if $GIT_DIR/hooks/post-receive
+ref update was successful, and if `$GIT_DIR/hooks/post-receive`
file exists and is executable, it will be invoked once with no
parameters. The standard input of the hook will be one line
for each successfully updated ref:
sha1-old SP sha1-new SP refname LF
-The refname value is relative to $GIT_DIR; e.g. for the master
-head this is "refs/heads/master". The two sha1 values before
+The refname value is relative to `$GIT_DIR`; e.g. for the master
+head this is `refs/heads/master`. The two sha1 values before
each refname are the object names for the refname before and after
the update. Refs that were created will have sha1-old equal to
0\{40}, while refs that were deleted will have sha1-new equal to
diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 4df63cad06..318b2220a2 100644
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -72,8 +72,8 @@ With `-m <master>` option, a symbolic-ref `refs/remotes/<name>/HEAD` is set
up to point at remote's `<master>` branch. See also the set-head command.
+
When a fetch mirror is created with `--mirror=fetch`, the refs will not
-be stored in the 'refs/remotes/' namespace, but rather everything in
-'refs/' on the remote will be directly mirrored into 'refs/' in the
+be stored in the `refs/remotes/` namespace, but rather everything in
+`refs/` on the remote will be directly mirrored into `refs/` in the
local repository. This option only makes sense in bare repositories,
because a fetch would overwrite any local commits.
+
diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt
index eb7d765e5d..19ca46df30 100644
--- a/Documentation/git-restore.txt
+++ b/Documentation/git-restore.txt
@@ -104,7 +104,7 @@ in linkgit:git-checkout[1] for details.
--ignore-skip-worktree-bits::
In sparse checkout mode, by default is to only update entries
matched by `<pathspec>` and sparse patterns in
- $GIT_DIR/info/sparse-checkout. This option ignores the sparse
+ `$GIT_DIR/info/sparse-checkout`. This option ignores the sparse
patterns and unconditionally restores any files in
`<pathspec>`.
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index 9908f3020f..bbace2dc5e 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -157,7 +157,7 @@ for another option.
explicitly disambiguating "heads/master" form, when you
want to name the `master` branch when there is an
unfortunately named tag "master"), and show them as full
- refnames (e.g. "refs/heads/master").
+ refnames (e.g. `refs/heads/master`).
Options for Objects
~~~~~~~~~~~~~~~~~~~
@@ -243,10 +243,10 @@ print a message to stderr and exit with nonzero status.
to the real repository is printed.
--git-path <path>::
- Resolve "$GIT_DIR/<path>" and takes other path relocation
- variables such as $GIT_OBJECT_DIRECTORY,
- $GIT_INDEX_FILE... into account. For example, if
- $GIT_OBJECT_DIRECTORY is set to /foo/bar then `git rev-parse
+ Resolve `$GIT_DIR/<path>` and takes other path relocation
+ variables such as `$GIT_OBJECT_DIRECTORY`,
+ `$GIT_INDEX_FILE`... into account. For example, if
+ `$GIT_OBJECT_DIRECTORY` is set to /foo/bar then `git rev-parse
--git-path objects/abc` returns /foo/bar/abc.
--show-toplevel::
@@ -461,13 +461,13 @@ EXAMPLES
$ git rev-parse --verify HEAD
------------
-* Print the commit object name from the revision in the $REV shell variable:
+* Print the commit object name from the revision in the `$REV` shell variable:
+
------------
$ git rev-parse --verify --end-of-options $REV^{commit}
------------
+
-This will error out if $REV is empty or not a valid revision.
+This will error out if `$REV` is empty or not a valid revision.
* Similar to above:
+
@@ -475,7 +475,7 @@ This will error out if $REV is empty or not a valid revision.
$ git rev-parse --default master --verify --end-of-options $REV
------------
+
-but if $REV is empty, the commit object name from `master` will be printed.
+but if `$REV` is empty, the commit object name from `master` will be printed.
GIT
---
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 916bd441d4..9455d4c654 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -216,7 +216,7 @@ a password is obtained using `git-credential`.
the program must support the `-i` option. Default value can
be specified by the `sendemail.smtpServer` configuration
option; the built-in default is to search for `sendmail` in
- `/usr/sbin`, `/usr/lib` and $PATH if such program is
+ `/usr/sbin`, `/usr/lib` and `$PATH` if such program is
available, falling back to `localhost` otherwise.
--smtp-server-port=<port>::
diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt
index 46f7757b9a..c0303d72eb 100644
--- a/Documentation/git-send-pack.txt
+++ b/Documentation/git-send-pack.txt
@@ -29,7 +29,7 @@ OPTIONS
Path to the `git-receive-pack` program on the remote
end. Sometimes useful when pushing to a remote
repository over ssh, and you do not have the program in
- a directory on the default $PATH.
+ a directory on the default `$PATH`.
--exec=<git-receive-pack>::
Same as `--receive-pack`=<git-receive-pack>.
@@ -133,7 +133,7 @@ name. See linkgit:git-rev-parse[1].
- If <dst> does not match any remote ref, either
- * it has to start with "refs/"; <dst> is used as the
+ * it has to start with `refs/`; <dst> is used as the
destination literally in this case.
* <src> == <dst> and the ref that matched the <src> must not
diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index 5531c435b0..79f65ce0aa 100644
--- a/Documentation/git-show-branch.txt
+++ b/Documentation/git-show-branch.txt
@@ -134,7 +134,7 @@ OUTPUT
------
Given N <references>, the first N lines are the one-line
description from their commit message. The branch head that is
-pointed at by $GIT_DIR/HEAD is prefixed with an asterisk `*`
+pointed at by `$GIT_DIR/HEAD` is prefixed with an asterisk `*`
character while other heads are prefixed with a `!` character.
Following these N lines, one-line log for each commit is
diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index 28be080b96..2a3699cb7f 100644
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -40,9 +40,9 @@ OPTIONS
--heads::
--tags::
- Limit to "refs/heads" and "refs/tags", respectively. These options
+ Limit to `refs/heads` and `refs/tags`, respectively. These options
are not mutually exclusive; when given both, references stored in
- "refs/heads" and "refs/tags" are displayed.
+ `refs/heads` and `refs/tags` are displayed.
-d::
--dereference::
@@ -89,9 +89,9 @@ OPTIONS
Show references matching one or more patterns. Patterns are matched from
the end of the full name, and only complete parts are matched, e.g.
- 'master' matches 'refs/heads/master', 'refs/remotes/origin/master',
- 'refs/tags/jedi/master' but not 'refs/heads/mymaster' or
- 'refs/remotes/master/jedi'.
+ 'master' matches `refs/heads/master`, `refs/remotes/origin/master`,
+ `refs/tags/jedi/master` but not `refs/heads/mymaster` or
+ `refs/remotes/master/jedi`.
OUTPUT
------
@@ -131,7 +131,7 @@ use:
git show-ref master
-----------------------------------------------------------------------------
-This will show "refs/heads/master" but also "refs/remote/other-repo/master",
+This will show `refs/heads/master` but also `refs/remote/other-repo/master`,
if such references exists.
When using the `--verify` flag, the command requires an exact path:
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 0a691b1df0..6cbf6a9ba1 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -205,17 +205,17 @@ information too.
foreach [--recursive] <command>::
Evaluates an arbitrary shell command in each checked out submodule.
- The command has access to the variables $name, $sm_path, $displaypath,
- $sha1 and $toplevel:
- $name is the name of the relevant submodule section in `.gitmodules`,
- $sm_path is the path of the submodule as recorded in the immediate
- superproject, $displaypath contains the relative path from the
+ The command has access to the variables `$name`, `$sm_path`, `$displaypath`,
+ `$sha1` and `$toplevel`:
+ `$name` is the name of the relevant submodule section in `.gitmodules`,
+ `$sm_path` is the path of the submodule as recorded in the immediate
+ superproject, `$displaypath` contains the relative path from the
current working directory to the submodules root directory,
$sha1 is the commit as recorded in the immediate
- superproject, and $toplevel is the absolute path to the top-level
+ superproject, and `$toplevel` is the absolute path to the top-level
of the immediate superproject.
- Note that to avoid conflicts with '$PATH' on Windows, the '$path'
- variable is now a deprecated synonym of '$sm_path' variable.
+ Note that to avoid conflicts with `$PATH` on Windows, the `$path`
+ variable is now a deprecated synonym of `$sm_path` variable.
Any submodules defined in the superproject but not checked out are
ignored by this command. Unless given `--quiet`, foreach prints the name
of each submodule before evaluating the command.
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 2e1e3348c7..727ea0603c 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -81,7 +81,7 @@ COMMANDS
specified, the prefix must include a trailing slash.
Setting a prefix (with a trailing slash) is strongly
encouraged in any case, as your SVN-tracking refs will
- then be located at "refs/remotes/$prefix/*", which is
+ then be located at `refs/remotes/$prefix/*`, which is
compatible with Git's own remote-tracking ref layout
(refs/remotes/$remote/*). Setting a prefix is also useful
if you wish to track multiple projects that share a common
@@ -89,7 +89,7 @@ COMMANDS
By default, the prefix is set to 'origin/'.
+
NOTE: Before Git v2.0, the default prefix was "" (no prefix). This
-meant that SVN-tracking refs were put at "refs/remotes/*", which is
+meant that SVN-tracking refs were put at `refs/remotes/*`, which is
incompatible with how Git's own remote-tracking refs are organized.
If you still want the old default, you can get it by passing
`--prefix ""` on the command line (`--prefix=""` may not work if
@@ -122,11 +122,11 @@ your Perl's Getopt::Long is < v2.37).
`fetch`::
Fetch unfetched revisions from the Subversion remote we are
tracking. The name of the [svn-remote "..."] section in the
- $GIT_DIR/config file may be specified as an optional
+ `$GIT_DIR/config` file may be specified as an optional
command-line argument.
+
This automatically updates the rev_map if needed (see
-'$GIT_DIR/svn/\**/.rev_map.*' in the FILES section below for details).
+`$GIT_DIR/svn/\**/.rev_map.*` in the FILES section below for details).
--localtime;;
Store Git commit times in the local time zone instead of UTC. This
@@ -144,7 +144,7 @@ the same local time zone.
--ignore-refs=<regex>;;
Ignore refs for branches or tags matching the Perl regular
- expression. A "negative look-ahead assertion" like
+ expression. A negative look-ahead assertion like
`^refs/remotes/origin/(?!tags/wanted-tag|wanted-branch).*$`
can be used to allow only certain refs.
+
@@ -239,7 +239,7 @@ Like `git rebase`; this requires that the working tree be clean
and have no uncommitted changes.
+
This automatically updates the rev_map if needed (see
-'$GIT_DIR/svn/\**/.rev_map.*' in the FILES section below for details).
+`$GIT_DIR/svn/\**/.rev_map.*` in the FILES section below for details).
-l;;
--local;;
@@ -439,11 +439,11 @@ Any other arguments are passed directly to `git log`
`show-ignore`::
Recursively finds and lists the svn:ignore property on
directories. The output is suitable for appending to
- the $GIT_DIR/info/exclude file.
+ the `$GIT_DIR/info/exclude` file.
`mkdirs`::
Attempts to recreate empty directories that core Git cannot track
- based on information in $GIT_DIR/svn/<refname>/unhandled.log files.
+ based on information in `$GIT_DIR/svn/<refname>/unhandled.log` files.
Empty directories are automatically recreated when using
`git svn clone` and `git svn rebase`, so `mkdirs` is intended
for use after commands like `git checkout` or `git reset`.
@@ -509,8 +509,8 @@ This will set the property 'svn:keywords' to 'FreeBSD=%H' for the file
specific revision.
`gc`::
- Compress $GIT_DIR/svn/<refname>/unhandled.log files and remove
- $GIT_DIR/svn/<refname>/index files.
+ Compress `$GIT_DIR/svn/<refname>/unhandled.log` files and remove
+ `$GIT_DIR/svn/<refname>/index` files.
`reset`::
Undoes the effects of `fetch` back to the specified revision.
@@ -524,7 +524,7 @@ This will set the property 'svn:keywords' to 'FreeBSD=%H' for the file
way to repair the repo is to use `reset`.
+
Only the rev_map and refs/remotes/git-svn are changed (see
-'$GIT_DIR/svn/\**/.rev_map.*' in the FILES section below for details).
+`$GIT_DIR/svn/\**/.rev_map.*` in the FILES section below for details).
Follow 'reset' with a `fetch` and then `git reset` or `git rebase` to
move local branches onto the new tree.
@@ -662,7 +662,7 @@ config key: `svn.authorsfile`
Due to historical reasons a relative 'filename' is first searched
relative to the current directory for `init` and `clone` and relative
to the root of the working tree for `fetch`. If 'filename' is
-not found, it is searched like any other command in '$PATH'.
+not found, it is searched like any other command in `$PATH`.
+
[verse]
config key: `svn.authorsProg`
@@ -761,7 +761,7 @@ svn-remote.<name>.noMetadata::
+
This option can only be used for one-shot imports as `git svn`
will not be able to fetch again without metadata. Additionally,
-if you lose your '$GIT_DIR/svn/\**/.rev_map.*' files, `git svn` will not
+if you lose your `$GIT_DIR/svn/\**/.rev_map.*` files, `git svn` will not
be able to rebuild them.
+
The `git svn log` command will not work on repositories using
@@ -1055,7 +1055,7 @@ When using multiple `--branches` or `--tags`, `git svn` does not automatically
handle name collisions (for example, if two branches from different paths have
the same name, or if a branch and a tag have the same name). In these cases,
use `init` to set up your Git repository then, before your first `fetch`, edit
-the $GIT_DIR/config file so that the branches and tags are associated
+the `$GIT_DIR/config` file so that the branches and tags are associated
with different name spaces. For example:
branches = stable/*:refs/remotes/svn/stable/*
@@ -1065,7 +1065,7 @@ BUGS
----
We ignore all SVN properties except svn:executable. Any unhandled
-properties are logged to $GIT_DIR/svn/<refname>/unhandled.log
+properties are logged to `$GIT_DIR/svn/<refname>/unhandled.log`
Renamed and copied directories are not detected by Git and hence not
tracked when committing to SVN. I do not plan on adding support for
@@ -1084,7 +1084,7 @@ CONFIGURATION
-------------
`git svn` stores [svn-remote] configuration information in the
-repository $GIT_DIR/config file. It is similar the core Git
+repository `$GIT_DIR/config` file. It is similar the core Git
[remote] sections except `fetch` keys do not accept glob
arguments; but they are instead handled by the 'branches'
and 'tags' keys. Since some SVN repositories are oddly
@@ -1150,12 +1150,12 @@ $ git svn branch -d branches/server release-2-3-0
Note that `git-svn` keeps track of the highest revision in which a branch
or tag has appeared. If the subset of branches or tags is changed after
-fetching, then $GIT_DIR/svn/.metadata must be manually edited to remove
+fetching, then `$GIT_DIR/svn/.metadata` must be manually edited to remove
(or reset) branches-maxRev and/or tags-maxRev as appropriate.
FILES
-----
-$GIT_DIR/svn/\**/.rev_map.*::
+`$GIT_DIR/svn/\**/.rev_map.*`::
Mapping between Subversion revision numbers and Git commit
names. In a repository where the noMetadata option is not set,
this can be rebuilt from the git-svn-id: lines that are at the
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index ec501232ad..02adf7aa81 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -178,7 +178,7 @@ may not support it yet.
--no-split-index::
Enable or disable split index mode. If split-index mode is
already enabled and `--split-index` is given again, all
- changes in $GIT_DIR/index are pushed back to the shared index
+ changes in `$GIT_DIR/index` are pushed back to the shared index
file.
+
These options take effect whatever the value of the `core.splitIndex`
@@ -415,9 +415,9 @@ SPLIT INDEX
This mode is designed for repositories with very large indexes, and
aims at reducing the time it takes to repeatedly write these indexes.
-In this mode, the index is split into two files, $GIT_DIR/index and
-$GIT_DIR/sharedindex.<SHA-1>. Changes are accumulated in
-$GIT_DIR/index, the split index, while the shared index file contains
+In this mode, the index is split into two files, `$GIT_DIR/index` and
+`$GIT_DIR/sharedindex.<SHA-1>`. Changes are accumulated in
+`$GIT_DIR/index`, the split index, while the shared index file contains
all index entries and stays unchanged.
All changes in the split index are pushed back to the shared index
diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index 3ad7771676..794dea70ec 100644
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -32,7 +32,7 @@ ref file by starting with the four-byte header sequence of
More importantly, it allows the update of a ref file to follow
these symbolic pointers, whether they are symlinks or these
"regular file symbolic refs". It follows *real* symlinks only
-if they start with "refs/": otherwise it will just try to read
+if they start with `refs/`: otherwise it will just try to read
them and update them as a regular file (i.e. it will allow the
filesystem to follow them, but will overwrite such a symlink to
somewhere else with a regular filename).
@@ -49,7 +49,7 @@ should be a _lot_ safer than doing
echo "$head" > "$GIT_DIR/HEAD"
both from a symlink following standpoint *and* an error checking
-standpoint. The "refs/" rule for symlinks means that symlinks
+standpoint. The `refs/` rule for symlinks means that symlinks
that point to "outside" the tree are safe: they'll be followed
for reading but not for writing (so we'll never write through a
ref symlink to some other tree, if you have copied a whole
@@ -150,10 +150,10 @@ still see a subset of the modifications.
LOGGING UPDATES
---------------
If config parameter `core.logAllRefUpdates` is true and the ref is one
-under "refs/heads/", "refs/remotes/", "refs/notes/", or a pseudoref
-like `HEAD` or `ORIG_HEAD`; or the file "$GIT_DIR/logs/<ref>" exists then
+under `refs/heads/`, `refs/remotes/`, `refs/notes/`, or a pseudoref
+like `HEAD` or `ORIG_HEAD`; or the file `$GIT_DIR/logs/<ref>` exists then
`git update-ref` will append a line to the log file
-"$GIT_DIR/logs/<ref>" (dereferencing all symbolic refs before creating
+`$GIT_DIR/logs/<ref>` (dereferencing all symbolic refs before creating
the log name) describing the change in ref value. Log lines are
formatted as:
diff --git a/Documentation/git-update-server-info.txt b/Documentation/git-update-server-info.txt
index 8dbb1a6172..426d12da36 100644
--- a/Documentation/git-update-server-info.txt
+++ b/Documentation/git-update-server-info.txt
@@ -14,8 +14,8 @@ SYNOPSIS
DESCRIPTION
-----------
A dumb server that does not do on-the-fly pack generations must
-have some auxiliary information files in $GIT_DIR/info and
-$GIT_OBJECT_DIRECTORY/info directories to help clients discover
+have some auxiliary information files in `$GIT_DIR/info` and
+`$GIT_OBJECT_DIRECTORY/info` directories to help clients discover
what references and packs the server has. This command
generates such auxiliary files.
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 6486abdd4d..4c6fca3128 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -122,7 +122,7 @@ sensitive information can be part of the key.
-p::
--paginate::
- Pipe all output into 'less' (or if set, $PAGER) if standard
+ Pipe all output into 'less' (or if set, `$PAGER`) if standard
output is a terminal. This overrides the `pager.<cmd>`
configuration options (see the "Configuration Mechanism" section
below).
@@ -515,9 +515,9 @@ double-quotes and respecting backslash escapes. E.g., the value
`GIT_COMMON_DIR`::
If this variable is set to a path, non-worktree files that are
- normally in $GIT_DIR will be taken from this path
+ normally in `$GIT_DIR` will be taken from this path
instead. Worktree-specific files such as `HEAD` or index are
- taken from $GIT_DIR. See linkgit:gitrepository-layout[5] and
+ taken from `$GIT_DIR`. See linkgit:gitrepository-layout[5] and
linkgit:git-worktree[1] for
details. This variable has lower precedence than other path
variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
index bd1cd2629c..a5cfef7f86 100644
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt
@@ -7,7 +7,7 @@ gitattributes - Defining attributes per path
SYNOPSIS
--------
-$GIT_DIR/info/attributes, `.gitattributes`
+`$GIT_DIR/info/attributes`, `.gitattributes`
DESCRIPTION
@@ -90,8 +90,8 @@ repositories (i.e., attributes of interest to all users) should go into
`.gitattributes` files. Attributes that should affect all repositories
for a single user should be placed in a file specified by the
`core.attributesFile` configuration option (see linkgit:git-config[1]).
-Its default value is $XDG_CONFIG_HOME/git/attributes. If $XDG_CONFIG_HOME
-is either not set or empty, $HOME/.config/git/attributes is used instead.
+Its default value is `$XDG_CONFIG_HOME/git/attributes`. If `$XDG_CONFIG_HOME`
+is either not set or empty, `$HOME/.config/git/attributes` is used instead.
Attributes for all users on a system should be placed in the
`$(prefix)/etc/gitattributes` file.
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index 8cee030fbd..ce1aa25d5a 100644
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -7,7 +7,7 @@ githooks - Hooks used by Git
SYNOPSIS
--------
-$GIT_DIR/hooks/* (or \`git config core.hooksPath`/*)
+`$GIT_DIR/hooks/*` (or \`git config core.hooksPath`/*)
DESCRIPTION
@@ -22,10 +22,10 @@ changed via the `core.hooksPath` configuration variable (see
linkgit:git-config[1]).
Before Git invokes a hook, it changes its working directory to either
-$GIT_DIR in a bare repository or the root of the working tree in a non-bare
+`$GIT_DIR` in a bare repository or the root of the working tree in a non-bare
repository. An exception are hooks triggered during a push ('pre-receive',
'update', 'post-receive', 'post-update', 'push-to-checkout') which are always
-executed in $GIT_DIR.
+executed in `$GIT_DIR`.
Hooks can get their arguments via the environment, command-line
arguments, and stdin. See the documentation for each hook below for
diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
index 7488cdb585..6dd09bd290 100644
--- a/Documentation/gitignore.txt
+++ b/Documentation/gitignore.txt
@@ -7,7 +7,7 @@ gitignore - Specifies intentionally untracked files to ignore
SYNOPSIS
--------
-$XDG_CONFIG_HOME/git/ignore, $GIT_DIR/info/exclude, `.gitignore`
+`$XDG_CONFIG_HOME/git/ignore`, `$GIT_DIR/info/exclude`, `.gitignore`
DESCRIPTION
-----------
@@ -57,8 +57,8 @@ be used.
ignore in all situations (e.g., backup or temporary files generated by
the user's editor of choice) generally go into a file specified by
`core.excludesFile` in the user's `~/.gitconfig`. Its default value is
- $XDG_CONFIG_HOME/git/ignore. If $XDG_CONFIG_HOME is either not set or
- empty, $HOME/.config/git/ignore is used instead.
+ `$XDG_CONFIG_HOME/git/ignore`. If `$XDG_CONFIG_HOME` is either not set or
+ empty, `$HOME/.config/git/ignore` is used instead.
The underlying Git plumbing tools, such as
`git ls-files` and `git read-tree`, read
diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index 41eb7a6577..bc0cb104cc 100644
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -158,7 +158,7 @@ User configuration and preferences are stored at:
* `$HOME/.gitk` if it exists
If neither of the above exist then `$XDG_CONFIG_HOME/git/gitk` is created and
-used by default. If '$XDG_CONFIG_HOME' is not set it defaults to
+used by default. If `$XDG_CONFIG_HOME` is not set it defaults to
`$HOME/.config` in all cases.
History
diff --git a/Documentation/gitmailmap.txt b/Documentation/gitmailmap.txt
index 3fb39f801f..8f9c3ac65b 100644
--- a/Documentation/gitmailmap.txt
+++ b/Documentation/gitmailmap.txt
@@ -7,7 +7,7 @@ gitmailmap - Map author/committer names and/or E-Mail addresses
SYNOPSIS
--------
-$GIT_WORK_TREE/.mailmap
+`$GIT_WORK_TREE/.mailmap`
DESCRIPTION
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index 2c1e847076..ea6b4427c6 100644
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -7,7 +7,7 @@ gitmodules - Defining submodule properties
SYNOPSIS
--------
-$GIT_WORK_TREE/.gitmodules
+`$GIT_WORK_TREE/.gitmodules`
DESCRIPTION
diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt
index 39cfebccf3..95a98f7802 100644
--- a/Documentation/gitrepository-layout.txt
+++ b/Documentation/gitrepository-layout.txt
@@ -7,7 +7,7 @@ gitrepository-layout - Git Repository Layout
SYNOPSIS
--------
-$GIT_DIR/*
+`$GIT_DIR/*`
DESCRIPTION
-----------
@@ -47,8 +47,8 @@ use with dumb transports but otherwise is OK as long as
`objects/info/alternates` points at the object stores it
borrows from.
+
-This directory is ignored if $GIT_COMMON_DIR is set and
-"$GIT_COMMON_DIR/objects" will be used instead.
+This directory is ignored if `$GIT_COMMON_DIR` is set and
+`$GIT_COMMON_DIR/objects` will be used instead.
objects/[0-9a-f][0-9a-f]::
A newly created object is stored in its own file.
@@ -97,8 +97,8 @@ refs::
objects reachable from refs found in this directory and
its subdirectories.
This directory is ignored (except refs/bisect,
- refs/rewritten and refs/worktree) if $GIT_COMMON_DIR is
- set and "$GIT_COMMON_DIR/refs" will be used instead.
+ refs/rewritten and refs/worktree) if `$GIT_COMMON_DIR` is
+ set and `$GIT_COMMON_DIR/refs` will be used instead.
refs/heads/`name`::
records tip-of-the-tree commit objects of branch `name`
@@ -120,8 +120,8 @@ refs/replace/`<obj-sha1>`::
packed-refs::
records the same information as refs/heads/, refs/tags/,
and friends record in a more efficient way. See
- linkgit:git-pack-refs[1]. This file is ignored if $GIT_COMMON_DIR
- is set and "$GIT_COMMON_DIR/packed-refs" will be used instead.
+ linkgit:git-pack-refs[1]. This file is ignored if `$GIT_COMMON_DIR`
+ is set and `$GIT_COMMON_DIR/packed-refs` will be used instead.
HEAD::
A symref (see glossary) to the `refs/heads/` namespace
@@ -142,7 +142,7 @@ for details.
config::
Repository specific configuration file. This file is ignored
- if $GIT_COMMON_DIR is set and "$GIT_COMMON_DIR/config" will be
+ if `$GIT_COMMON_DIR` is set and `$GIT_COMMON_DIR/config` will be
used instead.
config.worktree::
@@ -158,8 +158,8 @@ branches::
'repository' argument. See the REMOTES section in
linkgit:git-fetch[1] for details. This mechanism is legacy
and not likely to be found in modern repositories. This
- directory is ignored if $GIT_COMMON_DIR is set and
- "$GIT_COMMON_DIR/branches" will be used instead.
+ directory is ignored if `$GIT_COMMON_DIR` is set and
+ `$GIT_COMMON_DIR/branches` will be used instead.
hooks::
@@ -169,12 +169,12 @@ hooks::
default. To enable, the `.sample` suffix has to be
removed from the filename by renaming.
Read linkgit:githooks[5] for more details about
- each hook. This directory is ignored if $GIT_COMMON_DIR is set
- and "$GIT_COMMON_DIR/hooks" will be used instead.
+ each hook. This directory is ignored if `$GIT_COMMON_DIR` is set
+ and `$GIT_COMMON_DIR/hooks` will be used instead.
common::
When multiple working trees are used, most of files in
- $GIT_DIR are per-worktree with a few known exceptions. All
+ `$GIT_DIR` are per-worktree with a few known exceptions. All
files under 'common' however will be shared between all
working trees.
@@ -183,13 +183,13 @@ index::
usually not found in a bare repository.
sharedindex.<SHA-1>::
- The shared index part, to be referenced by $GIT_DIR/index and
+ The shared index part, to be referenced by `$GIT_DIR/index` and
other temporary index files. Only valid in split index mode.
info::
Additional information about the repository is recorded
- in this directory. This directory is ignored if $GIT_COMMON_DIR
- is set and "$GIT_COMMON_DIR/info" will be used instead.
+ in this directory. This directory is ignored if `$GIT_COMMON_DIR`
+ is set and `$GIT_COMMON_DIR/info` will be used instead.
info/refs::
This file helps dumb transports discover what refs are
@@ -234,14 +234,14 @@ remotes::
`git pull` and `git push` commands. See the REMOTES section
in linkgit:git-fetch[1] for details. This mechanism is legacy
and not likely to be found in modern repositories. This
- directory is ignored if $GIT_COMMON_DIR is set and
- "$GIT_COMMON_DIR/remotes" will be used instead.
+ directory is ignored if `$GIT_COMMON_DIR` is set and
+ `$GIT_COMMON_DIR/remotes` will be used instead.
logs::
Records of changes made to refs are stored in this directory.
See linkgit:git-update-ref[1] for more information. This
- directory is ignored (except logs/HEAD) if $GIT_COMMON_DIR is
- set and "$GIT_COMMON_DIR/logs" will be used instead.
+ directory is ignored (except logs/HEAD) if `$GIT_COMMON_DIR` is
+ set and `$GIT_COMMON_DIR/logs` will be used instead.
logs/refs/heads/`name`::
Records all changes made to the branch tip named `name`.
@@ -253,14 +253,14 @@ shallow::
This is similar to `info/grafts` but is internally used
and maintained by shallow clone mechanism. See `--depth`
option to linkgit:git-clone[1] and linkgit:git-fetch[1]. This
- file is ignored if $GIT_COMMON_DIR is set and
- "$GIT_COMMON_DIR/shallow" will be used instead.
+ file is ignored if `$GIT_COMMON_DIR` is set and
+ `$GIT_COMMON_DIR/shallow` will be used instead.
commondir::
- If this file exists, $GIT_COMMON_DIR (see linkgit:git[1]) will
+ If this file exists, `$GIT_COMMON_DIR` (see linkgit:git[1]) will
be set to the path specified in this file if it is not
explicitly set. If the specified path is relative, it is
- relative to $GIT_DIR. The repository with commondir is
+ relative to `$GIT_DIR`. The repository with commondir is
incomplete without the repository pointed by "commondir".
modules::
@@ -270,8 +270,8 @@ worktrees::
Contains administrative data for linked
working trees. Each subdirectory contains the working tree-related
part of a linked working tree. This directory is ignored if
- $GIT_COMMON_DIR is set, in which case
- "$GIT_COMMON_DIR/worktrees" will be used instead.
+ `$GIT_COMMON_DIR` is set, in which case
+ `$GIT_COMMON_DIR/worktrees` will be used instead.
worktrees/<id>/gitdir::
A text file containing the absolute path back to the .git file
diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt
index 891c8da4fd..f1bf6caa3a 100644
--- a/Documentation/gitsubmodules.txt
+++ b/Documentation/gitsubmodules.txt
@@ -7,7 +7,7 @@ gitsubmodules - Mounting one repository inside another
SYNOPSIS
--------
- .gitmodules, $GIT_DIR/config
+ `.gitmodules`, `$GIT_DIR/config`
------------------
git submodule
git <command> --recurse-submodules
diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt
index 5c74907da9..8a8d3f9acf 100644
--- a/Documentation/gitweb.conf.txt
+++ b/Documentation/gitweb.conf.txt
@@ -7,7 +7,7 @@ gitweb.conf - Gitweb (Git web interface) configuration file
SYNOPSIS
--------
-/etc/gitweb.conf, /etc/gitweb-common.conf, $GITWEBDIR/gitweb_config.perl
+`/etc/gitweb.conf`, `/etc/gitweb-common.conf`, `$GITWEBDIR/gitweb_config.perl`
DESCRIPTION
-----------
@@ -117,7 +117,7 @@ Git repositories, and how repositories are displayed and accessed.
See also "Repositories" and later subsections in linkgit:gitweb[1] manpage.
-$projectroot::
+`$projectroot`::
Absolute filesystem path which will be prepended to project path;
the path to repository is `$projectroot/$project`. Set to
`$GITWEB_PROJECTROOT` during installation. This variable has to be
@@ -144,7 +144,7 @@ http://git.example.com/gitweb.cgi/foo/bar.git
+
will map to the path `/srv/git/foo/bar.git` on the filesystem.
-$projects_list::
+`$projects_list`::
Name of a plain text file listing projects, or a name of directory
to be scanned for projects.
+
@@ -159,7 +159,7 @@ The default value of this variable is determined by the `GITWEB_LIST`
makefile variable at installation time. If this variable is empty, `gitweb`
will fall back to scanning the `$projectroot` directory for repositories.
-$project_maxdepth::
+`$project_maxdepth`::
If `$projects_list` variable is unset, `gitweb` will recursively
scan filesystem for Git repositories. The `$project_maxdepth`
is used to limit traversing depth, relative to `$projectroot`
@@ -174,7 +174,7 @@ The default value of this variable is determined by the build-time
configuration variable `GITWEB_PROJECT_MAXDEPTH`, which defaults to
2007.
-$export_ok::
+`$export_ok`::
Show repository only if this file exists (in repository). Only
effective if this variable evaluates to true. Can be set when
building `gitweb` by setting `GITWEB_EXPORT_OK`. This path is
@@ -182,13 +182,13 @@ $export_ok::
unless started with `--export-all`. By default this variable is
not set, which means that this feature is turned off.
-$export_auth_hook::
+`$export_auth_hook`::
Function used to determine which repositories should be shown.
This subroutine should take one parameter, the full path to
a project, and if it returns true, that project will be included
in the projects list and can be accessed through `gitweb` as long
- as it fulfills the other requirements described by $export_ok,
- $projects_list, and $projects_maxdepth. Example:
+ as it fulfills the other requirements described by `$export_ok`,
+ `$projects_list`, and `$projects_maxdepth`. Example:
+
----------------------------------------------------------------------------
our $export_auth_hook = sub { return -e "$_[0]/git-daemon-export-ok"; };
@@ -205,7 +205,7 @@ If not set (default), it means that this feature is disabled.
See also more involved example in "Controlling access to Git repositories"
subsection on linkgit:gitweb[1] manpage.
-$strict_export::
+`$strict_export`::
Only allow viewing of repositories also shown on the overview page.
This for example makes `$export_ok` file decide if repository is
available and not only if it is shown. If `$projects_list` points to
@@ -213,7 +213,7 @@ $strict_export::
available for `gitweb`. Can be set during building `gitweb` via
`GITWEB_STRICT_EXPORT`. By default this variable is not set, which
means that you can directly access those repositories that are hidden
- from projects list page (e.g. the are not listed in the $projects_list
+ from projects list page (e.g. the are not listed in the `$projects_list`
file).
@@ -222,7 +222,7 @@ Finding files
The following configuration variables tell `gitweb` where to find files.
The values of these variables are paths on the filesystem.
-$GIT::
+`$GIT`::
Core `git` executable to use. By default set to `$GIT_BINDIR/git`, which
in turn is by default set to `$(bindir)/git`. If you use Git installed
from a binary package, you should usually set this to "/usr/bin/git".
@@ -232,7 +232,7 @@ $GIT::
which one to use. Must be (correctly) set for `gitweb` to be able to
work.
-$mimetypes_file::
+`$mimetypes_file`::
File to use for (filename extension based) guessing of MIME types before
trying `/etc/mime.types`. *NOTE* that this path, if relative, is taken
as relative to the current Git repository, not to CGI script. If unset,
@@ -240,7 +240,7 @@ $mimetypes_file::
file is found, mimetype guessing based on extension of file is disabled.
Unset by default.
-$highlight_bin::
+`$highlight_bin`::
Path to the highlight executable to use (it must be the one from
http://www.andre-simon.de[] due to assumptions about parameters and output).
By default set to 'highlight'; set it to full path to highlight
@@ -305,7 +305,7 @@ i.e. if CSS minifier is used during build).
used by older `gitweb`. If `$stylesheet` variable is defined, only CSS stylesheet
given by this variable is used by `gitweb`.
-$logo::
+`$logo`::
Points to the location where you put 'git-logo.png' on your web
server, or to be more the generic URI of logo, 72x27 size). This image
is displayed in the top right corner of each `gitweb` page and used as
@@ -313,7 +313,7 @@ $logo::
Can be adjusted when building `gitweb` using `GITWEB_LOGO` variable
By default set to `static/git-logo.png`.
-$favicon::
+`$favicon`::
Points to the location where you put 'git-favicon.png' on your web
server, or to be more the generic URI of favicon, which will be served
as "image/png" type. Web browsers that support favicons (website icons)
@@ -322,7 +322,7 @@ $favicon::
build time using `GITWEB_FAVICON` variable.
By default set to `static/git-favicon.png`.
-$javascript::
+`$javascript`::
Points to the location where you put 'gitweb.js' on your web server,
or to be more generic the URI of JavaScript code used by `gitweb`.
Relative to the base URI of `gitweb`. Can be set at build time using
@@ -333,13 +333,13 @@ the `JSMIN` build variable was defined, i.e. if JavaScript minifier was used
at build time. *Note* that this single file is generated from multiple
individual JavaScript "modules".
-$home_link::
+`$home_link`::
Target of the home link on the top of all pages (the first part of view
"breadcrumbs"). By default it is set to the absolute URI of a current page
- (to the value of `$my_uri` variable, or to "/" if `$my_uri` is undefined
+ (to the value of `$my_uri` variable, or to `/` if `$my_uri` is undefined
or is an empty string).
-$home_link_str::
+`$home_link_str`::
Label for the "home link" at the top of all pages, leading to `$home_link`
(usually the main `gitweb` page, which contains the projects list). It is
used as the first component of gitweb's "breadcrumb trail":
@@ -367,8 +367,8 @@ For example, the following setting produces a breadcrumb trail like
);
----------------------------------------------------------------------------
-$logo_url::
-$logo_label::
+`$logo_url`::
+`$logo_label`::
URI and label (title) for the Git logo link (or your site logo,
if you chose to use different logo image). By default, these both
refer to Git homepage, https://git-scm.com[]; in the past, they pointed
@@ -382,48 +382,48 @@ below. You can change the site name, add common headers and footers for all
pages, and add a description of this `gitweb` installation on its main page
(which is the projects list page), etc.
-$site_name::
+`$site_name`::
Name of your site or organization, to appear in page titles. Set it
to something descriptive for clearer bookmarks etc. If this variable
is not set or is, then `gitweb` uses the value of the `SERVER_NAME`
- `CGI` environment variable, setting site name to "$SERVER_NAME Git",
+ `CGI` environment variable, setting site name to "`$SERVER_NAME` Git",
or "Untitled Git" if this variable is not set (e.g. if running `gitweb`
as standalone script).
+
Can be set using the `GITWEB_SITENAME` at build time. Unset by default.
-$site_html_head_string::
+`$site_html_head_string`::
HTML snippet to be included in the <head> section of each page.
Can be set using `GITWEB_SITE_HTML_HEAD_STRING` at build time.
No default value.
-$site_header::
+`$site_header`::
Name of a file with HTML to be included at the top of each page.
Relative to the directory containing the 'gitweb.cgi' script.
Can be set using `GITWEB_SITE_HEADER` at build time. No default
value.
-$site_footer::
+`$site_footer`::
Name of a file with HTML to be included at the bottom of each page.
Relative to the directory containing the 'gitweb.cgi' script.
Can be set using `GITWEB_SITE_FOOTER` at build time. No default
value.
-$home_text::
+`$home_text`::
Name of a HTML file which, if it exists, is included on the
`gitweb` projects overview page ("projects_list" view). Relative to
the directory containing the gitweb.cgi script. Default value
can be adjusted during build time using `GITWEB_HOMETEXT` variable.
By default set to 'indextext.html'.
-$projects_list_description_width::
+`$projects_list_description_width`::
The width (in characters) of the "Description" column of the projects list.
Longer descriptions will be truncated (trying to cut at word boundary);
the full description is available in the 'title' attribute (usually shown on
mouseover). The default is 25, which might be too small if you
use long project descriptions.
-$default_projects_order::
+`$default_projects_order`::
Default value of ordering of projects on projects list page, which
means the ordering used if you don't explicitly sort projects list
(if there is no "o" CGI query parameter in the URL). Valid values
@@ -439,7 +439,7 @@ Changing gitweb's behavior
~~~~~~~~~~~~~~~~~~~~~~~~~~
These configuration variables control _internal_ `gitweb` behavior.
-$default_blob_plain_mimetype::
+`$default_blob_plain_mimetype`::
Default mimetype for the blob_plain (raw) view, if mimetype checking
doesn't result in some other type; by default "text/plain".
Gitweb guesses mimetype of a file to display based on extension
@@ -447,11 +447,11 @@ $default_blob_plain_mimetype::
and `/etc/mime.types` files (see *mime.types*(5) manpage; only
filename extension rules are supported by `gitweb`).
-$default_text_plain_charset::
+`$default_text_plain_charset`::
Default charset for text files. If this is not set, the web server
configuration will be used. Unset by default.
-$fallback_encoding::
+`$fallback_encoding`::
Gitweb assumes this charset when a line contains non-UTF-8 characters.
The fallback decoding is used without error checking, so it can be even
"utf-8". The value must be a valid encoding; see the *Encoding::Supported*(3pm)
@@ -496,26 +496,26 @@ time by setting the `GITWEB_BASE_URL` build-time configuration variable.
By default it is set to (), i.e. an empty list. This means that `gitweb`
would not try to create project URL (to fetch) from project name.
-$projects_list_group_categories::
+`$projects_list_group_categories`::
Whether to enable the grouping of projects by category on the project
list page. The category of a project is determined by the
`$GIT_DIR/category` file or the `gitweb.category` variable in each
repository's configuration. Disabled by default (set to 0).
-$project_list_default_category::
+`$project_list_default_category`::
Default category for projects for which none is specified. If this is
set to the empty string, such projects will remain uncategorized and
listed at the top, above categorized projects. Used only if project
categories are enabled, which means if `$projects_list_group_categories`
is true. By default set to "" (empty string).
-$prevent_xss::
+`$prevent_xss`::
If true, some `gitweb` features are disabled to prevent content in
repositories from launching cross-site scripting (XSS) attacks. Set this
to true if you don't trust the content of your repositories.
False by default (set to 0).
-$maxload::
+`$maxload`::
Used to set the maximum load that we will still respond to `gitweb` queries.
If the server load exceeds this value then `gitweb` will return
"503 Service Unavailable" error. The server load is taken to be 0
@@ -527,14 +527,14 @@ $maxload::
Set `$maxload` to undefined value (`undef`) to turn this feature off.
The default value is 300.
-$omit_age_column::
+`$omit_age_column`::
If true, omit the column with date of the most current commit on the
projects list page. It can save a bit of I/O and a fork per repository.
-$omit_owner::
+`$omit_owner`::
If true prevents displaying information about repository owner.
-$per_request_config::
+`$per_request_config`::
If this is set to code reference, it will be run once for each request.
You can set parts of configuration that change per session this way.
For example, one might use the following code in a `gitweb` configuration
@@ -567,7 +567,7 @@ variables described below; they should be automatically set by `gitweb` to
correct value.
-$version::
+`$version`::
Gitweb version, set automatically when creating gitweb.cgi from
gitweb.perl. You might want to modify it if you are running modified
`gitweb`, for example
@@ -580,19 +580,19 @@ if you run modified version of `gitweb` with caching support. This variable
is purely informational, used e.g. in the "generator" meta header in HTML
header.
-$my_url::
-$my_uri::
+`$my_url`::
+`$my_uri`::
Full URL and absolute URL of the `gitweb` script;
in earlier versions of `gitweb` you might have need to set those
variables, but now there should be no need to do it. See
`$per_request_config` if you need to set them still.
-$base_url::
+`$base_url`::
Base URL for relative URLs in pages generated by `gitweb`,
(e.g. `$logo`, `$favicon`, `@stylesheets` if they are relative URLs),
needed and used '<base href="$base_url">' only for URLs with nonempty
PATH_INFO. Usually `gitweb` sets its value correctly,
- and there is no need to set this variable, e.g. to $my_uri or "/".
+ and there is no need to set this variable, e.g. to `$my_uri` or "/".
See `$per_request_config` if you need to override it anyway.
@@ -805,7 +805,7 @@ The "default" value consists of a list of triplets in the form
`("<label>", "<link>", "<position>")` where "position" is the label
after which to insert the link, "link" is a format string where `%n`
expands to the project name, `%f` to the project path within the
-filesystem (i.e. "$projectroot/$project"), `%h` to the current hash
+filesystem (i.e. `$projectroot`/`$project`), `%h` to the current hash
(\'h' `gitweb` parameter) and `%b` to the current hash base
(\'hb' `gitweb` parameter); `%%` expands to \'%'.
+
@@ -860,7 +860,7 @@ time zones in the form of "+/-HHMM", such as "+0200".
Project specific override is not supported.
extra-branch-refs::
- List of additional directories under "refs" which are going to
+ List of additional directories under `refs` which are going to
be used as branch refs. For example if you have a gerrit setup
where all branches under refs/heads/ are official,
push-after-review ones and branches under refs/sandbox/,
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index 14abdb843f..f164857d83 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -60,14 +60,14 @@ more exact; `gitweb` is not interested in a working area, and is best suited
to showing "bare" repositories).
The name of the repository in `gitweb` is the path to its `$GIT_DIR` (its object
-database) relative to `$projectroot`. Therefore the repository $repo can be
-found at "$projectroot/$repo".
+database) relative to `$projectroot`. Therefore the repository `$repo` can be
+found at `$projectroot`/`$repo`.
Projects list file format
~~~~~~~~~~~~~~~~~~~~~~~~~
Instead of having `gitweb` find repositories by scanning filesystem
-starting from $projectroot, you can provide a pre-generated list of
+starting from `$projectroot`, you can provide a pre-generated list of
visible projects by setting `$projects_list` to point to a plain text
file with a list of projects (with some additional info).
@@ -182,7 +182,7 @@ fetched from via `git://` protocol.
* Finally, it is possible to specify an arbitrary perl subroutine that will
be called for each repository to determine if it can be exported. The
subroutine receives an absolute path to the project (repository) as its only
-parameter (i.e. "$projectroot/$project").
+parameter (i.e. `$projectroot`/`$project`).
+
For example, if you use mod_perl to run the script, and have dumb
HTTP protocol authentication configured for your repositories, you
diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index 8fef8db89d..cc8bfc5cfb 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -533,7 +533,7 @@ The most notable example is `HEAD`.
[[def_remote_tracking_branch]]remote-tracking branch::
A <<def_ref,ref>> that is used to follow changes from another
<<def_repository,repository>>. It typically looks like
- 'refs/remotes/foo/bar' (indicating that it tracks a branch named
+ `refs/remotes/foo/bar` (indicating that it tracks a branch named
'bar' in a remote named 'foo'), and matches the right-hand-side of
a configured fetch <<def_refspec,refspec>>. A remote-tracking
branch should not contain direct modifications or have local
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index d8a755faf1..e3c3556363 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -217,9 +217,9 @@ The placeholders are:
the same time.
+
** 'match=<pattern>': Only consider tags matching the given
- `glob(7)` pattern, excluding the "refs/tags/" prefix.
+ `glob(7)` pattern, excluding the `refs/tags/` prefix.
** 'exclude=<pattern>': Do not consider tags matching the given
- `glob(7)` pattern, excluding the "refs/tags/" prefix.
+ `glob(7)` pattern, excluding the `refs/tags/` prefix.
'%S':: ref name given on the command line by which the commit was reached
(like `git log --source`), only works with `git log`
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index f8c61dd42e..f055f56c37 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -75,15 +75,15 @@ with `refs/notes/`; when it begins with `notes/`, `refs/` and otherwise
+
Multiple `--notes` options can be combined to control which notes are
being displayed. Examples: `--notes=foo` will show only notes from
-"refs/notes/foo"; `--notes=foo --notes` will show both notes from
-"refs/notes/foo" and from the default notes ref(s).
+`refs/notes/foo`; `--notes=foo --notes` will show both notes from
+`refs/notes/foo` and from the default notes ref(s).
--no-notes::
Do not show notes. This negates the above `--notes` option, by
resetting the list of notes refs from which notes are shown.
Options are parsed in the order given on the command line, so e.g.
`--notes --notes=foo --no-notes --notes=bar` will only show notes
- from "refs/notes/bar".
+ from `refs/notes/bar`.
--show-notes[=<ref>]::
--[no-]standard-notes::
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index e6e9669f68..fb491660d6 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -163,7 +163,7 @@ endif::git-log[]
--glob=<glob-pattern>::
Pretend as if all the refs matching shell glob '<glob-pattern>'
- are listed on the command line as '<commit>'. Leading 'refs/',
+ are listed on the command line as '<commit>'. Leading `refs/`,
is automatically prepended if missing. If pattern lacks '?', '{asterisk}',
or '[', '/{asterisk}' at the end is implied.
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index f1bb9d0877..0614772a76 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -23,27 +23,27 @@ characters and to avoid word splitting.
followed by a dash and a number of commits, followed by a dash, a
'g', and an abbreviated object name.
-'<refname>', e.g. `master`, 'heads/master', 'refs/heads/master'::
+'<refname>', e.g. `master`, 'heads/master', `refs/heads/master`::
A symbolic ref name. E.g. `master` typically means the commit
- object referenced by 'refs/heads/master'. If you
+ object referenced by `refs/heads/master`. If you
happen to have both 'heads/master' and 'tags/master', you can
explicitly say 'heads/master' to tell Git which one you mean.
When ambiguous, a '<refname>' is disambiguated by taking the
first match in the following rules:
- . If '$GIT_DIR/<refname>' exists, that is what you mean (this is usually
+ . If `$GIT_DIR/<refname>` exists, that is what you mean (this is usually
useful only for `HEAD`, `FETCH_HEAD`, `ORIG_HEAD`, `MERGE_HEAD`
and `CHERRY_PICK_HEAD`);
- . otherwise, 'refs/<refname>' if it exists;
+ . otherwise, `refs/<refname>` if it exists;
- . otherwise, 'refs/tags/<refname>' if it exists;
+ . otherwise, `refs/tags/<refname>` if it exists;
- . otherwise, 'refs/heads/<refname>' if it exists;
+ . otherwise, `refs/heads/<refname>` if it exists;
- . otherwise, 'refs/remotes/<refname>' if it exists;
+ . otherwise, `refs/remotes/<refname>` if it exists;
- . otherwise, 'refs/remotes/<refname>/HEAD' if it exists.
+ . otherwise, `refs/remotes/<refname>/HEAD` if it exists.
+
`HEAD` names the commit on which you based the changes in the working tree.
`FETCH_HEAD` records the branch which you fetched from a remote repository
@@ -57,7 +57,7 @@ when you run `git merge`.
`CHERRY_PICK_HEAD` records the commit which you are cherry-picking
when you run `git cherry-pick`.
+
-Note that any of the 'refs/*' cases above may come either from
+Note that any of the `refs/*` cases above may come either from
the `$GIT_DIR/refs` directory or from the `$GIT_DIR/packed-refs` file.
While the ref name encoding is unspecified, UTF-8 is preferred as
some output processing may assume ref names in UTF-8.
@@ -72,7 +72,7 @@ some output processing may assume ref names in UTF-8.
second ago}' or '{1979-02-26 18:30:00}') specifies the value
of the ref at a prior point in time. This suffix may only be
used immediately following a ref name and the ref must have an
- existing log ('$GIT_DIR/logs/<ref>'). Note that this looks up the state
+ existing log (`$GIT_DIR/logs/<ref>`). Note that this looks up the state
of your *local* ref at a given time; e.g., what was in your local
`master` branch last week. If you want to look at commits made during
certain times, see `--since` and `--until`.
@@ -84,7 +84,7 @@ some output processing may assume ref names in UTF-8.
is the immediate prior value of `master` while `master@{5}`
is the 5th prior value of `master`. This suffix may only be used
immediately following a ref name and the ref must have an existing
- log ('$GIT_DIR/logs/<refname>').
+ log (`$GIT_DIR/logs/<refname>`).
'@{<n>}', e.g. '@\{1\}'::
You can use the '@' construct with an empty ref part to get at a
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 09/13] doc: typeset command/option/value entries in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
` (7 preceding siblings ...)
2021-04-09 4:02 ` [RFC PATCH v1 08/13] doc: typeset filepath and $variables " Firmin Martin
@ 2021-04-09 4:02 ` Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 10/13] doc: typeset more command " Firmin Martin
` (4 subsequent siblings)
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Automatically wrap command-line option entries (i.e. something of the form
<entry>[::|;;]<description>) with backticks as indicated in the
CodingGuidelines. As an intended side effect, also wrap with backticks
some configuration options and values entries.
The following command and regex has performed the whole substitution
(without manual intervention).
REGEX="^([[:space:]]*?)[\"']?([][a-zA-Z-=<>]+)[\"']?(::|;;)([[:space:]]+|\$)" &&
perl -pi -e "s/$REGEX/\$1\`\$2\`\$3\$4/g" $(grep -Pl "$REGEX" *.txt --exclude-dir=RelNotes)
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/blame-options.txt | 30 +--
Documentation/config.txt | 12 +-
Documentation/diff-options.txt | 222 +++++++++++------------
Documentation/fetch-options.txt | 88 ++++-----
Documentation/git-add.txt | 66 +++----
Documentation/git-am.txt | 82 ++++-----
Documentation/git-apply.txt | 60 +++---
Documentation/git-archimport.txt | 12 +-
Documentation/git-archive.txt | 30 +--
Documentation/git-bisect.txt | 4 +-
Documentation/git-blame.txt | 22 +--
Documentation/git-branch.txt | 88 ++++-----
Documentation/git-bundle.txt | 14 +-
Documentation/git-cat-file.txt | 36 ++--
Documentation/git-check-attr.txt | 14 +-
Documentation/git-check-ignore.txt | 6 +-
Documentation/git-check-mailmap.txt | 2 +-
Documentation/git-check-ref-format.txt | 6 +-
Documentation/git-checkout-index.txt | 28 +--
Documentation/git-checkout.txt | 66 +++----
Documentation/git-cherry-pick.txt | 42 ++---
Documentation/git-cherry.txt | 8 +-
Documentation/git-clean.txt | 30 +--
Documentation/git-clone.txt | 58 +++---
Documentation/git-commit-graph.txt | 8 +-
Documentation/git-commit-tree.txt | 8 +-
Documentation/git-commit.txt | 106 +++++------
Documentation/git-config.txt | 60 +++---
Documentation/git-count-objects.txt | 8 +-
Documentation/git-cvsexportcommit.txt | 24 +--
Documentation/git-cvsimport.txt | 16 +-
Documentation/git-cvsserver.txt | 16 +-
Documentation/git-daemon.txt | 66 +++----
Documentation/git-describe.txt | 24 +--
Documentation/git-diff-files.txt | 6 +-
Documentation/git-diff-index.txt | 8 +-
Documentation/git-diff-tree.txt | 28 +--
Documentation/git-difftool.txt | 28 +--
Documentation/git-fast-export.txt | 28 +--
Documentation/git-fast-import.txt | 56 +++---
Documentation/git-fetch-pack.txt | 36 ++--
Documentation/git-fetch.txt | 12 +-
Documentation/git-filter-branch.txt | 6 +-
Documentation/git-fmt-merge-msg.txt | 6 +-
Documentation/git-for-each-ref.txt | 54 +++---
Documentation/git-format-patch.txt | 86 ++++-----
Documentation/git-fsck.txt | 28 +--
Documentation/git-gc.txt | 14 +-
Documentation/git-grep.txt | 126 ++++++-------
Documentation/git-gui.txt | 8 +-
Documentation/git-hash-object.txt | 12 +-
Documentation/git-help.txt | 26 +--
Documentation/git-http-backend.txt | 2 +-
Documentation/git-http-fetch.txt | 12 +-
Documentation/git-http-push.txt | 12 +-
Documentation/git-imap-send.txt | 12 +-
Documentation/git-index-pack.txt | 24 +--
Documentation/git-init.txt | 10 +-
Documentation/git-instaweb.txt | 32 ++--
Documentation/git-interpret-trailers.txt | 20 +-
Documentation/git-log.txt | 18 +-
Documentation/git-ls-files.txt | 82 ++++-----
Documentation/git-ls-remote.txt | 28 +--
Documentation/git-ls-tree.txt | 24 +--
Documentation/git-mailinfo.txt | 22 +--
Documentation/git-mailsplit.txt | 16 +-
Documentation/git-maintenance.txt | 30 +--
Documentation/git-merge-base.txt | 12 +-
Documentation/git-merge-file.txt | 10 +-
Documentation/git-merge-index.txt | 6 +-
Documentation/git-merge.txt | 16 +-
Documentation/git-mergetool.txt | 18 +-
Documentation/git-mktag.txt | 2 +-
Documentation/git-mktree.txt | 6 +-
Documentation/git-multi-pack-index.txt | 14 +-
Documentation/git-mv.txt | 14 +-
Documentation/git-name-rev.txt | 16 +-
Documentation/git-notes.txt | 56 +++---
Documentation/git-p4.txt | 38 ++--
Documentation/git-pack-objects.txt | 74 ++++----
Documentation/git-pack-redundant.txt | 6 +-
Documentation/git-pack-refs.txt | 4 +-
Documentation/git-patch-id.txt | 4 +-
Documentation/git-prune-packed.txt | 8 +-
Documentation/git-prune.txt | 10 +-
Documentation/git-pull.txt | 12 +-
Documentation/git-push.txt | 76 ++++----
Documentation/git-quiltimport.txt | 6 +-
Documentation/git-range-diff.txt | 10 +-
Documentation/git-read-tree.txt | 34 ++--
Documentation/git-rebase.txt | 114 ++++++------
Documentation/git-reflog.txt | 20 +-
Documentation/git-remote.txt | 26 +--
Documentation/git-repack.txt | 48 ++---
Documentation/git-replace.txt | 14 +-
Documentation/git-request-pull.txt | 8 +-
Documentation/git-rerere.txt | 10 +-
Documentation/git-reset.txt | 22 +--
Documentation/git-restore.txt | 48 ++---
Documentation/git-rev-parse.txt | 82 ++++-----
Documentation/git-revert.txt | 32 ++--
Documentation/git-rm.txt | 22 +--
Documentation/git-send-email.txt | 84 ++++-----
Documentation/git-send-pack.txt | 26 +--
Documentation/git-sh-i18n.txt | 2 +-
Documentation/git-sh-setup.txt | 4 +-
Documentation/git-shortlog.txt | 20 +-
Documentation/git-show-branch.txt | 38 ++--
Documentation/git-show-ref.txt | 24 +--
Documentation/git-sparse-checkout.txt | 12 +-
Documentation/git-stash.txt | 40 ++--
Documentation/git-status.txt | 42 ++---
Documentation/git-stripspace.txt | 8 +-
Documentation/git-submodule.txt | 56 +++---
Documentation/git-svn.txt | 150 +++++++--------
Documentation/git-switch.txt | 46 ++---
Documentation/git-symbolic-ref.txt | 12 +-
Documentation/git-tag.txt | 62 +++----
Documentation/git-unpack-objects.txt | 10 +-
Documentation/git-update-index.txt | 62 +++----
Documentation/git-update-ref.txt | 18 +-
Documentation/git-upload-pack.txt | 10 +-
Documentation/git-var.txt | 2 +-
Documentation/git-verify-commit.txt | 6 +-
Documentation/git-verify-pack.txt | 8 +-
Documentation/git-verify-tag.txt | 6 +-
Documentation/git-worktree.txt | 44 ++---
Documentation/git-write-tree.txt | 2 +-
Documentation/git.txt | 66 +++----
Documentation/gitattributes.txt | 42 ++---
Documentation/gitcli.txt | 4 +-
Documentation/gitcore-tutorial.txt | 2 +-
Documentation/gitcredentials.txt | 10 +-
Documentation/githooks.txt | 2 +-
Documentation/gitk.txt | 28 +--
Documentation/gitmodules.txt | 8 +-
Documentation/gitremote-helpers.txt | 38 ++--
Documentation/gitrepository-layout.txt | 32 ++--
Documentation/gitweb.conf.txt | 34 ++--
Documentation/gitweb.txt | 44 ++---
Documentation/glossary-content.txt | 12 +-
Documentation/merge-options.txt | 70 +++----
Documentation/merge-strategies.txt | 36 ++--
Documentation/pretty-options.txt | 28 +--
Documentation/rev-list-options.txt | 204 ++++++++++-----------
Documentation/sequencer.txt | 8 +-
Documentation/signoff-option.txt | 6 +-
147 files changed, 2320 insertions(+), 2320 deletions(-)
diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt
index 1d36a176bb..c58d30a648 100644
--- a/Documentation/blame-options.txt
+++ b/Documentation/blame-options.txt
@@ -1,12 +1,12 @@
--b::
+`-b`::
Show blank SHA-1 for boundary commits. This can also
be controlled via the `blame.blankBoundary` config option.
---root::
+`--root`::
Do not treat root commits as boundaries. This can also be
controlled via the `blame.showRoot` config option.
---show-stats::
+`--show-stats`::
Include additional statistics at the end of blame output.
-L <start>,<end>::
@@ -20,10 +20,10 @@
+
include::line-range-format.txt[]
--l::
+`-l`::
Show long rev (Default: off).
--t::
+`-t`::
Show raw timestamp (Default: off).
-S <revs-file>::
@@ -37,26 +37,26 @@ include::line-range-format.txt[]
START. `git blame --reverse START` is taken as `git blame
--reverse START..HEAD` for convenience.
---first-parent::
+`--first-parent`::
Follow only the first parent commit upon seeing a merge
commit. This option can be used to determine when a line
was introduced to a particular integration branch, rather
than when it was introduced to the history overall.
--p::
---porcelain::
+`-p`::
+`--porcelain`::
Show in a format designed for machine consumption.
---line-porcelain::
+`--line-porcelain`::
Show the porcelain format, but output commit information for
each line, not just the first time a commit is referenced.
Implies `--porcelain`.
---incremental::
+`--incremental`::
Show the result incrementally in a format designed for
machine consumption.
---encoding=<encoding>::
+`--encoding=<encoding>`::
Specifies the encoding used to output author names
and commit summaries. Setting it to `none` makes blame
output unconverted data. For more information see the
@@ -77,14 +77,14 @@ include::line-range-format.txt[]
iso format is used. For supported values, see the discussion
of the `--date` option at linkgit:git-log[1].
---[no-]progress::
+`--[no-]progress`::
Progress status is reported on the standard error stream
by default when it is attached to a terminal. This flag
enables progress reporting even if not attached to a
terminal. Can't use `--progress` together with `--porcelain`
or `--incremental`.
--M[<num>]::
+`-M[<num>]`::
Detect moved or copied lines within a file. When a commit
moves or copies a block of lines (e.g. the original file
has A and then B, and the commit changes it to B and then
@@ -100,7 +100,7 @@ alphanumeric characters that Git must detect as moving/copying
within a file for it to associate those lines with the parent
commit. The default value is 20.
--C[<num>]::
+`-C[<num>]`::
In addition to `-M`, detect lines moved or copied from other
files that were modified in the same commit. This is
useful when you reorganize your program and move code
@@ -136,5 +136,5 @@ take effect.
option. An empty file name, `""`, will clear the list of revs from
previously processed files.
--h::
+`-h`::
Show help message.
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 68529ad9db..6f83ce52a2 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -235,29 +235,29 @@ Values of many variables are treated as a simple string, but there
are variables that take values of specific types and there are rules
as to how to spell them.
-boolean::
+`boolean`::
When a variable is said to take a boolean value, many
synonyms are accepted for 'true' and 'false'; these are all
case-insensitive.
- true;; Boolean true literals are `yes`, `on`, `true`,
+ `true`;; Boolean true literals are `yes`, `on`, `true`,
and `1`. Also, a variable defined without `= <value>`
is taken as true.
- false;; Boolean false literals are `no`, `off`, `false`,
+ `false`;; Boolean false literals are `no`, `off`, `false`,
`0` and the empty string.
+
When converting a value to its canonical form using the `--type=bool` type
specifier, `git config` will ensure that the output is "true" or
"false" (spelled in lowercase).
-integer::
+`integer`::
The value for many variables that specify various sizes can
be suffixed with `k`, `M`,... to mean "scale the number by
1024", "by 1024x1024", etc.
-color::
+`color`::
The value for a variable that takes a color is a list of
colors (at most two, one for foreground and one for background)
and attributes (as many as you want), separated by spaces.
@@ -292,7 +292,7 @@ output) is set to be painted with `bold` or some other attribute.
However, custom log formats may do more complicated and layered
coloring, and the negated forms may be useful there.
-pathname::
+`pathname`::
A variable that takes a pathname value can be given a
string that begins with "`~/`" or "`~user/`", and the usual
tilde expansion happens to such a string: `~/`
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 34570aa445..1b594732aa 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -13,29 +13,29 @@ endif::git-diff[]
endif::git-format-patch[]
ifdef::git-format-patch[]
--p::
---no-stat::
+`-p`::
+`--no-stat`::
Generate plain patches without any diffstats.
endif::git-format-patch[]
ifndef::git-format-patch[]
--p::
--u::
---patch::
+`-p`::
+`-u`::
+`--patch`::
Generate patch (see section on generating patches).
ifdef::git-diff[]
This is the default.
endif::git-diff[]
--s::
---no-patch::
+`-s`::
+`--no-patch`::
Suppress diff output. Useful for commands like `git show` that
show the patch by default, or to cancel the effect of `--patch`.
endif::git-format-patch[]
ifdef::git-log[]
--diff-merges=(off|none|first-parent|1|separate|m|combined|c|dense-combined|cc)::
---no-diff-merges::
+`--no-diff-merges`::
Specify diff format to be used for merge commits. Default is
{diff-merges-default} unless `--first-parent` is in use, in which case
`first-parent` is the default.
@@ -76,7 +76,7 @@ ifdef::git-log[]
two variants and the merge result picks one of them without
modification. `--cc` implies `-p`.
---combined-all-paths::
+`--combined-all-paths`::
This flag causes combined diffs (used for merge commits) to
list the name of the file from all parents. It thus only has
effect when `--diff-merges=[dense-]combined` is in use, and
@@ -84,26 +84,26 @@ ifdef::git-log[]
when either rename or copy detection have been requested).
endif::git-log[]
--U<n>::
---unified=<n>::
+`-U<n>`::
+`--unified=<n>`::
Generate diffs with <n> lines of context instead of
the usual three.
ifndef::git-format-patch[]
Implies `--patch`.
endif::git-format-patch[]
---output=<file>::
+`--output=<file>`::
Output to a specific file instead of stdout.
---output-indicator-new=<char>::
---output-indicator-old=<char>::
---output-indicator-context=<char>::
+`--output-indicator-new=<char>`::
+`--output-indicator-old=<char>`::
+`--output-indicator-context=<char>`::
Specify the character used to indicate new, old or context
lines in the generated patch. Normally they are '+', '-' and
' ' respectively.
ifndef::git-format-patch[]
---raw::
+`--raw`::
ifndef::git-log[]
Generate the diff in raw format.
ifdef::git-diff-core[]
@@ -120,33 +120,33 @@ endif::git-log[]
endif::git-format-patch[]
ifndef::git-format-patch[]
---patch-with-raw::
+`--patch-with-raw`::
Synonym for `-p --raw`.
endif::git-format-patch[]
ifdef::git-log[]
--t::
+`-t`::
Show the tree objects in the diff output.
endif::git-log[]
---indent-heuristic::
+`--indent-heuristic`::
Enable the heuristic that shifts diff hunk boundaries to make patches
easier to read. This is the default.
---no-indent-heuristic::
+`--no-indent-heuristic`::
Disable the indent heuristic.
---minimal::
+`--minimal`::
Spend extra time to make sure the smallest possible
diff is produced.
---patience::
+`--patience`::
Generate a diff using the "patience diff" algorithm.
---histogram::
+`--histogram`::
Generate a diff using the "histogram diff" algorithm.
---anchored=<text>::
+`--anchored=<text>`::
Generate a diff using the "anchored diff" algorithm.
+
This option may be specified more than once.
@@ -194,7 +194,7 @@ have to use `--diff-algorithm=default` option.
These parameters can also be set individually with `--stat-width=<width>`,
`--stat-name-width=<name-width>` and `--stat-count=<count>`.
---compact-summary::
+`--compact-summary`::
Output a condensed summary of extended header information such
as file creations or deletions ("new" or "gone", optionally "+l"
if it's a symlink) and mode changes ("+x" or "-x" for adding
@@ -202,14 +202,14 @@ These parameters can also be set individually with `--stat-width=<width>`,
information is put between the filename part and the graph
part. Implies `--stat`.
---numstat::
+`--numstat`::
Similar to `--stat`, but shows number of added and
deleted lines in decimal notation and pathname without
abbreviation, to make it more machine friendly. For
binary files, outputs two `-` instead of saying
`0 0`.
---shortstat::
+`--shortstat`::
Output only the last line of the `--stat` format containing total
number of modified files, as well as number of added and deleted
lines.
@@ -248,7 +248,7 @@ These parameters can also be set individually with `--stat-width=<width>`,
Note that when using `cumulative`, the sum of the percentages
reported may exceed 100%. The default (non-cumulative) behavior can
be specified with the `noncumulative` parameter.
-<limit>;;
+`<limit>`;;
An integer parameter specifies a cut-off percent (3% by default).
Directories contributing less than this percentage of the changes
are not shown in the output.
@@ -259,24 +259,24 @@ directories with less than 10% of the total amount of changed files,
and accumulating child directory counts in the parent directories:
`--dirstat=files,10,cumulative`.
---cumulative::
+`--cumulative`::
Synonym for --dirstat=cumulative
--dirstat-by-file[=<param1,param2>...]::
Synonym for --dirstat=files,param1,param2...
---summary::
+`--summary`::
Output a condensed summary of extended header information
such as creations, renames and mode changes.
ifndef::git-format-patch[]
---patch-with-stat::
+`--patch-with-stat`::
Synonym for `-p --stat`.
endif::git-format-patch[]
ifndef::git-format-patch[]
--z::
+`-z`::
ifdef::git-log[]
Separate the commits with NULs instead of with new newlines.
+
@@ -292,14 +292,14 @@ Without this option, pathnames with "unusual" characters are quoted as
explained for the configuration variable `core.quotePath` (see
linkgit:git-config[1]).
---name-only::
+`--name-only`::
Show only names of changed files.
---name-status::
+`--name-status`::
Show only names and status of changed files. See the description
of the `--diff-filter` option on what the status letters mean.
---submodule[=<format>]::
+`--submodule[=<format>]`::
Specify how differences in submodules are shown. When specifying
`--submodule=short` the 'short' format is used. This format just
shows the names of the commits at the beginning and end of the range.
@@ -311,7 +311,7 @@ linkgit:git-config[1]).
commit range. Defaults to `diff.submodule` or the 'short' format
if the config option is unset.
---color[=<when>]::
+`--color[=<when>]`::
Show colored diff.
`--color` (i.e. without '=<when>') is the same as `--color=always`.
'<when>' can be one of `always`, `never`, or `auto`.
@@ -320,14 +320,14 @@ ifdef::git-diff[]
configuration settings.
endif::git-diff[]
---no-color::
+`--no-color`::
Turn off colored diff.
ifdef::git-diff[]
This can be used to override configuration settings.
endif::git-diff[]
It is the same as `--color=never`.
---color-moved[=<mode>]::
+`--color-moved[=<mode>]`::
Moved lines of code are colored differently.
ifdef::git-diff[]
It can be changed by the `diff.colorMoved` configuration setting.
@@ -337,40 +337,40 @@ endif::git-diff[]
The mode must be one of:
+
--
-no::
+`no`::
Moved lines are not highlighted.
-default::
+`default`::
Is a synonym for `zebra`. This may change to a more sensible mode
in the future.
-plain::
+`plain`::
Any line that is added in one location and was removed
in another location will be colored with `color.diff.newMoved`.
Similarly `color.diff.oldMoved` will be used for removed lines
that are added somewhere else in the diff. This mode picks up any
moved line, but it is not very useful in a review to determine
if a block of code was moved without permutation.
-blocks::
+`blocks`::
Blocks of moved text of at least 20 alphanumeric characters
are detected greedily. The detected blocks are
painted using either the `color.diff.{old,new}Moved` color.
Adjacent blocks cannot be told apart.
-zebra::
+`zebra`::
Blocks of moved text are detected as in 'blocks' mode. The blocks
are painted using either the `color.diff.{old,new}Moved` color or
`color.diff.{old,new}MovedAlternative`. The change between
the two colors indicates that a new block was detected.
-dimmed-zebra::
+`dimmed-zebra`::
Similar to 'zebra', but additional dimming of uninteresting parts
of moved code is performed. The bordering lines of two adjacent
blocks are considered interesting, the rest is uninteresting.
`dimmed_zebra` is a deprecated synonym.
--
---no-color-moved::
+`--no-color-moved`::
Turn off move detection. This can be used to override configuration
settings. It is the same as `--color-moved=no`.
---color-moved-ws=<modes>::
+`--color-moved-ws=<modes>`::
This configures how whitespace is ignored when performing the
move detection for `--color-moved`.
ifdef::git-diff[]
@@ -379,57 +379,57 @@ endif::git-diff[]
These modes can be given as a comma separated list:
+
--
-no::
+`no`::
Do not ignore whitespace when performing move detection.
-ignore-space-at-eol::
+`ignore-space-at-eol`::
Ignore changes in whitespace at EOL.
-ignore-space-change::
+`ignore-space-change`::
Ignore changes in amount of whitespace. This ignores whitespace
at line end, and considers all other sequences of one or
more whitespace characters to be equivalent.
-ignore-all-space::
+`ignore-all-space`::
Ignore whitespace when comparing lines. This ignores differences
even if one line has whitespace where the other line has none.
-allow-indentation-change::
+`allow-indentation-change`::
Initially ignore any whitespace in the move detection, then
group the moved code blocks only into a block if the change in
whitespace is the same per line. This is incompatible with the
other modes.
--
---no-color-moved-ws::
+`--no-color-moved-ws`::
Do not ignore whitespace when performing move detection. This can be
used to override configuration settings. It is the same as
`--color-moved-ws=no`.
---word-diff[=<mode>]::
+`--word-diff[=<mode>]`::
Show a word diff, using the <mode> to delimit changed words.
By default, words are delimited by whitespace; see
`--word-diff-regex` below. The <mode> defaults to 'plain', and
must be one of:
+
--
-color::
+`color`::
Highlight changed words using only colors. Implies `--color`.
-plain::
+`plain`::
Show words as `[-removed-]` and `{+added+}`. Makes no
attempts to escape the delimiters if they appear in the input,
so the output may be ambiguous.
-porcelain::
+`porcelain`::
Use a special line-based format intended for script
consumption. Added/removed/unchanged runs are printed in the
usual unified diff format, starting with a `+`/`-`/` `
character at the beginning of the line and extending to the
end of the line. Newlines in the input are represented by a
tilde `~` on a line of its own.
-none::
+`none`::
Disable word diff again.
--
+
Note that despite the name of the first mode, color is used to
highlight the changed parts in all modes if enabled.
---word-diff-regex=<regex>::
+`--word-diff-regex=<regex>`::
Use <regex> to decide what a word is, instead of considering
runs of non-whitespace to be a word. Also implies
`--word-diff` unless it was already enabled.
@@ -450,20 +450,20 @@ linkgit:gitattributes[5] or linkgit:git-config[1]. Giving it explicitly
overrides any diff driver or configuration setting. Diff drivers
override configuration settings.
---color-words[=<regex>]::
+`--color-words[=<regex>]`::
Equivalent to `--word-diff=color` plus (if a regex was
specified) `--word-diff-regex=<regex>`.
endif::git-format-patch[]
---no-renames::
+`--no-renames`::
Turn off rename detection, even when the configuration
file gives the default to do so.
---[no-]rename-empty::
+`--[no-]rename-empty`::
Whether to use empty blobs as rename source.
ifndef::git-format-patch[]
---check::
+`--check`::
Warn if changes introduce conflict markers or whitespace errors.
What are considered whitespace errors is controlled by `core.whitespace`
configuration. By default, trailing whitespaces (including
@@ -473,7 +473,7 @@ ifndef::git-format-patch[]
Exits with non-zero status if problems are found. Not compatible
with `--exit-code`.
---ws-error-highlight=<kind>::
+`--ws-error-highlight=<kind>`::
Highlight whitespace errors in the `context`, `old` or `new`
lines of the diff. Multiple values are separated by comma,
`none` resets previous values, `default` reset the list to
@@ -485,19 +485,19 @@ ifndef::git-format-patch[]
endif::git-format-patch[]
---full-index::
+`--full-index`::
Instead of the first handful of characters, show the full
pre- and post-image blob object names on the "index"
line when generating patch format output.
---binary::
+`--binary`::
In addition to `--full-index`, output a binary diff that
can be applied with `git-apply`.
ifndef::git-format-patch[]
Implies `--patch`.
endif::git-format-patch[]
---abbrev[=<n>]::
+`--abbrev[=<n>]`::
Instead of showing the full 40-byte hexadecimal object
name in diff-raw format output and diff-tree header
lines, show the shortest prefix that is at least '<n>'
@@ -530,8 +530,8 @@ addition and deletion compared to 20% or more of the file's size are
eligible for being picked up as a possible source of a rename to
another file.
--M[<n>]::
---find-renames[=<n>]::
+`-M[<n>]`::
+`--find-renames[=<n>]`::
ifndef::git-log[]
Detect renames.
endif::git-log[]
@@ -550,12 +550,12 @@ endif::git-log[]
the same as `-M5%`. To limit detection to exact renames, use
`-M100%`. The default similarity index is 50%.
--C[<n>]::
---find-copies[=<n>]::
+`-C[<n>]`::
+`--find-copies[=<n>]`::
Detect copies as well as renames. See also `--find-copies-harder`.
If `n` is specified, it has the same meaning as for `-M<n>`.
---find-copies-harder::
+`--find-copies-harder`::
For performance reasons, by default, `-C` option finds copies only
if the original file of the copy was modified in the same
changeset. This flag makes the command
@@ -564,8 +564,8 @@ endif::git-log[]
projects, so use it with caution. Giving more than one
`-C` option has the same effect.
--D::
---irreversible-delete::
+`-D`::
+`--irreversible-delete`::
Omit the preimage for deletes, i.e. print only the header but not
the diff between the preimage and `/dev/null`. The resulting patch
is not meant to be applied with `patch` or `git apply`; this is
@@ -577,7 +577,7 @@ endif::git-log[]
When used together with `-B`, omit also the preimage in the deletion part
of a delete/create pair.
--l<num>::
+`-l<num>`::
The `-M` and `-C` options require O(n^2) processing time where n
is the number of potential rename/copy targets. This
option prevents rename/copy detection from running if
@@ -606,7 +606,7 @@ from the index to the working tree can never have Added entries
the index). Similarly, copied and renamed entries cannot appear if
detection for those types is disabled.
--S<string>::
+`-S<string>`::
Look for differences that change the number of occurrences of
the specified string (i.e. addition/deletion) in a file.
Intended for the scripter's use.
@@ -619,7 +619,7 @@ very first version of the block.
+
Binary files are searched as well.
--G<regex>::
+`-G<regex>`::
Look for differences whose patch text contains added/removed
lines that match <regex>.
+
@@ -643,7 +643,7 @@ filter will be ignored.
See the 'pickaxe' entry in linkgit:gitdiffcore[7] for more
information.
---find-object=<object-id>::
+`--find-object=<object-id>`::
Look for differences that change the number of occurrences of
the specified object. Similar to `-S`, just the argument is different
in that it doesn't search for a specific string but for a specific
@@ -652,18 +652,18 @@ information.
The object can be a blob or a submodule commit. It implies the `-t` option in
`git-log` to also find trees.
---pickaxe-all::
+`--pickaxe-all`::
When `-S` or `-G` finds a change, show all the changes in that
changeset, not just the files that contain the change
in <string>.
---pickaxe-regex::
+`--pickaxe-regex`::
Treat the <string> given to `-S` as an extended POSIX regular
expression to match.
endif::git-format-patch[]
--O<orderfile>::
+`-O<orderfile>`::
Control the order in which files appear in the output.
This overrides the `diff.orderFile` configuration variable
(see linkgit:git-config[1]). To cancel `diff.orderFile`,
@@ -700,8 +700,8 @@ matches a pattern if removing any number of the final pathname
components matches the pattern. For example, the pattern "`foo*bar`"
matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`".
---skip-to=<file>::
---rotate-to=<file>::
+`--skip-to=<file>`::
+`--rotate-to=<file>`::
Discard the files before the named <file> from the output
(i.e. 'skip to'), or move them to the end of the output
(i.e. 'rotate to'). These were invented primarily for use
@@ -709,13 +709,13 @@ matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`".
otherwise.
ifndef::git-format-patch[]
--R::
+`-R`::
Swap two inputs; that is, show differences from index or
on-disk file to tree contents.
endif::git-format-patch[]
---relative[=<path>]::
---no-relative::
+`--relative[=<path>]`::
+`--no-relative`::
When run from a subdirectory of the project, it can be
told to exclude changes outside the directory and show
pathnames relative to it with this option. When you are
@@ -725,44 +725,44 @@ endif::git-format-patch[]
`--no-relative` can be used to countermand both `diff.relative` config
option and previous `--relative`.
--a::
---text::
+`-a`::
+`--text`::
Treat all files as text.
---ignore-cr-at-eol::
+`--ignore-cr-at-eol`::
Ignore carriage-return at the end of line when doing a comparison.
---ignore-space-at-eol::
+`--ignore-space-at-eol`::
Ignore changes in whitespace at EOL.
--b::
---ignore-space-change::
+`-b`::
+`--ignore-space-change`::
Ignore changes in amount of whitespace. This ignores whitespace
at line end, and considers all other sequences of one or
more whitespace characters to be equivalent.
--w::
---ignore-all-space::
+`-w`::
+`--ignore-all-space`::
Ignore whitespace when comparing lines. This ignores
differences even if one line has whitespace where the other
line has none.
---ignore-blank-lines::
+`--ignore-blank-lines`::
Ignore changes whose lines are all blank.
--I<regex>::
---ignore-matching-lines=<regex>::
+`-I<regex>`::
+`--ignore-matching-lines=<regex>`::
Ignore changes whose all lines match <regex>. This option may
be specified more than once.
---inter-hunk-context=<lines>::
+`--inter-hunk-context=<lines>`::
Show the context between diff hunks, up to the specified number
of lines, thereby fusing hunks that are close to each other.
Defaults to `diff.interHunkContext` or 0 if the config option
is unset.
--W::
---function-context::
+`-W`::
+`--function-context`::
Show whole function as context lines for each change.
The function names are determined in the same way as
`git diff` works out patch hunk headers (see 'Defining a
@@ -770,26 +770,26 @@ endif::git-format-patch[]
ifndef::git-format-patch[]
ifndef::git-log[]
---exit-code::
+`--exit-code`::
Make the program exit with codes similar to diff(1).
That is, it exits with 1 if there were differences and
0 means no differences.
---quiet::
+`--quiet`::
Disable all output of the program. Implies `--exit-code`.
endif::git-log[]
endif::git-format-patch[]
---ext-diff::
+`--ext-diff`::
Allow an external diff helper to be executed. If you set an
external diff driver with linkgit:gitattributes[5], you need
to use this option with linkgit:git-log[1] and friends.
---no-ext-diff::
+`--no-ext-diff`::
Disallow external diff drivers.
---textconv::
---no-textconv::
+`--textconv`::
+`--no-textconv`::
Allow (or disallow) external text conversion filters to be run
when comparing binary files. See linkgit:gitattributes[5] for
details. Because textconv filters are typically a one-way
@@ -799,7 +799,7 @@ endif::git-format-patch[]
linkgit:git-log[1], but not for linkgit:git-format-patch[1] or
diff plumbing commands.
---ignore-submodules[=<when>]::
+`--ignore-submodules[=<when>]`::
Ignore changes to submodules in the diff generation. <when> can be
either "none", "untracked", "dirty" or "all", which is the default.
Using "none" will consider the submodule modified when it either contains
@@ -812,19 +812,19 @@ endif::git-format-patch[]
only changes to the commits stored in the superproject are shown (this was
the behavior until 1.7.0). Using "all" hides all changes to submodules.
---src-prefix=<prefix>::
+`--src-prefix=<prefix>`::
Show the given source prefix instead of "a/".
---dst-prefix=<prefix>::
+`--dst-prefix=<prefix>`::
Show the given destination prefix instead of "b/".
---no-prefix::
+`--no-prefix`::
Do not show any source or destination prefix.
---line-prefix=<prefix>::
+`--line-prefix=<prefix>`::
Prepend an additional prefix to every line of output.
---ita-invisible-in-index::
+`--ita-invisible-in-index`::
By default entries added by `git add -N` appear as an existing
empty file in `git diff` and a new file in `git diff --cached`.
This option makes the entry appear as a new file in `git diff`
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index 94de13eec8..fcee0ad87d 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -1,38 +1,38 @@
---all::
+`--all`::
Fetch all remotes.
--a::
---append::
+`-a`::
+`--append`::
Append ref names and object names of fetched refs to the
existing contents of `.git/FETCH_HEAD`. Without this
option old data in `.git/FETCH_HEAD` will be overwritten.
---atomic::
+`--atomic`::
Use an atomic transaction to update local refs. Either all refs are
updated, or on error, no refs are updated.
---depth=<depth>::
+`--depth=<depth>`::
Limit fetching to the specified number of commits from the tip of
each remote branch history. If fetching to a 'shallow' repository
created by `git clone` with `--depth=<depth>` option (see
linkgit:git-clone[1]), deepen or shorten the history to the specified
number of commits. Tags for the deepened commits are not fetched.
---deepen=<depth>::
+`--deepen=<depth>`::
Similar to --depth, except it specifies the number of commits
from the current shallow boundary instead of from the tip of
each remote branch history.
---shallow-since=<date>::
+`--shallow-since=<date>`::
Deepen or shorten the history of a shallow repository to
include all reachable commits after <date>.
---shallow-exclude=<revision>::
+`--shallow-exclude=<revision>`::
Deepen or shorten the history of a shallow repository to
exclude commits reachable from a specified remote branch or tag.
This option can be specified multiple times.
---unshallow::
+`--unshallow`::
If the source repository is complete, convert a shallow
repository to a complete one, removing all the limitations
imposed by shallow repositories.
@@ -40,7 +40,7 @@
If the source repository is shallow, fetch as much as possible so that
the current repository has the same history as the source repository.
---update-shallow::
+`--update-shallow`::
By default when fetching from a shallow repository,
`git fetch` refuses refs that require updating
`.git/shallow`. This option updates `.git/shallow` and accept such
@@ -65,11 +65,11 @@ this option multiple times, one for each matching ref name.
See also the `fetch.negotiationAlgorithm` configuration variable
documented in linkgit:git-config[1].
---dry-run::
+`--dry-run`::
Show what would be done, without making any changes.
ifndef::git-pull[]
---[no-]write-fetch-head::
+`--[no-]write-fetch-head`::
Write the list of remote refs fetched in the `FETCH_HEAD`
file directly under `$GIT_DIR`. This is the default.
Passing `--no-write-fetch-head` from the command line tells
@@ -77,8 +77,8 @@ ifndef::git-pull[]
file is never written.
endif::git-pull[]
--f::
---force::
+`-f`::
+`--force`::
When `git fetch` is used with `<src>:<dst>` refspec it may
refuse to update the local branch as discussed
ifdef::git-pull[]
@@ -90,28 +90,28 @@ ifndef::git-pull[]
endif::git-pull[]
This option overrides that check.
--k::
---keep::
+`-k`::
+`--keep`::
Keep downloaded pack.
ifndef::git-pull[]
---multiple::
+`--multiple`::
Allow several <repository> and <group> arguments to be
specified. No <refspec>s may be specified.
---[no-]auto-maintenance::
---[no-]auto-gc::
+`--[no-]auto-maintenance`::
+`--[no-]auto-gc`::
Run `git maintenance run --auto` at the end to perform automatic
repository maintenance if needed. (`--[no-]auto-gc` is a synonym.)
This is enabled by default.
---[no-]write-commit-graph::
+`--[no-]write-commit-graph`::
Write a commit-graph after fetching. This overrides the config
setting `fetch.writeCommitGraph`.
endif::git-pull[]
--p::
---prune::
+`-p`::
+`--prune`::
Before fetching, remove any remote-tracking references that no
longer exist on the remote. Tags are not subject to pruning
if they are fetched only because of the default tag
@@ -125,8 +125,8 @@ ifndef::git-pull[]
+
See the PRUNING section below for more details.
--P::
---prune-tags::
+`-P`::
+`--prune-tags`::
Before fetching, remove any local tags that no longer exist on
the remote if `--prune` is enabled. This option should be used
more carefully, unlike `--prune` it will remove any local
@@ -139,16 +139,16 @@ See the PRUNING section below for more details.
endif::git-pull[]
ifndef::git-pull[]
--n::
+`-n`::
endif::git-pull[]
---no-tags::
+`--no-tags`::
By default, tags that point at objects that are downloaded
from the remote repository are fetched and stored locally.
This option disables this automatic tag following. The default
behavior for a remote may be specified with the remote.<name>.tagOpt
setting. See linkgit:git-config[1].
---refmap=<refspec>::
+`--refmap=<refspec>`::
When fetching refs listed on the command line, use the
specified refspec (can be given more than once) to map the
refs to remote-tracking branches, instead of the values of
@@ -159,8 +159,8 @@ endif::git-pull[]
command-line arguments. See section on "Configured Remote-tracking
Branches" for details.
--t::
---tags::
+`-t`::
+`--tags`::
Fetch all tags from the remote (i.e., fetch remote tags
`refs/tags/*` into local tags with the same name), in addition
to whatever else would otherwise be fetched. Using this
@@ -182,8 +182,8 @@ ifndef::git-pull[]
`fetch.recurseSubmodules` is set (see linkgit:git-config[1]).
endif::git-pull[]
--j::
---jobs=<n>::
+`-j`::
+`--jobs=<n>`::
Number of parallel children to be used for all forms of fetching.
+
If the `--multiple` option was specified, the different remotes will be fetched
@@ -195,12 +195,12 @@ Typically, parallel recursive and multi-remote fetches will be faster. By
default fetches are performed sequentially, not in parallel.
ifndef::git-pull[]
---no-recurse-submodules::
+`--no-recurse-submodules`::
Disable recursive fetching of submodules (this has the same effect as
using the `--recurse-submodules=no` option).
endif::git-pull[]
---set-upstream::
+`--set-upstream`::
If the remote is fetched successfully, add upstream
(tracking) reference, used by argument-less
linkgit:git-pull[1] and other commands. For more information,
@@ -208,7 +208,7 @@ endif::git-pull[]
linkgit:git-config[1].
ifndef::git-pull[]
---submodule-prefix=<path>::
+`--submodule-prefix=<path>`::
Prepend <path> to paths printed in informative messages
such as "Fetching submodule foo". This option is used
internally when recursing over submodules.
@@ -221,8 +221,8 @@ ifndef::git-pull[]
linkgit:git-config[1]) override this option, as does
specifying --[no-]recurse-submodules directly.
--u::
---update-head-ok::
+`-u`::
+`--update-head-ok`::
By default `git fetch` refuses to update the head which
corresponds to the current branch. This flag disables the
check. This is purely for the internal use for `git pull`
@@ -238,25 +238,25 @@ endif::git-pull[]
run on the other end.
ifndef::git-pull[]
--q::
---quiet::
+`-q`::
+`--quiet`::
Pass `--quiet` to `git-fetch-pack` and silence any other internally
used `git` commands. Progress is not reported to the standard error
stream.
--v::
---verbose::
+`-v`::
+`--verbose`::
Be verbose.
endif::git-pull[]
---progress::
+`--progress`::
Progress status is reported on the standard error stream
by default when it is attached to a terminal, unless -q
is specified. This flag forces progress status even if the
standard error stream is not directed to a terminal.
-o <option>::
---server-option=<option>::
+`--server-option=<option>`::
Transmit the given string to the server when communicating using
protocol version 2. The given string must not contain a NUL or LF
character. The server's handling of server options, including
@@ -264,13 +264,13 @@ endif::git-pull[]
When multiple `--server-option=<option>` are given, they are all
sent to the other side in the order listed on the command line.
---show-forced-updates::
+`--show-forced-updates`::
By default, `git` checks if a branch is force-updated during
fetch. This can be disabled through `fetch.showForcedUpdates`, but
the `--show-forced-updates` option guarantees this check occurs.
See linkgit:git-config[1].
---no-show-forced-updates::
+`--no-show-forced-updates`::
By default, `git` checks if a branch is force-updated during
fetch. Pass `--no-show-forced-updates` or set `fetch.showForcedUpdates`
to false to skip this check for performance reasons. If used during
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index 786c31fc60..646951cf7e 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -66,28 +66,28 @@ OPTIONS
For more details about the <pathspec> syntax, see the 'pathspec' entry
in linkgit:gitglossary[7].
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Don't actually add the file(s), just show if they exist and/or will
be ignored.
--v::
---verbose::
+`-v`::
+`--verbose`::
Be verbose.
--f::
---force::
+`-f`::
+`--force`::
Allow adding otherwise ignored files.
--i::
---interactive::
+`-i`::
+`--interactive`::
Add modified contents in the working tree interactively to
the index. Optional path arguments may be supplied to limit
operation to a subset of the working tree. See ``Interactive
mode'' for details.
--p::
---patch::
+`-p`::
+`--patch`::
Interactively choose hunks of patch between the index and the
work tree and add them to the index. This gives the user a chance
to review the difference before adding modified contents to the
@@ -97,8 +97,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.
@@ -109,8 +109,8 @@ quicker and more flexible than using the interactive hunk selector.
However, it is easy to confuse oneself and create a patch that does not
apply to the index. See EDITING PATCHES below.
--u::
---update::
+`-u`::
+`--update`::
Update the index just where it already has an entry matching
<pathspec>. This removes as well as modifies index entries to
match the working tree, but adds no new files.
@@ -120,9 +120,9 @@ tracked files in the entire working tree are updated (old versions
of Git used to limit the update to the current directory and its
subdirectories).
--A::
---all::
---no-ignore-removal::
+`-A`::
+`--all`::
+`--no-ignore-removal`::
Update the index not only where the working tree has a file
matching <pathspec> but also where the index already has an
entry. This adds, modifies, and removes index entries to
@@ -133,8 +133,8 @@ files in the entire working tree are updated (old versions
of Git used to limit the update to the current directory and its
subdirectories).
---no-all::
---ignore-removal::
+`--no-all`::
+`--ignore-removal`::
Update the index by adding new files that are unknown to the
index and files modified in the working tree, but ignore
files that have been removed from the working tree. This
@@ -144,39 +144,39 @@ This option is primarily to help users who are used to older
versions of Git, whose `git add <pathspec>...` was a synonym
for `git add --no-all <pathspec>...`, i.e. ignored removed files.
--N::
---intent-to-add::
+`-N`::
+`--intent-to-add`::
Record only the fact that the path will be added later. An entry
for the path is placed in the index with no content. This is
useful for, among other things, showing the unstaged content of
such files with `git diff` and committing them with `git commit
-a`.
---refresh::
+`--refresh`::
Don't add the file(s), but only refresh their stat()
information in the index.
---ignore-errors::
+`--ignore-errors`::
If some files could not be added because of errors indexing
them, do not abort the operation, but continue adding the
others. The command shall still exit with non-zero status.
The configuration variable `add.ignoreErrors` can be set to
true to make this the default behaviour.
---ignore-missing::
+`--ignore-missing`::
This option can only be used together with `--dry-run`. By using
this option the user can check if any of the given files would
be ignored, no matter if they are already present in the work
tree or not.
---no-warn-embedded-repo::
+`--no-warn-embedded-repo`::
By default, `git add` will warn when adding an embedded
repository to the index without using `git submodule add` to
create an entry in `.gitmodules`. This option will suppress the
warning (e.g., if you are manually performing operations on
submodules).
---renormalize::
+`--renormalize`::
Apply the "clean" process freshly to all tracked files to
forcibly add them again to the index. This is useful after
changing `core.autocrlf` configuration or the `text` attribute
@@ -188,7 +188,7 @@ for `git add --no-all <pathspec>...`, i.e. ignored removed files.
bit is only changed in the index, the files on disk are left
unchanged.
---pathspec-from-file=<file>::
+`--pathspec-from-file=<file>`::
Pathspec is passed in `<file>` instead of commandline args. If
`<file>` is exactly `-` then standard input is used. Pathspec
elements are separated by LF or CR/LF. Pathspec elements can be
@@ -196,7 +196,7 @@ for `git add --no-all <pathspec>...`, i.e. ignored removed files.
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
global `--literal-pathspecs`.
---pathspec-file-nul::
+`--pathspec-file-nul`::
Only meaningful with `--pathspec-from-file`. Pathspec elements are
separated with NUL character and all other characters are taken
literally (including newlines and quotes).
@@ -254,7 +254,7 @@ choice is unique.
The main command loop has 6 subcommands (plus help and quit).
-status::
+`status`::
This shows the change between `HEAD` and index (i.e. what will be
committed if you say `git commit`), and between index and
@@ -278,7 +278,7 @@ and 35 lines deleted if you commit what is in the index, but
working tree file has further modifications (one addition and
one deletion).
-update::
+`update`::
This shows the status information and issues an "Update>>"
prompt. When the prompt ends with double '>>', you can
@@ -307,7 +307,7 @@ Update>> -2
After making the selection, answer with an empty line to stage the
contents of working tree files for selected paths in the index.
-revert::
+`revert`::
This has a very similar UI to 'update', and the staged
information for selected paths are reverted to that of the
@@ -318,7 +318,7 @@ add untracked::
This has a very similar UI to 'update' and
'revert', and lets you add untracked paths to the index.
-patch::
+`patch`::
This lets you choose one path out of a 'status' like selection.
After choosing the path, it presents the diff between the index
@@ -347,7 +347,7 @@ that was chosen, the index is updated with the selected hunks.
You can omit having to type return here, by setting the configuration
variable `interactive.singleKey` to `true`.
-diff::
+`diff`::
This lets you review what will be committed (i.e. between
`HEAD` and index).
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index 80f2f89cbd..c8560bacad 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -31,50 +31,50 @@ OPTIONS
supply this argument, the command reads from the standard input.
If you supply directories, they will be treated as Maildirs.
--s::
---signoff::
+`-s`::
+`--signoff`::
Add a `Signed-off-by` trailer to the commit message, using
the committer identity of yourself.
See the signoff option in linkgit:git-commit[1] for more information.
--k::
---keep::
+`-k`::
+`--keep`::
Pass `-k` flag to `git mailinfo` (see linkgit:git-mailinfo[1]).
---keep-non-patch::
+`--keep-non-patch`::
Pass `-b` flag to `git mailinfo` (see linkgit:git-mailinfo[1]).
---[no-]keep-cr::
+`--[no-]keep-cr`::
With `--keep-cr`, call `git mailsplit` (see linkgit:git-mailsplit[1])
with the same option, to prevent it from stripping CR at the end of
lines. `am.keepcr` configuration variable can be used to specify the
default behaviour. `--no-keep-cr` is useful to override `am.keepcr`.
--c::
---scissors::
+`-c`::
+`--scissors`::
Remove everything in body before a scissors line (see
linkgit:git-mailinfo[1]). Can be activated by default using
the `mailinfo.scissors` configuration variable.
---no-scissors::
+`--no-scissors`::
Ignore scissors lines (see linkgit:git-mailinfo[1]).
--m::
---message-id::
+`-m`::
+`--message-id`::
Pass the `-m` flag to `git mailinfo` (see linkgit:git-mailinfo[1]),
so that the Message-ID header is added to the commit message.
The `am.messageid` configuration variable can be used to specify
the default behaviour.
---no-message-id::
+`--no-message-id`::
Do not add the Message-ID header to the commit message.
`no-message-id` is useful to override `am.messageid`.
--q::
---quiet::
+`-q`::
+`--quiet`::
Be quiet. Only print error messages.
--u::
+`-u`::
--utf8::
Pass `-u` flag to `git mailinfo` (see linkgit:git-mailinfo[1]).
The proposed commit log message taken from the e-mail
@@ -99,65 +99,65 @@ default. You can use `--no-utf8` to override this.
am.threeWay configuration variable. For more information,
see `am.threeWay` in linkgit:git-config[1].
---rerere-autoupdate::
---no-rerere-autoupdate::
+`--rerere-autoupdate`::
+`--no-rerere-autoupdate`::
Allow the rerere mechanism to update the index with the
result of auto-conflict resolution if possible.
---ignore-space-change::
---ignore-whitespace::
---whitespace=<option>::
--C<n>::
--p<n>::
---directory=<dir>::
---exclude=<path>::
---include=<path>::
---reject::
+`--ignore-space-change`::
+`--ignore-whitespace`::
+`--whitespace=<option>`::
+`-C<n>`::
+`-p<n>`::
+`--directory=<dir>`::
+`--exclude=<path>`::
+`--include=<path>`::
+`--reject`::
These flags are passed to the `git apply` (see linkgit:git-apply[1])
program that applies
the patch.
---patch-format::
+`--patch-format`::
By default the command will try to detect the patch format
automatically. This option allows the user to bypass the automatic
detection and specify the patch format that the patch(es) should be
interpreted as. Valid formats are mbox, mboxrd,
stgit, stgit-series and hg.
--i::
---interactive::
+`-i`::
+`--interactive`::
Run interactively.
---committer-date-is-author-date::
+`--committer-date-is-author-date`::
By default the command records the date from the e-mail
message as the commit author date, and uses the time of
commit creation as the committer date. This allows the
user to lie about the committer date by using the same
value as the author date.
---ignore-date::
+`--ignore-date`::
By default the command records the date from the e-mail
message as the commit author date, and uses the time of
commit creation as the committer date. This allows the
user to lie about the author date by using the same
value as the committer date.
---skip::
+`--skip`::
Skip the current patch. This is only meaningful when
restarting an aborted patch.
--S[<keyid>]::
---gpg-sign[=<keyid>]::
---no-gpg-sign::
+`-S[<keyid>]`::
+`--gpg-sign[=<keyid>]`::
+`--no-gpg-sign`::
GPG-sign commits. The `keyid` argument is optional and
defaults to the committer identity; if specified, it must be
stuck to the option without a space. `--no-gpg-sign` is useful to
countermand both `commit.gpgSign` configuration variable, and
earlier `--gpg-sign`.
---continue::
--r::
---resolved::
+`--continue`::
+`-r`::
+`--resolved`::
After a patch failure (e.g. attempting to apply
conflicting patch), the user has applied it by hand and
the index file stores the result of the application.
@@ -165,17 +165,17 @@ default. You can use `--no-utf8` to override this.
extracted from the e-mail message and the current index
file, and continue.
---resolvemsg=<msg>::
+`--resolvemsg=<msg>`::
When a patch failure occurs, <msg> will be printed
to the screen before exiting. This overrides the
standard message informing you to use `--continue`
or `--skip` to handle the failure. This is solely
for internal use between `git rebase` and `git am`.
---abort::
+`--abort`::
Restore the original branch and abort the patching operation.
---quit::
+`--quit`::
Abort the patching operation but keep `HEAD` and the index
untouched.
diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
index a836021d5e..88cdddb178 100644
--- a/Documentation/git-apply.txt
+++ b/Documentation/git-apply.txt
@@ -38,29 +38,29 @@ OPTIONS
The files to read the patch from. '-' can be used to read
from the standard input.
---stat::
+`--stat`::
Instead of applying the patch, output diffstat for the
input. Turns off "apply".
---numstat::
+`--numstat`::
Similar to `--stat`, but shows the number of added and
deleted lines in decimal notation and the pathname without
abbreviation, to make it more machine friendly. For
binary files, outputs two `-` instead of saying
`0 0`. Turns off "apply".
---summary::
+`--summary`::
Instead of applying the patch, output a condensed
summary of information obtained from `git diff` extended
headers, such as creations, renames and mode changes.
Turns off "apply".
---check::
+`--check`::
Instead of applying the patch, see if the patch is
applicable to the current working tree and/or the index
file and detects errors. Turns off "apply".
---index::
+`--index`::
Apply the patch to both the index and the working tree (or
merely check that it would apply cleanly to both if `--check` is
in effect). Note that `--index` expects index entries and
@@ -69,12 +69,12 @@ OPTIONS
raise an error if they are not, even if the patch would apply
cleanly to both the index and the working tree in isolation.
---cached::
+`--cached`::
Apply the patch to just the index, without touching the working
tree. If `--check` is in effect, merely check that it would
apply cleanly to the index entry.
---intent-to-add::
+`--intent-to-add`::
When applying the patch only to the working tree, mark new
files to be added to the index later (see `--intent-to-add`
option in linkgit:git-add[1]). This option is ignored unless
@@ -91,7 +91,7 @@ OPTIONS
resolve. This option implies the `--index` option, and is incompatible
with the `--reject` and the `--cached` options.
---build-fake-ancestor=<file>::
+`--build-fake-ancestor=<file>`::
Newer `git diff` output has embedded 'index information'
for each blob to help identify the original version that
the patch applies to. When this flag is given, and if
@@ -101,18 +101,18 @@ OPTIONS
When a pure mode change is encountered (which has no index information),
the information is read from the current index instead.
--R::
---reverse::
+`-R`::
+`--reverse`::
Apply the patch in reverse.
---reject::
+`--reject`::
For atomicity, `git apply` by default fails the whole patch and
does not touch the working tree when some of the hunks
do not apply. This option makes it apply
the parts of the patch that are applicable, and leave the
rejected hunks in corresponding *.rej files.
--z::
+`-z`::
When `--numstat` has been given, do not munge pathnames,
but use a NUL-terminated machine-readable format.
+
@@ -120,19 +120,19 @@ Without this option, pathnames with "unusual" characters are quoted as
explained for the configuration variable `core.quotePath` (see
linkgit:git-config[1]).
--p<n>::
+`-p<n>`::
Remove <n> leading path components (separated by slashes) from
traditional diff paths. E.g., with `-p2`, a patch against
`a/dir/file` will be applied directly to `file`. The default is
1.
--C<n>::
+`-C<n>`::
Ensure at least <n> lines of surrounding context match before
and after each change. When fewer lines of surrounding
context exist they all must match. By default no context is
ever ignored.
---unidiff-zero::
+`--unidiff-zero`::
By default, `git apply` expects that the patch being
applied is a unified diff with at least one line of context.
This provides good safety measures, but breaks down when
@@ -142,33 +142,33 @@ linkgit:git-config[1]).
Note, for the reasons stated above usage of context-free patches is
discouraged.
---apply::
+`--apply`::
If you use any of the options marked "Turns off
'apply'" above, `git apply` reads and outputs the
requested information without actually applying the
patch. Give this flag after those flags to also apply
the patch.
---no-add::
+`--no-add`::
When applying a patch, ignore additions made by the
patch. This can be used to extract the common part between
two files by first running 'diff' on them and applying
the result with this option, which would apply the
deletion part but not the addition part.
---allow-binary-replacement::
---binary::
+`--allow-binary-replacement`::
+`--binary`::
Historically we did not allow binary patch applied
without an explicit permission from the user, and this
flag was the way to do so. Currently we always allow binary
patch application, so this is a no-op.
---exclude=<path-pattern>::
+`--exclude=<path-pattern>`::
Don't apply changes to files matching the given path pattern. This can
be useful when importing patchsets, where you want to exclude certain
files or directories.
---include=<path-pattern>::
+`--include=<path-pattern>`::
Apply changes to files matching the given path pattern. This can
be useful when importing patchsets, where you want to include certain
files or directories.
@@ -179,15 +179,15 @@ patch to each path is used. A patch to a path that does not match any
include/exclude pattern is used by default if there is no include pattern
on the command line, and ignored if there is any include pattern.
---ignore-space-change::
---ignore-whitespace::
+`--ignore-space-change`::
+`--ignore-whitespace`::
When applying a patch, ignore changes in whitespace in context
lines if necessary.
Context lines will preserve their whitespace, and they will not
undergo whitespace fixing regardless of the value of the
`--whitespace` option. New lines will still be fixed, though.
---whitespace=<action>::
+`--whitespace=<action>`::
When applying a patch, detect a new or modified line that has
whitespace errors. What are considered whitespace errors is
controlled by `core.whitespace` configuration. By default,
@@ -214,25 +214,25 @@ behavior:
to apply the patch.
* `error-all` is similar to `error` but shows all errors.
---inaccurate-eof::
+`--inaccurate-eof`::
Under certain circumstances, some versions of 'diff' do not correctly
detect a missing new-line at the end of the file. As a result, patches
created by such 'diff' programs do not record incomplete lines
correctly. This option adds support for applying such patches by
working around this bug.
--v::
---verbose::
+`-v`::
+`--verbose`::
Report progress to stderr. By default, only a message about the
current patch being applied will be printed. This option will cause
additional information to be reported.
---recount::
+`--recount`::
Do not trust the line counts in the hunk headers, but infer them
by inspecting the patch (e.g. after editing the patch without
adjusting the hunk headers appropriately).
---directory=<root>::
+`--directory=<root>`::
Prepend <root> to all filenames. If a `-p` argument was also passed,
it is applied before prepending the new root.
+
@@ -240,7 +240,7 @@ For example, a patch that talks about updating `a/git-gui.sh` to `b/git-gui.sh`
can be applied to the file in the working tree `modules/git-gui/git-gui.sh` by
running `git apply --directory=modules/git-gui`.
---unsafe-paths::
+`--unsafe-paths`::
By default, a patch that affects outside the working area
(either a Git controlled working tree, or the current working
directory when `git apply` is used as a replacement of GNU
diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt
index 72237659d9..8ea76463bf 100644
--- a/Documentation/git-archimport.txt
+++ b/Documentation/git-archimport.txt
@@ -68,22 +68,22 @@ patches that have been traded out-of-sequence between the branches.
OPTIONS
-------
--h::
+`-h`::
Display usage.
--v::
+`-v`::
Verbose output.
--T::
+`-T`::
Many tags. Will create a tag for every commit, reflecting the commit
name in the Arch repository.
--f::
+`-f`::
Use the fast patchset import strategy. This can be significantly
faster for large trees, but cannot handle directory renames or
permissions changes. The default strategy is slow and safe.
--o::
+`-o`::
Use this for compatibility with old-style branch names used by
earlier versions of `git archimport`. Old-style branch names
were category{litdd}branch, whereas new-style branch names are
@@ -96,7 +96,7 @@ OPTIONS
merged from. Specify a depth greater than 1 if patch logs have been
pruned.
--a::
+`-a`::
Attempt to auto-register archives at http://mirrors.sourcecontrol.net
This is particularly useful with the `-D` option.
diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index 4bd6299046..d0ca1241a2 100644
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -33,57 +33,57 @@ comment.
OPTIONS
-------
---format=<fmt>::
+`--format=<fmt>`::
Format of the resulting archive: 'tar' or 'zip'. If this option
is not given, and the output file is specified, the format is
inferred from the filename if possible (e.g. writing to "foo.zip"
makes the output to be in the zip format). Otherwise the output
format is `tar`.
--l::
---list::
+`-l`::
+`--list`::
Show all available formats.
--v::
---verbose::
+`-v`::
+`--verbose`::
Report progress to stderr.
--prefix=<prefix>/::
Prepend <prefix>/ to each filename in the archive.
-o <file>::
---output=<file>::
+`--output=<file>`::
Write the archive to <file> instead of stdout.
---add-file=<file>::
+`--add-file=<file>`::
Add a non-tracked file to the archive. Can be repeated to add
multiple files. The path of the file in the archive is built
by concatenating the value for `--prefix` (if any) and the
basename of <file>.
---worktree-attributes::
+`--worktree-attributes`::
Look for attributes in .gitattributes files in the working tree
as well (see <<ATTRIBUTES>>).
-<extra>::
+`<extra>`::
This can be any options that the archiver backend understands.
See next section.
---remote=<repo>::
+`--remote=<repo>`::
Instead of making a tar archive from the local repository,
retrieve a tar archive from a remote repository. Note that the
remote repository may place restrictions on which sha1
expressions may be allowed in `<tree-ish>`. See
linkgit:git-upload-archive[1] for details.
---exec=<git-upload-archive>::
+`--exec=<git-upload-archive>`::
Used with `--remote` to specify the path to the
`git-upload-archive` on the remote side.
-<tree-ish>::
+`<tree-ish>`::
The tree or commit to produce an archive for.
-<path>::
+`<path>`::
Without an optional path parameter, all files and subdirectories
of the current working directory are included in the archive.
If one or more paths are specified, only these are included.
@@ -134,11 +134,11 @@ tar.<format>.remote::
ATTRIBUTES
----------
-export-ignore::
+`export-ignore`::
Files and directories with the attribute export-ignore won't be
added to archive files. See linkgit:gitattributes[5] for details.
-export-subst::
+`export-subst`::
If the attribute export-subst is set for a file then Git will
expand several placeholders when adding this file to an archive.
See linkgit:gitattributes[5] for details.
diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
index d59422636b..476835938f 100644
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt
@@ -354,7 +354,7 @@ determine the eventual outcome of the bisect session.
OPTIONS
-------
---no-checkout::
+`--no-checkout`::
+
Do not checkout the new working tree at each iteration of the bisection
process. Instead just update a special reference named `BISECT_HEAD` to make
@@ -365,7 +365,7 @@ does not require a checked out tree.
+
If the repository is bare, `--no-checkout` is assumed.
---first-parent::
+`--first-parent`::
+
Follow only the first parent commit upon seeing a merge commit.
+
diff --git a/Documentation/git-blame.txt b/Documentation/git-blame.txt
index aa1b5d56d3..b3d60d241a 100644
--- a/Documentation/git-blame.txt
+++ b/Documentation/git-blame.txt
@@ -50,10 +50,10 @@ OPTIONS
-------
include::blame-options.txt[]
--c::
+`-c`::
Use the same output mode as linkgit:git-annotate[1] (Default: off).
---score-debug::
+`--score-debug`::
Include debugging information related to the movement of
lines between files (see `-C`) and lines moved within a
file (see `-M`). The first number listed is the score.
@@ -62,30 +62,30 @@ include::blame-options.txt[]
a certain threshold for `git blame` to consider those lines
of code to have been moved.
--f::
---show-name::
+`-f`::
+`--show-name`::
Show the filename in the original commit. By default
the filename is shown if there is any line that came from a
file with a different name, due to rename detection.
--n::
---show-number::
+`-n`::
+`--show-number`::
Show the line number in the original commit (Default: off).
--s::
+`-s`::
Suppress the author name and timestamp from the output.
--e::
---show-email::
+`-e`::
+`--show-email`::
Show the author email instead of author name (Default: off).
This can also be controlled via the `blame.showEmail` config
option.
--w::
+`-w`::
Ignore whitespace when comparing the parent's version and
the child's to find where the lines came from.
---abbrev=<n>::
+`--abbrev=<n>`::
Instead of using the default 7+1 hexadecimal digits as the
abbreviated object name, use <m>+1 digits, where <m> is at
least <n> but ensures the commit object names are unique.
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index 6f37f11b33..b9f65c4d52 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -94,16 +94,16 @@ way to clean up all obsolete remote-tracking branches.
OPTIONS
-------
--d::
---delete::
+`-d`::
+`--delete`::
Delete a branch. The branch must be fully merged in its
upstream branch, or in `HEAD` if no upstream was set with
`--track` or `--set-upstream-to`.
--D::
+`-D`::
Shortcut for `--delete --force`.
---create-reflog::
+`--create-reflog`::
Create the branch's reflog. This activates recording of
all changes made to the branch ref, enabling use of date
based sha1 expressions such as "<branchname>@\{yesterday}".
@@ -113,8 +113,8 @@ OPTIONS
`--create-reflog`, but currently does not negate the setting of
`core.logAllRefUpdates`.
--f::
---force::
+`-f`::
+`--force`::
Reset <branchname> to <startpoint>, even if <branchname> exists
already. Without `-f`, `git branch` refuses to change an existing branch.
In combination with `-d` (or `--delete`), allow deleting the
@@ -122,65 +122,65 @@ OPTIONS
`-m` (or `--move`), allow renaming the branch even if the new
branch name already exists, the same applies for `-c` (or `--copy`).
--m::
---move::
+`-m`::
+`--move`::
Move/rename a branch and the corresponding reflog.
--M::
+`-M`::
Shortcut for `--move --force`.
--c::
---copy::
+`-c`::
+`--copy`::
Copy a branch and the corresponding reflog.
--C::
+`-C`::
Shortcut for `--copy --force`.
---color[=<when>]::
+`--color[=<when>]`::
Color branches to highlight current, local, and
remote-tracking branches.
The value must be always (the default), never, or auto.
---no-color::
+`--no-color`::
Turn off branch colors, even when the configuration file gives the
default to color output.
Same as `--color=never`.
--i::
---ignore-case::
+`-i`::
+`--ignore-case`::
Sorting and filtering branches are case insensitive.
---column[=<options>]::
---no-column::
+`--column[=<options>]`::
+`--no-column`::
Display branch listing in columns. See configuration variable
`column.branch` for option syntax. `--column` and `--no-column`
without options are equivalent to 'always' and 'never' respectively.
+
This option is only applicable in non-verbose mode.
--r::
---remotes::
+`-r`::
+`--remotes`::
List or delete (if used with -d) the remote-tracking branches.
Combine with `--list` to match the optional pattern(s).
--a::
---all::
+`-a`::
+`--all`::
List both remote-tracking branches and local branches.
Combine with `--list` to match optional pattern(s).
--l::
---list::
+`-l`::
+`--list`::
List branches. With optional `<pattern>...`, e.g. `git
branch --list 'maint-*'`, list only the branches that match
the pattern(s).
---show-current::
+`--show-current`::
Print the name of the current branch. In detached `HEAD` state,
nothing is printed.
--v::
--vv::
---verbose::
+`-v`::
+`-vv`::
+`--verbose`::
When in list mode,
show sha1 and commit subject line for each head, along with
relationship to upstream branch (if any). If given twice, print
@@ -189,23 +189,23 @@ This option is only applicable in non-verbose mode.
current worktree's `HEAD` will not have its path printed (it will always
be your current directory).
--q::
---quiet::
+`-q`::
+`--quiet`::
Be more quiet when creating or deleting a branch, suppressing
non-error messages.
---abbrev=<n>::
+`--abbrev=<n>`::
In the verbose listing that show the commit object name,
show the shortest prefix that is at least '<n>' hexdigits
long that uniquely refers the object.
The default value is 7 and can be overridden by the `core.abbrev`
config option.
---no-abbrev::
+`--no-abbrev`::
Display the full sha1s in the output listing rather than abbreviating them.
--t::
---track::
+`-t`::
+`--track`::
When creating a new branch, set up `branch.<name>.remote` and
`branch.<name>.merge` configuration entries to mark the
start-point branch as "upstream" from the new branch. This
@@ -220,25 +220,25 @@ want `git switch`, `git checkout` and `git branch` to always behave as if `--no-
were given. Set it to `always` if you want this behavior when the
start-point is either a local or remote-tracking branch.
---no-track::
+`--no-track`::
Do not set up "upstream" configuration, even if the
branch.autoSetupMerge configuration variable is true.
---set-upstream::
+`--set-upstream`::
As this option had confusing syntax, it is no longer supported.
Please use `--track` or `--set-upstream-to` instead.
-u <upstream>::
---set-upstream-to=<upstream>::
+`--set-upstream-to=<upstream>`::
Set up <branchname>'s tracking information so <upstream> is
considered <branchname>'s upstream branch. If no <branchname>
is specified, then it defaults to the current branch.
---unset-upstream::
+`--unset-upstream`::
Remove the upstream information for <branchname>. If no branch
is specified it defaults to the current branch.
---edit-description::
+`--edit-description`::
Open an editor and edit the text to explain what the branch is
for, to be used by various other commands (e.g. `format-patch`,
`request-pull`, and `merge` (if enabled)). Multi-line explanations
@@ -260,25 +260,25 @@ start-point is either a local or remote-tracking branch.
Only list branches whose tips are not reachable from the
specified commit (`HEAD` if not specified). Implies `--list`.
-<branchname>::
+`<branchname>`::
The name of the branch to create or delete.
The new branch name must pass all checks defined by
linkgit:git-check-ref-format[1]. Some of these checks
may restrict the characters allowed in a branch name.
-<start-point>::
+`<start-point>`::
The new branch head will point to this commit. It may be
given as a branch name, a commit-id, or a tag. If this
option is omitted, the current `HEAD` will be used instead.
-<oldbranch>::
+`<oldbranch>`::
The name of an existing branch to rename.
-<newbranch>::
+`<newbranch>`::
The new name for an existing branch. The same restrictions as for
<branchname> apply.
---sort=<key>::
+`--sort=<key>`::
Sort based on the key given. Prefix `-` to sort in descending
order of the value. You may use the `--sort=<key>` option
multiple times, in which case the last key becomes the primary
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index 51f8dd463f..92499c452d 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -63,7 +63,7 @@ unbundle <file>::
references matching those in the list are printed. This command is
really plumbing, intended to be called only by `git fetch`.
-<git-rev-list-args>::
+`<git-rev-list-args>`::
A list of arguments, acceptable to `git rev-parse` and
`git rev-list` (and containing a named ref, see SPECIFYING REFERENCES
below), that specifies the specific objects and references
@@ -81,13 +81,13 @@ unbundle <file>::
necessarily everything in the pack (in this case, `git bundle` acts
like `git fetch-pack`).
---progress::
+`--progress`::
Progress status is reported on the standard error stream
by default when it is attached to a terminal, unless -q
is specified. This flag forces progress status even if
the standard error stream is not directed to a terminal.
---all-progress::
+`--all-progress`::
When `--stdout` is specified then progress report is
displayed during the object count and compression phases
but inhibited during the write-out phase. The reason is
@@ -98,19 +98,19 @@ unbundle <file>::
report for the write-out phase as well even if `--stdout` is
used.
---all-progress-implied::
+`--all-progress-implied`::
This is used to imply `--all-progress` whenever progress display
is activated. Unlike `--all-progress` this flag doesn't actually
force any progress display by itself.
---version=<version>::
+`--version=<version>`::
Specify the bundle version. Version 2 is the older format and can only be
used with SHA-1 repositories; the newer version 3 contains capabilities that
permit extensions. The default is the oldest supported format, based on the
hash algorithm in use.
--q::
---quiet::
+`-q`::
+`--quiet`::
This flag makes the command not to report its progress
on the standard error stream.
diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt
index 3ac3d44fcb..ace67493f6 100644
--- a/Documentation/git-cat-file.txt
+++ b/Documentation/git-cat-file.txt
@@ -28,28 +28,28 @@ whitespace, so that the appropriate drivers can be determined.
OPTIONS
-------
-<object>::
+`<object>`::
The name of the object to show.
For a more complete list of ways to spell object names, see
the "SPECIFYING REVISIONS" section in linkgit:gitrevisions[7].
--t::
+`-t`::
Instead of the content, show the object type identified by
`<object>`.
--s::
+`-s`::
Instead of the content, show the object size identified by
`<object>`.
--e::
+`-e`::
Exit with zero status if `<object>` exists and is a valid
object. If `<object>` is of an invalid format exit with non-zero and
emits an error on stderr.
--p::
+`-p`::
Pretty-print the contents of `<object>` based on its type.
-<type>::
+`<type>`::
Typically this matches the real type of `<object>` but asking
for a type that can trivially be dereferenced from the given
`<object>` is also permitted. An example is to ask for a
@@ -57,54 +57,54 @@ OPTIONS
or to ask for a "blob" with `<object>` being a tag object that
points at it.
---textconv::
+`--textconv`::
Show the content as transformed by a textconv filter. In this case,
`<object>` has to be of the form `<tree-ish>:<path>`, or `:<path>` in
order to apply the filter to the content recorded in the index at
`<path>`.
---filters::
+`--filters`::
Show the content as converted by the filters configured in
the current working tree for the given `<path>` (i.e. smudge filters,
end-of-line conversion, etc). In this case, `<object>` has to be of
the form `<tree-ish>:<path>`, or `:<path>`.
---path=<path>::
+`--path=<path>`::
For use with `--textconv` or `--filters`, to allow specifying an object
name and a path separately, e.g. when it is difficult to figure out
the revision from which the blob came.
---batch::
---batch=<format>::
+`--batch`::
+`--batch=<format>`::
Print object information and contents for each object provided
on stdin. May not be combined with any other options or arguments
except `--textconv` or `--filters`, in which case the input lines
also need to specify the path, separated by whitespace. See the
section `BATCH OUTPUT` below for details.
---batch-check::
---batch-check=<format>::
+`--batch-check`::
+`--batch-check=<format>`::
Print object information for each object provided on stdin. May
not be combined with any other options or arguments except
`--textconv` or `--filters`, in which case the input lines also
need to specify the path, separated by whitespace. See the
section `BATCH OUTPUT` below for details.
---batch-all-objects::
+`--batch-all-objects`::
Instead of reading a list of objects on stdin, perform the
requested batch operation on all objects in the repository and
any alternate object stores (not just reachable objects).
Requires `--batch` or `--batch-check` be specified. Note that
the objects are visited in order sorted by their hashes.
---buffer::
+`--buffer`::
Normally batch output is flushed after each object is output, so
that a process can interactively read and write from
`cat-file`. With this option, the output uses normal stdio
buffering; this is much more efficient when invoking
`--batch-check` on a large number of objects.
---unordered::
+`--unordered`::
When `--batch-all-objects` is in use, visit objects in an
order which may be more efficient for accessing the object
contents than hash order. The exact details of the order are
@@ -114,10 +114,10 @@ OPTIONS
only once, even if it is stored multiple times in the
repository.
---allow-unknown-type::
+`--allow-unknown-type`::
Allow `-s` or `-t` to query broken/corrupt objects of unknown type.
---follow-symlinks::
+`--follow-symlinks`::
With `--batch` or `--batch-check`, follow symlinks inside the
repository when requesting objects with extended SHA-1
expressions of the form tree-ish:path-in-tree. Instead of
diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt
index 0ac496700e..45ec659231 100644
--- a/Documentation/git-check-attr.txt
+++ b/Documentation/git-check-attr.txt
@@ -24,14 +24,14 @@ OPTIONS
paths. If this option is used, then 'unspecified' attributes
will not be included in the output.
---cached::
+`--cached`::
Consider `.gitattributes` in the index only, ignoring the working tree.
---stdin::
+`--stdin`::
Read pathnames from the standard input, one per line,
instead of from the command-line.
--z::
+`-z`::
The output format is modified to be machine-parsable.
If `--stdin` is also given, input paths are separated
with a NUL character instead of a linefeed character.
@@ -57,10 +57,10 @@ unless `-z` is in effect, in which case NUL is used as delimiter:
<path> is the path of a file being queried, <attribute> is an attribute
being queried and <info> can be either:
-'unspecified';; when the attribute is not defined for the path.
-'unset';; when the attribute is defined as false.
-'set';; when the attribute is defined as true.
-<value>;; when a value has been assigned to the attribute.
+`unspecified`;; when the attribute is not defined for the path.
+`unset`;; when the attribute is defined as false.
+`set`;; when the attribute is defined as true.
+`<value>`;; when a value has been assigned to the attribute.
Buffering happens as documented under the `GIT_FLUSH` option in
linkgit:git[1]. The caller is responsible for avoiding deadlocks
diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt
index 56a4f655c8..eabe8467ef 100644
--- a/Documentation/git-check-ignore.txt
+++ b/Documentation/git-check-ignore.txt
@@ -40,11 +40,11 @@ OPTIONS
For precedence rules within and between exclude sources, see
linkgit:gitignore[5].
---stdin::
+`--stdin`::
Read pathnames from the standard input, one per line,
instead of from the command-line.
--z::
+`-z`::
The output format is modified to be machine-parsable (see
below). If `--stdin` is also given, input paths are separated
with a NUL character instead of a linefeed character.
@@ -55,7 +55,7 @@ linkgit:gitignore[5].
not be possible to distinguish between paths which match a
pattern and those which don't.
---no-index::
+`--no-index`::
Don't look in the index when undertaking the checks. This can
be used to debug why a path became tracked by e.g. `git add .`
and was not ignored by the rules as expected by the user or when
diff --git a/Documentation/git-check-mailmap.txt b/Documentation/git-check-mailmap.txt
index 302049afe4..d9a8e368c6 100644
--- a/Documentation/git-check-mailmap.txt
+++ b/Documentation/git-check-mailmap.txt
@@ -23,7 +23,7 @@ otherwise print the input as-is.
OPTIONS
-------
---stdin::
+`--stdin`::
Read contacts, one per line, from the standard input after exhausting
contacts provided on the command-line.
diff --git a/Documentation/git-check-ref-format.txt b/Documentation/git-check-ref-format.txt
index 77beb46e98..d97ee8892f 100644
--- a/Documentation/git-check-ref-format.txt
+++ b/Documentation/git-check-ref-format.txt
@@ -98,19 +98,19 @@ a branch.
OPTIONS
-------
---[no-]allow-onelevel::
+`--[no-]allow-onelevel`::
Controls whether one-level refnames are accepted (i.e.,
refnames that do not contain multiple `/`-separated
components). The default is `--no-allow-onelevel`.
---refspec-pattern::
+`--refspec-pattern`::
Interpret <refname> as a reference name pattern for a refspec
(as used with remote repositories). If this option is
enabled, <refname> is allowed to contain a single `*`
in the refspec (e.g., `foo/bar*/baz` or `foo/bar*baz/`
but not `foo/bar*/baz*`).
---normalize::
+`--normalize`::
Normalize 'refname' by removing any leading slash (`/`)
characters and collapsing runs of adjacent slashes between
name components into a single slash. If the normalized
diff --git a/Documentation/git-checkout-index.txt b/Documentation/git-checkout-index.txt
index 6e49062ea3..8b70168926 100644
--- a/Documentation/git-checkout-index.txt
+++ b/Documentation/git-checkout-index.txt
@@ -22,30 +22,30 @@ Will copy all files listed from the index to the working directory
OPTIONS
-------
--u::
---index::
+`-u`::
+`--index`::
update stat information for the checked out entries in
the index file.
--q::
---quiet::
+`-q`::
+`--quiet`::
be quiet if files exist or are not in the index
--f::
---force::
+`-f`::
+`--force`::
forces overwrite of existing files
--a::
---all::
+`-a`::
+`--all`::
checks out all files in the index. Cannot be used
together with explicit filenames.
--n::
---no-create::
+`-n`::
+`--no-create`::
Don't checkout new files, only refresh files already checked
out.
---prefix=<string>::
+`--prefix=<string>`::
When creating files, prepend <string> (usually a directory
including a trailing /)
@@ -54,17 +54,17 @@ OPTIONS
files from named stage. <number> must be between 1 and 3.
Note: `--stage=all` automatically implies `--temp`.
---temp::
+`--temp`::
Instead of copying the files to the working directory
write the content to temporary files. The temporary name
associations will be written to stdout.
---stdin::
+`--stdin`::
Instead of taking list of paths from the command line,
read list of paths from the standard input. Paths are
separated by LF (i.e. one path per line) by default.
--z::
+`-z`::
Only meaningful with `--stdin`; paths are separated with
NUL character instead of LF.
diff --git a/Documentation/git-checkout.txt b/Documentation/git-checkout.txt
index 15f9690e37..a6cd887e3c 100644
--- a/Documentation/git-checkout.txt
+++ b/Documentation/git-checkout.txt
@@ -104,19 +104,19 @@ file can be discarded to re-create the original conflicted merge result.
OPTIONS
-------
--q::
---quiet::
+`-q`::
+`--quiet`::
Quiet, suppress feedback messages.
---progress::
---no-progress::
+`--progress`::
+`--no-progress`::
Progress status is reported on the standard error stream
by default when it is attached to a terminal, unless `--quiet`
is specified. This flag enables progress reporting even if not
attached to a terminal, regardless of `--quiet`.
--f::
---force::
+`-f`::
+`--force`::
When switching branches, proceed even if the index or the
working tree differs from `HEAD`. This is used to throw away
local changes.
@@ -124,8 +124,8 @@ OPTIONS
When checking out paths from the index, do not fail upon unmerged
entries; instead, unmerged entries are ignored.
---ours::
---theirs::
+`--ours`::
+`--theirs`::
When checking out paths from the index, check out stage #2
('ours') or #3 ('theirs') for unmerged paths.
+
@@ -154,8 +154,8 @@ of it").
equivalent to running `git branch` with `-f`; see
linkgit:git-branch[1] for details.
--t::
---track::
+`-t`::
+`--track`::
When creating a new branch, set up "upstream" configuration. See
`--track` in linkgit:git-branch[1] for details.
+
@@ -169,12 +169,12 @@ off of `origin/hack` (or `remotes/origin/hack`, or even
guessing results in an empty name, the guessing is aborted. You can
explicitly give a name with `-b` in such a case.
---no-track::
+`--no-track`::
Do not set up "upstream" configuration, even if the
`branch.autoSetupMerge` configuration variable is true.
---guess::
---no-guess::
+`--guess`::
+`--no-guess`::
If `<branch>` is not found but there does exist a tracking
branch in exactly one remote (call it `<remote>`) with a
matching name, treat as equivalent to
@@ -197,12 +197,12 @@ linkgit:git-config[1].
The default behavior can be set via the `checkout.guess` configuration
variable.
--l::
+`-l`::
Create the new branch's reflog; see linkgit:git-branch[1] for
details.
--d::
---detach::
+`-d`::
+`--detach`::
Rather than checking out a branch to work on it, check out a
commit for inspection and discardable experiments.
This is the default behavior of `git checkout <commit>` when
@@ -234,14 +234,14 @@ branch by running `git rm -rf .` from the top level of the working tree.
Afterwards you will be ready to prepare your new files, repopulating the
working tree, by copying them from elsewhere, extracting a tarball, etc.
---ignore-skip-worktree-bits::
+`--ignore-skip-worktree-bits`::
In sparse checkout mode, `git checkout -- <paths>` would
update only entries matched by `<paths>` and sparse patterns
in `$GIT_DIR/info/sparse-checkout`. This option ignores
the sparse patterns and adds back any files in `<paths>`.
--m::
---merge::
+`-m`::
+`--merge`::
When switching branches,
if you have local modifications to one or more files that
are different between the current branch and the branch to
@@ -261,15 +261,15 @@ the conflicted merge in the specified paths.
+
When switching branches with `--merge`, staged changes may be lost.
---conflict=<style>::
+`--conflict=<style>`::
The same as `--merge` option above, but changes the way the
conflicting hunks are presented, overriding the
`merge.conflictStyle` configuration variable. Possible values are
"merge" (default) and "diff3" (in addition to what is shown by
"merge" style, shows the original contents).
--p::
---patch::
+`-p`::
+`--patch`::
Interactively select hunks in the difference between the
`<tree-ish>` (or the index, if unspecified) and the working
tree. The chosen hunks are then applied in reverse to the
@@ -282,20 +282,20 @@ section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
Note that this option uses the no overlay mode by default (see also
`--overlay`), and currently doesn't support overlay mode.
---ignore-other-worktrees::
+`--ignore-other-worktrees`::
`git checkout` refuses when the wanted ref is already checked
out by another worktree. This option makes it check the ref
out anyway. In other words, the ref can be held by more than one
worktree.
---overwrite-ignore::
---no-overwrite-ignore::
+`--overwrite-ignore`::
+`--no-overwrite-ignore`::
Silently overwrite ignored files when switching branches. This
is the default behavior. Use `--no-overwrite-ignore` to abort
the operation when the new branch contains ignored files.
---recurse-submodules::
---no-recurse-submodules::
+`--recurse-submodules`::
+`--no-recurse-submodules`::
Using `--recurse-submodules` will update the content of all active
submodules according to the commit recorded in the superproject. If
local modifications in a submodule would be overwritten the checkout
@@ -304,15 +304,15 @@ Note that this option uses the no overlay mode by default (see also
Just like linkgit:git-submodule[1], this will detach `HEAD` of the
submodule.
---overlay::
---no-overlay::
+`--overlay`::
+`--no-overlay`::
In the default overlay mode, `git checkout` never
removes files from the index or the working tree. When
specifying `--no-overlay`, files that appear in the index and
working tree, but not in `<tree-ish>` are removed, to make them
match `<tree-ish>` exactly.
---pathspec-from-file=<file>::
+`--pathspec-from-file=<file>`::
Pathspec is passed in `<file>` instead of commandline args. If
`<file>` is exactly `-` then standard input is used. Pathspec
elements are separated by LF or CR/LF. Pathspec elements can be
@@ -320,12 +320,12 @@ Note that this option uses the no overlay mode by default (see also
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
global `--literal-pathspecs`.
---pathspec-file-nul::
+`--pathspec-file-nul`::
Only meaningful with `--pathspec-from-file`. Pathspec elements are
separated with NUL character and all other characters are taken
literally (including newlines and quotes).
-<branch>::
+`<branch>`::
Branch to checkout; if it refers to a branch (i.e., a name that,
when prepended with `refs/heads/`, is a valid ref), then that
branch is checked out. Otherwise, if it refers to a valid
@@ -351,7 +351,7 @@ As a special case, you may use `"A...B"` as a shortcut for the
merge base of `A` and `B` if there is exactly one merge base. You can
leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
-<tree-ish>::
+`<tree-ish>`::
Tree to checkout from (when paths are given). If not specified,
the index will be used.
+
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index fb12a67778..5d6021e4ca 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -50,19 +50,19 @@ OPTIONS
feed all <commit>... arguments to a single revision walk
(see a later example that uses 'maint master..next').
--e::
---edit::
+`-e`::
+`--edit`::
With this option, `git cherry-pick` will let you edit the commit
message prior to committing.
---cleanup=<mode>::
+`--cleanup=<mode>`::
This option determines how the commit message will be cleaned up before
being passed on to the commit machinery. See linkgit:git-commit[1] for more
details. In particular, if the '<mode>' is given a value of `scissors`,
scissors will be appended to `MERGE_MSG` before being passed on in the case
of a conflict.
--x::
+`-x`::
When recording the commit, append a line that says
"(cherry picked from commit ...)" to the original commit
message in order to indicate which commit this change was
@@ -76,7 +76,7 @@ OPTIONS
development branch), adding this information can be
useful.
--r::
+`-r`::
It used to be that the command defaulted to do `-x`
described above, and `-r` was to disable it. Now the
default is not to do `-x` so this option is a no-op.
@@ -89,8 +89,8 @@ OPTIONS
the mainline and allows cherry-pick to replay the change
relative to the specified parent.
--n::
---no-commit::
+`-n`::
+`--no-commit`::
Usually the command automatically creates a sequence of commits.
This flag applies the changes necessary to cherry-pick
each named commit to your working tree and the index,
@@ -102,26 +102,26 @@ OPTIONS
This is useful when cherry-picking more than one commits'
effect to your index in a row.
--s::
---signoff::
+`-s`::
+`--signoff`::
Add a `Signed-off-by` trailer at the end of the commit message.
See the signoff option in linkgit:git-commit[1] for more information.
--S[<keyid>]::
---gpg-sign[=<keyid>]::
---no-gpg-sign::
+`-S[<keyid>]`::
+`--gpg-sign[=<keyid>]`::
+`--no-gpg-sign`::
GPG-sign commits. The `keyid` argument is optional and
defaults to the committer identity; if specified, it must be
stuck to the option without a space. `--no-gpg-sign` is useful to
countermand both `commit.gpgSign` configuration variable, and
earlier `--gpg-sign`.
---ff::
+`--ff`::
If the current `HEAD` is the same as the parent of the
cherry-pick'ed commit, then a fast forward to this commit will
be performed.
---allow-empty::
+`--allow-empty`::
By default, cherry-picking an empty commit will fail,
indicating that an explicit invocation of `git commit
--allow-empty` is required. This option overrides that
@@ -134,30 +134,30 @@ effect to your index in a row.
previous commit are dropped. To force the inclusion of those commits
use `--keep-redundant-commits`.
---allow-empty-message::
+`--allow-empty-message`::
By default, cherry-picking a commit with an empty message will fail.
This option overrides that behavior, allowing commits with empty
messages to be cherry picked.
---keep-redundant-commits::
+`--keep-redundant-commits`::
If a commit being cherry picked duplicates a commit already in the
current history, it will become empty. By default these
redundant commits cause `cherry-pick` to stop so the user can
examine the commit. This option overrides that behavior and
creates an empty commit object. Implies `--allow-empty`.
---strategy=<strategy>::
+`--strategy=<strategy>`::
Use the given merge strategy. Should only be used once.
See the MERGE STRATEGIES section in linkgit:git-merge[1]
for details.
--X<option>::
---strategy-option=<option>::
+`-X<option>`::
+`--strategy-option=<option>`::
Pass the merge strategy-specific option through to the
merge strategy. See linkgit:git-merge[1] for details.
---rerere-autoupdate::
---no-rerere-autoupdate::
+`--rerere-autoupdate`::
+`--no-rerere-autoupdate`::
Allow the rerere mechanism to update the index with the
result of auto-conflict resolution if possible.
diff --git a/Documentation/git-cherry.txt b/Documentation/git-cherry.txt
index ab55060668..ff57fd3329 100644
--- a/Documentation/git-cherry.txt
+++ b/Documentation/git-cherry.txt
@@ -26,17 +26,17 @@ commits that do not.
OPTIONS
-------
--v::
+`-v`::
Show the commit subjects next to the SHA1s.
-<upstream>::
+`<upstream>`::
Upstream branch to search for equivalent commits.
Defaults to the upstream branch of `HEAD`.
-<head>::
+`<head>`::
Working branch; defaults to `HEAD`.
-<limit>::
+`<limit>`::
Do not report commits up to (and including) limit.
EXAMPLES
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index 7923ae27a5..e782f48c2c 100644
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -25,7 +25,7 @@ are affected.
OPTIONS
-------
--d::
+`-d`::
Normally, when no <path> is specified, `git clean` will not
recurse into untracked directories to avoid removing too much.
Specify `-d` to have it recurse into such directories as well.
@@ -33,34 +33,34 @@ OPTIONS
files matching the specified paths (with exceptions for nested
`git` directories mentioned under `--force`) will be removed.
--f::
---force::
+`-f`::
+`--force`::
If the Git configuration variable `clean.requireForce` is not set
to false, `git clean` will refuse to delete files or directories
unless given `-f` or `-i`. Git will refuse to modify untracked
nested `git` repositories (directories with a .git subdirectory)
unless a second `-f` is given.
--i::
---interactive::
+`-i`::
+`--interactive`::
Show what would be done and clean files interactively. See
``Interactive mode'' for details.
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Don't actually remove anything, just show what would be done.
--q::
---quiet::
+`-q`::
+`--quiet`::
Be quiet, only report errors, but not the files that are
successfully removed.
-e <pattern>::
---exclude=<pattern>::
+`--exclude=<pattern>`::
Use the given exclude pattern in addition to the standard ignore rules
(see linkgit:gitignore[5]).
--x::
+`-x`::
Don't use the standard ignore rules (see linkgit:gitignore[5]), but
still use the ignore rules given with `-e` options from the command
line. This allows removing all untracked
@@ -68,7 +68,7 @@ OPTIONS
conjunction with `git restore` or `git reset`) to create a pristine
working directory to test a clean build.
--X::
+`-X`::
Remove only files ignored by Git. This may be useful to rebuild
everything from scratch, but keep manually created files.
@@ -94,7 +94,7 @@ You also could say `c` or `clean` above as long as the choice is unique.
The main command loop has 6 subcommands.
-clean::
+`clean`::
Start cleaning files and directories, and then quit.
@@ -125,11 +125,11 @@ ask each::
to delete items. Please note that this action is not as efficient
as the above two actions.
-quit::
+`quit`::
This lets you quit without do cleaning.
-help::
+`help`::
Show brief usage of interactive `git-clean`.
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index b8ca823467..935d191ae1 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -42,8 +42,8 @@ configuration variables.
OPTIONS
-------
--l::
---local::
+`-l`::
+`--local`::
When the repository to clone from is on a local machine,
this flag bypasses the normal "Git aware" transport
mechanism and clones the repository by making a copy of
@@ -62,14 +62,14 @@ Git transport instead.
source repository, similar to running `cp -r src dst` while modifying
`src`.
---no-hardlinks::
+`--no-hardlinks`::
Force the cloning process from a repository on a local
filesystem to copy the files under the `.git/objects`
directory instead of using hardlinks. This may be desirable
if you are trying to make a back-up of your repository.
--s::
---shared::
+`-s`::
+`--shared`::
When the repository to clone is on the local machine,
instead of using hard links, automatically setup
`.git/objects/info/alternates` to share the objects
@@ -110,7 +110,7 @@ objects from the source repository into a pack in the cloned repository.
*NOTE*: see the NOTE for the `--shared` option, and also the
`--dissociate` option.
---dissociate::
+`--dissociate`::
Borrow the objects from reference repositories specified
with the `--reference` options only to reduce network
transfer, and stop borrowing from them after a clone is made
@@ -121,23 +121,23 @@ objects from the source repository into a pack in the cloned repository.
same repository, and this option can be used to stop the
borrowing.
--q::
---quiet::
+`-q`::
+`--quiet`::
Operate quietly. Progress is not reported to the standard
error stream.
--v::
---verbose::
+`-v`::
+`--verbose`::
Run verbosely. Does not affect the reporting of progress status
to the standard error stream.
---progress::
+`--progress`::
Progress status is reported on the standard error stream
by default when it is attached to a terminal, unless `--quiet`
is specified. This flag forces progress status even if the
standard error stream is not directed to a terminal.
---server-option=<option>::
+`--server-option=<option>`::
Transmit the given string to the server when communicating using
protocol version 2. The given string must not contain a NUL or LF
character. The server's handling of server options, including
@@ -145,16 +145,16 @@ objects from the source repository into a pack in the cloned repository.
When multiple `--server-option=<option>` are given, they are all
sent to the other side in the order listed on the command line.
--n::
---no-checkout::
+`-n`::
+`--no-checkout`::
No checkout of `HEAD` is performed after the clone is complete.
---[no-]reject-shallow::
+`--[no-]reject-shallow`::
Fail if the source repository is a shallow repository.
- The 'clone.rejectShallow' configuration variable can be used to
+ The `clone.rejectShallow` configuration variable can be used to
specify the default.
---bare::
+`--bare`::
Make a 'bare' Git repository. That is, instead of
creating `<directory>` and placing the administrative
files in `<directory>/.git`, make the `<directory>`
@@ -166,13 +166,13 @@ objects from the source repository into a pack in the cloned repository.
used, neither remote-tracking branches nor the related
configuration variables are created.
---sparse::
+`--sparse`::
Initialize the sparse-checkout file so the working
directory starts with only the files in the root
of the repository. The sparse-checkout file can be
modified to grow the working directory as needed.
---filter=<filter-spec>::
+`--filter=<filter-spec>`::
Use the partial clone feature and request that the server sends
a subset of reachable objects according to a given object filter.
When using `--filter`, the supplied `<filter-spec>` is used for
@@ -182,7 +182,7 @@ objects from the source repository into a pack in the cloned repository.
at least `<size>`. For more details on filter specifications, see
the `--filter` option in linkgit:git-rev-list[1].
---mirror::
+`--mirror`::
Set up a mirror of the source repository. This implies `--bare`.
Compared to `--bare`, `--mirror` not only maps local branches of the
source to local branches of the target, it maps all refs (including
@@ -239,15 +239,15 @@ corresponding `--mirror` and `--no-tags` options instead.
tips of all branches. If you want to clone submodules shallowly,
also pass `--shallow-submodules`.
---shallow-since=<date>::
+`--shallow-since=<date>`::
Create a shallow clone with a history after the specified time.
---shallow-exclude=<revision>::
+`--shallow-exclude=<revision>`::
Create a shallow clone with a history, excluding commits
reachable from a specified remote branch or tag. This option
can be specified multiple times.
---[no-]single-branch::
+`--[no-]single-branch`::
Clone only the history leading to the tip of a single branch,
either specified by the `--branch` option or the primary
branch remote's `HEAD` points at.
@@ -257,7 +257,7 @@ corresponding `--mirror` and `--no-tags` options instead.
branch when `--single-branch` clone was made, no remote-tracking
branch is created.
---no-tags::
+`--no-tags`::
Don't clone any tags, and set
`remote.<remote>.tagOpt=--no-tags` in the config, ensuring
that future `git pull` and `git fetch` operations won't follow
@@ -269,7 +269,7 @@ maintain a branch with no references other than a single cloned
branch. This is useful e.g. to maintain minimal clones of the default
branch of some repository for search indexing.
---recurse-submodules[=<pathspec>]::
+`--recurse-submodules[=<pathspec>]`::
After the clone is created, initialize and clone submodules
within based on the provided pathspec. If no pathspec is
provided, all submodules are initialized and cloned.
@@ -285,10 +285,10 @@ the clone is finished. This option is ignored if the cloned repository does
not have a worktree/checkout (i.e. if any of `--no-checkout`/`-n`, `--bare`,
or `--mirror` is given)
---[no-]shallow-submodules::
+`--[no-]shallow-submodules`::
All submodules which are cloned will be shallow with a depth of 1.
---[no-]remote-submodules::
+`--[no-]remote-submodules`::
All submodules which are cloned will use the status of the submodule's
remote-tracking branch to update the submodule, rather than the
superproject's recorded SHA-1. Equivalent to passing `--remote` to
@@ -306,12 +306,12 @@ or `--mirror` is given)
The number of submodules fetched at the same time.
Defaults to the `submodule.fetchJobs` option.
-<repository>::
+`<repository>`::
The (possibly remote) repository to clone from. See the
<<URLS,GIT URLS>> section below for more information on specifying
repositories.
-<directory>::
+`<directory>`::
The name of a new directory to clone into. The "humanish"
part of the source repository is used if no directory is
explicitly given (`repo` for `/path/to/repo.git` and `foo`
diff --git a/Documentation/git-commit-graph.txt b/Documentation/git-commit-graph.txt
index 3246616b10..1e6db29d4a 100644
--- a/Documentation/git-commit-graph.txt
+++ b/Documentation/git-commit-graph.txt
@@ -21,7 +21,7 @@ Manage the serialized commit-graph file.
OPTIONS
-------
---object-dir::
+`--object-dir`::
Use given directory for the location of packfiles and commit-graph
file. This parameter exists to specify the location of an alternate
that only has the objects directory, not a full `.git` directory. The
@@ -31,13 +31,13 @@ OPTIONS
object directory, `git commit-graph ...` will exit with non-zero
status.
---[no-]progress::
+`--[no-]progress`::
Turn progress on/off explicitly. If neither is specified, progress is
shown if standard error is connected to a terminal.
COMMANDS
--------
-'write'::
+`write`::
Write a commit-graph file based on the commits found in packfiles. If
the config option `core.commitGraph` is disabled, then this command will
@@ -103,7 +103,7 @@ Finally, if `--expire-time=<datetime>` is not specified, let `datetime`
be the current time. After writing the split commit-graph, delete all
unused commit-graph whose modified times are older than `datetime`.
-'verify'::
+`verify`::
Read the commit-graph file and verify its contents against the object
database. Used to check for corrupted data.
diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt
index 48a76dd029..47f21f4bcc 100644
--- a/Documentation/git-commit-tree.txt
+++ b/Documentation/git-commit-tree.txt
@@ -44,7 +44,7 @@ state was.
OPTIONS
-------
-<tree>::
+`<tree>`::
An existing tree object.
-p <parent>::
@@ -59,9 +59,9 @@ OPTIONS
from the standard input. This can be given more than once and the
content of each file becomes its own paragraph.
--S[<keyid>]::
---gpg-sign[=<keyid>]::
---no-gpg-sign::
+`-S[<keyid>]`::
+`--gpg-sign[=<keyid>]`::
+`--no-gpg-sign`::
GPG-sign commits. The `keyid` argument is optional and
defaults to the committer identity; if specified, it must be
stuck to the option without a space. `--no-gpg-sign` is useful to
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 3b22ba718c..48be5646c4 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -64,26 +64,26 @@ that, you can recover from it with `git reset`.
OPTIONS
-------
--a::
---all::
+`-a`::
+`--all`::
Tell the command to automatically stage files that have
been modified and deleted, but new files you have not
told Git about are not affected.
--p::
---patch::
+`-p`::
+`--patch`::
Use the interactive patch selection interface to chose
which changes to commit. See linkgit:git-add[1] for
details.
-C <commit>::
---reuse-message=<commit>::
+`--reuse-message=<commit>`::
Take an existing commit object, and reuse the log message
and the authorship information (including the timestamp)
when creating the commit.
-c <commit>::
---reedit-message=<commit>::
+`--reedit-message=<commit>`::
Like `-C`, but with `-c` the editor is invoked, so that
the user can further edit the commit message.
@@ -126,37 +126,37 @@ Neither "fixup!" nor "amend!" commits change authorship of
`<commit>` when applied by `git rebase --autosquash`.
See linkgit:git-rebase[1] for details.
---squash=<commit>::
+`--squash=<commit>`::
Construct a commit message for use with `rebase --autosquash`.
The commit message subject line is taken from the specified
commit with a prefix of "squash! ". Can be used with additional
commit message options (`-m`/`-c`/`-C`/`-F`). See
linkgit:git-rebase[1] for details.
---reset-author::
+`--reset-author`::
When used with `-C`/`-c`/`--amend` options, or when committing after a
conflicting cherry-pick, declare that the authorship of the
resulting commit now belongs to the committer. This also renews
the author timestamp.
---short::
+`--short`::
When doing a dry-run, give the output in the short-format. See
linkgit:git-status[1] for details. Implies `--dry-run`.
---branch::
+`--branch`::
Show the branch and tracking info even in short-format.
---porcelain::
+`--porcelain`::
When doing a dry-run, give the output in a porcelain-ready
format. See linkgit:git-status[1] for details. Implies
`--dry-run`.
---long::
+`--long`::
When doing a dry-run, give the output in the long-format.
Implies `--dry-run`.
--z::
---null::
+`-z`::
+`--null`::
When showing `short` or `porcelain` status output, print the
filename verbatim and terminate the entries with NUL, instead of LF.
If no format is given, implies the `--porcelain` output format.
@@ -165,22 +165,22 @@ See linkgit:git-rebase[1] for details.
(see linkgit:git-config[1]).
-F <file>::
---file=<file>::
+`--file=<file>`::
Take the commit message from the given file. Use '-' to
read the message from the standard input.
---author=<author>::
+`--author=<author>`::
Override the commit author. Specify an explicit author using the
standard `A U Thor <author@example.com>` format. Otherwise <author>
is assumed to be a pattern and is used to search for an existing
commit by that author (i.e. `git rev-list --all -i --author=<author>`);
the commit author is then copied from the first such commit found.
---date=<date>::
+`--date=<date>`::
Override the author date used in the commit.
-m <msg>::
---message=<msg>::
+`--message=<msg>`::
Use the given <msg> as the commit message.
If multiple `-m` options are given, their values are
concatenated as separate paragraphs.
@@ -188,7 +188,7 @@ See linkgit:git-rebase[1] for details.
The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.
-t <file>::
---template=<file>::
+`--template=<file>`::
When editing the commit message, start the editor with the
contents in the given file. The `commit.template` configuration
variable is often used to give this option implicitly to the
@@ -200,7 +200,7 @@ The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.
include::signoff-option.txt[]
---trailer <token>[(=|:)<value>]::
+`--trailer <token>[(=|:)<value>]`::
Specify a (<token>, <value>) pair that should be applied as a
trailer. (e.g. `git commit --trailer "Signed-off-by:C O Mitter \
<committer@example.com>" --trailer "Helped-by:C O Mitter \
@@ -211,44 +211,44 @@ include::signoff-option.txt[]
a duplicated trailer is omitted, where in the run of trailers
each trailer would appear, and other details.
--n::
---no-verify::
+`-n`::
+`--no-verify`::
This option bypasses the pre-commit and commit-msg hooks.
See also linkgit:githooks[5].
---allow-empty::
+`--allow-empty`::
Usually recording a commit that has the exact same tree as its
sole parent commit is a mistake, and the command prevents you
from making such a commit. This option bypasses the safety, and
is primarily for use by foreign SCM interface scripts.
---allow-empty-message::
+`--allow-empty-message`::
Like `--allow-empty` this command is primarily for use by foreign
SCM interface scripts. It allows you to create a commit with an
empty commit message without using plumbing commands like
linkgit:git-commit-tree[1].
---cleanup=<mode>::
+`--cleanup=<mode>`::
This option determines how the supplied commit message should be
cleaned up before committing. The '<mode>' can be `strip`,
`whitespace`, `verbatim`, `scissors` or `default`.
+
--
-strip::
+`strip`::
Strip leading and trailing empty lines, trailing whitespace,
commentary and collapse consecutive empty lines.
-whitespace::
+`whitespace`::
Same as `strip` except #commentary is not removed.
-verbatim::
+`verbatim`::
Do not change the message at all.
-scissors::
+`scissors`::
Same as `whitespace` except that everything from (and including)
the line found below is truncated, if the message is to be edited.
"`#`" can be customized with `core.commentChar`.
# ------------------------ >8 ------------------------
-default::
+`default`::
Same as `strip` if the message is to be edited.
Otherwise `whitespace`.
--
@@ -256,19 +256,19 @@ default::
The default can be changed by the `commit.cleanup` configuration
variable (see linkgit:git-config[1]).
--e::
---edit::
+`-e`::
+`--edit`::
The message taken from file with `-F`, command line with
`-m`, and from commit object with `-C` are usually used as
the commit log message unmodified. This option lets you
further edit the message taken from these sources.
---no-edit::
+`--no-edit`::
Use the selected commit message without launching an editor.
For example, `git commit --amend --no-edit` amends a commit
without changing its commit message.
---amend::
+`--amend`::
Replace the tip of the current branch by creating a new
commit. The recorded tree is prepared as usual (including
the effect of the `-i` and `-o` options and explicit
@@ -294,18 +294,18 @@ You should understand the implications of rewriting history if you
amend a commit that has already been published. (See the "RECOVERING
FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
---no-post-rewrite::
+`--no-post-rewrite`::
Bypass the post-rewrite hook.
--i::
---include::
+`-i`::
+`--include`::
Before making a commit out of staged contents so far,
stage the contents of paths given on the command line
as well. This is usually not what you want unless you
are concluding a conflicted merge.
--o::
---only::
+`-o`::
+`--only`::
Make a commit by taking the updated working tree contents
of the paths specified on the
command line, disregarding any contents that have been
@@ -318,7 +318,7 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
already been staged. If used together with `--allow-empty`
paths are also not required, and an empty commit will be created.
---pathspec-from-file=<file>::
+`--pathspec-from-file=<file>`::
Pathspec is passed in `<file>` instead of commandline args. If
`<file>` is exactly `-` then standard input is used. Pathspec
elements are separated by LF or CR/LF. Pathspec elements can be
@@ -326,13 +326,13 @@ FROM UPSTREAM REBASE" section in linkgit:git-rebase[1].)
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
global `--literal-pathspecs`.
---pathspec-file-nul::
+`--pathspec-file-nul`::
Only meaningful with `--pathspec-from-file`. Pathspec elements are
separated with NUL character and all other characters are taken
literally (including newlines and quotes).
--u[<mode>]::
---untracked-files[=<mode>]::
+`-u[<mode>]`::
+`--untracked-files[=<mode>]`::
Show untracked files.
+
--
@@ -350,8 +350,8 @@ The default can be changed using the `status.showUntrackedFiles`
configuration variable documented in linkgit:git-config[1].
--
--v::
---verbose::
+`-v`::
+`--verbose`::
Show unified diff between the `HEAD` commit and what
would be committed at the bottom of the commit message
template to help the user describe the commit by reminding
@@ -365,29 +365,29 @@ If specified twice, show in addition the unified diff between
what would be committed and the worktree files, i.e. the unstaged
changes to tracked files.
--q::
---quiet::
+`-q`::
+`--quiet`::
Suppress commit summary message.
---dry-run::
+`--dry-run`::
Do not create a commit, but show a list of paths that are
to be committed, paths with local changes that will be left
uncommitted and paths that are untracked.
---status::
+`--status`::
Include the output of linkgit:git-status[1] in the commit
message template when using an editor to prepare the commit
message. Defaults to on, but can be used to override
configuration variable `commit.status`.
---no-status::
+`--no-status`::
Do not include the output of linkgit:git-status[1] in the
commit message template when using an editor to prepare the
default commit message.
--S[<keyid>]::
---gpg-sign[=<keyid>]::
---no-gpg-sign::
+`-S[<keyid>]`::
+`--gpg-sign[=<keyid>]`::
+`--no-gpg-sign`::
GPG-sign commits. The `keyid` argument is optional and
defaults to the committer identity; if specified, it must be
stuck to the option without a space. `--no-gpg-sign` is useful to
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 80b646b895..b70aad6e0f 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -74,24 +74,24 @@ On success, the command returns the exit code 0.
OPTIONS
-------
---replace-all::
+`--replace-all`::
Default behavior is to replace at most one line. This replaces
all lines matching the key (and optionally the `value-pattern`).
---add::
+`--add`::
Adds a new line to the option without altering any existing
values. This is the same as providing '^$' as the `value-pattern`
in `--replace-all`.
---get::
+`--get`::
Get the value for a given key (optionally filtered by a regex
matching the value). Returns error code 1 if the key was not
found and the last value if multiple key values were found.
---get-all::
+`--get-all`::
Like get, but returns all values for a multi-valued key.
---get-regexp::
+`--get-regexp`::
Like `--get-all`, but interprets the name as a regular expression and
writes out the key names. Regular expression matching is currently
case-sensitive and done against a canonicalized version of the key
@@ -106,7 +106,7 @@ OPTIONS
section as name, do so for all the keys in the section and
list them. Returns error code 1 if no value is found.
---global::
+`--global`::
For writing options: write to global `~/.gitconfig` file
rather than the repository `.git/config`, write to
`$XDG_CONFIG_HOME/git/config` file if this file exists and the
@@ -117,7 +117,7 @@ For reading options: read only from global `~/.gitconfig` and from
+
See also <<FILES>>.
---system::
+`--system`::
For writing options: write to system-wide
`$(prefix)/etc/gitconfig` rather than the repository
`.git/config`.
@@ -127,7 +127,7 @@ rather than from all available files.
+
See also <<FILES>>.
---local::
+`--local`::
For writing options: write to the repository `.git/config` file.
This is the default behavior.
+
@@ -136,7 +136,7 @@ from all available files.
+
See also <<FILES>>.
---worktree::
+`--worktree`::
Similar to `--local` except that `.git/config.worktree` is
read from or written to if `extensions.worktreeConfig` is
present. If not it's the same as `--local`.
@@ -152,23 +152,23 @@ See also <<FILES>>.
section in linkgit:gitrevisions[7] for a more complete list of
ways to spell blob names.
---remove-section::
+`--remove-section`::
Remove the given section from the configuration file.
---rename-section::
+`--rename-section`::
Rename the given section to a new name.
---unset::
+`--unset`::
Remove the line matching the key from config file.
---unset-all::
+`--unset-all`::
Remove all lines matching the key from config file.
--l::
---list::
+`-l`::
+`--list`::
List all variables set in config file, along with their values.
---fixed-value::
+`--fixed-value`::
When used with the `value-pattern` argument, treat `value-pattern` as
an exact string instead of a regular expression. This will restrict
the name/value pairs that are matched to only those where the value
@@ -199,21 +199,21 @@ Valid `<type>`'s include:
as-is.
+
---bool::
---int::
---bool-or-int::
---path::
---expiry-date::
+`--bool`::
+`--int`::
+`--bool-or-int`::
+`--path`::
+`--expiry-date`::
Historical options for selecting a type specifier. Prefer instead `--type`
(see above).
---no-type::
+`--no-type`::
Un-sets the previously set type specifier (if one was previously set). This
option requests that `git config` not canonicalize the retrieved variable.
`--no-type` has no effect without `--type=<type>` or `--<type>`.
--z::
---null::
+`-z`::
+`--null`::
For all options that output values and/or keys, always
end values with the null character (instead of a
newline). Use newline instead as a delimiter between
@@ -221,17 +221,17 @@ Valid `<type>`'s include:
output without getting confused e.g. by values that
contain line breaks.
---name-only::
+`--name-only`::
Output only the names of config variables for `--list` or
`--get-regexp`.
---show-origin::
+`--show-origin`::
Augment the output of all queried config options with the
origin type (file, standard input, blob, command line) and
the actual origin (config file path, ref, or blob id if
applicable).
---show-scope::
+`--show-scope`::
Similar to `--show-origin` in that it augments the output of
all queried config options with the scope of that value
(local, global, system, command).
@@ -258,12 +258,12 @@ Valid `<type>`'s include:
(but note that `--get-color` will omit the trailing newline printed by
`--type=color`).
--e::
---edit::
+`-e`::
+`--edit`::
Opens an editor to modify the specified config file; either
`--system`, `--global`, or repository (default).
---[no-]includes::
+`--[no-]includes`::
Respect `include.*` directives in config files when looking up
values. Defaults to `off` when a specific file is given (e.g.,
using `--file`, `--global`, etc) and `on` when searching all
diff --git a/Documentation/git-count-objects.txt b/Documentation/git-count-objects.txt
index a52bd618c4..6033087dbd 100644
--- a/Documentation/git-count-objects.txt
+++ b/Documentation/git-count-objects.txt
@@ -18,8 +18,8 @@ them, to help you decide when it is a good time to repack.
OPTIONS
-------
--v::
---verbose::
+`-v`::
+`--verbose`::
Report in more detail:
+
count: the number of loose objects
@@ -44,8 +44,8 @@ multiple times, one line per path. Note that if the path contains
non-printable characters, it may be surrounded by double-quotes and
contain C-style backslashed escape sequences.
--H::
---human-readable::
+`-H`::
+`--human-readable`::
Print sizes in human readable format
diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt
index 596512ec73..64e98c4f1d 100644
--- a/Documentation/git-cvsexportcommit.txt
+++ b/Documentation/git-cvsexportcommit.txt
@@ -34,52 +34,52 @@ parent the changeset should be done against.
OPTIONS
-------
--c::
+`-c`::
Commit automatically if the patch applied cleanly. It will not
commit if any hunks fail to apply or there were other problems.
--p::
+`-p`::
Be pedantic (paranoid) when applying patches. Invokes patch with
`--fuzz=0`
--a::
+`-a`::
Add authorship information. Adds Author line, and Committer (if
different from Author) to the message.
--d::
+`-d`::
Set an alternative CVSROOT to use. This corresponds to the CVS
`-d` parameter. Usually users will not want to set this, except
if using CVS in an asymmetric fashion.
--f::
+`-f`::
Force the merge even if the files are not up to date.
--P::
+`-P`::
Force the parent commit, even if it is not a direct parent.
--m::
+`-m`::
Prepend the commit message with the provided prefix.
Useful for patch series and the like.
--u::
+`-u`::
Update affected files from CVS repository before attempting export.
--k::
+`-k`::
Reverse CVS keyword expansion (e.g. $Revision: 1.2.3.4$
becomes $Revision$) in working CVS checkout before applying patch.
--w::
+`-w`::
Specify the location of the CVS checkout to use for the export. This
option does not require GIT_DIR to be set before execution if the
current directory is within a Git repository. The default is the
value of `cvsexportcommit.cvsdir`.
--W::
+`-W`::
Tell cvsexportcommit that the current working directory is not only
a Git checkout, but also the CVS checkout. Therefore, Git will
reset the working directory to the parent commit before proceeding.
--v::
+`-v`::
Verbose.
CONFIGURATION
diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt
index ead844944e..5caeed88ed 100644
--- a/Documentation/git-cvsimport.txt
+++ b/Documentation/git-cvsimport.txt
@@ -49,7 +49,7 @@ See linkgit:gitcvs-migration[7].
OPTIONS
-------
--v::
+`-v`::
Verbosity: let 'cvsimport' report what it is doing.
-d <CVSROOT>::
@@ -85,17 +85,17 @@ OPTIONS
Use `-o master` for continuing an import that was initially done by
the old cvs2git tool.
--i::
+`-i`::
Import-only: don't perform a checkout after importing. This option
ensures the working directory and index remain untouched and will
not create them if they do not exist.
--k::
+`-k`::
Kill keywords: will extract files with `-kk` from the CVS archive
to avoid noisy changesets. Highly recommended, but off by default
to preserve compatibility with early imported trees.
--u::
+`-u`::
Convert underscores in tag and branch names to dots.
-s <subst>::
@@ -115,7 +115,7 @@ If you need to pass multiple options, separate them with a comma.
Instead of calling cvsps, read the provided cvsps output file. Useful
for debugging or when cvsps is being handled outside cvsimport.
--m::
+`-m`::
Attempt to detect merges based on the commit message. This option
will enable default regexes that try to capture the source
branch name from the commit message.
@@ -132,7 +132,7 @@ This option can be used several times to provide several detection regexes.
-S <regex>::
Skip paths matching the regex.
--a::
+`-a`::
Import all commits, including recent ones. cvsimport by default
skips commits that have a timestamp less than 10 minutes ago.
@@ -165,7 +165,7 @@ It is not recommended to use this feature if you intend to
export changes back to CVS again later with
`git cvsexportcommit`.
--R::
+`-R`::
Generate a `$GIT_DIR/cvs-revisions` file containing a mapping from CVS
revision numbers to newly-created Git commit IDs. The generated file
will contain one line for each (filename, revision) pair imported;
@@ -181,7 +181,7 @@ doing incremental imports.
This option may be useful if you have CVS revision numbers stored in commit
messages, bug-tracking systems, email archives, and the like.
--h::
+`-h`::
Print a short usage message and exit.
OUTPUT
diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
index bf53d16a7f..5b7bfe6dc0 100644
--- a/Documentation/git-cvsserver.txt
+++ b/Documentation/git-cvsserver.txt
@@ -34,23 +34,23 @@ closely as possible.
--base-path <path>::
Prepend 'path' to requested CVSROOT
---strict-paths::
+`--strict-paths`::
Don't allow recursing into subdirectories
---export-all::
+`--export-all`::
Don't check for `gitcvs.enabled` in config. You also have to specify a list
of allowed directories (see below) if you want to use this option.
--V::
---version::
+`-V`::
+`--version`::
Print version information and exit
--h::
--H::
---help::
+`-h`::
+`-H`::
+`--help`::
Print usage information and exit
-<directory>::
+`<directory>`::
You can specify a list of allowed directories. If no directories
are given, all are allowed. This is an additional restriction, gitcvs
access still needs to be enabled by the `gitcvs.enabled` config option
diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index 3f684378f4..533be2b997 100644
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -46,26 +46,26 @@ An `upload-archive` also exists to serve `git archive`.
OPTIONS
-------
---strict-paths::
+`--strict-paths`::
Match paths exactly (i.e. don't allow "/foo/repo" when the real path is
"/foo/repo.git" or "/foo/repo/.git") and don't do user-relative paths.
`git daemon` will refuse to start when this option is enabled and no
whitelist is specified.
---base-path=<path>::
+`--base-path=<path>`::
Remap all the path requests as relative to the given path.
This is sort of "Git root" - if you run `git daemon` with
`--base-path=/srv/git` on `example.com`, then if you later try to pull
`git://example.com/hello.git`, `git daemon` will interpret the path
as `/srv/git/hello.git`.
---base-path-relaxed::
+`--base-path-relaxed`::
If `--base-path` is enabled and repo lookup fails, with this option
`git daemon` will attempt to lookup without prefixing the base path.
This is useful for switching to `--base-path` usage, while still
allowing the old paths.
---interpolated-path=<pathtemplate>::
+`--interpolated-path=<pathtemplate>`::
To support virtual hosting, an interpolated path template can be
used to dynamically construct alternate paths. The template
supports %H for the target hostname as supplied by the client but
@@ -75,12 +75,12 @@ OPTIONS
After interpolation, the path is validated against the directory
whitelist.
---export-all::
+`--export-all`::
Allow pulling from all directories that look like Git repositories
(have the 'objects' and 'refs' subdirectories), even if they
do not have the `git-daemon-export-ok` file.
---inetd::
+`--inetd`::
Have the server run as an inetd service. Implies `--syslog` (may be
overridden with `--log-destination=`).
Incompatible with `--detach`, `--port`, `--listen`, `--user` and `--group`
@@ -94,49 +94,49 @@ OPTIONS
Can be given more than once.
Incompatible with `--inetd` option.
---port=<n>::
+`--port=<n>`::
Listen on an alternative port. Incompatible with `--inetd` option.
---init-timeout=<n>::
+`--init-timeout=<n>`::
Timeout (in seconds) between the moment the connection is established
and the client request is received (typically a rather low value, since
that should be basically immediate).
---timeout=<n>::
+`--timeout=<n>`::
Timeout (in seconds) for specific client sub-requests. This includes
the time it takes for the server to process the sub-request and the
time spent waiting for the next client's request.
---max-connections=<n>::
+`--max-connections=<n>`::
Maximum number of concurrent clients, defaults to 32. Set it to
zero for no limit.
---syslog::
+`--syslog`::
Short for `--log-destination=syslog`.
---log-destination=<destination>::
+`--log-destination=<destination>`::
Send log messages to the specified destination.
Note that this option does not imply `--verbose`,
thus by default only error conditions will be logged.
The <destination> must be one of:
+
--
-stderr::
+`stderr`::
Write to standard error.
Note that if `--detach` is specified,
the process disconnects from the real standard error,
making this destination effectively equivalent to `none`.
-syslog::
+`syslog`::
Write to syslog, using the `git-daemon` identifier.
-none::
+`none`::
Disable all logging.
--
+
The default destination is `syslog` if `--inetd` or `--detach` is specified,
otherwise `stderr`.
---user-path::
---user-path=<path>::
+`--user-path`::
+`--user-path=<path>`::
Allow {tilde}user notation to be used in requests. When
specified with no parameter, requests to
`git://host/~alice/foo` is taken as a request to access
@@ -145,23 +145,23 @@ otherwise `stderr`.
taken as a request to access `path/foo` repository in
the home directory of user `alice`.
---verbose::
+`--verbose`::
Log details about the incoming connections and requested files.
---reuseaddr::
+`--reuseaddr`::
Use SO_REUSEADDR when binding the listening socket.
This allows the server to restart without waiting for
old connections to time out.
---detach::
+`--detach`::
Detach from the shell. Implies `--syslog`.
---pid-file=<file>::
+`--pid-file=<file>`::
Save the process id in 'file'. Ignored when the daemon
is run under `--inetd`.
---user=<user>::
---group=<group>::
+`--user=<user>`::
+`--group=<group>`::
Change daemon's uid and gid before entering the service loop.
When only `--user` is given without `--group`, the
primary group ID for the user is used. The values of
@@ -179,21 +179,21 @@ may also want to set and export `HOME` to point at the home
directory of `<user>` before starting the daemon, and make sure any
Git configuration files in that directory are readable by `<user>`.
---enable=<service>::
---disable=<service>::
+`--enable=<service>`::
+`--disable=<service>`::
Enable/disable the service site-wide per default. Note
that a service disabled site-wide can still be enabled
per repository if it is marked overridable and the
repository enables the service with a configuration
item.
---allow-override=<service>::
---forbid-override=<service>::
+`--allow-override=<service>`::
+`--forbid-override=<service>`::
Allow/forbid overriding the site-wide default with per
repository configuration. By default, all the services
may be overridden.
---[no-]informative-errors::
+`--[no-]informative-errors`::
When informative errors are turned on, `git-daemon` will report
more verbose errors to the client, differentiating conditions
like "no such repository" from "repository not exported". This
@@ -202,7 +202,7 @@ Git configuration files in that directory are readable by `<user>`.
errors are not enabled, all errors report "access denied" to the
client. The default is `--no-informative-errors`.
---access-hook=<path>::
+`--access-hook=<path>`::
Every time a client connects, first run an external command
specified by the <path> with service name (e.g. "upload-pack"),
path to the repository, hostname (%H), canonical hostname
@@ -217,7 +217,7 @@ The external command can optionally write a single line to its
standard output to be sent to the requestor as an error message when
it declines the service.
-<directory>::
+`<directory>`::
A directory to add to the whitelist of allowed directories. Unless
`--strict-paths` is specified this will also include subdirectories
of each named directory.
@@ -232,18 +232,18 @@ against only in a few selected repositories the daemon serves),
the per-repository configuration file can be used to enable or
disable them.
-upload-pack::
+`upload-pack`::
This serves `git fetch-pack` and `git ls-remote`
clients. It is enabled by default, but a repository can
disable it by setting `daemon.uploadpack` configuration
item to `false`.
-upload-archive::
+`upload-archive`::
This serves `git archive --remote`. It is disabled by
default, but a repository can enable it by setting
`daemon.uploadarch` configuration item to `true`.
-receive-pack::
+`receive-pack`::
This serves `git send-pack` clients, allowing anonymous
push. It is disabled by default, as there is _no_
authentication in the protocol (in other words, anybody
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index a21eafa025..39cecb4ce6 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -37,8 +37,8 @@ OPTIONS
<commit-ish>...::
Commit-ish object names to describe. Defaults to `HEAD` if omitted.
---dirty[=<mark>]::
---broken[=<mark>]::
+`--dirty[=<mark>]`::
+`--broken[=<mark>]`::
Describe the state of the working tree. When the working
tree matches `HEAD`, the output is the same as `git describe
HEAD`. If the working tree has local modification "-dirty"
@@ -47,44 +47,44 @@ OPTIONS
error out, unless `--broken' is given, which appends
the suffix "-broken" instead.
---all::
+`--all`::
Instead of using only the annotated tags, use any ref
found in `refs/` namespace. This option enables matching
any known branch, remote-tracking branch, or lightweight tag.
---tags::
+`--tags`::
Instead of using only the annotated tags, use any tag
found in `refs/tags` namespace. This option enables matching
a lightweight (non-annotated) tag.
---contains::
+`--contains`::
Instead of finding the tag that predates the commit, find
the tag that comes after the commit, and thus contains it.
Automatically implies `--tags`.
---abbrev=<n>::
+`--abbrev=<n>`::
Instead of using the default 7 hexadecimal digits as the
abbreviated object name, use <n> digits, or as many digits
as needed to form a unique object name. An <n> of 0
will suppress long format, only showing the closest tag.
---candidates=<n>::
+`--candidates=<n>`::
Instead of considering only the 10 most recent tags as
candidates to describe the input commit-ish consider
up to <n> candidates. Increasing <n> above 10 will take
slightly longer but may produce a more accurate result.
An <n> of 0 will cause only exact matches to be output.
---exact-match::
+`--exact-match`::
Only output exact matches (a tag directly references the
supplied commit). This is a synonym for `--candidates=0`.
---debug::
+`--debug`::
Verbosely display information about the searching strategy
being employed to standard error. The tag name will still
be printed to standard out.
---long::
+`--long`::
Always output the long format (the tag, the number of commits
and the abbreviated commit name) even when it matches a tag.
This is useful when you want to see parts of the commit object name
@@ -115,10 +115,10 @@ OPTIONS
match any of the `--exclude` patterns. Use `--no-exclude` to clear and
reset the list of patterns.
---always::
+`--always`::
Show uniquely abbreviated commit object as fallback.
---first-parent::
+`--first-parent`::
Follow only the first parent commit upon seeing a merge commit.
This is useful when you wish to not match tags on branches merged
in the history of the target commit.
diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt
index b0fb276b99..5a993a309f 100644
--- a/Documentation/git-diff-files.txt
+++ b/Documentation/git-diff-files.txt
@@ -34,14 +34,14 @@ The default is to diff against our branch (-2) and the
cleanly resolved paths. The option -0 can be given to
omit diff output for unmerged entries and just show "Unmerged".
--c::
---cc::
+`-c`::
+`--cc`::
This compares stage 2 (our branch), stage 3 (their
branch) and the working tree file and outputs a combined
diff, similar to the way 'diff-tree' shows a merge
commit with these flags.
--q::
+`-q`::
Remain silent even on nonexistent files
diff --git a/Documentation/git-diff-index.txt b/Documentation/git-diff-index.txt
index 87db234e77..e95e997e2b 100644
--- a/Documentation/git-diff-index.txt
+++ b/Documentation/git-diff-index.txt
@@ -23,18 +23,18 @@ OPTIONS
-------
include::diff-options.txt[]
-<tree-ish>::
+`<tree-ish>`::
The id of a tree object to diff against.
---cached::
+`--cached`::
Do not consider the on-disk file at all.
---merge-base::
+`--merge-base`::
Instead of comparing <tree-ish> directly, use the merge base
between <tree-ish> and `HEAD` instead. <tree-ish> must be a
commit.
--m::
+`-m`::
By default, files recorded in the index but not checked
out are reported as deleted. This flag makes
`git diff-index` say that all non-checked-out files are up
diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt
index 56354886a4..098e67f872 100644
--- a/Documentation/git-diff-tree.txt
+++ b/Documentation/git-diff-tree.txt
@@ -26,29 +26,29 @@ OPTIONS
-------
include::diff-options.txt[]
-<tree-ish>::
+`<tree-ish>`::
The id of a tree object.
<path>...::
If provided, the results are limited to a subset of files
matching one of the provided pathspecs.
--r::
+`-r`::
recurse into sub-trees
--t::
+`-t`::
show tree entry itself as well as subtrees. Implies `-r`.
---root::
+`--root`::
When `--root` is specified the initial commit will be shown as a big
creation event. This is equivalent to a diff against the NULL tree.
---merge-base::
+`--merge-base`::
Instead of comparing the <tree-ish>s directly, use the merge
base between the two <tree-ish>s as the "before" side. There
must be two <tree-ish>s given and they must both be commits.
---stdin::
+`--stdin`::
When `--stdin` is specified, the command does not take
<tree-ish> arguments from the command line. Instead, it
reads lines containing either two <tree>, one <commit>, or a
@@ -68,29 +68,29 @@ newline, is printed.
The following flags further affect the behavior when comparing
commits (but not trees).
--m::
+`-m`::
By default, `git diff-tree --stdin` does not show
differences for merge commits. With this flag, it shows
differences to that commit from all of its parents. See
also `-c`.
--s::
+`-s`::
By default, `git diff-tree --stdin` shows differences,
either in machine-readable form (without `-p`) or in patch
form (with `-p`). This output can be suppressed. It is
only useful with `-v` flag.
--v::
+`-v`::
This flag causes `git diff-tree --stdin` to also show
the commit message before the differences.
include::pretty-options.txt[]
---no-commit-id::
+`--no-commit-id`::
`git diff-tree` outputs a line with the commit ID when
applicable. This flag suppressed the commit ID output.
--c::
+`-c`::
This flag changes the way a merge commit is displayed
(which means it is useful only when the command is given
one <tree-ish>, or `--stdin`). It shows the differences
@@ -100,7 +100,7 @@ include::pretty-options.txt[]
Furthermore, it lists only files which were modified
from all parents.
---cc::
+`--cc`::
This flag changes the way a merge commit patch is displayed,
in a similar way to the `-c` option. It implies the `-c`
and `-p` options and further compresses the patch output
@@ -110,14 +110,14 @@ include::pretty-options.txt[]
itself and the commit log message is not shown, just like in any other
"empty diff" case.
---combined-all-paths::
+`--combined-all-paths`::
This flag causes combined diffs (used for merge commits) to
list the name of the file from all parents. It thus only has
effect when `-c` or `--cc` are specified, and is likely only
useful if filename changes are detected (i.e. when either
rename or copy detection have been requested).
---always::
+`--always`::
Show the commit itself and the commit log message even
if the diff itself is empty.
diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
index b646654941..f8b1e83404 100644
--- a/Documentation/git-difftool.txt
+++ b/Documentation/git-difftool.txt
@@ -19,31 +19,31 @@ linkgit:git-diff[1].
OPTIONS
-------
--d::
---dir-diff::
+`-d`::
+`--dir-diff`::
Copy the modified files to a temporary location and perform
a directory diff on them. This mode never prompts before
launching the diff tool.
--y::
---no-prompt::
+`-y`::
+`--no-prompt`::
Do not prompt before launching a diff tool.
---prompt::
+`--prompt`::
Prompt before each invocation of the diff tool.
This is the default behaviour; the option is provided to
override any configuration settings.
---rotate-to=<file>::
+`--rotate-to=<file>`::
Start showing the diff for the given path,
the paths before it will move to end and output.
---skip-to=<file>::
+`--skip-to=<file>`::
Start showing the diff for the given path, skipping all
the paths before it.
-t <tool>::
---tool=<tool>::
+`--tool=<tool>`::
Use the diff tool specified by <tool>. Valid values include
emerge, kompare, meld, and vimdiff. Run `git difftool --tool-help`
for the list of valid <tool> settings.
@@ -74,10 +74,10 @@ of the diff post-image. `$MERGED` is the name of the file which is
being compared. `$BASE` is provided for compatibility
with custom merge tool commands and has the same value as `$MERGED`.
---tool-help::
+`--tool-help`::
Print a list of diff tools that may be used with `--tool`.
---[no-]symlinks::
+`--[no-]symlinks`::
`git difftool`'s default behavior is create symlinks to the
working tree when run in `--dir-diff` mode and the right-hand
side of the comparison yields the same content as the file in
@@ -87,14 +87,14 @@ Specifying `--no-symlinks` instructs `git difftool` to create copies
instead. `--no-symlinks` is the default on Windows.
-x <command>::
---extcmd=<command>::
+`--extcmd=<command>`::
Specify a custom command for viewing diffs.
`git-difftool` ignores the configured defaults and runs
`$command $LOCAL $REMOTE` when this option is specified.
Additionally, `$BASE` is set in the environment.
--g::
---[no-]gui::
+`-g`::
+`--[no-]gui`::
When `git-difftool` is invoked with the `-g` or `--gui` option
the default diff tool will be read from the configured
`diff.guitool` variable instead of `diff.tool`. The `--no-gui`
@@ -102,7 +102,7 @@ instead. `--no-symlinks` is the default on Windows.
is not set, we will fallback in the order of `merge.guitool`,
`diff.tool`, `merge.tool` until a tool is found.
---[no-]trust-exit-code::
+`--[no-]trust-exit-code`::
`git-difftool` invokes a diff tool individually on each file.
Errors reported by the diff tool are ignored by default.
Use `--trust-exit-code` to make `git-difftool` exit when an
diff --git a/Documentation/git-fast-export.txt b/Documentation/git-fast-export.txt
index 0e1db78aee..b50751b344 100644
--- a/Documentation/git-fast-export.txt
+++ b/Documentation/git-fast-export.txt
@@ -23,7 +23,7 @@ relied on by tools like `git filter-repo`).
OPTIONS
-------
---progress=<n>::
+`--progress=<n>`::
Insert 'progress' statements every <n> objects, to be shown by
`git fast-import` during import.
@@ -50,8 +50,8 @@ the output. With 'rewrite', if the tagged object is a commit, it will
rewrite the tag to tag an ancestor commit (via parent rewriting; see
linkgit:git-rev-list[1])
--M::
--C::
+`-M`::
+`-C`::
Perform move and/or copy detection, as described in the
linkgit:git-diff[1] manual page, and use it to generate
rename and copy commands in the output dump.
@@ -59,7 +59,7 @@ linkgit:git-rev-list[1])
Note that earlier versions of this command did not complain and
produced incorrect results if you gave these options.
---export-marks=<file>::
+`--export-marks=<file>`::
Dumps the internal marks table to <file> when complete.
Marks are written one per line as `:markid SHA-1`. Only marks
for revisions are dumped; marks for blobs are ignored.
@@ -71,12 +71,12 @@ produced incorrect results if you gave these options.
The file will not be written if no new object has been
marked/exported.
---import-marks=<file>::
+`--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`.
---mark-tags::
+`--mark-tags`::
In addition to labelling blobs and commits with mark ids, also
label tags. This is useful in conjunction with
`--export-marks` and `--import-marks`, and is also useful (and
@@ -90,17 +90,17 @@ exported again. 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.
---fake-missing-tagger::
+`--fake-missing-tagger`::
Some old repositories have tags without a tagger. The
fast-import protocol was pretty strict about that, and did not
allow that. So fake a tagger to be able to fast-import the
output.
---use-done-feature::
+`--use-done-feature`::
Start the stream with a 'feature done' stanza, and terminate
it with a 'done' command.
---no-data::
+`--no-data`::
Skip output of blob objects and instead refer to blobs via
their original SHA-1 hash. This is useful when rewriting the
directory structure or history of a repository without
@@ -108,13 +108,13 @@ by keeping the marks the same across runs.
resulting stream can only be used by a repository which
already contains the necessary objects.
---full-tree::
+`--full-tree`::
This option will cause fast-export to issue a "deleteall"
directive for each commit followed by a full list of all files
in the commit (as opposed to just listing the files which are
different from the commit's first parent).
---anonymize::
+`--anonymize`::
Anonymize the contents of the repository while still retaining
the shape of the history and stored tree. See the section on
`ANONYMIZING` below.
@@ -124,7 +124,7 @@ by keeping the marks the same across runs.
`<to>` is omitted, map `<from>` to itself (i.e., do not
anonymize it). See the section on `ANONYMIZING` below.
---reference-excluded-parents::
+`--reference-excluded-parents`::
By default, running a command such as `git fast-export
master~5..master` will not include the commit `master~5`
and will make `master~4` no longer have `master~5` as
@@ -136,7 +136,7 @@ by keeping the marks the same across runs.
repository which already contains the necessary parent
commits.
---show-original-ids::
+`--show-original-ids`::
Add an extra directive to the output for commits and blobs,
`original-oid <SHA1SUM>`. While such directives will likely be
ignored by importers such as `git-fast-import`, it may be useful
@@ -150,7 +150,7 @@ by keeping the marks the same across runs.
message will be re-encoded into UTF-8. With 'no', the original
encoding will be preserved.
---refspec::
+`--refspec`::
Apply the specified refspec to each ref exported. Multiple of them can
be specified.
diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt
index 7b801de61a..cfbb47665f 100644
--- a/Documentation/git-fast-import.txt
+++ b/Documentation/git-fast-import.txt
@@ -34,24 +34,24 @@ the frontend program in use.
OPTIONS
-------
---force::
+`--force`::
Force updating modified existing branches, even if doing
so would cause commits to be lost (as the new commit does
not contain the old commit).
---quiet::
+`--quiet`::
Disable the output shown by `--stats`, making fast-import usually
be silent when it is successful. However, if the import stream
has directives intended to show user output (e.g. `progress`
directives), the corresponding messages will still be shown.
---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`.
---allow-unsafe-features::
+`--allow-unsafe-features`::
Many command-line options can be provided as part of the
fast-import stream itself by using the `feature` or `option`
commands. However, some of these options are unsafe (e.g.,
@@ -69,19 +69,19 @@ OPTIONS
Options for Frontends
~~~~~~~~~~~~~~~~~~~~~
---cat-blob-fd=<fd>::
+`--cat-blob-fd=<fd>`::
Write responses to `get-mark`, `cat-blob`, and `ls` queries to the
file descriptor <fd> instead of `stdout`. Allows `progress`
output intended for the end-user to be separated from other
output.
---date-format=<fmt>::
+`--date-format=<fmt>`::
Specify the type of dates the frontend will supply to
fast-import within `author`, `committer` and `tagger` commands.
See ``Date Formats'' below for details about which formats
are supported, and their syntax.
---done::
+`--done`::
Terminate with error if there is no `done` command at the end of
the stream. This option might be useful for detecting errors
that cause the frontend to terminate before it has started to
@@ -90,7 +90,7 @@ Options for Frontends
Locations of Marks Files
~~~~~~~~~~~~~~~~~~~~~~~~
---export-marks=<file>::
+`--export-marks=<file>`::
Dumps the internal marks table to <file> when complete.
Marks are written one per line as `:markid SHA-1`.
Frontends can use this file to validate imports after they
@@ -99,7 +99,7 @@ Locations of Marks Files
at checkpoint (or completion) the same path can also be
safely given to `--import-marks`.
---import-marks=<file>::
+`--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`.
@@ -107,11 +107,11 @@ Locations of Marks Files
set of marks. If a mark is defined to different values,
the last file wins.
---import-marks-if-exists=<file>::
+`--import-marks-if-exists=<file>`::
Like `--import-marks` but instead of erroring out, silently
skips the file if it does not exist.
---[no-]relative-marks::
+`--[no-]relative-marks`::
After specifying `--relative-marks` the paths specified
with `--import-marks`= and `--export-marks`= are relative
to an internal directory in the current repository.
@@ -145,21 +145,21 @@ algorithm.
Performance and Compression Tuning
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
---active-branches=<n>::
+`--active-branches=<n>`::
Maximum number of branches to maintain active at once.
See ``Memory Utilization'' below for details. Default is 5.
---big-file-threshold=<n>::
+`--big-file-threshold=<n>`::
Maximum size of a blob that fast-import will attempt to
create a delta for, expressed in bytes. The default is 512m
(512 MiB). Some importers may wish to lower this on systems
with constrained memory.
---depth=<n>::
+`--depth=<n>`::
Maximum delta depth, for blob and tree deltification.
Default is 50.
---export-pack-edges=<file>::
+`--export-pack-edges=<file>`::
After creating a packfile, print a line of data to
<file> listing the filename of the packfile and the last
commit on each branch that was written to that packfile.
@@ -168,7 +168,7 @@ Performance and Compression Tuning
as these commits can be used as edge points during calls
to `git pack-objects`.
---max-pack-size=<n>::
+`--max-pack-size=<n>`::
Maximum size of each output packfile.
The default is unlimited.
@@ -1141,17 +1141,17 @@ it does not.
The <feature> part of the command may be any one of the following:
-date-format::
-export-marks::
-relative-marks::
-no-relative-marks::
-force::
+`date-format`::
+`export-marks`::
+`relative-marks`::
+`no-relative-marks`::
+`force`::
Act as though the corresponding command-line option with
a leading `--` was passed on the command line
(see OPTIONS, above).
-import-marks::
-import-marks-if-exists::
+`import-marks`::
+`import-marks-if-exists`::
Like `--import-marks` except in two respects: first, only one
"feature import-marks" or "feature import-marks-if-exists"
command is allowed per stream; second, an `--import-marks=`
@@ -1160,9 +1160,9 @@ import-marks-if-exists::
"feature import-marks-if-exists" like a corresponding
command-line option silently skips a nonexistent file.
-get-mark::
-cat-blob::
-ls::
+`get-mark`::
+`cat-blob`::
+`ls`::
Require that the backend support the 'get-mark', 'cat-blob',
or 'ls' command respectively.
Versions of fast-import not supporting the specified command
@@ -1171,13 +1171,13 @@ ls::
rather than wasting time on the early part of an import
before the unsupported command is detected.
-notes::
+`notes`::
Require that the backend support the 'notemodify' (N)
subcommand to the 'commit' command.
Versions of fast-import not supporting notes will exit
with a message indicating so.
-done::
+`done`::
Error out if the stream ends without a 'done' command.
Without this feature, errors causing the frontend to end
abruptly at a convenient point in the stream can go
diff --git a/Documentation/git-fetch-pack.txt b/Documentation/git-fetch-pack.txt
index 3d829538b0..e7e4ed214a 100644
--- a/Documentation/git-fetch-pack.txt
+++ b/Documentation/git-fetch-pack.txt
@@ -32,10 +32,10 @@ have a common ancestor commit.
OPTIONS
-------
---all::
+`--all`::
Fetch all remote refs.
---stdin::
+`--stdin`::
Take the list of refs from stdin, one per line. If there
are refs specified on the command line in addition to this
option, then the refs from stdin are processed after those
@@ -45,29 +45,29 @@ If `--stateless-rpc` is specified together with this option then
the list of refs must be in packet format (pkt-line). Each ref must
be in a separate packet, and the list must end with a flush packet.
--q::
---quiet::
+`-q`::
+`--quiet`::
Pass `-q` flag to `git unpack-objects`; this makes the
cloning process less verbose.
--k::
---keep::
+`-k`::
+`--keep`::
Do not invoke `git unpack-objects` on received data, but
create a single packfile out of it instead, and store it
in the object database. If provided twice then the pack is
locked against repacking.
---thin::
+`--thin`::
Fetch a "thin" pack, which records objects in deltified form based
on objects not included in the pack to reduce network traffic.
---include-tag::
+`--include-tag`::
If the remote side supports it, annotated tags objects will
be downloaded on the same connection as the other objects if
the object the tag references is downloaded. The caller must
otherwise determine the tags this option made available.
---upload-pack=<git-upload-pack>::
+`--upload-pack=<git-upload-pack>`::
Use this to specify the path to `git-upload-pack` on the
remote side, if is not found on your `$PATH`.
Installations of sshd ignores the user's environment
@@ -79,39 +79,39 @@ be in a separate packet, and the list must end with a flush packet.
shells by having a lean `.bashrc` file (they set most of
the things up in `.bash_profile`).
---exec=<git-upload-pack>::
+`--exec=<git-upload-pack>`::
Same as `--upload-pack`=<git-upload-pack>.
---depth=<n>::
+`--depth=<n>`::
Limit fetching to ancestor-chains not longer than n.
`git-upload-pack` treats the special depth 2147483647 as
infinite even if there is an ancestor-chain that long.
---shallow-since=<date>::
+`--shallow-since=<date>`::
Deepen or shorten the history of a shallow repository to
include all reachable commits after <date>.
---shallow-exclude=<revision>::
+`--shallow-exclude=<revision>`::
Deepen or shorten the history of a shallow repository to
exclude commits reachable from a specified remote branch or tag.
This option can be specified multiple times.
---deepen-relative::
+`--deepen-relative`::
Argument `--depth` specifies the number of commits from the
current shallow boundary instead of from the tip of each
remote branch history.
---no-progress::
+`--no-progress`::
Do not show the progress.
---check-self-contained-and-connected::
+`--check-self-contained-and-connected`::
Output "connectivity-ok" if the received pack is
self-contained and connected.
--v::
+`-v`::
Run verbosely.
-<repository>::
+`<repository>`::
The URL to the remote repository.
<refs>...::
diff --git a/Documentation/git-fetch.txt b/Documentation/git-fetch.txt
index 11ee865969..79c7f15904 100644
--- a/Documentation/git-fetch.txt
+++ b/Documentation/git-fetch.txt
@@ -48,7 +48,7 @@ include::fetch-options.txt[]
include::pull-fetch-param.txt[]
---stdin::
+`--stdin`::
Read refspecs, one per line, from stdin in addition to those provided
as arguments. The "tag <name>" format is not supported.
@@ -212,7 +212,7 @@ In compact output mode, specified with configuration variable
other string, it will be substituted with `*` in the other string. For
example, `master -> origin/master` becomes `master -> origin/*`.
-flag::
+`flag`::
A single character indicating the status of the ref:
(space);; for a successfully fetched fast-forward;
`+`;; for a successful forced update;
@@ -222,22 +222,22 @@ flag::
`!`;; for a ref that was rejected or failed to update; and
`=`;; for a ref that was up to date and did not need fetching.
-summary::
+`summary`::
For a successfully fetched ref, the summary shows the old and new
values of the ref in a form suitable for using as an argument to
`git log` (this is `<old>..<new>` in most cases, and
`<old>...<new>` for forced non-fast-forward updates).
-from::
+`from`::
The name of the remote ref being fetched from, minus its
`refs/<type>/` prefix. In the case of deletion, the name of
the remote ref is "(none)".
-to::
+`to`::
The name of the local ref being updated, minus its
`refs/<type>/` prefix.
-reason::
+`reason`::
A human-readable explanation. In the case of successfully fetched
refs, no explanation is needed. For a failed ref, the reason for
failure is described.
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 8b19805695..4a72e4ce44 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -185,7 +185,7 @@ be removed, buyer beware. There is also no support for changing the
author or timestamp (or the tag message for that matter). Tags which point
to other tags will be rewritten to point to the underlying commit.
---prune-empty::
+`--prune-empty`::
Some filters will generate empty commits that leave the tree untouched.
This option instructs `git-filter-branch` to remove such commits if they
have exactly one or zero non-pruned parents; merge commits will
@@ -205,8 +205,8 @@ to other tags will be rewritten to point to the underlying commit.
does this in the `.git-rewrite/` directory but you can override
that choice by this parameter.
--f::
---force::
+`-f`::
+`--force`::
`git filter-branch` refuses to start with an existing temporary
directory or when there are already refs starting with
`refs/original/`, unless forced.
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index a8e9ab914d..283bb59199 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -24,18 +24,18 @@ automatically invoking `git merge`.
OPTIONS
-------
---log[=<n>]::
+`--log[=<n>]`::
In addition to branch names, populate the log message with
one-line descriptions from the actual commits that are being
merged. At most <n> commits from each merge parent will be
used (20 if <n> is omitted). This overrides the `merge.log`
configuration variable.
---no-log::
+`--no-log`::
Do not list one-line descriptions from the actual commits being
merged.
---[no-]summary::
+`--[no-]summary`::
Synonyms to `--log` and `--no-log`; these are deprecated and will be
removed in the future.
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 518f040fcd..74be946d9d 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -32,19 +32,19 @@ OPTIONS
literally, in the latter case matching completely or from the
beginning up to a slash.
---count=<count>::
+`--count=<count>`::
By default the command shows all refs that match
`<pattern>`. This option makes it stop after showing
that many refs.
---sort=<key>::
+`--sort=<key>`::
A field name to sort on. Prefix `-` to sort in
descending order of the value. When unspecified,
`refname` is used. You may use the `--sort=<key>` option
multiple times, in which case the last key becomes the primary
key.
---format=<format>::
+`--format=<format>`::
A string that interpolates `%(fieldname)` from a ref being shown
and the object it points at. If `fieldname`
is prefixed with an asterisk (`*`) and the ref points
@@ -57,40 +57,40 @@ OPTIONS
`xx`; for example `%00` interpolates to `\0` (NUL),
`%09` to `\t` (TAB) and `%0a` to `\n` (LF).
---color[=<when>]::
+`--color[=<when>]`::
Respect any colors specified in the `--format` option. The
`<when>` field must be one of `always`, `never`, or `auto` (if
`<when>` is absent, behave as if `always` was given).
---shell::
---perl::
---python::
---tcl::
+`--shell`::
+`--perl`::
+`--python`::
+`--tcl`::
If given, strings that substitute `%(fieldname)`
placeholders are quoted as string literals suitable for
the specified host language. This is meant to produce
a scriptlet that can directly be `eval`ed.
---points-at=<object>::
+`--points-at=<object>`::
Only list refs which points at the given object.
---merged[=<object>]::
+`--merged[=<object>]`::
Only list refs whose tips are reachable from the
specified commit (`HEAD` if not specified).
---no-merged[=<object>]::
+`--no-merged[=<object>]`::
Only list refs whose tips are not reachable from the
specified commit (`HEAD` if not specified).
---contains[=<object>]::
+`--contains[=<object>]`::
Only list refs which contain the specified commit (`HEAD` if not
specified).
---no-contains[=<object>]::
+`--no-contains[=<object>]`::
Only list refs which don't contain the specified commit (`HEAD`
if not specified).
---ignore-case::
+`--ignore-case`::
Sorting and filtering refs are case insensitive.
FIELD NAMES
@@ -102,7 +102,7 @@ keys.
For all objects, the following names can be used:
-refname::
+`refname`::
The name of the ref (the part after `$GIT_DIR`/).
For a non-ambiguous short name of the ref append `:short`.
The option `core.warnAmbiguousRefs` is used to select the strict
@@ -121,25 +121,25 @@ refname::
+
`strip` can be used as a synonym to `lstrip`.
-objecttype::
+`objecttype`::
The type of the object (`blob`, `tree`, `commit`, `tag`).
-objectsize::
+`objectsize`::
The size of the object (the same as `git cat-file -s` reports).
Append `:disk` to get the size, in bytes, that the object takes up on
disk. See the note about on-disk sizes in the `CAVEATS` section below.
-objectname::
+`objectname`::
The object name (aka SHA-1).
For a non-ambiguous abbreviation of the object name append `:short`.
For an abbreviation of the object name with desired length append
`:short=<length>`, where the minimum length is MINIMUM_ABBREV. The
length may be exceeded to ensure unique object names.
-deltabase::
+`deltabase`::
This expands to the object name of the delta base for the
given object, if it is stored as a delta. Otherwise it
expands to the null object name (all zeroes).
-upstream::
+`upstream`::
The name of a local ref which can be considered ``upstream''
from the displayed ref. Respects `:short`, `:lstrip` and
`:rstrip` in the same way as `refname` above. Additionally
@@ -161,24 +161,24 @@ Has no effect if the ref does not have tracking information associated
with it. All the options apart from `nobracket` are mutually exclusive,
but if used together the last option is selected.
-push::
+`push`::
The name of a local ref which represents the `@{push}`
location for the displayed ref. Respects `:short`, `:lstrip`,
`:rstrip`, `:track`, `:trackshort`, `:remotename`, and `:remoteref`
options as `upstream` does. Produces an empty string if no `@{push}`
ref is configured.
-HEAD::
+`HEAD`::
'*' if `HEAD` matches current ref (the checked out branch), ' '
otherwise.
-color::
+`color`::
Change output color. Followed by `:<colorname>`, where color
names are described under Values in the "CONFIGURATION FILE"
section of linkgit:git-config[1]. For example,
`%(color:bold red)`.
-align::
+`align`::
Left-, middle-, or right-align the content between
%(align:...) and %(end). The "align:" is followed by
`width=<width>` and `position=<position>` in any order
@@ -193,7 +193,7 @@ align::
quoted, but if nested then only the topmost level performs
quoting.
-if::
+`if`::
Used as %(if)...%(then)...%(end) or
%(if)...%(then)...%(else)...%(end). If there is an atom with
value or string literal after the %(if) then everything after
@@ -206,13 +206,13 @@ if::
the value between the %(if:...) and %(then) atoms with the
given string.
-symref::
+`symref`::
The ref which the given symbolic ref refers to. If not a
symbolic ref, nothing is printed. Respects the `:short`,
`:lstrip` and `:rstrip` options in the same way as `refname`
above.
-worktreepath::
+`worktreepath`::
The absolute path to the worktree in which the ref is checked
out, if it is checked out in any linked worktree. Empty string
otherwise.
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 3b10a6f7ea..3372e13868 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -107,7 +107,7 @@ OPTIONS
:git-format-patch: 1
include::diff-options.txt[]
--<n>::
+`-<n>`::
Prepare patches from the topmost <n> commits.
-o <dir>::
@@ -115,52 +115,52 @@ include::diff-options.txt[]
Use <dir> to store the resulting files, instead of the
current working directory.
--n::
---numbered::
+`-n`::
+`--numbered`::
Name output in '[PATCH n/m]' format, even with a single patch.
--N::
---no-numbered::
+`-N`::
+`--no-numbered`::
Name output in '[PATCH]' format.
--start-number <n>::
Start numbering the patches at <n> instead of 1.
---numbered-files::
+`--numbered-files`::
Output file names will be a simple number sequence
without the default first line of the commit appended.
--k::
---keep-subject::
+`-k`::
+`--keep-subject`::
Do not strip/add '[PATCH]' from the first line of the
commit log message.
--s::
---signoff::
+`-s`::
+`--signoff`::
Add a `Signed-off-by` trailer to the commit message, using
the committer identity of yourself.
See the signoff option in linkgit:git-commit[1] for more information.
---stdout::
+`--stdout`::
Print all commits to the standard output in mbox format,
instead of creating a file for each one.
---attach[=<boundary>]::
+`--attach[=<boundary>]`::
Create multipart/mixed attachment, the first part of
which is the commit message and the patch itself in the
second part, with `Content-Disposition: attachment`.
---no-attach::
+`--no-attach`::
Disable the creation of an attachment, overriding the
configuration setting.
---inline[=<boundary>]::
+`--inline[=<boundary>]`::
Create multipart/mixed attachment, the first part of
which is the commit message and the patch itself in the
second part, with `Content-Disposition: inline`.
---thread[=<style>]::
---no-thread::
+`--thread[=<style>]`::
+`--no-thread`::
Controls addition of `In-Reply-To` and `References` headers to
make the second and subsequent mails appear as replies to the
first. Also controls generation of the `Message-Id` header to
@@ -185,14 +185,14 @@ will want to ensure that threading is disabled for `git send-email`.
reply to the given <message id>, which avoids breaking threads to
provide a new patch series.
---ignore-if-in-upstream::
+`--ignore-if-in-upstream`::
Do not include a patch that matches a commit in
<until>..<since>. This will examine all patches reachable
from <since> but not from <until> and compare them with the
patches being generated, and any patch that matches is
ignored.
---cover-from-description=<mode>::
+`--cover-from-description=<mode>`::
Controls which parts of the cover letter will be automatically
populated using the branch's description.
+
@@ -218,20 +218,20 @@ populated with placeholder text.
allows for useful naming of a patch series, and can be
combined with the `--numbered` option.
---filename-max-length=<n>::
+`--filename-max-length=<n>`::
Instead of the standard 64 bytes, chomp the generated output
filenames at around '<n>' bytes (too short a value will be
silently raised to a reasonable length). Defaults to the
value of the `format.filenameMaxLength` configuration
variable, or 64 if unconfigured.
---rfc::
+`--rfc`::
Alias for `--subject-prefix="RFC PATCH"`. RFC means "Request For
Comments"; use this when sending an experimental patch for
discussion rather than application.
-v <n>::
---reroll-count=<n>::
+`--reroll-count=<n>`::
Mark the series as the <n>-th iteration of the topic. The
output filenames have `v<n>` prepended to them, and the
subject prefix ("PATCH" by default, but configurable via the
@@ -244,20 +244,20 @@ populated with placeholder text.
with the previous version does not state exactly which
version the new interation is compared against.
---to=<email>::
+`--to=<email>`::
Add a `To:` header to the email headers. This is in addition
to any configured headers, and may be used multiple times.
The negated form `--no-to` discards all `To:` headers added so
far (from config or command line).
---cc=<email>::
+`--cc=<email>`::
Add a `Cc:` header to the email headers. This is in addition
to any configured headers, and may be used multiple times.
The negated form `--no-cc` discards all `Cc:` headers added so
far (from config or command line).
---from::
---from=<ident>::
+`--from`::
+`--from=<ident>`::
Use `ident` in the `From:` header of each commit email. If the
author ident of the commit is not textually identical to the
provided `ident`, place a `From:` header in the body of the
@@ -271,7 +271,7 @@ header). Note also that `git send-email` already handles this
transformation for you, and this option should not be used if you are
feeding the result to `git send-email`.
---add-header=<header>::
+`--add-header=<header>`::
Add an arbitrary header to the email headers. This is in addition
to any configured headers, and may be used multiple times.
For example, `--add-header="Organization: git-foo"`.
@@ -279,19 +279,19 @@ feeding the result to `git send-email`.
`Cc:`, and custom) headers added so far from config or command
line.
---[no-]cover-letter::
+`--[no-]cover-letter`::
In addition to the patches, generate a cover letter file
containing the branch description, shortlog and the overall diffstat. You can
fill in a description in the file before sending it out.
---encode-email-headers::
---no-encode-email-headers::
+`--encode-email-headers`::
+`--no-encode-email-headers`::
Encode email headers that have non-ASCII characters with
"Q-encoding" (described in RFC 2047), instead of outputting the
headers verbatim. Defaults to the value of the
`format.encodeEmailHeaders` configuration variable.
---interdiff=<previous>::
+`--interdiff=<previous>`::
As a reviewer aid, insert an interdiff into the cover letter,
or as commentary of the lone patch of a 1-patch series, showing
the differences between the previous version of the patch series and
@@ -300,7 +300,7 @@ feeding the result to `git send-email`.
the series being formatted (for example `git format-patch
--cover-letter --interdiff=feature/v1 -3 feature/v2`).
---range-diff=<previous>::
+`--range-diff=<previous>`::
As a reviewer aid, insert a range-diff (see linkgit:git-range-diff[1])
into the cover letter, or as commentary of the lone patch of a
1-patch series, showing the differences between the previous
@@ -317,14 +317,14 @@ product of `format-patch` is generated, and they are not passed to
the underlying `range-diff` machinery used to generate the cover-letter
material (this may change in the future).
---creation-factor=<percent>::
+`--creation-factor=<percent>`::
Used with `--range-diff`, tweak the heuristic which matches up commits
between the previous and current series of patches by adjusting the
creation/deletion cost fudge factor. See linkgit:git-range-diff[1])
for details.
---notes[=<ref>]::
---no-notes::
+`--notes[=<ref>]`::
+`--no-notes`::
Append the notes (see linkgit:git-notes[1]) for the commit
after the three-dash line.
+
@@ -339,13 +339,13 @@ configuration options in linkgit:git-notes[1] to use this workflow).
The default is `--no-notes`, unless the `format.notes` configuration is
set.
---[no-]signature=<signature>::
+`--[no-]signature=<signature>`::
Add a signature to each message produced. Per RFC 3676 the signature
is separated from the body by a line with '-- ' on it. If the
signature option is omitted the signature defaults to the Git version
number.
---signature-file=<file>::
+`--signature-file=<file>`::
Works just like `--signature` except the signature is read from a file.
--suffix=.<sfx>::
@@ -357,35 +357,35 @@ set.
Note that the leading character does not have to be a dot; for example,
you can use `--suffix=-patch` to get `0001-description-of-my-change-patch`.
--q::
---quiet::
+`-q`::
+`--quiet`::
Do not print the names of the generated files to standard output.
---no-binary::
+`--no-binary`::
Do not output contents of changes in binary files, instead
display a notice that those files changed. Patches generated
using this option cannot be applied properly, but they are
still useful for code review.
---zero-commit::
+`--zero-commit`::
Output an all-zero hash in each patch's From header instead
of the hash of the commit.
---[no-]base[=<commit>]::
+`--[no-]base[=<commit>]`::
Record the base tree information to identify the state the
patch series applies to. See the BASE TREE INFORMATION section
below for details. If <commit> is "auto", a base commit is
automatically chosen. The `--no-base` option overrides a
`format.useAutoBase` configuration.
---root::
+`--root`::
Treat the revision argument as a <revision range>, even if it
is just a single commit (that would normally be treated as a
<since>). Note that root commits included in the specified
range are always formatted as creation patches, independently
of this flag.
---progress::
+`--progress`::
Show progress reports on stderr as patches are generated.
CONFIGURATION
diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt
index 2d90384355..f942c5a7a6 100644
--- a/Documentation/git-fsck.txt
+++ b/Documentation/git-fsck.txt
@@ -20,38 +20,38 @@ Verifies the connectivity and validity of the objects in the database.
OPTIONS
-------
-<object>::
+`<object>`::
An object to treat as the head of an unreachability trace.
+
If no objects are given, `git fsck` defaults to using the
index file, all SHA-1 references in `refs` namespace, and all reflogs
(unless `--no-reflogs` is given) as heads.
---unreachable::
+`--unreachable`::
Print out objects that exist but that aren't reachable from any
of the reference nodes.
---[no-]dangling::
+`--[no-]dangling`::
Print objects that exist but that are never 'directly' used (default).
`--no-dangling` can be used to omit this information from the output.
---root::
+`--root`::
Report root nodes.
---tags::
+`--tags`::
Report tags.
---cache::
+`--cache`::
Consider any object recorded in the index also as a head node for
an unreachability trace.
---no-reflogs::
+`--no-reflogs`::
Do not consider commits that are referenced only by an
entry in a reflog to be reachable. This option is meant
only to search for commits that used to be in a ref, but
now aren't, but are still in that corresponding reflog.
---full::
+`--full`::
Check not just objects in GIT_OBJECT_DIRECTORY
(`$GIT_DIR/objects`), but also the ones found in alternate
object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES
@@ -61,7 +61,7 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs
object pools. This is now default; you can turn it off
with `--no-full`.
---connectivity-only::
+`--connectivity-only`::
Check only the connectivity of reachable objects, making sure
that any objects referenced by a reachable tag, commit, or tree
is present. This speeds up the operation by avoiding reading
@@ -74,7 +74,7 @@ Unreachable tags, commits, and trees will also be accessed to find the
tips of dangling segments of history. Use `--no-dangling` if you don't
care about this output and want to speed it up further.
---strict::
+`--strict`::
Enable more strict checking, namely to catch a file mode
recorded with g+w bit set, which was created by older
versions of Git. Existing repositories, including the
@@ -82,22 +82,22 @@ care about this output and want to speed it up further.
objects that triggers this check, but it is recommended
to check new projects with this flag.
---verbose::
+`--verbose`::
Be chatty.
---lost-found::
+`--lost-found`::
Write dangling objects into `.git/lost-found/commit/` or
`.git/lost-found/other/`, depending on type. If the object is
a blob, the contents are written into the file, rather than
its object name.
---name-objects::
+`--name-objects`::
When displaying names of reachable objects, in addition to the
SHA-1 also display a name that describes *how* they are reachable,
compatible with linkgit:git-rev-parse[1], e.g.
`HEAD@{1234567890}~25^2:src/`.
---[no-]progress::
+`--[no-]progress`::
Progress status is reported on the standard error stream by
default when it is attached to a terminal, unless
`--no-progress` or `--verbose` is specified. `--progress` forces
diff --git a/Documentation/git-gc.txt b/Documentation/git-gc.txt
index c5c71febf5..831dbe74e0 100644
--- a/Documentation/git-gc.txt
+++ b/Documentation/git-gc.txt
@@ -34,14 +34,14 @@ linkgit:git-fast-import[1] for more details on the import case.
OPTIONS
-------
---aggressive::
+`--aggressive`::
Usually `git gc` runs very quickly while providing good disk
space utilization and performance. This option will cause
`git gc` to more aggressively optimize the repository at the expense
of taking much more time. The effects of this optimization are
mostly persistent. See the "AGGRESSIVE" section below for details.
---auto::
+`--auto`::
With this option, `git gc` checks whether any housekeeping is
required; if not, it exits without performing any work.
+
@@ -54,7 +54,7 @@ other housekeeping tasks (e.g. rerere, working trees, reflog...) will
be performed as well.
---prune=<date>::
+`--prune=<date>`::
Prune loose objects older than date (default is 2 weeks ago,
overridable by the config variable `gc.pruneExpire`).
`--prune=now` prunes loose objects regardless of their age and
@@ -62,17 +62,17 @@ be performed as well.
the repository concurrently; see "NOTES" below. `--prune` is on by
default.
---no-prune::
+`--no-prune`::
Do not prune any loose objects.
---quiet::
+`--quiet`::
Suppress all progress reports.
---force::
+`--force`::
Force `git gc` to run even if there may be another `git gc`
instance running on this repository.
---keep-largest-pack::
+`--keep-largest-pack`::
All packs except the largest pack and those marked with a
`.keep` files are consolidated into a single pack. When this
option is used, `gc.bigPackThreshold` is ignored.
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index b10a3f6bb4..478abece38 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -72,50 +72,50 @@ grep.fallbackToNoIndex::
OPTIONS
-------
---cached::
+`--cached`::
Instead of searching tracked files in the working tree, search
blobs registered in the index file.
---no-index::
+`--no-index`::
Search files in the current directory that is not managed by Git.
---untracked::
+`--untracked`::
In addition to searching in the tracked files in the working
tree, search also in untracked files.
---no-exclude-standard::
+`--no-exclude-standard`::
Also search in ignored files by not honoring the `.gitignore`
mechanism. Only useful with `--untracked`.
---exclude-standard::
+`--exclude-standard`::
Do not pay attention to ignored files specified via the `.gitignore`
mechanism. Only useful when searching files in the current directory
with `--no-index`.
---recurse-submodules::
+`--recurse-submodules`::
Recursively search in each submodule that is active and
checked out in the repository. When used in combination with the
<tree> option the prefix of all submodule output will be the name of
the parent project's <tree> object. This option has no effect
if `--no-index` is given.
--a::
---text::
+`-a`::
+`--text`::
Process binary files as if they were text.
---textconv::
+`--textconv`::
Honor textconv filter settings.
---no-textconv::
+`--no-textconv`::
Do not honor textconv filter settings.
This is the default.
--i::
---ignore-case::
+`-i`::
+`--ignore-case`::
Ignore case differences between the patterns and the
files.
--I::
+`-I`::
Don't match the pattern in binary files.
--max-depth <depth>::
@@ -125,77 +125,77 @@ OPTIONS
In other words if "a*" matches a directory named "a*",
"*" is matched literally so `--max-depth` is still effective.
--r::
---recursive::
+`-r`::
+`--recursive`::
Same as `--max-depth=-1`; this is the default.
---no-recursive::
+`--no-recursive`::
Same as `--max-depth=0`.
--w::
---word-regexp::
+`-w`::
+`--word-regexp`::
Match the pattern only at word boundary (either begin at the
beginning of a line, or preceded by a non-word character; end at
the end of a line or followed by a non-word character).
--v::
---invert-match::
+`-v`::
+`--invert-match`::
Select non-matching lines.
--h::
--H::
+`-h`::
+`-H`::
By default, the command shows the filename for each
match. `-h` option is used to suppress this output.
`-H` is there for completeness and does not do anything
except it overrides `-h` given earlier on the command
line.
---full-name::
+`--full-name`::
When run from a subdirectory, the command usually
outputs paths relative to the current directory. This
option forces paths to be output relative to the project
top directory.
--E::
---extended-regexp::
--G::
---basic-regexp::
+`-E`::
+`--extended-regexp`::
+`-G`::
+`--basic-regexp`::
Use POSIX extended/basic regexp for patterns. Default
is to use basic regexp.
--P::
---perl-regexp::
+`-P`::
+`--perl-regexp`::
Use Perl-compatible regular expressions for patterns.
+
Support for these types of regular expressions is an optional
compile-time dependency. If Git wasn't compiled with support for them
providing this option will cause it to die.
--F::
---fixed-strings::
+`-F`::
+`--fixed-strings`::
Use fixed strings for patterns (don't interpret pattern
as a regex).
--n::
---line-number::
+`-n`::
+`--line-number`::
Prefix the line number to matching lines.
---column::
+`--column`::
Prefix the 1-indexed byte-offset of the first match from the start of the
matching line.
--l::
---files-with-matches::
---name-only::
--L::
---files-without-match::
+`-l`::
+`--files-with-matches`::
+`--name-only`::
+`-L`::
+`--files-without-match`::
Instead of showing every matched line, show only the
names of files that contain (or do not contain) matches.
For better compatibility with `git diff`, `--name-only` is a
synonym for `--files-with-matches`.
--O[<pager>]::
---open-files-in-pager[=<pager>]::
+`-O[<pager>]`::
+`--open-files-in-pager[=<pager>]`::
Open the matching files in the pager (not the output of 'grep').
If the pager happens to be `less` or `vi`, and the user
specified only one pattern, the first file is positioned at
@@ -204,48 +204,48 @@ providing this option will cause it to die.
without a space. If `pager` is unspecified, the default pager
will be used (see `core.pager` in linkgit:git-config[1]).
--z::
---null::
+`-z`::
+`--null`::
Use \0 as the delimiter for pathnames in the output, and print
them verbatim. Without this option, pathnames with "unusual"
characters are quoted as explained for the configuration
variable `core.quotePath` (see linkgit:git-config[1]).
--o::
---only-matching::
+`-o`::
+`--only-matching`::
Print only the matched (non-empty) parts of a matching line, with each such
part on a separate output line.
--c::
---count::
+`-c`::
+`--count`::
Instead of showing every matched line, show the number of
lines that match.
---color[=<when>]::
+`--color[=<when>]`::
Show colored matches.
The value must be always (the default), never, or auto.
---no-color::
+`--no-color`::
Turn off match highlighting, even when the configuration file
gives the default to color output.
Same as `--color=never`.
---break::
+`--break`::
Print an empty line between matches from different files.
---heading::
+`--heading`::
Show the filename above the matches in that file instead of
at the start of each shown line.
--p::
---show-function::
+`-p`::
+`--show-function`::
Show the preceding line that contains the function name of
the match, unless the matching line is a function name itself.
The name is determined in the same way as `git diff` works out
patch hunk headers (see 'Defining a custom hunk-header' in
linkgit:gitattributes[5]).
--<num>::
+`-<num>`::
-C <num>::
--context <num>::
Show <num> leading and trailing lines, and place a line
@@ -261,8 +261,8 @@ providing this option will cause it to die.
Show <num> leading lines, and place a line containing
`--` between contiguous groups of matches.
--W::
---function-context::
+`-W`::
+`--function-context`::
Show the surrounding text from the previous line containing a
function name up to the one before the next function name,
effectively showing the whole function in which the match was
@@ -294,28 +294,28 @@ In future versions we may learn to support patterns containing \0 for
more search backends, until then we'll die when the pattern type in
question doesn't support them.
--e::
+`-e`::
The next parameter is the pattern. This option has to be
used for patterns starting with `-` and should be used in
scripts passing user input to grep. Multiple patterns are
combined by 'or'.
---and::
---or::
---not::
+`--and`::
+`--or`::
+`--not`::
( ... )::
Specify how multiple patterns are combined using Boolean
expressions. `--or` is the default operator. `--and` has
higher precedence than `--or`. `-e` has to be used for all
patterns.
---all-match::
+`--all-match`::
When giving multiple pattern expressions combined with `--or`,
this flag is specified to limit the match to files that
have lines to match all of them.
--q::
---quiet::
+`-q`::
+`--quiet`::
Do not output matched lines; instead, exit with status 0 when
there is a match and with non-zero status when there isn't.
diff --git a/Documentation/git-gui.txt b/Documentation/git-gui.txt
index ff66c5b1d0..ed6fe4871e 100644
--- a/Documentation/git-gui.txt
+++ b/Documentation/git-gui.txt
@@ -29,22 +29,22 @@ a fairly native interface for users.
COMMANDS
--------
-blame::
+`blame`::
Start a blame viewer on the specified file on the given
version (or working directory if not specified).
-browser::
+`browser`::
Start a tree browser showing all files in the specified
commit. Files selected through the
browser are opened in the blame viewer.
-citool::
+`citool`::
Start `git gui` and arrange to make exactly one commit before
exiting and returning to the shell. The interface is limited
to only commit actions, slightly reducing the application's
startup time and simplifying the menubar.
-version::
+`version`::
Display the currently running version of `git gui`.
diff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt
index 15c2945345..40f5574afe 100644
--- a/Documentation/git-hash-object.txt
+++ b/Documentation/git-hash-object.txt
@@ -26,17 +26,17 @@ OPTIONS
-t <type>::
Specify the type (default: "blob").
--w::
+`-w`::
Actually write the object into the object database.
---stdin::
+`--stdin`::
Read the object from standard input instead of from a file.
---stdin-paths::
+`--stdin-paths`::
Read file names from the standard input, one per line, instead
of from the command-line.
---path::
+`--path`::
Hash object as it were located at the given path. The location of
file does not directly influence on the hash value, but path is
used to determine what Git filters should be applied to the object
@@ -46,13 +46,13 @@ OPTIONS
temporary files located outside of the working directory or files
read from stdin.
---no-filters::
+`--no-filters`::
Hash the contents as is, ignoring any input filter that would
have been chosen by the attributes mechanism, including the end-of-line
conversion. If the file is read from standard input then this
is always implied, unless the `--path` option is given.
---literally::
+`--literally`::
Allow `--stdin` to hash any garbage into a loose object which might not
otherwise pass standard object parsing or `git-fsck` checks. Useful for
stress-testing Git itself or reproducing characteristics of corrupt or
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 2d5660f47a..070ef46a8d 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -42,32 +42,32 @@ This page can be displayed with `git help help` or `git help --help`
OPTIONS
-------
--a::
---all::
+`-a`::
+`--all`::
Prints all the available commands on the standard output. This
option overrides any given command or guide name.
---verbose::
+`--verbose`::
When used with `--all` print description for all recognized
commands. This is the default.
--c::
---config::
+`-c`::
+`--config`::
List all available configuration variables. This is a short
summary of the list in linkgit:git-config[1].
--g::
---guides::
+`-g`::
+`--guides`::
Prints a list of the Git concept guides on the standard output. This
option overrides any given command or guide name.
--i::
---info::
+`-i`::
+`--info`::
Display manual page for the command in the 'info' format. The
'info' program will be used for that purpose.
--m::
---man::
+`-m`::
+`--man`::
Display manual page for the command in the 'man' format. This
option may be used to override a value set in the
`help.format` configuration variable.
@@ -76,8 +76,8 @@ By default the 'man' program will be used to display the manual page,
but the `man.viewer` configuration variable may be used to choose
other display programs (see below).
--w::
---web::
+`-w`::
+`--web`::
Display manual page for the command in the 'web' (HTML)
format. A web browser will be used for that purpose.
+
diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt
index 4bbf4811c0..d512add556 100644
--- a/Documentation/git-http-backend.txt
+++ b/Documentation/git-http-backend.txt
@@ -190,7 +190,7 @@ ScriptAliasMatch \
ScriptAlias /git/ /var/www/cgi-bin/gitweb.cgi/
----------------------------------------------------------------
-Lighttpd::
+`Lighttpd`::
Ensure that `mod_cgi`, `mod_alias`, `mod_auth`, `mod_setenv` are
loaded, then set `GIT_PROJECT_ROOT` appropriately and redirect
all requests to the CGI:
diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt
index 58e92f22c6..63e447642e 100644
--- a/Documentation/git-http-fetch.txt
+++ b/Documentation/git-http-fetch.txt
@@ -21,26 +21,26 @@ silently ignored.
OPTIONS
-------
-commit-id::
+`commit-id`::
Either the hash or the filename under [URL]/refs/ to
pull.
-a, -c, -t::
These options are ignored for historical reasons.
--v::
+`-v`::
Report what is downloaded.
-w <filename>::
Writes the commit-id into the filename under `$GIT_DIR/refs/<filename>` on
the local end after the transfer is complete.
---stdin::
+`--stdin`::
Instead of a commit id on the command line (which is not expected in this
case), `git http-fetch` expects lines on stdin in the format
<commit-id>['\t'<filename-as-in--w>]
---packfile=<hash>::
+`--packfile=<hash>`::
For internal use only. Instead of a commit id on the command
line (which is not expected in
this case), `git http-fetch` fetches the packfile directly at the given
@@ -49,11 +49,11 @@ commit-id::
arbitrary. The output of index-pack is printed to stdout. Requires
`--index-pack-args`.
---index-pack-args=<args>::
+`--index-pack-args=<args>`::
For internal use only. The command to run on the contents of the
downloaded pack. Arguments are URL-encoded separated by spaces.
---recover::
+`--recover`::
Verify that everything reachable from target is fetched. Used after
an earlier fetch is interrupted.
diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt
index a2932ba27f..d43f84dccd 100644
--- a/Documentation/git-http-push.txt
+++ b/Documentation/git-http-push.txt
@@ -22,27 +22,27 @@ not to work and sometimes corrupts repository.
OPTIONS
-------
---all::
+`--all`::
Do not assume that the remote repository is complete in its
current state, and verify all objects in the entire local
ref's history exist in the remote repository.
---force::
+`--force`::
Usually, the command refuses to update a remote ref that
is not an ancestor of the local ref used to overwrite it.
This flag disables the check. What this means is that
the remote repository can lose commits; use it with
care.
---dry-run::
+`--dry-run`::
Do everything except actually send the updates.
---verbose::
+`--verbose`::
Report the list of objects being walked locally and the
list of objects successfully sent to the remote repository.
--d::
--D::
+`-d`::
+`-D`::
Remove <ref> from remote repository. The specified branch
cannot be the remote `HEAD`. If `-d` is specified the following
other conditions must also be met:
diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt
index 68b1fb19e2..644fa7e847 100644
--- a/Documentation/git-imap-send.txt
+++ b/Documentation/git-imap-send.txt
@@ -29,20 +29,20 @@ git format-patch --signoff --stdout --attach origin | git imap-send
OPTIONS
-------
--v::
---verbose::
+`-v`::
+`--verbose`::
Be verbose.
--q::
---quiet::
+`-q`::
+`--quiet`::
Be quiet.
---curl::
+`--curl`::
Use libcurl to communicate with the IMAP server, unless tunneling
into it. Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND
option set.
---no-curl::
+`--no-curl`::
Talk to the IMAP server using git's own IMAP routines instead of
using libcurl. Ignored if Git was built with the NO_OPENSSL option
set.
diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt
index fa859f759d..b42e095f3e 100644
--- a/Documentation/git-index-pack.txt
+++ b/Documentation/git-index-pack.txt
@@ -25,7 +25,7 @@ the objects/pack/ directory of a Git repository.
OPTIONS
-------
--v::
+`-v`::
Be verbose about what is going on, including progress status.
-o <index-file>::
@@ -36,14 +36,14 @@ OPTIONS
fails if the name of packed archive does not end
with .pack).
---[no-]rev-index::
+`--[no-]rev-index`::
When this flag is provided, generate a reverse index
(a `.rev` file) corresponding to the given pack. If
`--verify` is given, ensure that the existing
reverse index is correct. Takes precedence over
`pack.writeReverseIndex`.
---stdin::
+`--stdin`::
When this flag is provided, the pack is read from stdin
instead and a copy is then written to <pack-file>. If
<pack-file> is not specified, the pack is written to
@@ -53,13 +53,13 @@ OPTIONS
prevent a race condition between this process and
`git repack`.
---fix-thin::
+`--fix-thin`::
Fix a "thin" pack produced by `git pack-objects --thin` (see
linkgit:git-pack-objects[1] for details) by adding the
excluded objects the deltified objects are based on to the
pack. This option only makes sense in conjunction with `--stdin`.
---keep::
+`--keep`::
Before moving the index into its final destination
create an empty .keep file for the associated pack file.
This option is usually necessary with `--stdin` to prevent a
@@ -67,7 +67,7 @@ OPTIONS
the newly constructed pack and index before refs can be
updated to use objects contained in the pack.
---keep=<msg>::
+`--keep=<msg>`::
Like `--keep` create a .keep file before moving the index into
its final destination, but rather than creating an empty file
place '<msg>' followed by an LF into the .keep file. The '<msg>'
@@ -79,13 +79,13 @@ OPTIONS
to force the version for the generated pack index, and to force
64-bit index entries on objects located above the given offset.
---strict::
+`--strict`::
Die, if the pack contains broken objects or links.
---check-self-contained-and-connected::
+`--check-self-contained-and-connected`::
Die if the pack contains broken links. For internal use only.
---fsck-objects::
+`--fsck-objects`::
For internal use only.
+
Die if the pack contains broken objects. If the pack contains a tree
@@ -93,7 +93,7 @@ pointing to a .gitmodules blob that does not exist, prints the hash of
that blob (for the caller to check) after the hash that goes into the
name of the pack/idx file (see "Notes").
---threads=<n>::
+`--threads=<n>`::
Specifies the number of threads to spawn when resolving
deltas. This requires that index-pack be compiled with
pthreads otherwise this option is ignored with a warning.
@@ -103,10 +103,10 @@ name of the pack/idx file (see "Notes").
Specifying 0 will cause Git to auto-detect the number of CPU's
and use maximum 3 threads.
---max-input-size=<size>::
+`--max-input-size=<size>`::
Die, if the pack is larger than <size>.
---object-format=<hash-algorithm>::
+`--object-format=<hash-algorithm>`::
Specify the given object format (hash algorithm) for the pack. The valid
values are 'sha1' and (if enabled) 'sha256'. The default is the algorithm for
the current repository (set by `extensions.objectFormat`), or 'sha1' if no
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index 2ee178a81c..cfa190859e 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -40,17 +40,17 @@ the repository to another place if `--separate-git-dir` is given).
OPTIONS
-------
--q::
---quiet::
+`-q`::
+`--quiet`::
Only print error and warning messages; all other output will be suppressed.
---bare::
+`--bare`::
Create a bare repository. If `GIT_DIR` environment is not set, it is set to the
current working directory.
---object-format=<format>::
+`--object-format=<format>`::
Specify the given object format (hash algorithm) for the repository. The valid
values are 'sha1' and (if enabled) 'sha256'. 'sha1' is the default.
@@ -72,7 +72,7 @@ repository.
If this is reinitialization, the repository will be moved to the specified path.
-b <branch-name>::
---initial-branch=<branch-name>::
+`--initial-branch=<branch-name>`::
Use the specified name for the initial branch in the newly created
repository. If not specified, fall back to the default name (currently
diff --git a/Documentation/git-instaweb.txt b/Documentation/git-instaweb.txt
index a8876b74ca..f23cebccd9 100644
--- a/Documentation/git-instaweb.txt
+++ b/Documentation/git-instaweb.txt
@@ -20,12 +20,12 @@ repository.
OPTIONS
-------
--l::
---local::
+`-l`::
+`--local`::
Only bind the web server to the local IP (127.0.0.1).
--d::
---httpd::
+`-d`::
+`--httpd`::
The HTTP daemon command-line that will be executed.
Command-line options may be specified here, and the
configuration file will be added at the end of the command-line.
@@ -33,36 +33,36 @@ OPTIONS
webrick are supported.
(Default: lighttpd)
--m::
---module-path::
+`-m`::
+`--module-path`::
The module path (only needed if httpd is Apache).
(Default: /usr/lib/apache2/modules)
--p::
---port::
+`-p`::
+`--port`::
The port number to bind the httpd to. (Default: 1234)
--b::
---browser::
+`-b`::
+`--browser`::
The web browser that should be used to view the `gitweb`
page. This will be passed to the `git web--browse` helper
script along with the URL of the `gitweb` instance. See
linkgit:git-web{litdd}browse[1] for more information about this. If
the script fails, the URL will be printed to stdout.
-start::
---start::
+`start`::
+`--start`::
Start the httpd instance and exit. Regenerate configuration files
as necessary for spawning a new instance.
-stop::
---stop::
+`stop`::
+`--stop`::
Stop the httpd instance and exit. This does not generate
any of the configuration files for spawning a new instance,
nor does it close the browser.
-restart::
---restart::
+`restart`::
+`--restart`::
Restart the httpd instance and exit. Regenerate configuration files
as necessary for spawning a new instance.
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index b687701104..dc2974c611 100644
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -71,10 +71,10 @@ the encoding rules and probably many other rules.
OPTIONS
-------
---in-place::
+`--in-place`::
Edit the files in place.
---trim-empty::
+`--trim-empty`::
If the <value> part of any trailer contains only whitespace,
the whole trailer will be removed from the resulting message.
This applies to existing trailers as well as new trailers.
@@ -85,7 +85,7 @@ OPTIONS
command.
--where <placement>::
---no-where::
+`--no-where`::
Specify where all new trailers will be added. A setting
provided with `--where` overrides all configuration variables
and applies to all `--trailer` options until the next occurrence of
@@ -93,7 +93,7 @@ OPTIONS
`end` or `start`.
--if-exists <action>::
---no-if-exists::
+`--no-if-exists`::
Specify what action will be performed when there is already at
least one trailer with the same <token> in the message. A setting
provided with `--if-exists` overrides all configuration variables
@@ -102,7 +102,7 @@ OPTIONS
`addIfDifferentNeighbor`, `add`, `replace` and `doNothing`.
--if-missing <action>::
---no-if-missing::
+`--no-if-missing`::
Specify what action will be performed when there is no other
trailer with the same <token> in the message. A setting
provided with `--if-missing` overrides all configuration variables
@@ -110,23 +110,23 @@ OPTIONS
`--if-missing` or `--no-if-missing`. Possible actions are `doNothing`
or `add`.
---only-trailers::
+`--only-trailers`::
Output only the trailers, not any other parts of the input.
---only-input::
+`--only-input`::
Output only trailers that exist in the input; do not add any
from the command-line or by following configured `trailer.*`
rules.
---unfold::
+`--unfold`::
Remove any whitespace-continuation in trailers, so that each
trailer appears on a line by itself with its full content.
---parse::
+`--parse`::
A convenience alias for `--only-trailers --only-input
--unfold`.
---no-divider::
+`--no-divider`::
Do not treat `---` as the end of the commit message. Use this
when you know your input contains just the commit message itself
(and not an email or the output of `git format-patch`).
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 43f9a5c69e..21f9328681 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -27,11 +27,11 @@ each commit introduces are shown.
OPTIONS
-------
---follow::
+`--follow`::
Continue listing the history of a file beyond renames
(works only for a single file).
---no-decorate::
+`--no-decorate`::
--decorate[=short|full|auto|no]::
Print out the ref names of any commits that are shown. If 'short' is
specified, the ref name prefixes `refs/heads/`, `refs/tags/` and
@@ -41,8 +41,8 @@ OPTIONS
are shown as if 'short' were given, otherwise no ref names are
shown. The default option is 'short'.
---decorate-refs=<pattern>::
---decorate-refs-exclude=<pattern>::
+`--decorate-refs=<pattern>`::
+`--decorate-refs-exclude=<pattern>`::
If no `--decorate-refs` is given, pretend as if all refs were
included. For each candidate, do not use it for decoration if it
matches any patterns given to `--decorate-refs-exclude` or if it
@@ -51,17 +51,17 @@ OPTIONS
the decorations, but an explicit `--decorate-refs` pattern will
override a match in `log.excludeDecoration`.
---source::
+`--source`::
Print out the ref name given on the command line by which each
commit was reached.
---[no-]mailmap::
---[no-]use-mailmap::
+`--[no-]mailmap`::
+`--[no-]use-mailmap`::
Use mailmap file to map author and committer names and email
addresses to canonical real names and email addresses. See
linkgit:git-shortlog[1].
---full-diff::
+`--full-diff`::
Without this flag, `git log -p <path>...` shows commits that
touch the specified paths, and diffs about the same specified
paths. With this, the full diff is shown for commits that touch
@@ -71,7 +71,7 @@ OPTIONS
Note that this affects all diff-based output types, e.g. those
produced by `--stat`, etc.
---log-size::
+`--log-size`::
Include a line ``log size <number>'' in the output for each commit,
where <number> is the length of that commit's message in bytes.
Intended to speed up tools that read log messages from `git log`
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 3557823de9..0e26aafc63 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -32,56 +32,56 @@ shown:
OPTIONS
-------
--c::
---cached::
+`-c`::
+`--cached`::
Show cached files in the output (default)
--d::
---deleted::
+`-d`::
+`--deleted`::
Show deleted files in the output
--m::
---modified::
+`-m`::
+`--modified`::
Show modified files in the output
--o::
---others::
+`-o`::
+`--others`::
Show other (i.e. untracked) files in the output
--i::
---ignored::
+`-i`::
+`--ignored`::
Show only ignored files in the output. When showing files in the
index, print only those matched by an exclude pattern. When
showing "other" files, show only those matched by an exclude
pattern. Standard ignore rules are not automatically activated,
therefore at least one of the `--exclude*` options is required.
--s::
---stage::
+`-s`::
+`--stage`::
Show staged contents' mode bits, object name and stage number in the output.
---directory::
+`--directory`::
If a whole directory is classified as "other", show just its
name (with a trailing slash) and not its whole contents.
---no-empty-directory::
+`--no-empty-directory`::
Do not list empty directories. Has no effect without `--directory`.
--u::
---unmerged::
+`-u`::
+`--unmerged`::
Show unmerged files in the output (forces `--stage`)
--k::
---killed::
+`-k`::
+`--killed`::
Show files on the filesystem that need to be removed due
to file/directory conflicts for checkout-index to
succeed.
--z::
+`-z`::
\0 line termination on output and do not quote filenames.
See OUTPUT below for more information.
---deduplicate::
+`--deduplicate`::
When only filenames are shown, suppress duplicates that may
come from having multiple stages during a merge, or giving
`--deleted` and `--modified` option at the same time.
@@ -89,35 +89,35 @@ OPTIONS
in use, this option has no effect.
-x <pattern>::
---exclude=<pattern>::
+`--exclude=<pattern>`::
Skip untracked files matching pattern.
Note that pattern is a shell wildcard pattern. See EXCLUDE PATTERNS
below for more information.
-X <file>::
---exclude-from=<file>::
+`--exclude-from=<file>`::
Read exclude patterns from <file>; 1 per line.
---exclude-per-directory=<file>::
+`--exclude-per-directory=<file>`::
Read additional exclude patterns that apply only to the
directory and its subdirectories in <file>.
---exclude-standard::
+`--exclude-standard`::
Add the standard Git exclusions: `.git/info/exclude`, `.gitignore`
in each directory, and the user's global exclusion file.
---error-unmatch::
+`--error-unmatch`::
If any <file> does not appear in the index, treat this as an
error (return 1).
---with-tree=<tree-ish>::
+`--with-tree=<tree-ish>`::
When using `--error-unmatch` to expand the user supplied
<file> (i.e. path pattern) arguments to paths, pretend
that paths which were removed in the index since the
named <tree-ish> are still present. Using this option
with `-s` or `-u` options does not make any sense.
--t::
+`-t`::
This feature is semi-deprecated. For scripting purpose,
linkgit:git-status[1] `--porcelain` and
linkgit:git-diff-files[1] `--name-status` are almost always
@@ -129,48 +129,48 @@ OPTIONS
This option identifies the file status with the following tags (followed by
a space) at the start of each line:
- H:: cached
- S:: skip-worktree
- M:: unmerged
- R:: removed/deleted
- C:: modified/changed
- K:: to be killed
+ `H`:: cached
+ `S`:: skip-worktree
+ `M`:: unmerged
+ `R`:: removed/deleted
+ `C`:: modified/changed
+ `K`:: to be killed
?:: other
--
--v::
+`-v`::
Similar to `-t`, but use lowercase letters for files
that are marked as 'assume unchanged' (see
linkgit:git-update-index[1]).
--f::
+`-f`::
Similar to `-t`, but use lowercase letters for files
that are marked as 'fsmonitor valid' (see
linkgit:git-update-index[1]).
---full-name::
+`--full-name`::
When run from a subdirectory, the command usually
outputs paths relative to the current directory. This
option forces paths to be output relative to the project
top directory.
---recurse-submodules::
+`--recurse-submodules`::
Recursively calls ls-files on each active submodule in the repository.
Currently there is only support for the `--cached` mode.
---abbrev[=<n>]::
+`--abbrev[=<n>]`::
Instead of showing the full 40-byte hexadecimal object
lines, show the shortest prefix that is at least '<n>'
hexdigits long that uniquely refers the object.
Non default number of digits can be specified with `--abbrev=<n>`.
---debug::
+`--debug`::
After each line that describes a file, add more data about its
cache entry. This is intended to show as much information as
possible for manual inspection; the exact format may change at
any time.
---eol::
+`--eol`::
Show <eolinfo> and <eolattr> of files.
<eolinfo> is the file content identification used by Git when
the "text" attribute is "auto" (or not set and `core.autocrlf` is not false).
@@ -190,7 +190,7 @@ followed by the ("attr/<eolattr>").
\--::
Do not interpret any more arguments as options.
-<file>::
+`<file>`::
Files to show. If no files are given all files which match the other
specified criteria are shown.
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index cc1525f487..6dc89de377 100644
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -21,10 +21,10 @@ commit IDs.
OPTIONS
-------
--h::
---heads::
--t::
---tags::
+`-h`::
+`--heads`::
+`-t`::
+`--tags`::
Limit to only refs/heads and refs/tags, respectively.
These options are _not_ mutually exclusive; when given
both, references stored in refs/heads and refs/tags are
@@ -32,37 +32,37 @@ OPTIONS
anything else on the command line gives help, consistent
with other `git` subcommands.
---refs::
+`--refs`::
Do not show peeled tags or pseudorefs like `HEAD` in the output.
--q::
---quiet::
+`-q`::
+`--quiet`::
Do not print remote URL to stderr.
---upload-pack=<exec>::
+`--upload-pack=<exec>`::
Specify the full path of `git-upload-pack` on the remote
host. This allows listing references from repositories accessed via
SSH and where the SSH daemon does not use the PATH configured by the
user.
---exit-code::
+`--exit-code`::
Exit with status "2" when no matching refs are found in the remote
repository. Usually the command exits with status "0" to indicate
it successfully talked with the remote repository, whether it
found any matching refs.
---get-url::
+`--get-url`::
Expand the URL of the given remote repository taking into account any
`url.<base>.insteadOf` config setting (See linkgit:git-config[1]) and
exit without talking to the remote.
---symref::
+`--symref`::
In addition to the object pointed by it, show the underlying
ref pointed by it when showing a symbolic ref. Currently,
upload-pack only shows the symref `HEAD`, so it will be the only
one shown by ls-remote.
---sort=<key>::
+`--sort=<key>`::
Sort based on the key given. Prefix `-` to sort in descending order
of the value. Supports "version:refname" or "v:refname" (tag names
are treated as versions). The "version:refname" sort order can also
@@ -73,14 +73,14 @@ OPTIONS
fetched from the remote, and will give a `missing object` error.
-o <option>::
---server-option=<option>::
+`--server-option=<option>`::
Transmit the given string to the server when communicating using
protocol version 2. The given string must not contain a NUL or LF
character.
When multiple `--server-option=<option>` are given, they are all
sent to the other side in the order listed on the command line.
-<repository>::
+`<repository>`::
The "remote" repository to query. This parameter can be
either a URL or the name of a remote (see the GIT URLS and
REMOTES sections of linkgit:git-fetch[1]).
diff --git a/Documentation/git-ls-tree.txt b/Documentation/git-ls-tree.txt
index 82c802d918..11c25fe451 100644
--- a/Documentation/git-ls-tree.txt
+++ b/Documentation/git-ls-tree.txt
@@ -35,42 +35,42 @@ in the current working directory. Note that:
OPTIONS
-------
-<tree-ish>::
+`<tree-ish>`::
Id of a tree-ish.
--d::
+`-d`::
Show only the named tree entry itself, not its children.
--r::
+`-r`::
Recurse into sub-trees.
--t::
+`-t`::
Show tree entries even when going to recurse them. Has no effect
if `-r` was not passed. `-d` implies `-t`.
--l::
---long::
+`-l`::
+`--long`::
Show object size of blob (file) entries.
--z::
+`-z`::
\0 line termination on output and do not quote filenames.
See OUTPUT FORMAT below for more information.
---name-only::
---name-status::
+`--name-only`::
+`--name-status`::
List only filenames (instead of the "long" output), one per line.
---abbrev[=<n>]::
+`--abbrev[=<n>]`::
Instead of showing the full 40-byte hexadecimal object
lines, show the shortest prefix that is at least '<n>'
hexdigits long that uniquely refers the object.
Non default number of digits can be specified with `--abbrev`=<n>.
---full-name::
+`--full-name`::
Instead of showing the path names relative to the current working
directory, show the full path names.
---full-tree::
+`--full-tree`::
Do not limit the listing to the current working directory.
Implies `--full-name`.
diff --git a/Documentation/git-mailinfo.txt b/Documentation/git-mailinfo.txt
index b47e92ee57..5898b9ee89 100644
--- a/Documentation/git-mailinfo.txt
+++ b/Documentation/git-mailinfo.txt
@@ -24,7 +24,7 @@ command directly. See linkgit:git-am[1] instead.
OPTIONS
-------
--k::
+`-k`::
Usually the program removes email cruft from the Subject:
header line to extract the title line for the commit log
message. This option prevents this munging, and is most
@@ -44,12 +44,12 @@ Specifically, the following are removed until none of them remain:
Finally, runs of whitespace are normalized to a single ASCII space
character.
--b::
+`-b`::
When `-k` is not in effect, all leading strings bracketed with '['
and ']' pairs are stripped. This option limits the stripping to
only the pairs whose bracketed string contains the word "PATCH".
--u::
+`-u`::
The commit log message, author name and author email are
taken from the e-mail, and after minimally decoding MIME
transfer encoding, re-coded in the charset specified by
@@ -59,19 +59,19 @@ character.
Note that the patch is always used as-is without charset
conversion, even with this flag.
---encoding=<encoding>::
+`--encoding=<encoding>`::
Similar to `-u`. But when re-coding, the charset specified here is
used instead of the one specified by `i18n.commitEncoding` or UTF-8.
--n::
+`-n`::
Disable all charset re-coding of the metadata.
--m::
---message-id::
+`-m`::
+`--message-id`::
Copy the Message-ID header at the end of the commit message. This
is useful in order to associate commits with mailing list discussions.
---scissors::
+`--scissors`::
Remove everything in body before a scissors line (e.g. "-- >8 --").
The line represents scissors and perforation marks, and is used to
request the reader to cut the message at that line. If that line
@@ -86,14 +86,14 @@ beginning of the proposed commit log message with a scissors line.
+
This can be enabled by default with the configuration option `mailinfo.scissors`.
---no-scissors::
+`--no-scissors`::
Ignore scissors lines. Useful for overriding `mailinfo.scissors` settings.
-<msg>::
+`<msg>`::
The commit log message extracted from e-mail, usually
except the title line which comes from e-mail Subject.
-<patch>::
+`<patch>`::
The patch extracted from e-mail.
GIT
diff --git a/Documentation/git-mailsplit.txt b/Documentation/git-mailsplit.txt
index 151c4f96be..1446a1588f 100644
--- a/Documentation/git-mailsplit.txt
+++ b/Documentation/git-mailsplit.txt
@@ -21,34 +21,34 @@ patches in the correct order.
OPTIONS
-------
-<mbox>::
+`<mbox>`::
Mbox file to split. If not given, the mbox is read from
the standard input.
-<Maildir>::
+`<Maildir>`::
Root of the Maildir to split. This directory should contain the cur, tmp
and new subdirectories.
--o<directory>::
+`-o<directory>`::
Directory in which to place the individual messages.
--b::
+`-b`::
If any file doesn't begin with a From line, assume it is a
single mail message instead of signaling error.
--d<prec>::
+`-d<prec>`::
Instead of the default 4 digits with leading zeros,
different precision can be specified for the generated
filenames.
--f<nn>::
+`-f<nn>`::
Skip the first <nn> numbers, for example if `-f`3 is specified,
start the numbering with 0004.
---keep-cr::
+`--keep-cr`::
Do not remove `\r` from lines ending with `\r\n`.
---mboxrd::
+`--mboxrd`::
Input is of the "mboxrd" format and "^>+From " line escaping is
reversed.
diff --git a/Documentation/git-maintenance.txt b/Documentation/git-maintenance.txt
index c69b3cec4f..b333fd2cd9 100644
--- a/Documentation/git-maintenance.txt
+++ b/Documentation/git-maintenance.txt
@@ -29,7 +29,7 @@ Git repository.
SUBCOMMANDS
-----------
-register::
+`register`::
Initialize Git config values so any scheduled maintenance will
start running on this repository. This adds the repository to the
`maintenance.repo` config variable in the current user's global
@@ -55,25 +55,25 @@ task:
setting `maintenance.auto = false` in the current repository. This config
setting will remain after a `git maintenance unregister` command.
-run::
+`run`::
Run one or more maintenance tasks. If one or more `--task` options
are specified, then those tasks are run in that order. Otherwise,
the tasks are determined by which `maintenance.<task>.enabled`
config options are true. By default, only `maintenance.gc.enabled`
is true.
-start::
+`start`::
Start running maintenance on the current repository. This performs
the same config updates as the `register` subcommand, then updates
the background scheduler to run `git maintenance run --scheduled`
on an hourly basis.
-stop::
+`stop`::
Halt the background maintenance schedule. The current repository
is not removed from the list of maintained repositories, in case
the background maintenance is restarted later.
-unregister::
+`unregister`::
Remove the current repository from background maintenance. This
only removes the repository from the configured list. It does not
stop the background maintenance processes from running.
@@ -81,7 +81,7 @@ unregister::
TASKS
-----
-commit-graph::
+`commit-graph`::
The `commit-graph` job updates the `commit-graph` files incrementally,
then verifies that the written data is correct. The incremental
write is safe to run alongside concurrent Git processes since it
@@ -89,7 +89,7 @@ commit-graph::
`commit-graph-chain` file. They will be deleted by a later run based
on the expiration delay.
-prefetch::
+`prefetch`::
The `prefetch` task updates the object directory with the latest
objects from all registered remotes. For each remote, a `git fetch`
command is run. The refmap is custom to avoid updating local or remote
@@ -104,7 +104,7 @@ already be obtained, so the real fetch would go faster. In the ideal case,
it will just become an update to a bunch of remote-tracking branches without
any object transfer.
-gc::
+`gc`::
Clean up unnecessary files and optimize the local repository. "GC"
stands for "garbage collection," but this task performs many
smaller tasks. This task can be expensive for large repositories,
@@ -112,7 +112,7 @@ gc::
be disruptive in some situations, as it deletes stale data. See
linkgit:git-gc[1] for more details on garbage collection in Git.
-loose-objects::
+`loose-objects`::
The `loose-objects` job cleans up loose objects and places them into
pack-files. In order to prevent race conditions with concurrent Git
commands, it follows a two-step process. First, it deletes any loose
@@ -127,7 +127,7 @@ loose-objects::
advisable to enable both the `loose-objects` and `gc` tasks at the
same time.
-incremental-repack::
+`incremental-repack`::
The `incremental-repack` job repacks the object directory
using the `multi-pack-index` feature. In order to prevent race
conditions with concurrent Git commands, it follows a two-step
@@ -145,7 +145,7 @@ incremental-repack::
which is a special case that attempts to repack all pack-files
into a single pack-file.
-pack-refs::
+`pack-refs`::
The `pack-refs` task collects the loose reference files and
collects them into a single file. This speeds up operations that
need to iterate across many references. See linkgit:git-pack-refs[1]
@@ -153,7 +153,7 @@ pack-refs::
OPTIONS
-------
---auto::
+`--auto`::
When combined with the `run` subcommand, run maintenance tasks
only if certain thresholds are met. For example, the `gc` task
runs when the number of loose objects exceeds the number stored
@@ -161,7 +161,7 @@ OPTIONS
exceeds the `gc.autoPackLimit` config setting. Not compatible with
the `--schedule` option.
---schedule::
+`--schedule`::
When combined with the `run` subcommand, run maintenance tasks
only if certain time conditions are met, as specified by the
`maintenance.<task>.schedule` config value for each `<task>`.
@@ -171,10 +171,10 @@ OPTIONS
the `--task=<task>` option(s) or those with
`maintenance.<task>.enabled` set to true.
---quiet::
+`--quiet`::
Do not report progress or other information over `stderr`.
---task=<task>::
+`--task=<task>`::
If this option is specified one or more times, then only run the
specified tasks in the specified order. If no `--task=<task>`
arguments are specified, then only the tasks with
diff --git a/Documentation/git-merge-base.txt b/Documentation/git-merge-base.txt
index 323bc045bf..272ef445e3 100644
--- a/Documentation/git-merge-base.txt
+++ b/Documentation/git-merge-base.txt
@@ -40,24 +40,24 @@ As a consequence, the 'merge base' is not necessarily contained in each of the
commit arguments if more than two commits are specified. This is different
from linkgit:git-show-branch[1] when used with the `--merge-base` option.
---octopus::
+`--octopus`::
Compute the best common ancestors of all supplied commits,
in preparation for an n-way merge. This mimics the behavior
of `git show-branch --merge-base`.
---independent::
+`--independent`::
Instead of printing merge bases, print a minimal subset of
the supplied commits with the same ancestors. In other words,
among the commits given, list those which cannot be reached
from any other. This mimics the behavior of `git show-branch
--independent`.
---is-ancestor::
+`--is-ancestor`::
Check if the first <commit> is an ancestor of the second <commit>,
and exit with status 0 if true, or with status 1 if not.
Errors are signaled by a non-zero status that is not 1.
---fork-point::
+`--fork-point`::
Find the point at which a branch (or any history that leads
to <commit>) forked from another branch (or any reference)
<ref>. This does not just look for the common ancestor of
@@ -68,8 +68,8 @@ from linkgit:git-show-branch[1] when used with the `--merge-base` option.
OPTIONS
-------
--a::
---all::
+`-a`::
+`--all`::
Output all merge bases for the commits, instead of just one.
DISCUSSION
diff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt
index 427f93cd8c..d7605b60f0 100644
--- a/Documentation/git-merge-file.txt
+++ b/Documentation/git-merge-file.txt
@@ -60,19 +60,19 @@ OPTIONS
looks like it came from files x, y and z instead of
from files a, b and c.
--p::
+`-p`::
Send results to standard output instead of overwriting
`<current-file>`.
--q::
+`-q`::
Quiet; do not warn about conflicts.
--diff3::
Show conflicts in "diff3" style.
---ours::
---theirs::
---union::
+`--ours`::
+`--theirs`::
+`--union`::
Instead of leaving conflicts in the file, resolve conflicts
favouring our (or their or both) side of the lines.
diff --git a/Documentation/git-merge-index.txt b/Documentation/git-merge-index.txt
index be978144d5..a1cef44c33 100644
--- a/Documentation/git-merge-index.txt
+++ b/Documentation/git-merge-index.txt
@@ -23,16 +23,16 @@ OPTIONS
\--::
Do not interpret any more arguments as options.
--a::
+`-a`::
Run merge against all files in the index that need merging.
--o::
+`-o`::
Instead of stopping at the first failed merge, do all of them
in one shot - continue with merging even when previous merges
returned errors, and only return the error code after all the
merges.
--q::
+`-q`::
Do not complain about a failed merge program (a merge program
failure usually indicates conflicts during the merge). This is for
porcelains which might want to emit custom messages.
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index 029c7807db..de57a4fb54 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -75,24 +75,24 @@ used to give a good default for automated `git merge`
invocations. The automated message can include the branch description.
-F <file>::
---file=<file>::
+`--file=<file>`::
Read the commit message to be used for the merge commit (in
case one is created).
+
If `--log` is specified, a shortlog of the commits being merged
will be appended to the specified message.
---rerere-autoupdate::
---no-rerere-autoupdate::
+`--rerere-autoupdate`::
+`--no-rerere-autoupdate`::
Allow the rerere mechanism to update the index with the
result of auto-conflict resolution if possible.
---overwrite-ignore::
---no-overwrite-ignore::
+`--overwrite-ignore`::
+`--no-overwrite-ignore`::
Silently overwrite ignored files from the merge result. This
is the default behavior. Use `--no-overwrite-ignore` to abort.
---abort::
+`--abort`::
Abort the current conflict resolution process, and
try to reconstruct the pre-merge state. If an autostash entry is
present, apply it to the worktree.
@@ -108,12 +108,12 @@ which case `git merge --abort` applies the stash entry to the worktree
whereas `git reset --merge` will save the stashed changes in the stash
list.
---quit::
+`--quit`::
Forget about the current merge in progress. Leave the index
and the working tree as-is. If `MERGE_AUTOSTASH` is present, the
stash entry will be saved to the stash list.
---continue::
+`--continue`::
After a `git merge` stops due to conflicts you can conclude the
merge by running `git merge --continue` (see "HOW TO RESOLVE
CONFLICTS" section below).
diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt
index 530f8a278f..1a5b30b293 100644
--- a/Documentation/git-mergetool.txt
+++ b/Documentation/git-mergetool.txt
@@ -25,7 +25,7 @@ the merge tool program on every file with merge conflicts.
OPTIONS
-------
-t <tool>::
---tool=<tool>::
+`--tool=<tool>`::
Use the merge resolution program specified by <tool>.
Valid values include emerge, gvimdiff, kdiff3,
meld, vimdiff, and tortoisemerge. Run `git mergetool --tool-help`
@@ -64,35 +64,35 @@ variable `mergetool.<tool>.trustExitCode` can be set to `true`.
Otherwise, `git mergetool` will prompt the user to indicate the
success of the resolution after the custom tool has exited.
---tool-help::
+`--tool-help`::
Print a list of merge tools that may be used with `--tool`.
--y::
---no-prompt::
+`-y`::
+`--no-prompt`::
Don't prompt before each invocation of the merge resolution
program.
This is the default if the merge resolution program is
explicitly specified with the `--tool` option or with the
`merge.tool` configuration variable.
---prompt::
+`--prompt`::
Prompt before each invocation of the merge resolution program
to give the user a chance to skip the path.
--g::
---gui::
+`-g`::
+`--gui`::
When `git-mergetool` is invoked with the `-g` or `--gui` option
the default merge tool will be read from the configured
`merge.guitool` variable instead of `merge.tool`. If
`merge.guitool` is not set, we will fallback to the tool
configured under `merge.tool`.
---no-gui::
+`--no-gui`::
This overrides a previous `-g` or `--gui` setting and reads the
default merge tool will be read from the configured `merge.tool`
variable.
--O<orderfile>::
+`-O<orderfile>`::
Process files in the order specified in the
<orderfile>, which has one shell glob pattern per line.
This overrides the `diff.orderFile` configuration variable
diff --git a/Documentation/git-mktag.txt b/Documentation/git-mktag.txt
index 1ba01b1a9b..2a38aeae34 100644
--- a/Documentation/git-mktag.txt
+++ b/Documentation/git-mktag.txt
@@ -14,7 +14,7 @@ SYNOPSIS
OPTIONS
-------
---strict::
+`--strict`::
By default mktag turns on the equivalent of
linkgit:git-fsck[1] `--strict` mode. Use `--no-strict` to
disable it.
diff --git a/Documentation/git-mktree.txt b/Documentation/git-mktree.txt
index 709e05ab6f..0f6e9fcecc 100644
--- a/Documentation/git-mktree.txt
+++ b/Documentation/git-mktree.txt
@@ -20,16 +20,16 @@ built is written to the standard output.
OPTIONS
-------
--z::
+`-z`::
Read the NUL-terminated `ls-tree -z` output instead.
---missing::
+`--missing`::
Allow missing objects. The default behaviour (without this option)
is to verify that each tree entry's sha1 identifies an existing
object. This option has no effect on the treatment of gitlink entries
(aka "submodules") which are always allowed to be missing.
---batch::
+`--batch`::
Allow building of more than one tree object before exiting. Each
tree is separated by as single blank line. The final new-line is
optional. Note - if the `-z` option is used, lines are terminated
diff --git a/Documentation/git-multi-pack-index.txt b/Documentation/git-multi-pack-index.txt
index ff56181795..b269392221 100644
--- a/Documentation/git-multi-pack-index.txt
+++ b/Documentation/git-multi-pack-index.txt
@@ -19,38 +19,38 @@ Write or verify a multi-pack-index (MIDX) file.
OPTIONS
-------
---object-dir=<dir>::
+`--object-dir=<dir>`::
Use given directory for the location of Git objects. We check
`<dir>/packs/multi-pack-index` for the current MIDX file, and
`<dir>/packs` for the pack-files to index.
---[no-]progress::
+`--[no-]progress`::
Turn progress on/off explicitly. If neither is specified, progress is
shown if standard error is connected to a terminal.
The following subcommands are available:
-write::
+`write`::
Write a new MIDX file. The following options are available for
the `write` sub-command:
+
--
- --preferred-pack=<pack>::
+ `--preferred-pack=<pack>`::
Optionally specify the tie-breaking pack used when
multiple packs contain the same object. If not given,
ties are broken in favor of the pack with the lowest
mtime.
--
-verify::
+`verify`::
Verify the contents of the MIDX file.
-expire::
+`expire`::
Delete the pack-files that are tracked by the MIDX file, but
have no objects referenced by the MIDX. Rewrite the MIDX file
afterward to remove all references to these pack-files.
-repack::
+`repack`::
Create a new pack-file containing objects in small pack-files
referenced by the multi-pack-index. If the size given by the
`--batch-size=<size>` argument is zero, then create a pack
diff --git a/Documentation/git-mv.txt b/Documentation/git-mv.txt
index 183e7d5770..0944651f6a 100644
--- a/Documentation/git-mv.txt
+++ b/Documentation/git-mv.txt
@@ -28,20 +28,20 @@ committed.
OPTIONS
-------
--f::
---force::
+`-f`::
+`--force`::
Force renaming or moving of a file even if the target exists
--k::
+`-k`::
Skip move or rename actions which would lead to an error
condition. An error happens when a source is neither existing nor
controlled by Git, or when it would overwrite an existing
file unless `-f` is given.
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Do nothing; only show what would happen
--v::
---verbose::
+`-v`::
+`--verbose`::
Report the names of files as they are moved.
SUBMODULES
diff --git a/Documentation/git-name-rev.txt b/Documentation/git-name-rev.txt
index c6c1f89117..526914f710 100644
--- a/Documentation/git-name-rev.txt
+++ b/Documentation/git-name-rev.txt
@@ -21,16 +21,16 @@ format parsable by `git rev-parse`.
OPTIONS
-------
---tags::
+`--tags`::
Do not use branch names, but only tags to name the commits
---refs=<pattern>::
+`--refs=<pattern>`::
Only use refs whose names match a given shell pattern. The pattern
can be one of branch name, tag name or fully qualified ref name. If
given multiple times, use refs whose names match any of the given shell
patterns. Use `--no-refs` to clear any previous ref patterns given.
---exclude=<pattern>::
+`--exclude=<pattern>`::
Do not use any ref whose name matches a given shell pattern. The
pattern can be one of branch name, tag name or fully qualified ref
name. If given multiple times, a ref will be excluded when it matches
@@ -39,26 +39,26 @@ OPTIONS
does not match any `--exclude` patterns. Use `--no-exclude` to clear the
list of exclude patterns.
---all::
+`--all`::
List all commits reachable from all refs
---stdin::
+`--stdin`::
Transform stdin by substituting all the 40-character SHA-1
hexes (say $hex) with "$hex ($rev_name)". When used with
`--name-only`, substitute with "$rev_name", omitting $hex
altogether. Intended for the scripter's use.
---name-only::
+`--name-only`::
Instead of printing both the SHA-1 and the name, print only
the name. If given with `--tags` the usual tag prefix of
"tags/" is also omitted from the name, matching the output
of `git-describe` more closely.
---no-undefined::
+`--no-undefined`::
Die with error code != 0 when a reference is undefined,
instead of printing `undefined`.
---always::
+`--always`::
Show uniquely abbreviated commit object as fallback.
EXAMPLES
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index ffc6fc51a7..16afea280d 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -53,13 +53,13 @@ notes across commands that rewrite commits.
SUBCOMMANDS
-----------
-list::
+`list`::
List the notes object for a given object. If no object is
given, show a list of all note objects and the objects they
annotate (in the format "<note object> <annotated object>").
This is the default subcommand if no subcommand is given.
-add::
+`add`::
Add notes for a given object (defaults to `HEAD`). Abort if the
object already has notes (use `-f` to overwrite existing notes).
However, if you're using `add` interactively (using an editor
@@ -67,7 +67,7 @@ add::
the existing notes will be opened in the editor (like the `edit`
subcommand).
-copy::
+`copy`::
Copy the notes for the first object onto the second object (defaults to
`HEAD`). Abort if the second object already has notes, or if the first
object has none (use -f to overwrite existing notes to the
@@ -84,17 +84,17 @@ on standard input, and copy the notes from each <from-object> to its
corresponding <to-object>. (The optional `<rest>` is ignored so that
the command can read the input given to the `post-rewrite` hook.)
-append::
+`append`::
Append to the notes of an existing object (defaults to `HEAD`).
Creates a new notes object if needed.
-edit::
+`edit`::
Edit the notes for a given object (defaults to `HEAD`).
-show::
+`show`::
Show the notes for a given object (defaults to `HEAD`).
-merge::
+`merge`::
Merge the given notes ref into the current notes ref.
This will try to merge the changes made by the given
notes ref (called "remote") since the merge-base (if
@@ -109,28 +109,28 @@ When done, the user can either finalize the merge with
`git notes merge --commit`, or abort the merge with
`git notes merge --abort`.
-remove::
+`remove`::
Remove the notes for given objects (defaults to `HEAD`). When
giving zero or one object from the command line, this is
equivalent to specifying an empty note message to
the `edit` subcommand.
-prune::
+`prune`::
Remove all notes for non-existing/unreachable objects.
-get-ref::
+`get-ref`::
Print the current notes ref. This provides an easy way to
retrieve the current notes ref (e.g. from scripts).
OPTIONS
-------
--f::
---force::
+`-f`::
+`--force`::
When adding notes to an object that already has notes,
overwrite the existing notes (instead of aborting).
-m <msg>::
---message=<msg>::
+`--message=<msg>`::
Use the given note message (instead of prompting).
If multiple `-m` options are given, their values
are concatenated as separate paragraphs.
@@ -138,24 +138,24 @@ OPTIONS
single line between paragraphs will be stripped out.
-F <file>::
---file=<file>::
+`--file=<file>`::
Take the note message from the given file. Use '-' to
read the note message from the standard input.
Lines starting with `#` and empty lines other than a
single line between paragraphs will be stripped out.
-C <object>::
---reuse-message=<object>::
+`--reuse-message=<object>`::
Take the given blob object (for example, another note) as the
note message. (Use `git notes copy <object>` instead to
copy notes between objects.)
-c <object>::
---reedit-message=<object>::
+`--reedit-message=<object>`::
Like `-C`, but with `-c` the editor is invoked, so that
the user can further edit the note message.
---allow-empty::
+`--allow-empty`::
Allow an empty note object to be stored. The default behavior is
to automatically remove empty notes.
@@ -166,22 +166,22 @@ OPTIONS
begins with `notes/`, `refs/` and otherwise `refs/notes/` is prefixed
to form a full name of the ref.
---ignore-missing::
+`--ignore-missing`::
Do not consider it an error to request removing notes from an
object that does not have notes attached to it.
---stdin::
+`--stdin`::
Also read the object names to remove notes from the standard
input (there is no reason you cannot combine this with object
names from the command line).
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Do not remove anything; just report the object names whose notes
would be removed.
-s <strategy>::
---strategy=<strategy>::
+`--strategy=<strategy>`::
When merging notes, resolve notes conflicts using the given
strategy. The following strategies are recognized: "manual"
(default), "ours", "theirs", "union" and "cat_sort_uniq".
@@ -189,7 +189,7 @@ OPTIONS
See the "NOTES MERGE STRATEGIES" section below for more
information on each notes merge strategy.
---commit::
+`--commit`::
Finalize an in-progress `git notes merge`. Use this option
when you have resolved the conflicts that `git notes merge`
stored in `.git/NOTES_MERGE_WORKTREE`. This amends the partial
@@ -198,17 +198,17 @@ OPTIONS
`.git/NOTES_MERGE_WORKTREE`. The notes ref stored in the
`.git/NOTES_MERGE_REF` symref is updated to the resulting commit.
---abort::
+`--abort`::
Abort/reset an in-progress `git notes merge`, i.e. a notes merge
with conflicts. This simply removes all files related to the
notes merge.
--q::
---quiet::
+`-q`::
+`--quiet`::
When merging notes, operate quietly.
--v::
---verbose::
+`-v`::
+`--verbose`::
When merging notes, be more verbose.
When pruning notes, report all object names whose notes are
removed.
diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index a74866d84f..90280af75b 100644
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -205,8 +205,8 @@ All commands except clone accept these options.
--git-dir <dir>::
Set the `GIT_DIR` environment variable. See linkgit:git[1].
--v::
---verbose::
+`-v`::
+`--verbose`::
Provide more progress information.
Sync options
@@ -233,7 +233,7 @@ Git repository:
$ git p4 sync --branch=refs/remotes/p4/proj2 //depot/proj2
----
---detect-branches::
+`--detect-branches`::
Use the branch detection algorithm to find new paths in p4. It is
documented below in "BRANCH DETECTION".
@@ -242,18 +242,18 @@ Git repository:
line. Normally, `git p4` inspects the current p4 repository
state and detects the changes it should import.
---silent::
+`--silent`::
Do not print any progress information.
---detect-labels::
+`--detect-labels`::
Query p4 for labels associated with the depot paths, and add
them as tags in Git. Limited usefulness as only imports labels
associated with new changelists. Deprecated.
---import-labels::
+`--import-labels`::
Import labels from p4 into Git.
---import-local::
+`--import-local`::
By default, p4 branches are stored in `refs/remotes/p4/`,
where they will be treated as remote-tracking branches by
linkgit:git-branch[1] and other commands. This option instead
@@ -277,7 +277,7 @@ Git repository:
one block of changes of the given size. The default block size
is 500, which should usually be suitable.
---keep-path::
+`--keep-path`::
The mapping of file names from the p4 depot path to Git, by
default, involves removing the entire depot path. With this
option, the full p4 depot path is retained in Git. For example,
@@ -285,7 +285,7 @@ Git repository:
'//depot/main/', becomes 'foo/bar.c'. With `--keep-path`, the
Git path is instead 'depot/main/foo/bar.c'.
---use-client-spec::
+`--use-client-spec`::
Use a client spec to find the list of interesting files in p4.
See the "CLIENT SPEC" section below.
@@ -302,7 +302,7 @@ options described above.
component in the p4 depot path is used to create a new
directory.
---bare::
+`--bare`::
Perform a bare clone. See linkgit:git-clone[1].
Submit options
@@ -314,22 +314,22 @@ These options can be used to modify `git p4 submit` behavior.
p4. By default, this is the most recent p4 commit reachable
from `HEAD`.
--M::
+`-M`::
Detect renames. See linkgit:git-diff[1]. Renames will be
represented in p4 using explicit 'move' operations. There
is no corresponding option to detect copies, but there are
variables for both moves and copies.
---preserve-user::
+`--preserve-user`::
Re-author p4 changes before submitting to p4. This option
requires p4 admin privileges.
---export-labels::
+`--export-labels`::
Export tags from Git as p4 labels. Tags found in Git are applied
to the perforce working directory.
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Show just what commits would be submitted to p4; do not change
state in Git or p4.
@@ -340,7 +340,7 @@ These options can be used to modify `git p4 submit` behavior.
submit manually or revert. This option always stops after the
first (oldest) commit. Git tags are not exported to p4.
---shelve::
+`--shelve`::
Instead of submitting create a series of shelved changelists.
After creating each shelve, the relevant files are reverted/deleted.
If you have multiple commits pending multiple shelves will be created.
@@ -365,7 +365,7 @@ These options can be used to modify `git p4 submit` behavior.
Submit only the specified commit or range of commits, instead of the full
list of changes that are in the current Git branch.
---disable-rebase::
+`--disable-rebase`::
Disable the automatic rebase after all commits have been successfully
submitted. Can also be set with `git-p4.disableRebase`.
@@ -427,13 +427,13 @@ Rebase options
~~~~~~~~~~~~~~
These options can be used to modify `git p4 rebase` behavior.
---import-labels::
+`--import-labels`::
Import p4 labels.
Unshelve options
~~~~~~~~~~~~~~~~
---origin::
+`--origin`::
Sets the `git` refspec against which the shelved P4 changelist is compared.
Defaults to p4/master.
diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
index 118fdeac35..4a924ccd32 100644
--- a/Documentation/git-pack-objects.txt
+++ b/Documentation/git-pack-objects.txt
@@ -48,7 +48,7 @@ transport by their peers.
OPTIONS
-------
-base-name::
+`base-name`::
Write into pairs of files (.pack and .idx), using
<base-name> to determine the name of the created file.
When this option is used, the two files in a pair are written in
@@ -56,11 +56,11 @@ base-name::
based on the pack content and is written to the standard
output of the command.
---stdout::
+`--stdout`::
Write the pack contents (what would have been written to
.pack file) out to the standard output.
---revs::
+`--revs`::
Read the revision arguments from the standard input, instead of
individual object names. The revision arguments are processed
the same way as `git rev-list` with the `--objects` flag
@@ -69,23 +69,23 @@ base-name::
Besides revisions, `--not` or `--shallow <SHA-1>` lines are
also accepted.
---unpacked::
+`--unpacked`::
This implies `--revs`. When processing the list of
revision arguments read from the standard input, limit
the objects packed to those that are not already packed.
---all::
+`--all`::
This implies `--revs`. In addition to the list of
revision arguments read from the standard input, pretend
as if all refs under `refs/` are specified to be
included.
---include-tag::
+`--include-tag`::
Include unasked-for annotated tags if the object they
reference was included in the resulting packfile. This
can be useful to send new tags to native Git clients.
---stdin-packs::
+`--stdin-packs`::
Read the basenames of packfiles (e.g., `pack-1234abcd.pack`)
from the standard input, instead of object names or revision
arguments. The resulting pack contains all objects listed in the
@@ -95,8 +95,8 @@ base-name::
Incompatible with `--revs`, or options that imply `--revs` (such as
`--all`), with the exception of `--unpacked`, which is compatible.
---window=<n>::
---depth=<n>::
+`--window=<n>`::
+`--depth=<n>`::
These two options affect how the objects contained in
the pack are stored using delta compression. The
objects are first internally sorted by type, size and
@@ -110,7 +110,7 @@ Incompatible with `--revs`, or options that imply `--revs` (such as
The default value for `--window` is 10 and `--depth` is 50. The maximum
depth is 4095.
---window-memory=<n>::
+`--window-memory=<n>`::
This option provides an additional limit on top of `--window`;
the window size will dynamically scale down so as to not take
up more than '<n>' bytes in memory. This is useful in
@@ -121,7 +121,7 @@ depth is 4095.
`--window-memory=0` makes memory usage unlimited. The default
is taken from the `pack.windowMemory` configuration variable.
---max-pack-size=<n>::
+`--max-pack-size=<n>`::
In unusual scenarios, you may not be able to create files
larger than a certain size on your filesystem, and this option
can be used to tell the command to split the output packfile
@@ -133,38 +133,38 @@ depth is 4095.
The default is unlimited, unless the config variable
`pack.packSizeLimit` is set.
---honor-pack-keep::
+`--honor-pack-keep`::
This flag causes an object already in a local pack that
has a .keep file to be ignored, even if it would have
otherwise been packed.
---keep-pack=<pack-name>::
+`--keep-pack=<pack-name>`::
This flag causes an object already in the given pack to be
ignored, even if it would have otherwise been
packed. `<pack-name>` is the pack file name without
leading directory (e.g. `pack-123.pack`). The option could be
specified multiple times to keep multiple packs.
---incremental::
+`--incremental`::
This flag causes an object already in a pack to be ignored
even if it would have otherwise been packed.
---local::
+`--local`::
This flag causes an object that is borrowed from an alternate
object store to be ignored even if it would have otherwise been
packed.
---non-empty::
+`--non-empty`::
Only create a packed archive if it would contain at
least one object.
---progress::
+`--progress`::
Progress status is reported on the standard error stream
by default when it is attached to a terminal, unless -q
is specified. This flag forces progress status even if
the standard error stream is not directed to a terminal.
---all-progress::
+`--all-progress`::
When `--stdout` is specified then progress report is
displayed during the object count and compression phases
but inhibited during the write-out phase. The reason is
@@ -175,30 +175,30 @@ depth is 4095.
report for the write-out phase as well even if `--stdout` is
used.
---all-progress-implied::
+`--all-progress-implied`::
This is used to imply `--all-progress` whenever progress display
is activated. Unlike `--all-progress` this flag doesn't actually
force any progress display by itself.
--q::
+`-q`::
This flag makes the command not to report its progress
on the standard error stream.
---no-reuse-delta::
+`--no-reuse-delta`::
When creating a packed archive in a repository that
has existing packs, the command reuses existing deltas.
This sometimes results in a slightly suboptimal pack.
This flag tells the command not to reuse existing deltas
but compute them from scratch.
---no-reuse-object::
+`--no-reuse-object`::
This flag tells the command not to reuse existing object data at all,
including non deltified object, forcing recompression of everything.
This implies `--no-reuse-delta`. Useful only in the obscure case where
wholesale enforcement of a different compression level on the
packed data is desired.
---compression=<n>::
+`--compression=<n>`::
Specifies compression level for newly-compressed data in the
generated pack. If not specified, pack compression level is
determined first by pack.compression, then by core.compression,
@@ -206,7 +206,7 @@ depth is 4095.
Add `--no-reuse-object` if you want to force a uniform compression
level on all data no matter the source.
---[no-]sparse::
+`--[no-]sparse`::
Toggle the "sparse" algorithm to determine which objects to include in
the pack, when combined with the `--revs` option. This algorithm
only walks trees that appear in paths that introduce new objects.
@@ -217,7 +217,7 @@ depth is 4095.
it defaults to the value of `pack.useSparse`, which is true unless
otherwise specified.
---thin::
+`--thin`::
Create a "thin" pack by omitting the common objects between a
sender and a receiver in order to reduce network transfer. This
option only makes sense in conjunction with `--stdout`.
@@ -227,12 +227,12 @@ required objects and is thus unusable by Git without making it
self-contained. Use `git index-pack --fix-thin`
(see linkgit:git-index-pack[1]) to restore the self-contained property.
---shallow::
+`--shallow`::
Optimize a pack that will be provided to a client with a shallow
repository. This option, combined with `--thin`, can result in a
smaller pack at the cost of speed.
---delta-base-offset::
+`--delta-base-offset`::
A packed archive can express the base object of a delta as
either a 20-byte object name or as an offset in the
stream, but ancient versions of Git don't understand the
@@ -248,7 +248,7 @@ Note: Porcelain commands such as `git gc` (see linkgit:git-gc[1]),
in modern Git when they put objects in your repository into pack files.
So does `git bundle` (see linkgit:git-bundle[1]) when it creates a bundle.
---threads=<n>::
+`--threads=<n>`::
Specifies the number of threads to spawn when searching for best
delta matches. This requires that pack-objects be compiled with
pthreads otherwise this option is ignored with a warning.
@@ -263,19 +263,19 @@ So does `git bundle` (see linkgit:git-bundle[1]) when it creates a bundle.
to force the version for the generated pack index, and to force
64-bit index entries on objects located above the given offset.
---keep-true-parents::
+`--keep-true-parents`::
With this option, parents that are hidden by grafts are packed
nevertheless.
---filter=<filter-spec>::
+`--filter=<filter-spec>`::
Requires `--stdout`. Omits certain objects (usually blobs) from
the resulting packfile. See linkgit:git-rev-list[1] for valid
`<filter-spec>` forms.
---no-filter::
+`--no-filter`::
Turns off any previous `--filter=` argument.
---missing=<missing-action>::
+`--missing=<missing-action>`::
A debug option to help with future "partial clone" development.
This option specifies how missing objects are handled.
+
@@ -293,27 +293,27 @@ allow object traversal to continue for EXPECTED promisor missing objects.
No fetch of a missing object will occur. An unexpected missing object will
raise an error.
---exclude-promisor-objects::
+`--exclude-promisor-objects`::
Omit objects that are known to be in the promisor remote. (This
option has the purpose of operating only on locally created objects,
so that when we repack, we still maintain a distinction between
locally created objects [without .promisor] and objects from the
promisor remote [with .promisor].) This is used with partial clone.
---keep-unreachable::
+`--keep-unreachable`::
Objects unreachable from the refs in packs named with
`--unpacked`= option are added to the resulting pack, in
addition to the reachable objects that are not in packs marked
with *.keep files. This implies `--revs`.
---pack-loose-unreachable::
+`--pack-loose-unreachable`::
Pack unreachable loose objects (and their loose counterparts
removed). This implies `--revs`.
---unpack-unreachable::
+`--unpack-unreachable`::
Keep unreachable objects in loose form. This implies `--revs`.
---delta-islands::
+`--delta-islands`::
Restrict delta matches based on "islands". See DELTA ISLANDS
below.
diff --git a/Documentation/git-pack-redundant.txt b/Documentation/git-pack-redundant.txt
index a288be2c12..cc028d80de 100644
--- a/Documentation/git-pack-redundant.txt
+++ b/Documentation/git-pack-redundant.txt
@@ -29,14 +29,14 @@ OPTIONS
-------
---all::
+`--all`::
Processes all packs. Any filenames on the command line are ignored.
---alt-odb::
+`--alt-odb`::
Don't require objects present in packs from alternate object
directories to be present in local packs.
---verbose::
+`--verbose`::
Outputs some statistics to stderr. Has a small performance penalty.
SEE ALSO
diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt
index f77bd0e27f..3235e5129e 100644
--- a/Documentation/git-pack-refs.txt
+++ b/Documentation/git-pack-refs.txt
@@ -45,7 +45,7 @@ unpacked.
OPTIONS
-------
---all::
+`--all`::
The command by default packs all tags and refs that are already
packed, and leaves other refs
@@ -54,7 +54,7 @@ developed and packing their tips does not help performance.
This option causes branch tips to be packed as well. Useful for
a repository with many branches of historical interests.
---no-prune::
+`--no-prune`::
The command usually removes loose refs under `$GIT_DIR/refs`
hierarchy after packing them. This option tells it not to.
diff --git a/Documentation/git-patch-id.txt b/Documentation/git-patch-id.txt
index 5e8747f673..e50d13c6ed 100644
--- a/Documentation/git-patch-id.txt
+++ b/Documentation/git-patch-id.txt
@@ -30,7 +30,7 @@ This can be used to make a mapping from patch ID to commit ID.
OPTIONS
-------
---stable::
+`--stable`::
Use a "stable" sum of hashes as the patch ID. With this option:
- Reordering file diffs that make up a patch does not affect the ID.
In particular, two patches produced by comparing the same two trees
@@ -47,7 +47,7 @@ OPTIONS
This is the default if `patchid.stable` is set to true.
---unstable::
+`--unstable`::
Use an "unstable" hash as the patch ID. With this option,
the result produced is compatible with the patch-id value produced
by `git` 1.9 and older. Users with pre-existing databases storing
diff --git a/Documentation/git-prune-packed.txt b/Documentation/git-prune-packed.txt
index 77603fd5e2..9b4414a34e 100644
--- a/Documentation/git-prune-packed.txt
+++ b/Documentation/git-prune-packed.txt
@@ -28,13 +28,13 @@ disk storage, etc.
OPTIONS
-------
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Don't actually remove any objects, only show those that would have been
removed.
--q::
---quiet::
+`-q`::
+`--quiet`::
Squelch the progress indicator.
SEE ALSO
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt
index 382e5f70f4..1e4a2a648f 100644
--- a/Documentation/git-prune.txt
+++ b/Documentation/git-prune.txt
@@ -33,16 +33,16 @@ not desired, see linkgit:git-repack[1].
OPTIONS
-------
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Do not remove anything; just report what it would
remove.
--v::
---verbose::
+`-v`::
+`--verbose`::
Report all removed objects.
---progress::
+`--progress`::
Show progress.
--expire <time>::
diff --git a/Documentation/git-pull.txt b/Documentation/git-pull.txt
index a64a137a89..7b83ac3577 100644
--- a/Documentation/git-pull.txt
+++ b/Documentation/git-pull.txt
@@ -74,14 +74,14 @@ pulling or stash them away with linkgit:git-stash[1].
OPTIONS
-------
--q::
---quiet::
+`-q`::
+`--quiet`::
This is passed to both underlying `git-fetch` to squelch reporting of
during transfer, and underlying `git-merge` to squelch output during
merging.
--v::
---verbose::
+`-v`::
+`--verbose`::
Pass `--verbose` to `git-fetch` and `git-merge`.
--[no-]recurse-submodules[=yes|on-demand|no]::
@@ -101,7 +101,7 @@ Options related to merging
include::merge-options.txt[]
--r::
+`-r`::
--rebase[=false|true|merges|preserve|interactive]::
When true, rebase the current branch on top of the upstream
branch after fetching. If there is a remote-tracking branch
@@ -131,7 +131,7 @@ It rewrites history, which does not bode well when you
published that history already. Do *not* use this option
unless you have read linkgit:git-rebase[1] carefully.
---no-rebase::
+`--no-rebase`::
Override earlier `--rebase`.
Options related to fetching
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index 7811e2c73b..c33ebe5f4a 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -47,7 +47,7 @@ local one.
OPTIONS[[OPTIONS]]
------------------
-<repository>::
+`<repository>`::
The "remote" repository that is destination of a push
operation. This parameter can be either a URL
(see the section <<URLS,GIT URLS>> below) or the name
@@ -146,11 +146,11 @@ already exists on the remote side.
+
`tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
---all::
+`--all`::
Push all branches (i.e. refs under `refs/heads/`); cannot be
used with other <refspec>.
---prune::
+`--prune`::
Remove remote branches that don't have a local counterpart. For example
a remote branch `tmp` will be removed if a local branch with the same
name doesn't exist any more. This also respects refspecs, e.g.
@@ -158,7 +158,7 @@ already exists on the remote side.
make sure that remote `refs/tmp/foo` will be removed if `refs/heads/foo`
doesn't exist.
---mirror::
+`--mirror`::
Instead of naming each ref to push, specifies that all
refs under `refs/` (which includes but is not
limited to `refs/heads/`, `refs/remotes/`, and `refs/tags/`)
@@ -169,26 +169,26 @@ already exists on the remote side.
if the configuration option `remote.<remote>.mirror` is
set.
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Do everything except actually send the updates.
---porcelain::
+`--porcelain`::
Produce machine-readable output. The output status line for each ref
will be tab-separated and sent to stdout instead of stderr. The full
symbolic names of the refs will be given.
--d::
---delete::
+`-d`::
+`--delete`::
All listed refs are deleted from the remote repository. This is
the same as prefixing all refs with a colon.
---tags::
+`--tags`::
All refs under `refs/tags` are pushed, in
addition to refspecs explicitly listed on the command
line.
---follow-tags::
+`--follow-tags`::
Push all the refs that would be pushed without this option,
and also push annotated tags in `refs/tags` that are missing
from the remote but are pointing at commit-ish that are
@@ -196,7 +196,7 @@ already exists on the remote side.
with configuration variable `push.followTags`. For more
information, see `push.followTags` in linkgit:git-config[1].
---[no-]signed::
+`--[no-]signed`::
--signed=(true|false|if-asked)::
GPG-sign the push request to update refs on the receiving
side, to allow it to be checked by the hooks and/or be
@@ -207,13 +207,13 @@ already exists on the remote side.
will also fail if the actual call to `gpg --sign` fails. See
linkgit:git-receive-pack[1] for the details on the receiving end.
---[no-]atomic::
+`--[no-]atomic`::
Use an atomic transaction on the remote side if available.
Either all refs are updated, or on error, no refs are updated.
If the server does not support atomic pushes the push will fail.
-o <option>::
---push-option=<option>::
+`--push-option=<option>`::
Transmit the given string to the server, which passes them to
the pre-receive as well as the post-receive hook. The given string
must not contain a NUL or LF character.
@@ -224,15 +224,15 @@ already exists on the remote side.
line, the values of configuration variable `push.pushOption`
are used instead.
---receive-pack=<git-receive-pack>::
---exec=<git-receive-pack>::
+`--receive-pack=<git-receive-pack>`::
+`--exec=<git-receive-pack>`::
Path to the `git-receive-pack` program on the remote
end. Sometimes useful when pushing to a remote
repository over ssh, and you do not have the program in
a directory on the default `$PATH`.
---[no-]force-with-lease::
---force-with-lease=<refname>::
+`--[no-]force-with-lease`::
+`--force-with-lease=<refname>`::
--force-with-lease=<refname>:<expect>::
Usually, `git push` refuses to update a remote ref that is
not an ancestor of the local ref used to overwrite it.
@@ -329,8 +329,8 @@ verify if updates from the remote-tracking refs that may have been
implicitly updated in the background are integrated locally before
allowing a forced update.
--f::
---force::
+`-f`::
+`--force`::
Usually, the command refuses to update a remote ref that is
not an ancestor of the local ref used to overwrite it.
Also, when `--force-with-lease` option is used, the command refuses
@@ -349,7 +349,7 @@ one branch, use a `+` in front of the refspec to push (e.g `git push
origin +master` to force a push to the `master` branch). See the
`<refspec>...` section above for details.
---[no-]force-if-includes::
+`--[no-]force-if-includes`::
Force an update only if the tip of the remote-tracking ref
has been integrated locally.
+
@@ -365,40 +365,40 @@ a "no-op".
+
Specifying `--no-force-if-includes` disables this behavior.
---repo=<repository>::
+`--repo=<repository>`::
This option is equivalent to the <repository> argument. If both
are specified, the command-line argument takes precedence.
--u::
---set-upstream::
+`-u`::
+`--set-upstream`::
For every branch that is up to date or successfully pushed, add
upstream (tracking) reference, used by argument-less
linkgit:git-pull[1] and other commands. For more information,
see `branch.<name>.merge` in linkgit:git-config[1].
---[no-]thin::
+`--[no-]thin`::
These options are passed to linkgit:git-send-pack[1]. A thin transfer
significantly reduces the amount of sent data when the sender and
receiver share many of the same objects in common. The default is
`--thin`.
--q::
---quiet::
+`-q`::
+`--quiet`::
Suppress all output, including the listing of updated refs,
unless an error occurs. Progress is not reported to the standard
error stream.
--v::
---verbose::
+`-v`::
+`--verbose`::
Run verbosely.
---progress::
+`--progress`::
Progress status is reported on the standard error stream
by default when it is attached to a terminal, unless -q
is specified. This flag forces progress status even if the
standard error stream is not directed to a terminal.
---no-recurse-submodules::
+`--no-recurse-submodules`::
--recurse-submodules=check|on-demand|only|no::
May be used to make sure all submodule commits used by the
revisions to be pushed are available on a remote-tracking branch.
@@ -414,7 +414,7 @@ Specifying `--no-force-if-includes` disables this behavior.
to override the `push.recurseSubmodules` configuration variable when no
submodule recursion is required.
---[no-]verify::
+`--[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.
@@ -452,7 +452,7 @@ If `--porcelain` is used, then each line of the output is of the form:
The status of up-to-date refs is shown only if `--porcelain` or `--verbose`
option is used.
-flag::
+`flag`::
A single character indicating the status of the ref:
(space);; for a successfully pushed fast-forward;
`+`;; for a successful forced update;
@@ -461,7 +461,7 @@ flag::
`!`;; for a ref that was rejected or failed to push; and
`=`;; for a ref that was up to date and did not need pushing.
-summary::
+`summary`::
For a successfully pushed ref, the summary shows the old and new
values of the ref in a form suitable for using as an argument to
`git log` (this is `<old>..<new>` in most cases, and
@@ -470,7 +470,7 @@ summary::
For a failed update, more details are given:
+
--
-rejected::
+`rejected`::
Git did not try to send the ref at all, typically because it
is not a fast-forward and you did not force the update.
@@ -489,16 +489,16 @@ remote failure::
break in the network connection, or other transient error.
--
-from::
+`from`::
The name of the local ref being pushed, minus its
`refs/<type>/` prefix. In the case of deletion, the
name of the local ref is omitted.
-to::
+`to`::
The name of the remote ref being updated, minus its
`refs/<type>/` prefix.
-reason::
+`reason`::
A human-readable explanation. In the case of successfully pushed
refs, no explanation is needed. For a failed ref, the reason for
failure is described.
diff --git a/Documentation/git-quiltimport.txt b/Documentation/git-quiltimport.txt
index 831bf55ed8..c3ec9efe38 100644
--- a/Documentation/git-quiltimport.txt
+++ b/Documentation/git-quiltimport.txt
@@ -31,8 +31,8 @@ preserved as the 1 line subject in the Git description.
OPTIONS
-------
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Walk through the patches in the series and warn
if we cannot find all of the necessary information to commit
a patch. At the time of this writing only missing author
@@ -56,7 +56,7 @@ The default for the series file is <patches>/series
or the value of the `$QUILT_SERIES` environment
variable.
---keep-non-patch::
+`--keep-non-patch`::
Pass `-b` flag to `git mailinfo` (see linkgit:git-mailinfo[1]).
GIT
diff --git a/Documentation/git-range-diff.txt b/Documentation/git-range-diff.txt
index 2de9ca2d08..8703bef8ef 100644
--- a/Documentation/git-range-diff.txt
+++ b/Documentation/git-range-diff.txt
@@ -43,7 +43,7 @@ There are three ways to specify the commit ranges:
OPTIONS
-------
---no-dual-color::
+`--no-dual-color`::
When the commit diffs differ, `git range-diff` recreates the
original diffs' coloring, and adds outer -/+ diff markers with
the *background* being red/green to make it easier to see e.g.
@@ -61,7 +61,7 @@ This is known to `range-diff` as "dual coloring". Use `--no-dual-color`
to revert to color all lines according to the outer diff markers
(and completely ignore the inner diff when it comes to color).
---creation-factor=<percent>::
+`--creation-factor=<percent>`::
Set the creation/deletion cost fudge factor to `<percent>`.
Defaults to 60. Try a larger value if `git range-diff` erroneously
considers a large change a total rewrite (deletion of one commit
@@ -69,15 +69,15 @@ to revert to color all lines according to the outer diff markers
See the ``Algorithm`` section below for an explanation why this is
needed.
---left-only::
+`--left-only`::
Suppress commits that are missing from the first specified range
(or the "left range" when using the `<rev1>...<rev2>` format).
---right-only::
+`--right-only`::
Suppress commits that are missing from the second specified range
(or the "right range" when using the `<rev1>...<rev2>` format).
---[no-]notes[=<ref>]::
+`--[no-]notes[=<ref>]`::
This flag is passed to the `git log` program
(see linkgit:git-log[1]) that generates the patches.
diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index 2b2bd665e0..e242a2553a 100644
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -31,22 +31,22 @@ will be in unmerged state when `git read-tree` returns.
OPTIONS
-------
--m::
+`-m`::
Perform a merge, not just a read. The command will
refuse to run if your index file has unmerged entries,
indicating that you have not finished previous merge you
started.
---reset::
+`--reset`::
Same as `-m`, except that unmerged entries are discarded instead
of failing. When used with `-u`, updates leading to loss of
working tree changes will not abort the operation.
--u::
+`-u`::
After a successful merge, update the files in the work
tree with the result of the merge.
--i::
+`-i`::
Usually a merge requires the index file as well as the
files in the working tree to be up to date with the
current head commit, in order not to lose local
@@ -55,21 +55,21 @@ OPTIONS
trees that are not directly related to the current
working tree status into a temporary index file.
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Check if the command would error out, without updating the index
or the files in the working tree for real.
--v::
+`-v`::
Show the progress of checking files out.
---trivial::
+`--trivial`::
Restrict three-way merge by `git read-tree` to happen
only if there is no file-level merging required, instead
of resolving merge for trivial cases and leaving
conflicting files unresolved in the index.
---aggressive::
+`--aggressive`::
Usually a three-way merge by `git read-tree` resolves
the merge for really trivial cases and leaves other
cases unresolved in the index, so that porcelains can
@@ -82,13 +82,13 @@ OPTIONS
* when both sides add a path identically. The resolution
is to add that path.
---prefix=<prefix>::
+`--prefix=<prefix>`::
Keep the current index contents, and read the contents
of the named tree-ish under the directory at `<prefix>`.
The command will refuse to overwrite entries that already
existed in the original index file.
---exclude-per-directory=<gitignore>::
+`--exclude-per-directory=<gitignore>`::
When running the command with `-u` and `-m` options, the
merge result may need to overwrite paths that are not
tracked in the current branch. The command usually
@@ -103,7 +103,7 @@ OPTIONS
file (usually '.gitignore') and allows such an untracked
but explicitly ignored file to be overwritten.
---index-output=<file>::
+`--index-output=<file>`::
Instead of writing the results out to `$GIT_INDEX_FILE`,
write the resulting index in the named file. While the
command is operating, the original index file is locked
@@ -115,22 +115,22 @@ OPTIONS
directories the index file and index output file are
located in.
---[no-]recurse-submodules::
+`--[no-]recurse-submodules`::
Using `--recurse-submodules` will update the content of all active
submodules according to the commit recorded in the superproject by
calling read-tree recursively, also setting the submodules' `HEAD` to be
detached at that commit.
---no-sparse-checkout::
+`--no-sparse-checkout`::
Disable sparse checkout support even if `core.sparseCheckout`
is true.
---empty::
+`--empty`::
Instead of reading tree object(s) into the index, just empty
it.
--q::
---quiet::
+`-q`::
+`--quiet`::
Quiet, suppress feedback messages.
<tree-ish#>::
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index 1c5eaf8cf7..f32ffaa011 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -218,7 +218,7 @@ As a special case, you may use "A\...B" as a shortcut for the
merge base of A and B if there is exactly one merge base. You can
leave out at most one of A and B, in which case it defaults to `HEAD`.
---keep-base::
+`--keep-base`::
Set the starting point at which to create the new commits to the
merge base of <upstream> <branch>. Running
`git rebase --keep-base <upstream> <branch>` is equivalent to
@@ -236,31 +236,31 @@ the merge base to determine the _set of commits_ which will be rebased.
+
See also INCOMPATIBLE OPTIONS below.
-<upstream>::
+`<upstream>`::
Upstream branch to compare against. May be any valid commit,
not just an existing branch name. Defaults to the configured
upstream for the current branch.
-<branch>::
+`<branch>`::
Working branch; defaults to `HEAD`.
---continue::
+`--continue`::
Restart the rebasing process after having resolved a merge conflict.
---abort::
+`--abort`::
Abort the rebase operation and reset `HEAD` to the original
branch. If <branch> was provided when the rebase operation was
started, then `HEAD` will be reset to <branch>. Otherwise `HEAD`
will be reset to where it was when the rebase operation was
started.
---quit::
+`--quit`::
Abort the rebase operation but `HEAD` is not reset back to the
original branch. The index and working tree are also left
unchanged as a result. If a temporary stash entry was created
using `--autostash`, it will be saved to the stash list.
---apply::
+`--apply`::
Use applying strategies to rebase (calling `git-am`
internally). This option may become a no-op in the future
once the merge backend handles everything the apply one does.
@@ -286,8 +286,8 @@ preliminary step (unless `--reapply-cherry-picks` is passed).
+
See also INCOMPATIBLE OPTIONS below.
---no-keep-empty::
---keep-empty::
+`--no-keep-empty`::
+`--keep-empty`::
Do not keep commits that start empty before the rebase
(i.e. that do not change anything from its parent) in the
result. The default is to keep commits which start empty,
@@ -307,8 +307,8 @@ see the `--empty` flag.
+
See also INCOMPATIBLE OPTIONS below.
---reapply-cherry-picks::
---no-reapply-cherry-picks::
+`--reapply-cherry-picks`::
+`--no-reapply-cherry-picks`::
Reapply all clean cherry-picks of any upstream commit instead
of preemptively dropping them. (If these commits then become
empty after rebasing, because they contain a subset of already
@@ -325,7 +325,7 @@ commits, potentially improving performance.
+
See also INCOMPATIBLE OPTIONS below.
---allow-empty-message::
+`--allow-empty-message`::
No-op. Rebasing commits with an empty message used to fail
and this option would override that behavior, allowing commits
with empty messages to be rebased. Now commits with an empty
@@ -333,19 +333,19 @@ See also INCOMPATIBLE OPTIONS below.
+
See also INCOMPATIBLE OPTIONS below.
---skip::
+`--skip`::
Restart the rebasing process by skipping the current patch.
---edit-todo::
+`--edit-todo`::
Edit the todo list during an interactive rebase.
---show-current-patch::
+`--show-current-patch`::
Show the current patch in an interactive rebase or when rebase
is stopped because of conflicts. This is the equivalent of
`git show REBASE_HEAD`.
--m::
---merge::
+`-m`::
+`--merge`::
Use merging strategies to rebase. When the recursive (default) merge
strategy is used, this allows rebase to be aware of renames on the
upstream side. This is the default.
@@ -359,7 +359,7 @@ other words, the sides are swapped.
See also INCOMPATIBLE OPTIONS below.
-s <strategy>::
---strategy=<strategy>::
+`--strategy=<strategy>`::
Use the given merge strategy.
If there is no `-s` option `git merge-recursive` is used
instead. This implies `--merge`.
@@ -372,7 +372,7 @@ which makes little sense.
See also INCOMPATIBLE OPTIONS below.
-X <strategy-option>::
---strategy-option=<strategy-option>::
+`--strategy-option=<strategy-option>`::
Pass the <strategy-option> through to the merge strategy.
This implies `--merge` and, if no strategy has been
specified, `-s recursive`. Note the reversal of 'ours' and
@@ -380,44 +380,44 @@ See also INCOMPATIBLE OPTIONS below.
+
See also INCOMPATIBLE OPTIONS below.
---rerere-autoupdate::
---no-rerere-autoupdate::
+`--rerere-autoupdate`::
+`--no-rerere-autoupdate`::
Allow the rerere mechanism to update the index with the
result of auto-conflict resolution if possible.
--S[<keyid>]::
---gpg-sign[=<keyid>]::
---no-gpg-sign::
+`-S[<keyid>]`::
+`--gpg-sign[=<keyid>]`::
+`--no-gpg-sign`::
GPG-sign commits. The `keyid` argument is optional and
defaults to the committer identity; if specified, it must be
stuck to the option without a space. `--no-gpg-sign` is useful to
countermand both `commit.gpgSign` configuration variable, and
earlier `--gpg-sign`.
--q::
---quiet::
+`-q`::
+`--quiet`::
Be quiet. Implies `--no-stat`.
--v::
---verbose::
+`-v`::
+`--verbose`::
Be verbose. Implies `--stat`.
---stat::
+`--stat`::
Show a diffstat of what changed upstream since the last rebase. The
diffstat is also controlled by the configuration option `rebase.stat`.
--n::
---no-stat::
+`-n`::
+`--no-stat`::
Do not show a diffstat as part of the rebase process.
---no-verify::
+`--no-verify`::
This option bypasses the pre-rebase hook. See also linkgit:githooks[5].
---verify::
+`--verify`::
Allows the pre-rebase hook to run, which is the default. This option can
be used to override `--no-verify`. See also linkgit:githooks[5].
--C<n>::
+`-C<n>`::
Ensure at least <n> lines of surrounding context match before
and after each change. When fewer lines of surrounding
context exist they all must match. By default no context is
@@ -425,9 +425,9 @@ See also INCOMPATIBLE OPTIONS below.
+
See also INCOMPATIBLE OPTIONS below.
---no-ff::
---force-rebase::
--f::
+`--no-ff`::
+`--force-rebase`::
+`-f`::
Individually replay all rebased commits instead of fast-forwarding
over the unchanged ones. This ensures that the entire history of
the rebased branch is composed of new commits.
@@ -438,8 +438,8 @@ successfully without needing to "revert the reversion" (see the
link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for
details).
---fork-point::
---no-fork-point::
+`--fork-point`::
+`--no-fork-point`::
Use reflog to find a better common ancestor between <upstream>
and <branch> when calculating which commits have been
introduced by <branch>.
@@ -459,7 +459,7 @@ with `--keep-base` in order to drop those commits from your branch.
+
See also INCOMPATIBLE OPTIONS below.
---ignore-whitespace::
+`--ignore-whitespace`::
Ignore whitespace differences when trying to reconcile
differences. Currently, each backend implements an approximation of
this behavior:
@@ -475,35 +475,35 @@ when merging. Unfortunately, this means that any patch hunks that were
intended to modify whitespace and nothing else will be dropped, even
if the other side had no changes that conflicted.
---whitespace=<option>::
+`--whitespace=<option>`::
This flag is passed to the `git apply` program
(see linkgit:git-apply[1]) that applies the patch.
Implies `--apply`.
+
See also INCOMPATIBLE OPTIONS below.
---committer-date-is-author-date::
+`--committer-date-is-author-date`::
Instead of using the current time as the committer date, use
the author date of the commit being rebased as the committer
date. This option implies `--force-rebase`.
---ignore-date::
---reset-author-date::
+`--ignore-date`::
+`--reset-author-date`::
Instead of using the author date of the original commit, use
the current time as the author date of the rebased commit. This
option implies `--force-rebase`.
+
See also INCOMPATIBLE OPTIONS below.
---signoff::
+`--signoff`::
Add a `Signed-off-by` trailer to all the rebased commits. Note
that if `--interactive` is given then only commits marked to be
picked, edited or reworded will have the trailer added.
+
See also INCOMPATIBLE OPTIONS below.
--i::
---interactive::
+`-i`::
+`--interactive`::
Make a list of the commits which are about to be rebased. Let the
user edit that list before rebasing. This mode can also be used to
split commits (see SPLITTING COMMITS below).
@@ -514,7 +514,7 @@ have the long commit hash prepended to the format.
+
See also INCOMPATIBLE OPTIONS below.
--r::
+`-r`::
--rebase-merges[=(rebase-cousins|no-rebase-cousins)]::
By default, a rebase will simply drop merge commits from the todo
list, and put the rebased commits into a single, linear branch.
@@ -541,8 +541,8 @@ explicit `exec git merge -s <strategy> [...]` commands.
+
See also REBASING MERGES and INCOMPATIBLE OPTIONS below.
--p::
---preserve-merges::
+`-p`::
+`--preserve-merges`::
[DEPRECATED: use `--rebase-merges` instead] Recreate merge commits
instead of flattening the history by replaying commits a merge commit
introduces. Merge conflict resolutions or manual amendments to merge
@@ -579,7 +579,7 @@ without an explicit `--interactive`.
+
See also INCOMPATIBLE OPTIONS below.
---root::
+`--root`::
Rebase all commits reachable from <branch>, instead of
limiting them with an <upstream>. This allows you to rebase
the root commit(s) on a branch. When used with `--onto`, it
@@ -591,8 +591,8 @@ See also INCOMPATIBLE OPTIONS below.
+
See also INCOMPATIBLE OPTIONS below.
---autosquash::
---no-autosquash::
+`--autosquash`::
+`--no-autosquash`::
When the commit log message begins with "squash! ..." or "fixup! ..."
or "amend! ...", and there is already a commit in the todo list that
matches the same `...`, automatically modify the todo list of
@@ -611,16 +611,16 @@ used to override and disable this setting.
+
See also INCOMPATIBLE OPTIONS below.
---autostash::
---no-autostash::
+`--autostash`::
+`--no-autostash`::
Automatically create a temporary stash entry before the operation
begins, and apply it after the operation ends. This means
that you can run rebase on a dirty worktree. However, use
with care: the final stash application after a successful
rebase might result in non-trivial conflicts.
---reschedule-failed-exec::
---no-reschedule-failed-exec::
+`--reschedule-failed-exec`::
+`--no-reschedule-failed-exec`::
Automatically reschedule `exec` commands that failed. This only makes
sense in interactive mode (or when an `--exec` option was provided).
diff --git a/Documentation/git-reflog.txt b/Documentation/git-reflog.txt
index c33a577a00..6aca5d9fa2 100644
--- a/Documentation/git-reflog.txt
+++ b/Documentation/git-reflog.txt
@@ -69,15 +69,15 @@ Options for `show`
Options for `expire`
~~~~~~~~~~~~~~~~~~~~
---all::
+`--all`::
Process the reflogs of all references.
---single-worktree::
+`--single-worktree`::
By default when `--all` is specified, reflogs from all working
trees are processed. This option limits the processing to reflogs
from the current working tree only.
---expire=<time>::
+`--expire=<time>`::
Prune entries older than the specified time. If this option is
not specified, the expiration time is taken from the
configuration setting `gc.reflogExpire`, which in turn
@@ -85,7 +85,7 @@ Options for `expire`
of their age; `--expire=never` turns off pruning of reachable
entries (but see `--expire-unreachable`).
---expire-unreachable=<time>::
+`--expire-unreachable=<time>`::
Prune entries older than `<time>` that are not reachable from
the current tip of the branch. If this option is not
specified, the expiration time is taken from the configuration
@@ -95,17 +95,17 @@ Options for `expire`
turns off early pruning of unreachable entries (but see
`--expire`).
---updateref::
+`--updateref`::
Update the reference to the value of the top reflog entry (i.e.
<ref>@\{0\}) if the previous top entry was pruned. (This
option is ignored for symbolic references.)
---rewrite::
+`--rewrite`::
If a reflog entry's predecessor is pruned, adjust its "old"
SHA-1 to be equal to the "new" SHA-1 field of the entry that
now precedes it.
---stale-fix::
+`--stale-fix`::
Prune any reflog entries that point to "broken commits". A
broken commit is a commit that is not reachable from any of
the reference tips and that refers, directly or indirectly, to
@@ -116,12 +116,12 @@ has the same cost as `git prune`. It is primarily intended to fix
corruption caused by garbage collecting using older versions of Git,
which didn't protect objects referred to by reflogs.
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Do not actually prune any entries; just show what would have
been pruned.
---verbose::
+`--verbose`::
Print extra information on screen.
diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt
index 318b2220a2..f2d8f3723d 100644
--- a/Documentation/git-remote.txt
+++ b/Documentation/git-remote.txt
@@ -32,8 +32,8 @@ Manage the set of repositories ("remotes") whose branches you track.
OPTIONS
-------
--v::
---verbose::
+`-v`::
+`--verbose`::
Be a little more verbose and show remote url after name.
NOTE: This must be placed between `remote` and subcommand.
@@ -44,7 +44,7 @@ COMMANDS
With no arguments, shows a list of existing remotes. Several
subcommands are available to perform operations on the remotes.
-'add'::
+`add`::
Add a remote named <name> for the repository at
<url>. The command `git fetch <name>` can then be used to create and
@@ -80,7 +80,7 @@ because a fetch would overwrite any local commits.
When a push mirror is created with `--mirror=push`, then `git push`
will always behave as if `--mirror` was passed.
-'rename'::
+`rename`::
Rename the remote named <old> to <new>. All remote-tracking branches and
configuration settings for the remote are updated.
@@ -89,13 +89,13 @@ In case <old> and <new> are the same, and <old> is a file under
`$GIT_DIR/remotes` or `$GIT_DIR/branches`, the remote is converted to
the configuration file format.
-'remove'::
-'rm'::
+`remove`::
+`rm`::
Remove the remote named <name>. All remote-tracking branches and
configuration settings for the remote are removed.
-'set-head'::
+`set-head`::
Sets or deletes the default branch (i.e. the target of the
symbolic-ref `refs/remotes/<name>/HEAD`) for
@@ -120,7 +120,7 @@ remote set-head origin master` will set the symbolic-ref `refs/remotes/origin/HE
`refs/remotes/origin/master` already exists; if not it must be fetched first.
+
-'set-branches'::
+`set-branches`::
Changes the list of branches tracked by the named remote.
This can be used to track a subset of the available remote branches
@@ -132,7 +132,7 @@ The named branches will be interpreted as if specified with the
With `--add`, instead of replacing the list of currently tracked
branches, adds to that list.
-'get-url'::
+`get-url`::
Retrieves the URLs for a remote. Configurations for `insteadOf` and
`pushInsteadOf` are expanded here. By default, only the first URL is listed.
@@ -141,7 +141,7 @@ With `--push`, push URLs are queried rather than fetch URLs.
+
With `--all`, all URLs for the remote will be listed.
-'set-url'::
+`set-url`::
Changes URLs for the remote. Sets first URL for remote <name> that matches
regex <oldurl> (first URL if no <oldurl> is given) to <newurl>. If
@@ -163,14 +163,14 @@ fetch from one place (e.g. your upstream) and push to another (e.g.
your publishing repository), use two separate remotes.
-'show'::
+`show`::
Gives some information about the remote <name>.
+
With `-n` option, the remote heads are not queried first with
`git ls-remote <name>`; cached information is used instead.
-'prune'::
+`prune`::
Deletes stale references associated with <name>. By default, stale
remote-tracking branches under <name> are deleted, but depending on
@@ -184,7 +184,7 @@ depending on various configuration.
With `--dry-run` option, report what branches would be pruned, but do not
actually prune them.
-'update'::
+`update`::
Fetch updates for remotes or remote groups in the repository as defined by
`remotes.<group>`. If neither group nor remote is specified on the command line,
diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt
index c99a70e426..864196273b 100644
--- a/Documentation/git-repack.txt
+++ b/Documentation/git-repack.txt
@@ -28,7 +28,7 @@ engines, disk storage, etc.
OPTIONS
-------
--a::
+`-a`::
Instead of incrementally packing the unpacked objects,
pack everything referenced into a single pack.
Especially useful when packing a repository that is used
@@ -46,7 +46,7 @@ have an associated ".promisor" file, these packfiles will be repacked
into another separate pack, and an empty ".promisor" file corresponding
to the new separate pack will be written.
--A::
+`-A`::
Same as `-a`, unless `-d` is used. Then any unreachable
objects in a previous pack become loose, unpacked objects,
instead of being left in the old pack. Unreachable objects
@@ -57,37 +57,37 @@ to the new separate pack will be written.
will be pruned according to normal expiry rules
with the next `git gc` invocation. See linkgit:git-gc[1].
--d::
+`-d`::
After packing, if the newly created packs make some
existing packs redundant, remove the redundant packs.
Also run `git prune-packed` to remove redundant
loose object files.
--l::
+`-l`::
Pass the `--local` option to `git pack-objects`. See
linkgit:git-pack-objects[1].
--f::
+`-f`::
Pass the `--no-reuse-delta` option to `git-pack-objects`, see
linkgit:git-pack-objects[1].
--F::
+`-F`::
Pass the `--no-reuse-object` option to `git-pack-objects`, see
linkgit:git-pack-objects[1].
--q::
+`-q`::
Pass the `-q` option to `git pack-objects`. See
linkgit:git-pack-objects[1].
--n::
+`-n`::
Do not update the server information with
`git update-server-info`. This option skips
updating local catalog files needed to publish
this repository (or a direct copy of it)
over HTTP or FTP. See linkgit:git-update-server-info[1].
---window=<n>::
---depth=<n>::
+`--window=<n>`::
+`--depth=<n>`::
These two options affect how the objects contained in the pack are
stored using delta compression. The objects are first internally
sorted by type, size and optionally names and compared against the
@@ -99,10 +99,10 @@ to the new separate pack will be written.
The default value for `--window` is 10 and `--depth` is 50. The maximum
depth is 4095.
---threads=<n>::
+`--threads=<n>`::
This option is passed through to `git pack-objects`.
---window-memory=<n>::
+`--window-memory=<n>`::
This option provides an additional limit on top of `--window`;
the window size will dynamically scale down so as to not take
up more than '<n>' bytes in memory. This is useful in
@@ -115,7 +115,7 @@ depth is 4095.
Note that the actual memory usage will be the limit multiplied
by the number of threads used by linkgit:git-pack-objects[1].
---max-pack-size=<n>::
+`--max-pack-size=<n>`::
Maximum size of each output pack file. The size can be suffixed with
"k", "m", or "g". The minimum size allowed is limited to 1 MiB.
If specified, multiple packfiles may be created, which also
@@ -123,15 +123,15 @@ depth is 4095.
The default is unlimited, unless the config variable
`pack.packSizeLimit` is set.
--b::
---write-bitmap-index::
+`-b`::
+`--write-bitmap-index`::
Write a reachability bitmap index as part of the repack. This
only makes sense when used with `-a` or `-A`, as the bitmaps
must be able to refer to all reachable objects. This option
overrides the setting of `repack.writeBitmaps`. This option
has no effect if multiple packfiles are created.
---pack-kept-objects::
+`--pack-kept-objects`::
Include objects in `.keep` files when repacking. Note that we
still do not delete `.keep` packs after `pack-objects` finishes.
This means that we may duplicate objects, but this makes the
@@ -140,33 +140,33 @@ depth is 4095.
with `-b` or `repack.writeBitmaps`, as it ensures that the
bitmapped packfile has the necessary objects.
---keep-pack=<pack-name>::
+`--keep-pack=<pack-name>`::
Exclude the given pack from repacking. This is the equivalent
of having `.keep` file on the pack. `<pack-name>` is the
pack file name without leading directory (e.g. `pack-123.pack`).
The option could be specified multiple times to keep multiple
packs.
---unpack-unreachable=<when>::
+`--unpack-unreachable=<when>`::
When loosening unreachable objects, do not bother loosening any
objects older than `<when>`. This can be used to optimize out
the write of any objects that would be immediately pruned by
a follow-up `git prune`.
--k::
---keep-unreachable::
+`-k`::
+`--keep-unreachable`::
When used with `-ad`, any unreachable objects from existing
packs will be appended to the end of the packfile instead of
being removed. In addition, any unreachable loose objects will
be packed (and their loose counterparts removed).
--i::
---delta-islands::
+`-i`::
+`--delta-islands`::
Pass the `--delta-islands` option to `git-pack-objects`, see
linkgit:git-pack-objects[1].
--g=<factor>::
---geometric=<factor>::
+`-g=<factor>`::
+`--geometric=<factor>`::
Arrange resulting pack structure so that each successive pack
contains at least `<factor>` times the number of objects as the
next-largest pack.
diff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt
index 3da7c4de90..fc6fc6ae6f 100644
--- a/Documentation/git-replace.txt
+++ b/Documentation/git-replace.txt
@@ -57,13 +57,13 @@ achieve the same effect as the `--no-replace-objects` option.
OPTIONS
-------
--f::
---force::
+`-f`::
+`--force`::
If an existing replace ref for the same object exists, it will
be overwritten (instead of failing).
--d::
---delete::
+`-d`::
+`--delete`::
Delete existing replace refs for the given objects.
--edit <object>::
@@ -75,7 +75,7 @@ OPTIONS
newly created object. See linkgit:git-var[1] for details about
how the editor will be chosen.
---raw::
+`--raw`::
When editing, provide the raw object contents rather than
pretty-printed ones. Currently this only affects trees, which
will be shown in their binary form. This is harder to work with,
@@ -91,7 +91,7 @@ OPTIONS
commit. Use `--convert-graft-file` to convert a
`$GIT_DIR/info/grafts` file and use replace refs instead.
---convert-graft-file::
+`--convert-graft-file`::
Creates graft commits for all entries in `$GIT_DIR/info/grafts`
and deletes that file upon success. The purpose is to help users
with transitioning off of the now-deprecated graft file.
@@ -103,7 +103,7 @@ OPTIONS
Typing `git replace` without arguments, also lists all replace
refs.
---format=<format>::
+`--format=<format>`::
When listing, use the specified <format>, which can be one of
'short', 'medium' and 'long'. When omitted, the format
defaults to 'short'.
diff --git a/Documentation/git-request-pull.txt b/Documentation/git-request-pull.txt
index e9e703a814..58b5b5dd08 100644
--- a/Documentation/git-request-pull.txt
+++ b/Documentation/git-request-pull.txt
@@ -26,17 +26,17 @@ the repository named by `<url>`.
OPTIONS
-------
--p::
+`-p`::
Include patch text in the output.
-<start>::
+`<start>`::
Commit to start at. This names a commit that is already in
the upstream history.
-<url>::
+`<url>`::
The repository URL to be pulled from.
-<end>::
+`<end>`::
Commit to end at (defaults to `HEAD`). This names the commit
at the tip of the history you are asking to be pulled.
+
diff --git a/Documentation/git-rerere.txt b/Documentation/git-rerere.txt
index 687b08d56c..2e5e6329a2 100644
--- a/Documentation/git-rerere.txt
+++ b/Documentation/git-rerere.txt
@@ -35,7 +35,7 @@ Normally, `git rerere` is run without arguments or user-intervention.
However, it has several commands that allow it to interact with
its working state.
-'clear'::
+`clear`::
Reset the metadata used by rerere if a merge resolution is to be
aborted. Calling `git am [--skip|--abort]` or `git rebase [--skip|--abort]`
@@ -46,24 +46,24 @@ will automatically invoke this command.
Reset the conflict resolutions which rerere has recorded for the current
conflict in <pathspec>.
-'diff'::
+`diff`::
Display diffs for the current state of the resolution. It is
useful for tracking what has changed while the user is resolving
conflicts. Additional arguments are passed directly to the system
'diff' command installed in PATH.
-'status'::
+`status`::
Print paths with conflicts whose merge resolution rerere will record.
-'remaining'::
+`remaining`::
Print paths with conflicts that have not been autoresolved by rerere.
This includes paths whose resolutions cannot be tracked by rerere,
such as conflicting submodules.
-'gc'::
+`gc`::
Prune records of conflicted merges that
occurred a long time ago. By default, unresolved conflicts older
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 58fe574e71..7e44572383 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -53,13 +53,13 @@ section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
defaults to `--mixed`. The `<mode>` must be one of the following:
+
--
---soft::
+`--soft`::
Does not touch the index file or the working tree at all (but
resets the head to `<commit>`, just like all modes do). This leaves
all your changed files "Changes to be committed", as `git status`
would put it.
---mixed::
+`--mixed`::
Resets the index but not the working tree (i.e., the changed files
are preserved but not marked for commit) and reports what has not
been updated. This is the default action.
@@ -67,11 +67,11 @@ section of linkgit:git-add[1] to learn how to operate the `--patch` mode.
If `-N` is specified, removed paths are marked as intent-to-add (see
linkgit:git-add[1]).
---hard::
+`--hard`::
Resets the index and working tree. Any changes to tracked files in the
working tree since `<commit>` are discarded.
---merge::
+`--merge`::
Resets the index and updates the files in the working tree that are
different between `<commit>` and `HEAD`, but keeps those which are
different between the index and working tree (i.e. which have changes
@@ -82,13 +82,13 @@ linkgit:git-add[1]).
In other words, `--merge` does something like a `git read-tree -u -m <commit>`,
but carries forward unmerged index entries.
---keep::
+`--keep`::
Resets index entries and updates files in the working tree that are
different between `<commit>` and `HEAD`.
If a file that is different between `<commit>` and `HEAD` has local
changes, reset is aborted.
---[no-]recurse-submodules::
+`--[no-]recurse-submodules`::
When the working tree is updated, using `--recurse-submodules` will
also recursively reset the working tree of all active submodules
according to the commit recorded in the superproject, also setting
@@ -102,14 +102,14 @@ between the three commands.
OPTIONS
-------
--q::
---quiet::
---no-quiet::
+`-q`::
+`--quiet`::
+`--no-quiet`::
Be quiet, only report errors. The default behavior is set by the
`reset.quiet` config option. `--quiet` and `--no-quiet` will
override the default behavior.
---pathspec-from-file=<file>::
+`--pathspec-from-file=<file>`::
Pathspec is passed in `<file>` instead of commandline args. If
`<file>` is exactly `-` then standard input is used. Pathspec
elements are separated by LF or CR/LF. Pathspec elements can be
@@ -117,7 +117,7 @@ OPTIONS
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
global `--literal-pathspecs`.
---pathspec-file-nul::
+`--pathspec-file-nul`::
Only meaningful with `--pathspec-from-file`. Pathspec elements are
separated with NUL character and all other characters are taken
literally (including newlines and quotes).
diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt
index 19ca46df30..25a7160aab 100644
--- a/Documentation/git-restore.txt
+++ b/Documentation/git-restore.txt
@@ -33,7 +33,7 @@ THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.
OPTIONS
-------
-s <tree>::
---source=<tree>::
+`--source=<tree>`::
Restore the working tree files with the content from the given
tree. It is common to specify the source tree by naming a
commit, branch or tag associated with it.
@@ -45,8 +45,8 @@ As a special case, you may use `"A...B"` as a shortcut for the
merge base of `A` and `B` if there is exactly one merge base. You can
leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
--p::
---patch::
+`-p`::
+`--patch`::
Interactively select hunks in the difference between the
restore source and the restore location. See the ``Interactive
Mode'' section of linkgit:git-add[1] to learn how to operate
@@ -55,27 +55,27 @@ leave out at most one of `A` and `B`, in which case it defaults to `HEAD`.
Note that `--patch` can accept no pathspec and will prompt to restore
all modified paths.
--W::
---worktree::
--S::
---staged::
+`-W`::
+`--worktree`::
+`-S`::
+`--staged`::
Specify the restore location. If neither option is specified,
by default the working tree is restored. Specifying `--staged`
will only restore the index. Specifying both restores both.
--q::
---quiet::
+`-q`::
+`--quiet`::
Quiet, suppress feedback messages. Implies `--no-progress`.
---progress::
---no-progress::
+`--progress`::
+`--no-progress`::
Progress status is reported on the standard error stream
by default when it is attached to a terminal, unless `--quiet`
is specified. This flag enables progress reporting even if not
attached to a terminal, regardless of `--quiet`.
---ours::
---theirs::
+`--ours`::
+`--theirs`::
When restoring files in the working tree from the index, use
stage #2 ('ours') or #3 ('theirs') for unmerged paths.
+
@@ -83,33 +83,33 @@ Note that during `git rebase` and `git pull --rebase`, 'ours' and
'theirs' may appear swapped. See the explanation of the same options
in linkgit:git-checkout[1] for details.
--m::
---merge::
+`-m`::
+`--merge`::
When restoring files on the working tree from the index,
recreate the conflicted merge in the unmerged paths.
---conflict=<style>::
+`--conflict=<style>`::
The same as `--merge` option above, but changes the way the
conflicting hunks are presented, overriding the
`merge.conflictStyle` configuration variable. Possible values
are "merge" (default) and "diff3" (in addition to what is
shown by "merge" style, shows the original contents).
---ignore-unmerged::
+`--ignore-unmerged`::
When restoring files on the working tree from the index, do
not abort the operation if there are unmerged entries and
neither `--ours`, `--theirs`, `--merge` or `--conflict` is
specified. Unmerged paths on the working tree are left alone.
---ignore-skip-worktree-bits::
+`--ignore-skip-worktree-bits`::
In sparse checkout mode, by default is to only update entries
matched by `<pathspec>` and sparse patterns in
`$GIT_DIR/info/sparse-checkout`. This option ignores the sparse
patterns and unconditionally restores any files in
`<pathspec>`.
---recurse-submodules::
---no-recurse-submodules::
+`--recurse-submodules`::
+`--no-recurse-submodules`::
If `<pathspec>` names an active submodule and the restore location
includes the working tree, the submodule will only be updated if
this option is given, in which case its working tree will be
@@ -119,14 +119,14 @@ in linkgit:git-checkout[1] for details.
not be updated. Just like linkgit:git-checkout[1], this will detach
`HEAD` of the submodule.
---overlay::
---no-overlay::
+`--overlay`::
+`--no-overlay`::
In overlay mode, the command never removes files when
restoring. In no-overlay mode, tracked files that do not
appear in the `--source` tree are removed, to make them match
`<tree>` exactly. The default is no-overlay mode.
---pathspec-from-file=<file>::
+`--pathspec-from-file=<file>`::
Pathspec is passed in `<file>` instead of commandline args. If
`<file>` is exactly `-` then standard input is used. Pathspec
elements are separated by LF or CR/LF. Pathspec elements can be
@@ -134,7 +134,7 @@ in linkgit:git-checkout[1] for details.
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
global `--literal-pathspecs`.
---pathspec-file-nul::
+`--pathspec-file-nul`::
Only meaningful with `--pathspec-from-file`. Pathspec elements are
separated with NUL character and all other characters are taken
literally (including newlines and quotes).
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index bbace2dc5e..d84a853018 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -30,10 +30,10 @@ Operation Modes
Each of these options must appear first on the command line.
---parseopt::
+`--parseopt`::
Use `git rev-parse` in option parsing mode (see PARSEOPT section below).
---sq-quote::
+`--sq-quote`::
Use `git rev-parse` in shell quoting mode (see SQ-QUOTE
section below). In contrast to the `--sq` option below, this
mode does only quoting. Nothing else is done to command input.
@@ -41,34 +41,34 @@ Each of these options must appear first on the command line.
Options for --parseopt
~~~~~~~~~~~~~~~~~~~~~~
---keep-dashdash::
+`--keep-dashdash`::
Only meaningful in `--parseopt` mode. Tells the option parser to echo
out the first `--` met instead of skipping it.
---stop-at-non-option::
+`--stop-at-non-option`::
Only meaningful in `--parseopt` mode. Lets the option parser stop at
the first non-option argument. This can be used to parse sub-commands
that take options themselves.
---stuck-long::
+`--stuck-long`::
Only meaningful in `--parseopt` mode. Output the options in their
long form if available, and with their arguments stuck.
Options for Filtering
~~~~~~~~~~~~~~~~~~~~~
---revs-only::
+`--revs-only`::
Do not output flags and parameters not meant for
`git rev-list` command.
---no-revs::
+`--no-revs`::
Do not output flags and parameters meant for
`git rev-list` command.
---flags::
+`--flags`::
Do not output non-flag parameters.
---no-flags::
+`--no-flags`::
Do not output flag parameters.
Options for Output
@@ -95,7 +95,7 @@ cd "$(git rev-parse --show-toplevel)"
eval "set $(git rev-parse --sq --prefix "$prefix" -- "$@")"
----
---verify::
+`--verify`::
Verify that exactly one parameter is provided, and that it
can be turned into a raw 20-byte SHA-1 that can be used to
access the object database. If so, emit it to the standard
@@ -114,14 +114,14 @@ Note that if you are verifying a name from an untrusted source, it is
wise to use `--end-of-options` so that the name argument is not mistaken
for another option.
--q::
---quiet::
+`-q`::
+`--quiet`::
Only meaningful in `--verify` mode. Do not output an error
message if the first argument is not a valid object name;
instead exit with non-zero status silently.
SHA-1s for valid object names are printed to stdout on success.
---sq::
+`--sq`::
Usually the output is made one line per flag and
parameter. This option makes output a single line,
properly quoted for consumption by shell. Useful when
@@ -130,13 +130,13 @@ for another option.
`git diff-*`). In contrast to the `--sq-quote` option,
the command input is still interpreted as usual.
---short[=length]::
+`--short[=length]`::
Same as `--verify` but shortens the object name to a unique
prefix with at least `length` characters. The minimum length
is 4, the default is the effective value of the `core.abbrev`
configuration variable (see linkgit:git-config[1]).
---not::
+`--not`::
When showing object names, prefix them with '{caret}' and
strip '{caret}' prefix from the object names that already have
one.
@@ -146,12 +146,12 @@ for another option.
The option `core.warnAmbiguousRefs` is used to select the strict
abbreviation mode.
---symbolic::
+`--symbolic`::
Usually the object names are output in SHA-1 form (with
possible '{caret}' prefix); this option makes them output in a
form as close to the original input as possible.
---symbolic-full-name::
+`--symbolic-full-name`::
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
@@ -162,12 +162,12 @@ for another option.
Options for Objects
~~~~~~~~~~~~~~~~~~~
---all::
+`--all`::
Show all refs found in `refs/`.
---branches[=pattern]::
---tags[=pattern]::
---remotes[=pattern]::
+`--branches[=pattern]`::
+`--tags[=pattern]`::
+`--remotes[=pattern]`::
Show all branches, tags, or remote-tracking branches,
respectively (i.e., refs found in `refs/heads`,
`refs/tags`, or `refs/remotes`, respectively).
@@ -176,14 +176,14 @@ If a `pattern` is given, only refs matching the given shell glob are
shown. If the pattern does not contain a globbing character (`?`,
`*`, or `[`), it is turned into a prefix match by appending `/*`.
---glob=pattern::
+`--glob=pattern`::
Show all refs matching the shell glob pattern `pattern`. If
the pattern does not start with `refs/`, this is automatically
prepended. If the pattern does not contain a globbing
character (`?`, `*`, or `[`), it is turned into a prefix
match by appending `/*`.
---exclude=<glob-pattern>::
+`--exclude=<glob-pattern>`::
Do not include refs matching '<glob-pattern>' that the next `--all`,
`--branches`, `--tags`, `--remotes`, or `--glob` would otherwise
consider. Repetitions of this option accumulate exclusion patterns
@@ -197,7 +197,7 @@ respectively, and they must begin with `refs/` when applied to `--glob`
or `--all`. If a trailing '/{asterisk}' is intended, it must be given
explicitly.
---disambiguate=<prefix>::
+`--disambiguate=<prefix>`::
Show every object whose name begins with the given prefix.
The <prefix> must be at least 4 hexadecimal digits long to
avoid listing each and every object in the repository by
@@ -206,7 +206,7 @@ explicitly.
Options for Files
~~~~~~~~~~~~~~~~~
---local-env-vars::
+`--local-env-vars`::
List the GIT_* environment variables that are local to the
repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
Only the names of the variables are listed, not their value,
@@ -224,7 +224,7 @@ instance of this option.
The following options are modified by `--path-format`:
---git-dir::
+`--git-dir`::
Show `$GIT_DIR` if defined. Otherwise show the path to
the .git directory. The path shown, when relative, is
relative to the current working directory.
@@ -233,7 +233,7 @@ If `$GIT_DIR` is not defined and the current directory
is not detected to lie in a Git repository or work tree
print a message to stderr and exit with nonzero status.
---git-common-dir::
+`--git-common-dir`::
Show `$GIT_COMMON_DIR` if defined, else `$GIT_DIR`.
--resolve-git-dir <path>::
@@ -249,46 +249,46 @@ print a message to stderr and exit with nonzero status.
`$GIT_OBJECT_DIRECTORY` is set to /foo/bar then `git rev-parse
--git-path objects/abc` returns /foo/bar/abc.
---show-toplevel::
+`--show-toplevel`::
Show the (by default, absolute) path of the top-level directory
of the working tree. If there is no working tree, report an error.
---show-superproject-working-tree::
+`--show-superproject-working-tree`::
Show the absolute path of the root of the superproject's
working tree (if exists) that uses the current repository as
its submodule. Outputs nothing if the current repository is
not used as a submodule by any project.
---shared-index-path::
+`--shared-index-path`::
Show the path to the shared index file in split index mode, or
empty if not in split-index mode.
The following options are unaffected by `--path-format`:
---absolute-git-dir::
+`--absolute-git-dir`::
Like `--git-dir`, but its output is always the canonicalized
absolute path.
---is-inside-git-dir::
+`--is-inside-git-dir`::
When the current working directory is below the repository
directory print "true", otherwise "false".
---is-inside-work-tree::
+`--is-inside-work-tree`::
When the current working directory is inside the work tree of the
repository print "true", otherwise "false".
---is-bare-repository::
+`--is-bare-repository`::
When the repository is bare print "true", otherwise "false".
---is-shallow-repository::
+`--is-shallow-repository`::
When the repository is shallow print "true", otherwise "false".
---show-cdup::
+`--show-cdup`::
When the command is invoked from a subdirectory, show the
path of the top-level directory relative to the current
directory (typically a sequence of "../", or an empty string).
---show-prefix::
+`--show-prefix`::
When the command is invoked from a subdirectory, show the
path of the current directory relative to the top-level
directory.
@@ -303,13 +303,13 @@ The following options are unaffected by `--path-format`:
Other Options
~~~~~~~~~~~~~
---since=datestring::
---after=datestring::
+`--since=datestring`::
+`--after=datestring`::
Parse the date string, and output the corresponding
`--max-age`= parameter for `git rev-list`.
---until=datestring::
---before=datestring::
+`--until=datestring`::
+`--before=datestring`::
Parse the date string, and output the corresponding
`--min-age`= parameter for `git rev-list`.
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index 0ebe45153e..5fde44478f 100644
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -41,8 +41,8 @@ OPTIONS
default, see linkgit:git-rev-list[1] and its `--no-walk`
option.
--e::
---edit::
+`-e`::
+`--edit`::
With this option, `git revert` will let you edit the commit
message prior to committing the revert. This is the default if
you run the command from a terminal.
@@ -63,19 +63,19 @@ reverted merge. This may or may not be what you want.
See the link:howto/revert-a-faulty-merge.html[revert-a-faulty-merge How-To] for
more details.
---no-edit::
+`--no-edit`::
With this option, `git revert` will not start the commit
message editor.
---cleanup=<mode>::
+`--cleanup=<mode>`::
This option determines how the commit message will be cleaned up before
being passed on to the commit machinery. See linkgit:git-commit[1] for more
details. In particular, if the '<mode>' is given a value of `scissors`,
scissors will be appended to `MERGE_MSG` before being passed on in the case
of a conflict.
--n::
---no-commit::
+`-n`::
+`--no-commit`::
Usually the command automatically creates some commits with
commit log messages stating which commits were
reverted. This flag applies the changes necessary
@@ -88,32 +88,32 @@ more details.
This is useful when reverting more than one commits'
effect to your index in a row.
--S[<keyid>]::
---gpg-sign[=<keyid>]::
---no-gpg-sign::
+`-S[<keyid>]`::
+`--gpg-sign[=<keyid>]`::
+`--no-gpg-sign`::
GPG-sign commits. The `keyid` argument is optional and
defaults to the committer identity; if specified, it must be
stuck to the option without a space. `--no-gpg-sign` is useful to
countermand both `commit.gpgSign` configuration variable, and
earlier `--gpg-sign`.
--s::
---signoff::
+`-s`::
+`--signoff`::
Add a `Signed-off-by` trailer at the end of the commit message.
See the signoff option in linkgit:git-commit[1] for more information.
---strategy=<strategy>::
+`--strategy=<strategy>`::
Use the given merge strategy. Should only be used once.
See the MERGE STRATEGIES section in linkgit:git-merge[1]
for details.
--X<option>::
---strategy-option=<option>::
+`-X<option>`::
+`--strategy-option=<option>`::
Pass the merge strategy-specific option through to the
merge strategy. See linkgit:git-merge[1] for details.
---rerere-autoupdate::
---no-rerere-autoupdate::
+`--rerere-autoupdate`::
+`--no-rerere-autoupdate`::
Allow the rerere mechanism to update the index with the
result of auto-conflict resolution if possible.
diff --git a/Documentation/git-rm.txt b/Documentation/git-rm.txt
index 24eb799d6e..d1f49a0bea 100644
--- a/Documentation/git-rm.txt
+++ b/Documentation/git-rm.txt
@@ -43,17 +43,17 @@ of directory `d2`.
+
For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
--f::
---force::
+`-f`::
+`--force`::
Override the up-to-date check.
--n::
---dry-run::
+`-n`::
+`--dry-run`::
Don't actually remove any file(s). Instead, just show
if they exist in the index and would otherwise be removed
by the command.
--r::
+`-r`::
Allow recursive removal when a leading directory name is
given.
@@ -62,20 +62,20 @@ For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
the list of files, (useful when filenames might be mistaken
for command-line options).
---cached::
+`--cached`::
Use this option to unstage and remove paths only from the index.
Working tree files, whether modified or not, will be
left alone.
---ignore-unmatch::
+`--ignore-unmatch`::
Exit with a zero status even if no files matched.
--q::
---quiet::
+`-q`::
+`--quiet`::
`git rm` normally outputs one line (in the form of an `rm` command)
for each file removed. This option suppresses that output.
---pathspec-from-file=<file>::
+`--pathspec-from-file=<file>`::
Pathspec is passed in `<file>` instead of commandline args. If
`<file>` is exactly `-` then standard input is used. Pathspec
elements are separated by LF or CR/LF. Pathspec elements can be
@@ -83,7 +83,7 @@ For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
global `--literal-pathspecs`.
---pathspec-file-nul::
+`--pathspec-file-nul`::
Only meaningful with `--pathspec-from-file`. Pathspec elements are
separated with NUL character and all other characters are taken
literally (including newlines and quotes).
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 9455d4c654..6e96c23492 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -45,7 +45,7 @@ OPTIONS
Composing
~~~~~~~~~
---annotate::
+`--annotate`::
Review and edit each patch you're about to send. Default is the value
of `sendemail.annotate`. See the CONFIGURATION section for
`sendemail.multiEdit`.
@@ -62,7 +62,7 @@ This option may be specified multiple times.
+
This option may be specified multiple times.
---compose::
+`--compose`::
Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
to edit an introductory message for the patch series.
+
@@ -76,7 +76,7 @@ Missing From or In-Reply-To headers will be prompted for.
+
See the CONFIGURATION section for `sendemail.multiEdit`.
---from=<address>::
+`--from=<address>`::
Specify the sender of the emails. If not specified on the command line,
the value of the `sendemail.from` configuration option is used. If
neither the command-line option nor `sendemail.from` are set, then the
@@ -84,12 +84,12 @@ See the CONFIGURATION section for `sendemail.multiEdit`.
the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
set, as returned by `git var -l`.
---reply-to=<address>::
+`--reply-to=<address>`::
Specify the address where replies from recipients should go to.
Use this if replies to messages should go to another address than what
is specified with the `--from` parameter.
---in-reply-to=<identifier>::
+`--in-reply-to=<identifier>`::
Make the first mail (or all the mails with `--no-thread`) appear as a
reply to the given Message-Id, which avoids breaking threads to
provide a new patch series.
@@ -111,7 +111,7 @@ illustration below where `[PATCH v2 0/3]` is in reply to `[PATCH 0/2]`:
Only necessary if `--compose` is also set. If `--compose`
is not set, this will be prompted for.
---subject=<string>::
+`--subject=<string>`::
Specify the initial subject of the email thread.
Only necessary if `--compose` is also set. If `--compose`
is not set, this will be prompted for.
@@ -133,7 +133,7 @@ This option may be specified multiple times.
+
Note that no attempts whatsoever are made to validate the encoding.
---compose-encoding=<encoding>::
+`--compose-encoding=<encoding>`::
Specify encoding of compose message. Default is the value of the
`sendemail.composeencoding`; if that is unspecified, UTF-8 is assumed.
@@ -149,8 +149,8 @@ Note that no attempts whatsoever are made to validate the encoding.
Default is the value of the `sendemail.transferEncoding` configuration
value; if that is unspecified, default to `auto`.
---xmailer::
---no-xmailer::
+`--xmailer`::
+`--no-xmailer`::
Add (or prevent adding) the "X-Mailer:" header. By default,
the header is added, but it can be turned off by setting the
`sendemail.xmailer` configuration variable to `false`.
@@ -158,7 +158,7 @@ value; if that is unspecified, default to `auto`.
Sending
~~~~~~~
---envelope-sender=<address>::
+`--envelope-sender=<address>`::
Specify the envelope sender used to send the emails.
This is useful if your default address is not the address that is
subscribed to a list. In order to use the 'From' address, set the
@@ -167,19 +167,19 @@ Sending
`sendemail.envelopeSender` configuration variable; if that is
unspecified, choosing the envelope sender is left to your MTA.
---smtp-encryption=<encryption>::
+`--smtp-encryption=<encryption>`::
Specify the encryption to use, either 'ssl' or 'tls'. Any other
value reverts to plain SMTP. Default is the value of
`sendemail.smtpEncryption`.
---smtp-domain=<FQDN>::
+`--smtp-domain=<FQDN>`::
Specifies the Fully Qualified Domain Name (FQDN) used in the
HELO/EHLO command to the SMTP server. Some servers require the
FQDN to match your IP address. If not set, `git send-email` attempts
to determine your FQDN automatically. Default is the value of
`sendemail.smtpDomain`.
---smtp-auth=<mechanisms>::
+`--smtp-auth=<mechanisms>`::
Whitespace-separated list of allowed SMTP-AUTH mechanisms. This setting
forces using only the listed mechanisms. Example:
+
@@ -194,7 +194,7 @@ is specified, all mechanisms supported by the SASL library can be used. The
special value 'none' maybe specified to completely disable authentication
independently of `--smtp-user`
---smtp-pass[=<password>]::
+`--smtp-pass[=<password>]`::
Password for SMTP-AUTH. The argument is optional: If no
argument is specified, then the empty string is used as
the password. Default is the value of `sendemail.smtpPass`,
@@ -206,10 +206,10 @@ or on the command line. If a username has been specified (with
specified (with `--smtp-pass` or `sendemail.smtpPass`), then
a password is obtained using `git-credential`.
---no-smtp-auth::
+`--no-smtp-auth`::
Disable SMTP authentication. Short hand for `--smtp-auth=none`
---smtp-server=<host>::
+`--smtp-server=<host>`::
If set, specifies the outgoing SMTP server to use (e.g.
`smtp.example.com` or a raw IP address). Alternatively it can
specify a full pathname of a sendmail-like program instead;
@@ -219,7 +219,7 @@ a password is obtained using `git-credential`.
`/usr/sbin`, `/usr/lib` and `$PATH` if such program is
available, falling back to `localhost` otherwise.
---smtp-server-port=<port>::
+`--smtp-server-port=<port>`::
Specifies a port different from the default port (SMTP
servers typically listen to smtp port 25, but may also listen to
submission port 587, or the common SSL smtp port 465);
@@ -227,7 +227,7 @@ a password is obtained using `git-credential`.
are also accepted. The port can also be set with the
`sendemail.smtpServerPort` configuration variable.
---smtp-server-option=<option>::
+`--smtp-server-option=<option>`::
If set, specifies the outgoing SMTP server option to use.
Default value can be specified by the `sendemail.smtpServerOption`
configuration option.
@@ -236,10 +236,10 @@ The `--smtp-server-option` option must be repeated for each option you want
to pass to the server. Likewise, different lines in the configuration files
must be used for each option.
---smtp-ssl::
+`--smtp-ssl`::
Legacy alias for `--smtp-encryption ssl`.
---smtp-ssl-cert-path::
+`--smtp-ssl-cert-path`::
Path to a store of trusted CA certificates for SMTP SSL/TLS
certificate validation (either a directory that has been processed
by 'c_rehash', or a single file containing one or more PEM format
@@ -250,7 +250,7 @@ must be used for each option.
backing SSL library's compiled-in default otherwise (which should
be the best choice on most platforms).
---smtp-user=<user>::
+`--smtp-user=<user>`::
Username for SMTP-AUTH. Default is the value of `sendemail.smtpUser`;
if a username is not specified (with `--smtp-user` or `sendemail.smtpUser`),
then authentication is not attempted.
@@ -260,7 +260,7 @@ must be used for each option.
commands and replies will be printed. Useful to debug TLS
connection and authentication problems.
---batch-size=<num>::
+`--batch-size=<num>`::
Some email servers (e.g. smtp.163.com) limit the number emails to be
sent per session (connection) and this will lead to a failure when
sending many messages. With this option, send-email will disconnect after
@@ -270,7 +270,7 @@ must be used for each option.
your password every time this happens. Defaults to the
`sendemail.smtpBatchSize` configuration variable.
---relogin-delay=<int>::
+`--relogin-delay=<int>`::
Waiting $<int> seconds before reconnecting to SMTP server. Used together
with `--batch-size` option. Defaults to the `sendemail.smtpReloginDelay`
configuration variable.
@@ -282,23 +282,23 @@ Automating
Clears any list of "To:", "Cc:", "Bcc:" addresses previously
set via config.
---no-identity::
+`--no-identity`::
Clears the previously read value of `sendemail.identity` set
via config, if any.
---to-cmd=<command>::
+`--to-cmd=<command>`::
Specify a command to execute once per patch file which
should generate patch file specific "To:" entries.
Output of this command must be single email address per line.
Default is the value of `sendemail.tocmd` configuration value.
---cc-cmd=<command>::
+`--cc-cmd=<command>`::
Specify a command to execute once per patch file which
should generate patch file specific "Cc:" entries.
Output of this command must be single email address per line.
Default is the value of `sendemail.ccCmd` configuration value.
---[no-]chain-reply-to::
+`--[no-]chain-reply-to`::
If this is set, each email will be sent as a reply to the previous
email sent. If disabled with `--no-chain-reply-to`, all emails after
the first will be sent as replies to the first email sent. When using
@@ -306,30 +306,30 @@ Automating
entire patch series. Disabled by default, but the `sendemail.chainReplyTo`
configuration variable can be used to enable it.
---identity=<identity>::
+`--identity=<identity>`::
A configuration identity. When given, causes values in the
`sendemail.<identity>` subsection to take precedence over
values in the `sendemail` section. The default identity is
the value of `sendemail.identity`.
---[no-]signed-off-by-cc::
+`--[no-]signed-off-by-cc`::
If this is set, add emails found in the `Signed-off-by` trailer or Cc: lines to the
cc list. Default is the value of `sendemail.signedoffbycc` configuration
value; if that is unspecified, default to `--signed-off-by-cc`.
---[no-]cc-cover::
+`--[no-]cc-cover`::
If this is set, emails found in Cc: headers in the first patch of
the series (typically the cover letter) are added to the cc list
for each email set. Default is the value of `sendemail.cccover`
configuration value; if that is unspecified, default to `--no-cc-cover`.
---[no-]to-cover::
+`--[no-]to-cover`::
If this is set, emails found in To: headers in the first patch of
the series (typically the cover letter) are added to the to list
for each email set. Default is the value of `sendemail.tocover`
configuration value; if that is unspecified, default to `--no-to-cover`.
---suppress-cc=<category>::
+`--suppress-cc=<category>`::
Specify an additional category of recipients to suppress the
auto-cc of:
+
@@ -354,12 +354,12 @@ Default is the value of `sendemail.suppresscc` configuration value; if
that is unspecified, default to 'self' if `--suppress-from` is
specified, as well as 'body' if `--no-signed-off-cc` is specified.
---[no-]suppress-from::
+`--[no-]suppress-from`::
If this is set, do not add the From: address to the cc: list.
Default is the value of `sendemail.suppressFrom` configuration
value; if that is unspecified, default to `--no-suppress-from`.
---[no-]thread::
+`--[no-]thread`::
If this is set, the In-Reply-To and References headers will be
added to each email sent. Whether each mail refers to the
previous email (`deep` threading per `git format-patch`
@@ -381,7 +381,7 @@ recipient's MUA.
Administering
~~~~~~~~~~~~~
---confirm=<mode>::
+`--confirm=<mode>`::
Confirm just before sending:
+
--
@@ -397,20 +397,20 @@ Default is the value of `sendemail.confirm` configuration value; if that
is unspecified, default to 'auto' unless any of the suppress options
have been specified, in which case default to 'compose'.
---dry-run::
+`--dry-run`::
Do everything except actually send the emails.
---[no-]format-patch::
+`--[no-]format-patch`::
When an argument may be understood either as a reference or as a file name,
choose to understand it as a format-patch argument (`--format-patch`)
or as a file name (`--no-format-patch`). By default, when such a conflict
occurs, `git send-email` will fail.
---quiet::
+`--quiet`::
Make `git-send-email` less verbose. One line per email should be
all that is output.
---[no-]validate::
+`--[no-]validate`::
Perform sanity checks on patches.
Currently, validation means the following:
+
@@ -426,14 +426,14 @@ have been specified, in which case default to 'compose'.
Default is the value of `sendemail.validate`; if this is not set,
default to `--validate`.
---force::
+`--force`::
Send emails even if safety checks would prevent it.
Information
~~~~~~~~~~~
---dump-aliases::
+`--dump-aliases`::
Instead of the normal operation, dump the shorthand alias names from
the configured alias file(s), one per line in alphabetical order. Note,
this only includes the alias name and not its expanded email addresses.
@@ -457,7 +457,7 @@ differences and limitations from the standard formats are
described below:
+
--
-sendmail;;
+`sendmail`;;
* Quoted aliases and quoted addresses are not supported: lines that
contain a `"` symbol are ignored.
* Redirection to a file (`/path/name`) or pipe (`|command`) is not
diff --git a/Documentation/git-send-pack.txt b/Documentation/git-send-pack.txt
index c0303d72eb..2852d3981b 100644
--- a/Documentation/git-send-pack.txt
+++ b/Documentation/git-send-pack.txt
@@ -25,20 +25,20 @@ updates it from the current repository, sending named refs.
OPTIONS
-------
---receive-pack=<git-receive-pack>::
+`--receive-pack=<git-receive-pack>`::
Path to the `git-receive-pack` program on the remote
end. Sometimes useful when pushing to a remote
repository over ssh, and you do not have the program in
a directory on the default `$PATH`.
---exec=<git-receive-pack>::
+`--exec=<git-receive-pack>`::
Same as `--receive-pack`=<git-receive-pack>.
---all::
+`--all`::
Instead of explicitly specifying which refs to update,
update all heads that locally exist.
---stdin::
+`--stdin`::
Take the list of refs from stdin, one per line. If there
are refs specified on the command line in addition to this
option, then the refs from stdin are processed after those
@@ -48,29 +48,29 @@ If `--stateless-rpc` is specified together with this option then
the list of refs must be in packet format (pkt-line). Each ref must
be in a separate packet, and the list must end with a flush packet.
---dry-run::
+`--dry-run`::
Do everything except actually send the updates.
---force::
+`--force`::
Usually, the command refuses to update a remote ref that
is not an ancestor of the local ref used to overwrite it.
This flag disables the check. What this means is that
the remote repository can lose commits; use it with
care.
---verbose::
+`--verbose`::
Run verbosely.
---thin::
+`--thin`::
Send a "thin" pack, which records objects in deltified form based
on objects not included in the pack to reduce network traffic.
---atomic::
+`--atomic`::
Use an atomic transaction for updating the refs. If any of the refs
fails to update then the entire push will fail without changing any
refs.
---[no-]signed::
+`--[no-]signed`::
--signed=(true|false|if-asked)::
GPG-sign the push request to update refs on the receiving
side, to allow it to be checked by the hooks and/or be
@@ -81,18 +81,18 @@ be in a separate packet, and the list must end with a flush packet.
will also fail if the actual call to `gpg --sign` fails. See
linkgit:git-receive-pack[1] for the details on the receiving end.
---push-option=<string>::
+`--push-option=<string>`::
Pass the specified string as a push option for consumption by
hooks on the server side. If the server doesn't support push
options, error out. See linkgit:git-push[1] and
linkgit:githooks[5] for details.
-<host>::
+`<host>`::
A remote host to house the repository. When this
part is specified, `git-receive-pack` is invoked via
ssh.
-<directory>::
+`<directory>`::
The repository to update.
<ref>...::
diff --git a/Documentation/git-sh-i18n.txt b/Documentation/git-sh-i18n.txt
index 23c504bbd8..ea8fc781e8 100644
--- a/Documentation/git-sh-i18n.txt
+++ b/Documentation/git-sh-i18n.txt
@@ -27,7 +27,7 @@ without GNU gettext.
FUNCTIONS
---------
-gettext::
+`gettext`::
Currently a dummy fall-through function implemented as a wrapper
around `printf(1)`. Will be replaced by a real gettext
implementation in a later version.
diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt
index ed33a46a77..d1e999d60e 100644
--- a/Documentation/git-sh-setup.txt
+++ b/Documentation/git-sh-setup.txt
@@ -33,11 +33,11 @@ variables, but does *not* export them to the environment.
FUNCTIONS
---------
-die::
+`die`::
exit after emitting the supplied error message to the
standard error stream.
-usage::
+`usage`::
die with the usage message.
set_reflog_action::
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index d9226b63da..c3f6997d2e 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -26,20 +26,20 @@ reference to the current repository.
OPTIONS
-------
--n::
---numbered::
+`-n`::
+`--numbered`::
Sort output according to the number of commits per author instead
of author alphabetic order.
--s::
---summary::
+`-s`::
+`--summary`::
Suppress commit description and provide a commit count summary only.
--e::
---email::
+`-e`::
+`--email`::
Show the email address of each author.
---format[=<format>]::
+`--format[=<format>]`::
Instead of the commit subject, use some other information to
describe each commit. '<format>' can be any string accepted
by the `--format` option of `git log`, such as '* [%h] %s'.
@@ -47,7 +47,7 @@ OPTIONS
Each pretty-printed commit will be rewrapped before it is shown.
---group=<type>::
+`--group=<type>`::
Group commits based on `<type>`. If no `--group` option is
specified, the default is `author`. `<type>` is one of:
+
@@ -76,8 +76,8 @@ value (but again, only once per unique value in that commit). For
example, `git shortlog --group=author --group=trailer:co-authored-by`
counts both authors and co-authors.
--c::
---committer::
+`-c`::
+`--committer`::
This is an alias for `--group=committer`.
-w[<width>[,<indent1>[,<indent2>]]]::
diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index 79f65ce0aa..017390e1ed 100644
--- a/Documentation/git-show-branch.txt
+++ b/Documentation/git-show-branch.txt
@@ -30,46 +30,46 @@ no <rev> or <glob> is given on the command line.
OPTIONS
-------
-<rev>::
+`<rev>`::
Arbitrary extended SHA-1 expression (see linkgit:gitrevisions[7])
that typically names a branch head or a tag.
-<glob>::
+`<glob>`::
A glob pattern that matches branch or tag names under
refs/. For example, if you have many topic
branches under refs/heads/topic, giving
`topic/*` would show all of them.
--r::
---remotes::
+`-r`::
+`--remotes`::
Show the remote-tracking branches.
--a::
---all::
+`-a`::
+`--all`::
Show both remote-tracking branches and local branches.
---current::
+`--current`::
With this option, the command includes the current
branch to the list of revs to be shown when it is not
given on the command line.
---topo-order::
+`--topo-order`::
By default, the branches and their commits are shown in
reverse chronological order. This option makes them
appear in topological order (i.e., descendant commits
are shown before their parents).
---date-order::
+`--date-order`::
This option is similar to `--topo-order` in the sense that no
parent comes before all of its children, but otherwise commits
are ordered according to their commit date.
---sparse::
+`--sparse`::
By default, the output omits merges that are reachable
from only one tip being shown. This option makes them
visible.
---more=<n>::
+`--more=<n>`::
Usually the command stops output upon showing the commit
that is the common ancestor of all the branches. This
flag tells the command to go <n> more common commits
@@ -77,21 +77,21 @@ OPTIONS
<reference>s given, without showing the commit ancestry
tree.
---list::
+`--list`::
Synonym to `--more=-1`
---merge-base::
+`--merge-base`::
Instead of showing the commit list, determine possible
merge bases for the specified commits. All merge bases
will be contained in all specified commits. This is
different from how linkgit:git-merge-base[1] handles
the case of three or more commits.
---independent::
+`--independent`::
Among the <reference>s given, display only the ones that
cannot be reached from any other <reference>.
---no-name::
+`--no-name`::
Do not show naming strings for each commit.
--sha1-name::
@@ -100,7 +100,7 @@ OPTIONS
of "master"), name them with the unique prefix of their
object names.
---topics::
+`--topics`::
Shows only commits that are NOT on the first branch given.
This helps track topic branches by hiding any commit that
is already in the main line of development. When given
@@ -108,7 +108,7 @@ OPTIONS
will show the revisions given by `git rev-list {caret}master
topic1 topic2`
--g::
+`-g`::
--reflog[=<n>[,<base>]] [<ref>]::
Shows <n> most recent ref-log entries for the given
ref. If <base> is given, <n> entries going back from
@@ -116,12 +116,12 @@ OPTIONS
When no explicit <ref> parameter is given, it defaults to the
current branch (or `HEAD` if it is detached).
---color[=<when>]::
+`--color[=<when>]`::
Color the status sign (one of these: `*` `!` `+` `-`) of each commit
corresponding to the branch it's in.
The value must be always (the default), never, or auto.
---no-color::
+`--no-color`::
Turn off colored output, even when the configuration file gives the
default to color output.
Same as `--color=never`.
diff --git a/Documentation/git-show-ref.txt b/Documentation/git-show-ref.txt
index 2a3699cb7f..3d8e1f455b 100644
--- a/Documentation/git-show-ref.txt
+++ b/Documentation/git-show-ref.txt
@@ -33,47 +33,47 @@ the `.git` directory.
OPTIONS
-------
---head::
+`--head`::
Show the `HEAD` reference, even if it would normally be filtered out.
---heads::
---tags::
+`--heads`::
+`--tags`::
Limit to `refs/heads` and `refs/tags`, respectively. These options
are not mutually exclusive; when given both, references stored in
`refs/heads` and `refs/tags` are displayed.
--d::
---dereference::
+`-d`::
+`--dereference`::
Dereference tags into object IDs as well. They will be shown with "{caret}{}"
appended.
--s::
---hash[=<n>]::
+`-s`::
+`--hash[=<n>]`::
Only show the SHA-1 hash, not the reference name. When combined with
`--dereference` the dereferenced tag will still be shown after the SHA-1.
---verify::
+`--verify`::
Enable stricter reference checking by requiring an exact ref path.
Aside from returning an error code of 1, it will also print an error
message if `--quiet` was not specified.
---abbrev[=<n>]::
+`--abbrev[=<n>]`::
Abbreviate the object name. When using `--hash`, you do
not have to say `--hash --abbrev`; `--hash=n` would do.
--q::
---quiet::
+`-q`::
+`--quiet`::
Do not print any results to stdout. When combined with `--verify` this
can be used to silently check if a reference exists.
---exclude-existing[=<pattern>]::
+`--exclude-existing[=<pattern>]`::
Make `git show-ref` act as a filter that reads refs from stdin of the
form "`^(?:<anything>\s)?<refname>(?:\^{})?$`"
diff --git a/Documentation/git-sparse-checkout.txt b/Documentation/git-sparse-checkout.txt
index efadc656e8..1655282b58 100644
--- a/Documentation/git-sparse-checkout.txt
+++ b/Documentation/git-sparse-checkout.txt
@@ -27,10 +27,10 @@ THE FUTURE.
COMMANDS
--------
-'list'::
+`list`::
Describe the patterns in the sparse-checkout file.
-'init'::
+`init`::
Enable the `core.sparseCheckout` setting. If the
sparse-checkout file does not exist, then populate it with
patterns that match every file in the root directory and
@@ -46,7 +46,7 @@ When `--cone` is provided, the `core.sparseCheckoutCone` setting is
also set, allowing for better performance with a limited set of
patterns (see 'CONE PATTERN SET' below).
-'set'::
+`set`::
Write a set of patterns to the sparse-checkout file, as given as
a list of arguments following the 'set' subcommand. Update the
working directory to match the new patterns. Enable the
@@ -63,14 +63,14 @@ directories. The input format matches the output of `git ls-tree --name-only`.
This includes interpreting pathnames that begin with a double quote (") as
C-style quoted strings.
-'add'::
+`add`::
Update the sparse-checkout file to include additional patterns.
By default, these patterns are read from the command-line arguments,
but they can be read from stdin using the `--stdin` option. When
`core.sparseCheckoutCone` is enabled, the given patterns are interpreted
as directory names as in the 'set' subcommand.
-'reapply'::
+`reapply`::
Reapply the sparsity pattern rules to paths in the working tree.
Commands like merge or rebase can materialize paths to do their
work (e.g. in order to show you a conflict), and other
@@ -80,7 +80,7 @@ C-style quoted strings.
after cleaning up affected paths (e.g. resolving conflicts, undoing
or committing changes, etc.).
-'disable'::
+`disable`::
Disable the `core.sparseCheckout` config setting, and restore the
working directory to include all files. Leaves the sparse-checkout
file intact so a later `git sparse-checkout init` command may
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 142e5f3751..974b16963c 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -125,7 +125,7 @@ the stash entry is applied on top of the commit that was `HEAD` at the
time `git stash` was run, it restores the originally stashed state
with no conflicts.
-clear::
+`clear`::
Remove all the stash entries. Note that those entries will then
be subject to pruning, and may be impossible to recover (see
'Examples' below for a possible strategy).
@@ -134,7 +134,7 @@ drop [-q|--quiet] [<stash>]::
Remove a single stash entry from the list of stash entries.
-create::
+`create`::
Create a stash entry (which is a regular commit object) and
return its object name, without storing it anywhere in the ref
@@ -142,7 +142,7 @@ create::
This is intended to be useful for scripts. It is probably not
the command you want to use; see "push" above.
-store::
+`store`::
Store a given stash created via `git stash create` (which is a
dangling merge commit) in the stash ref, updating the stash
@@ -151,16 +151,16 @@ store::
OPTIONS
-------
--a::
---all::
+`-a`::
+`--all`::
This option is only valid for `push` and `save` commands.
+
All ignored and untracked files are also stashed and then cleaned
up with `git clean`.
--u::
---include-untracked::
---no-include-untracked::
+`-u`::
+`--include-untracked`::
+`--no-include-untracked`::
When used with the `push` and `save` commands,
all untracked files are also stashed and then cleaned up with
`git clean`.
@@ -168,12 +168,12 @@ up with `git clean`.
When used with the `show` command, show the untracked files in the stash
entry as part of the diff.
---only-untracked::
+`--only-untracked`::
This option is only valid for the `show` command.
+
Show only the untracked files in the stash entry as part of the diff.
---index::
+`--index`::
This option is only valid for `pop` and `apply` commands.
+
Tries to reinstate not only the working tree's changes, but also
@@ -181,15 +181,15 @@ the index's ones. However, this can fail, when you have conflicts
(which are stored in the index, where you therefore can no longer
apply the changes as they were originally).
--k::
---keep-index::
---no-keep-index::
+`-k`::
+`--keep-index`::
+`--no-keep-index`::
This option is only valid for `push` and `save` commands.
+
All changes already added to the index are left intact.
--p::
---patch::
+`-p`::
+`--patch`::
This option is only valid for `push` and `save` commands.
+
Interactively select hunks from the diff between `HEAD` and the
@@ -203,7 +203,7 @@ to learn how to operate the `--patch` mode.
The `--patch` option implies `--keep-index`. You can use
`--no-keep-index` to override this.
---pathspec-from-file=<file>::
+`--pathspec-from-file=<file>`::
This option is only valid for `push` command.
+
Pathspec is passed in `<file>` instead of commandline args. If
@@ -213,15 +213,15 @@ quoted as explained for the configuration variable `core.quotePath`
(see linkgit:git-config[1]). See also `--pathspec-file-nul` and
global `--literal-pathspecs`.
---pathspec-file-nul::
+`--pathspec-file-nul`::
This option is only valid for `push` command.
+
Only meaningful with `--pathspec-from-file`. Pathspec elements are
separated with NUL character and all other characters are taken
literally (including newlines and quotes).
--q::
---quiet::
+`-q`::
+`--quiet`::
This option is only valid for `apply`, `drop`, `pop`, `push`,
`save`, `store` commands.
+
@@ -242,7 +242,7 @@ too, leaving files that do not match the pathspec intact.
+
For more details, see the 'pathspec' entry in linkgit:gitglossary[7].
-<stash>::
+`<stash>`::
This option is only valid for `apply`, `branch`, `drop`, `pop`,
`show` commands.
+
diff --git a/Documentation/git-status.txt b/Documentation/git-status.txt
index 2abb6d69f5..bb8f0f4bdd 100644
--- a/Documentation/git-status.txt
+++ b/Documentation/git-status.txt
@@ -24,18 +24,18 @@ third are what you _could_ commit by running `git add` before running
OPTIONS
-------
--s::
---short::
+`-s`::
+`--short`::
Give the output in the short-format.
--b::
---branch::
+`-b`::
+`--branch`::
Show the branch and tracking info even in short-format.
---show-stash::
+`--show-stash`::
Show the number of entries currently stashed away.
---porcelain[=<version>]::
+`--porcelain[=<version>]`::
Give the output in an easy-to-parse format for scripts.
This is similar to the short output, but will remain stable
across Git versions and regardless of user configuration. See
@@ -44,19 +44,19 @@ OPTIONS
The version parameter is used to specify the format version.
This is optional and defaults to the original version 'v1' format.
---long::
+`--long`::
Give the output in the long-format. This is the default.
--v::
---verbose::
+`-v`::
+`--verbose`::
In addition to the names of files that have been changed, also
show the textual changes that are staged to be committed
(i.e., like the output of `git diff --cached`). If `-v` is specified
twice, then also show the changes in the working tree that
have not yet been staged (i.e., like the output of `git diff`).
--u[<mode>]::
---untracked-files[=<mode>]::
+`-u[<mode>]`::
+`--untracked-files[=<mode>]`::
Show untracked files.
+
--
@@ -84,7 +84,7 @@ The default can be changed using the `status.showUntrackedFiles`
configuration variable documented in linkgit:git-config[1].
--
---ignore-submodules[=<when>]::
+`--ignore-submodules[=<when>]`::
Ignore changes to submodules when looking for changes. <when> can be
either "none", "untracked", "dirty" or "all", which is the default.
Using "none" will consider the submodule modified when it either contains
@@ -99,7 +99,7 @@ configuration variable documented in linkgit:git-config[1].
(and suppresses the output of submodule summaries when the config option
`status.submoduleSummary` is set).
---ignored[=<mode>]::
+`--ignored[=<mode>]`::
Show ignored files as well.
+
--
@@ -123,28 +123,28 @@ a directory does not match an ignore pattern, but all contents are
ignored, then the directory is not shown, but all contents are shown.
--
--z::
+`-z`::
Terminate entries with NUL, instead of LF. This implies
the `--porcelain=v1` output format if no other format is given.
---column[=<options>]::
---no-column::
+`--column[=<options>]`::
+`--no-column`::
Display untracked files in columns. See configuration variable
`column.status` for option syntax. `--column` and `--no-column`
without options are equivalent to 'always' and 'never'
respectively.
---ahead-behind::
---no-ahead-behind::
+`--ahead-behind`::
+`--no-ahead-behind`::
Display or do not display detailed ahead/behind counts for the
branch relative to its upstream branch. Defaults to true.
---renames::
---no-renames::
+`--renames`::
+`--no-renames`::
Turn on/off rename detection regardless of user configuration.
See also linkgit:git-diff[1] `--no-renames`.
---find-renames[=<n>]::
+`--find-renames[=<n>]`::
Turn on rename detection, optionally setting the similarity
threshold.
See also linkgit:git-diff[1] `--find-renames`.
diff --git a/Documentation/git-stripspace.txt b/Documentation/git-stripspace.txt
index 6397de9cb3..bed4f35d0b 100644
--- a/Documentation/git-stripspace.txt
+++ b/Documentation/git-stripspace.txt
@@ -35,12 +35,12 @@ the repository.
OPTIONS
-------
--s::
---strip-comments::
+`-s`::
+`--strip-comments`::
Skip and remove all lines starting with comment character (default '#').
--c::
---comment-lines::
+`-c`::
+`--comment-lines`::
Prepend comment character and blank to each line. Lines will automatically
be terminated with a newline. On empty lines, only the comment character
will be prepended.
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 6cbf6a9ba1..95868792c9 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -146,7 +146,7 @@ the configuration variable. If neither is given, a 'checkout' is performed.
The 'update' procedures supported both from the command line as well as
through the `submodule.<name>.update` configuration are:
- checkout;; the commit recorded in the superproject will be
+ `checkout`;; the commit recorded in the superproject will be
checked out in the submodule on a detached `HEAD`.
+
If `--force` is specified, the submodule will be checked out (using
@@ -154,10 +154,10 @@ If `--force` is specified, the submodule will be checked out (using
in the index of the containing repository already matches the commit
checked out in the submodule.
- rebase;; the current branch of the submodule will be rebased
+ `rebase`;; the current branch of the submodule will be rebased
onto the commit recorded in the superproject.
- merge;; the commit recorded in the superproject will be merged
+ `merge`;; the commit recorded in the superproject will be merged
into the current branch in the submodule.
The following 'update' procedures are only available via the
@@ -169,7 +169,7 @@ The following 'update' procedures are only available via the
is set to '!command', the remainder after the exclamation mark
is the custom command.
- none;; the submodule is not updated.
+ `none`;; the submodule is not updated.
If the submodule is not yet initialized, and you just want to use the
setting as stored in `.gitmodules`, you can automatically initialize the
@@ -246,7 +246,7 @@ sync [--recursive] [--] [<path>...]::
If `--recursive` is specified, this command will recurse into the
registered submodules, and sync any nested submodules within.
-absorbgitdirs::
+`absorbgitdirs`::
If a `git` directory of a submodule is inside the submodule,
move the `git` directory of the submodule into its superproject's
`$GIT_DIR/modules` path and then connect the `git` directory and
@@ -262,18 +262,18 @@ This command is recursive by default.
OPTIONS
-------
--q::
---quiet::
+`-q`::
+`--quiet`::
Only print error messages.
---progress::
+`--progress`::
This option is only valid for add and update commands.
Progress status is reported on the standard error stream
by default when it is attached to a terminal, unless -q
is specified. This flag forces progress status even if the
standard error stream is not directed to a terminal.
---all::
+`--all`::
This option is only valid for the deinit command. Unregister all
submodules in the working tree.
@@ -286,8 +286,8 @@ OPTIONS
same name as the current branch in the current repository. If the
option is not specified, it defaults to the remote `HEAD`.
--f::
---force::
+`-f`::
+`--force`::
This option is only valid for add, deinit and update commands.
When running add, allow adding an otherwise ignored submodule path.
When running deinit the submodule working trees will be removed even
@@ -299,25 +299,25 @@ OPTIONS
containing repository matches the commit checked out in the
submodule.
---cached::
+`--cached`::
This option is only valid for status and summary commands. These
commands typically use the commit found in the submodule `HEAD`, but
with this option, the commit stored in the index is used instead.
---files::
+`--files`::
This option is only valid for the summary command. This command
compares the commit in the index with that in the submodule `HEAD`
when this option is used.
--n::
---summary-limit::
+`-n`::
+`--summary-limit`::
This option is only valid for the summary command.
Limit the summary size (number of commits shown in total).
Giving 0 will disable the summary; a negative number means unlimited
(the default). This limit only applies to modified submodules. The
size is always limited to 1 for added/deleted/typechanged submodules.
---remote::
+`--remote`::
This option is only valid for the update command. Instead of using
the superproject's recorded SHA-1 to update the submodule, use the
status of the submodule's remote-tracking branch. The remote used
@@ -348,12 +348,12 @@ to distribute the default upstream branch with the superproject and
`branch.<name>.merge` if you want a more native feel while working in
the submodule itself.
--N::
---no-fetch::
+`-N`::
+`--no-fetch`::
This option is only valid for the update command.
Don't fetch new objects from the remote site.
---checkout::
+`--checkout`::
This option is only valid for the update command.
Checkout the commit recorded in the superproject on a detached `HEAD`
in the submodule. This is the default behavior, the main use of
@@ -362,7 +362,7 @@ the submodule itself.
If the key `submodule.$name.update` is either not explicitly set or
set to `checkout`, this option is implicit.
---merge::
+`--merge`::
This option is only valid for the update command.
Merge the commit recorded in the superproject into the current branch
of the submodule. If this option is given, the submodule's `HEAD` will
@@ -372,7 +372,7 @@ the submodule itself.
If the key `submodule.$name.update` is set to `merge`, this option is
implicit.
---rebase::
+`--rebase`::
This option is only valid for the update command.
Rebase the current branch onto the commit recorded in the
superproject. If this option is given, the submodule's `HEAD` will not
@@ -381,12 +381,12 @@ the submodule itself.
If the key `submodule.$name.update` is set to `rebase`, this option is
implicit.
---init::
+`--init`::
This option is only valid for the update command.
Initialize all submodules for which `git submodule init` has not been
called so far before updating.
---name::
+`--name`::
This option is only valid for the add command. It sets the submodule's
name to the given string instead of defaulting to its path. The name
must be valid as a directory name and may not end with a '/'.
@@ -400,25 +400,25 @@ the submodule itself.
for linkgit:git-clone[1]'s `--reference`, `--shared`, and `--dissociate`
options carefully.
---dissociate::
+`--dissociate`::
This option is only valid for add and update commands. These
commands sometimes need to clone a remote repository. In this case,
this option will be passed to the linkgit:git-clone[1] command.
+
*NOTE*: see the NOTE for the `--reference` option.
---recursive::
+`--recursive`::
This option is only valid for foreach, update, status and sync commands.
Traverse submodules recursively. The operation is performed not
only in the submodules of the current repo, but also
in any nested submodules inside those submodules (and so on).
---depth::
+`--depth`::
This option is valid for add and update commands. Create a 'shallow'
clone with a history truncated to the specified number of revisions.
See linkgit:git-clone[1]
---[no-]recommend-shallow::
+`--[no-]recommend-shallow`::
This option is only valid for the update command.
The initial clone of a submodule will use the recommended
`submodule.<name>.shallow` as provided by the `.gitmodules` file
@@ -430,7 +430,7 @@ options carefully.
Clone new submodules in parallel with as many jobs.
Defaults to the `submodule.fetchJobs` option.
---[no-]single-branch::
+`--[no-]single-branch`::
This option is only valid for the update command.
Clone only one branch during update: `HEAD` or one specified by `--branch`.
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 727ea0603c..6fca35c8cb 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -43,8 +43,8 @@ COMMANDS
--tags=<tags_subdir>;;
-b<branches_subdir>;;
--branches=<branches_subdir>;;
--s;;
---stdlayout;;
+`-s`;;
+`--stdlayout`;;
These are optional command-line options for `init`. Each of
these flags can point to a relative repository path
(`--tags=project/tags`) or a full url
@@ -55,24 +55,24 @@ COMMANDS
a shorthand way of setting trunk,tags,branches as the relative paths,
which is the Subversion default. If any of the other options are given
as well, they take precedence.
---no-metadata;;
+`--no-metadata`;;
Set the 'noMetadata' option in the [svn-remote] config.
This option is not recommended, please read the `svn.noMetadata`
section of this manpage before using this option.
---use-svm-props;;
+`--use-svm-props`;;
Set the 'useSvmProps' option in the [svn-remote] config.
---use-svnsync-props;;
+`--use-svnsync-props`;;
Set the 'useSvnsyncProps' option in the [svn-remote] config.
---rewrite-root=<URL>;;
+`--rewrite-root=<URL>`;;
Set the 'rewriteRoot' option in the [svn-remote] config.
---rewrite-uuid=<UUID>;;
+`--rewrite-uuid=<UUID>`;;
Set the 'rewriteUUID' option in the [svn-remote] config.
---username=<user>;;
+`--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`
---prefix=<prefix>;;
+`--prefix=<prefix>`;;
This allows one to specify a prefix which is prepended
to the names of remotes if trunk/branches/tags are
specified. The prefix does not automatically include a
@@ -95,19 +95,19 @@ If you still want the old default, you can get it by passing
`--prefix ""` on the command line (`--prefix=""` may not work if
your Perl's Getopt::Long is < v2.37).
---ignore-refs=<regex>;;
+`--ignore-refs=<regex>`;;
When passed to `init` or `clone` this regular expression will
be preserved as a config key. See `fetch` for a description
of `--ignore-refs`.
---ignore-paths=<regex>;;
+`--ignore-paths=<regex>`;;
When passed to `init` or `clone` this regular expression will
be preserved as a config key. See `fetch` for a description
of `--ignore-paths`.
---include-paths=<regex>;;
+`--include-paths=<regex>`;;
When passed to `init` or `clone` this regular expression will
be preserved as a config key. See `fetch` for a description
of `--include-paths`.
---no-minimize-url;;
+`--no-minimize-url`;;
When tracking multiple directories (using `--stdlayout`,
`--branches`, or `--tags` options), `git svn` will attempt to connect
to the root (or highest allowed level) of the Subversion
@@ -128,7 +128,7 @@ your Perl's Getopt::Long is < v2.37).
This automatically updates the rev_map if needed (see
`$GIT_DIR/svn/\**/.rev_map.*` in the FILES section below for details).
---localtime;;
+`--localtime`;;
Store Git commit times in the local time zone instead of UTC. This
makes `git log` (even without `--date=local`) show the same times
that `svn log` would in the local time zone.
@@ -139,10 +139,10 @@ repository to be able to interoperate with someone else's local Git
repository, either don't use this option or you should both use it in
the same local time zone.
---parent;;
+`--parent`;;
Fetch only from the SVN parent of the current `HEAD`.
---ignore-refs=<regex>;;
+`--ignore-refs=<regex>`;;
Ignore refs for branches or tags matching the Perl regular
expression. A negative look-ahead assertion like
`^refs/remotes/origin/(?!tags/wanted-tag|wanted-branch).*$`
@@ -154,7 +154,7 @@ config key: `svn-remote.<name>.ignore-refs`
If the ignore-refs configuration key is set, and the command-line
option is also given, both regular expressions will be used.
---ignore-paths=<regex>;;
+`--ignore-paths=<regex>`;;
This allows one to specify a Perl regular expression that will
cause skipping of all matching paths from checkout from SVN.
The `--ignore-paths` option should match for every `fetch`
@@ -183,7 +183,7 @@ Skip "branches" and "tags" of first level directories;;
------------------------------------------------------------------------
--
---include-paths=<regex>;;
+`--include-paths=<regex>`;;
This allows one to specify a Perl regular expression that will
cause the inclusion of only matching paths from checkout from SVN.
The `--include-paths` option should match for every `fetch`
@@ -194,7 +194,7 @@ Skip "branches" and "tags" of first level directories;;
[verse]
config key: `svn-remote.<name>.include-paths`
---log-window-size=<n>;;
+`--log-window-size=<n>`;;
Fetch <n> log entries per request when scanning Subversion history.
The default is 100. For very large Subversion repositories, larger
values may be needed for `clone`/'fetch' to complete in reasonable
@@ -212,14 +212,14 @@ config key: `svn-remote.<name>.include-paths`
affecting the working tree; and the `rebase` command will be
able to update the working tree with the latest changes.
---preserve-empty-dirs;;
+`--preserve-empty-dirs`;;
Create a placeholder file in the local Git repository for each
empty directory fetched from Subversion. This includes directories
that become empty by removing all entries in the Subversion
repository (but not the directory itself). The placeholder files
are also tracked and removed when no longer necessary.
---placeholder-filename=<filename>;;
+`--placeholder-filename=<filename>`;;
Set the name of placeholder files created by `--preserve-empty-dirs`.
Default: "`.gitignore`"
@@ -241,8 +241,8 @@ and have no uncommitted changes.
This automatically updates the rev_map if needed (see
`$GIT_DIR/svn/\**/.rev_map.*` in the FILES section below for details).
--l;;
---local;;
+`-l`;;
+`--local`;;
Do not `fetch` remotely; only run `git rebase` against the
last fetched commit from the upstream SVN.
@@ -258,7 +258,7 @@ branch, not on the current branch.
+
Use of `dcommit` is preferred to `set-tree` (below).
+
---no-rebase;;
+`--no-rebase`;;
After committing, do not rebase or reset.
--commit-url <URL>;;
Commit to this SVN URL (the full path). This is intended to
@@ -278,7 +278,7 @@ If you rather want to set the commit URL for an entire SVN repository use
Using this option for any other purpose (don't ask) is very strongly
discouraged.
---mergeinfo=<mergeinfo>;;
+`--mergeinfo=<mergeinfo>`;;
Add the given merge information during the `dcommit`
(e.g. `--mergeinfo="/branches/foo:1-10"`). All svn server versions can
store this information (as a property), and svn clients starting from
@@ -294,7 +294,7 @@ svn:mergeinfo property in the SVN repository when possible. Currently, this can
only be done when dcommitting non-fast-forward merges where all parents but the
first have already been pushed into SVN.
---interactive;;
+`--interactive`;;
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".
@@ -305,17 +305,17 @@ committing anything to SVN.
`branch`::
Create a branch in the SVN repository.
--m;;
---message;;
+`-m`;;
+`--message`;;
Allows to specify the commit message.
--t;;
---tag;;
+`-t`;;
+`--tag`;;
Create a tag by using the tags_subdir instead of the branches_subdir
specified during `git svn` init.
--d<path>;;
---destination=<path>;;
+`-d<path>`;;
+`--destination=<path>`;;
If more than one `--branches` (or `--tags`) option was given to the `init`
or `clone` command, you must provide the location of the branch (or
@@ -330,11 +330,11 @@ committing anything to SVN.
where <name> is the name of the SVN repository as specified by the `-R` option to
`init` (or "svn" by default).
---username;;
+`--username`;;
Specify the SVN username to perform the commit as. This option overrides
the 'username' configuration property.
---commit-url;;
+`--commit-url`;;
Use the specified URL to connect to the destination Subversion
repository. This is useful in cases where the source SVN
repository is read-only. This option overrides configuration
@@ -343,7 +343,7 @@ where <name> is the name of the SVN repository as specified by the `-R` option t
git config --get-all svn-remote.<name>.commiturl
+
---parents;;
+`--parents`;;
Create parent folders. This parameter is equivalent to the parameter
`--parents` on svn cp commands and is useful for non-standard repository
layouts.
@@ -363,23 +363,23 @@ The following features from `svn log' are supported:
--revision=<n>[:<n>];;
is supported, non-numeric args are not:
HEAD, NEXT, BASE, PREV, etc ...
--v;;
---verbose;;
+`-v`;;
+`--verbose`;;
it's not completely compatible with the `--verbose`
output in svn log, but reasonably close.
---limit=<n>;;
+`--limit=<n>`;;
is NOT the same as `--max-count`, doesn't count
merged/excluded commits
---incremental;;
+`--incremental`;;
supported
--
+
New features:
+
--
---show-commit;;
+`--show-commit`;;
shows the Git commit sha1, as well
---oneline;;
+`--oneline`;;
our version of `--pretty=oneline`
--
+
@@ -397,26 +397,26 @@ Any other arguments are passed directly to `git log`
the version of the file in the `HEAD` revision is annotated. Unknown
arguments are passed directly to `git blame`.
+
---git-format;;
+`--git-format`;;
Produce output in the same format as `git blame`, but with
SVN revision numbers instead of Git commit hashes. In this mode,
changes that haven't been committed to SVN (including local
working-copy edits) are shown as revision 0.
-'find-rev'::
+`find-rev`::
When given an SVN revision number of the form 'rN', returns the
corresponding Git commit hash (this can optionally be followed by a
tree-ish to specify which branch should be searched). When given a
tree-ish, returns the corresponding SVN revision number.
+
--B;;
---before;;
+`-B`;;
+`--before`;;
Don't require an exact match if given an SVN revision, instead find
the commit corresponding to the state of the SVN repository (on the
current branch) at the specified revision.
+
--A;;
---after;;
+`-A`;;
+`--after`;;
Don't require an exact match if given an SVN revision; if there is
not an exact match return the closest match searching forward in the
history.
@@ -466,12 +466,12 @@ denotes such an object, or it is requested by invoking an editor (see
`--edit` option below).
-m <msg>;;
---message=<msg>;;
+`--message=<msg>`;;
Use the given `msg` as the commit message. This option
disables the `--edit` option.
-F <filename>;;
---file=<filename>;;
+`--file=<filename>`;;
Take the commit message from the given file. This option
disables the `--edit` option.
@@ -529,11 +529,11 @@ Follow 'reset' with a `fetch` and then `git reset` or `git rebase` to
move local branches onto the new tree.
-r <n>;;
---revision=<n>;;
+`--revision=<n>`;;
Specify the most recent revision to keep. All later revisions
are discarded.
--p;;
---parent;;
+`-p`;;
+`--parent`;;
Discard the specified revision as well, keeping the nearest
parent instead.
Example:;;
@@ -591,15 +591,15 @@ This can allow you to make partial mirrors when running `fetch`;
but is generally not recommended because history will be skipped
and lost.
--::
---stdin::
+`-`::
+`--stdin`::
Only used with the `set-tree` command.
+
Read a list of commits from stdin and commit them in reverse
order. Only the leading sha1 is read from each line, so
`git rev-list --pretty=oneline` output can be used.
---rmdir::
+`--rmdir`::
Only used with the `dcommit`, `set-tree` and `commit-diff` commands.
+
Remove directories from the SVN tree if there are no files left
@@ -611,8 +611,8 @@ the commit to SVN act like Git.
[verse]
config key: `svn.rmdir`
--e::
---edit::
+`-e`::
+`--edit`::
Only used with the `dcommit`, `set-tree` and `commit-diff` commands.
+
Edit the commit message before committing to SVN. This is off by
@@ -622,8 +622,8 @@ tree objects.
[verse]
config key: `svn.edit`
--l<num>::
---find-copies-harder::
+`-l<num>`::
+`--find-copies-harder`::
Only used with the `dcommit`, `set-tree` and `commit-diff` commands.
+
They are both passed directly to `git diff-tree`; see
@@ -633,8 +633,8 @@ linkgit:git-diff-tree[1] for more information.
config key: `svn.l`
config key: `svn.findcopiesharder`
--A<filename>::
---authors-file=<filename>::
+`-A<filename>`::
+`--authors-file=<filename>`::
Syntax is compatible with the file used by `git cvsimport` but
an empty email address can be supplied with '<>':
+
@@ -651,7 +651,7 @@ after the authors-file is modified should continue operation.
[verse]
config key: `svn.authorsfile`
---authors-prog=<filename>::
+`--authors-prog=<filename>`::
If this option is specified, for each SVN committer name that
does not exist in the authors file, the given file is executed
with the committer name as the first argument. The program is
@@ -667,25 +667,25 @@ not found, it is searched like any other command in `$PATH`.
[verse]
config key: `svn.authorsProg`
--q::
---quiet::
+`-q`::
+`--quiet`::
Make `git svn` less verbose. Specify a second time to make it
even less verbose.
--m::
---merge::
--s<strategy>::
---strategy=<strategy>::
--p::
---rebase-merges::
+`-m`::
+`--merge`::
+`-s<strategy>`::
+`--strategy=<strategy>`::
+`-p`::
+`--rebase-merges`::
--preserve-merges (DEPRECATED)::
These are only used with the `dcommit` and `rebase` commands.
+
Passed directly to `git rebase` when using `dcommit` if a
`git reset` cannot be used (see `dcommit`).
--n::
---dry-run::
+`-n`::
+`--dry-run`::
This can be used with the `dcommit`, `rebase`, `branch` and
`tag` commands.
+
@@ -699,7 +699,7 @@ repository that will be fetched from.
For `branch` and `tag`, display the urls that will be used for copying when
creating the branch or tag.
---use-log-author::
+`--use-log-author`::
When retrieving svn commits into Git (as part of `fetch`, `rebase`, or
`dcommit` operations), look for the first `From:` line or `Signed-off-by` trailer
in the log message and use that as the author string.
@@ -707,7 +707,7 @@ creating the branch or tag.
[verse]
config key: `svn.useLogAuthor`
---add-author-from::
+`--add-author-from`::
When committing to svn from Git (as part of `set-tree` or `dcommit`
operations), if the existing log message doesn't already have a
`From:` or `Signed-off-by` trailer, append a `From:` line based on the
@@ -733,7 +733,7 @@ ADVANCED OPTIONS
this allows SVN multiple repositories to be tracked.
Default: "svn"
---follow-parent::
+`--follow-parent`::
This option is only relevant if we are tracking branches (using
one of the repository layout options `--trunk`, `--tags`,
`--branches`, `--stdlayout`). For each tracked branch, try to find
diff --git a/Documentation/git-switch.txt b/Documentation/git-switch.txt
index da16df9efa..44ae45e838 100644
--- a/Documentation/git-switch.txt
+++ b/Documentation/git-switch.txt
@@ -33,13 +33,13 @@ THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.
OPTIONS
-------
-<branch>::
+`<branch>`::
Branch to switch to.
-<new-branch>::
+`<new-branch>`::
Name for the new branch.
-<start-point>::
+`<start-point>`::
The starting point for the new branch. Specifying a
`<start-point>` allows you to create a branch based on some
other point in history than where `HEAD` currently points. (Or,
@@ -78,14 +78,14 @@ $ git branch -f <new-branch>
$ git switch <new-branch>
------------
--d::
---detach::
+`-d`::
+`--detach`::
Switch to a commit for inspection and discardable
experiments. See the "DETACHED HEAD" section in
linkgit:git-checkout[1] for details.
---guess::
---no-guess::
+`--guess`::
+`--no-guess`::
If `<branch>` is not found but there does exist a tracking
branch in exactly one remote (call it `<remote>`) with a
matching name, treat as equivalent to
@@ -107,19 +107,19 @@ ambiguous but exists on the `origin` remote. See also
The default behavior can be set via the `checkout.guess` configuration
variable.
--f::
---force::
+`-f`::
+`--force`::
An alias for `--discard-changes`.
---discard-changes::
+`--discard-changes`::
Proceed even if the index or the working tree differs from
`HEAD`. Both the index and working tree are restored to match
the switching target. If `--recurse-submodules` is specified,
submodule content is also restored to match the switching
target. This is used to throw away local changes.
--m::
---merge::
+`-m`::
+`--merge`::
If you have local modifications to one or more files that are
different between the current branch and the branch to which
you are switching, the command refuses to switch branches in
@@ -133,26 +133,26 @@ paths are left unmerged, and you need to resolve the conflicts
and mark the resolved paths with `git add` (or `git rm` if the merge
should result in deletion of the path).
---conflict=<style>::
+`--conflict=<style>`::
The same as `--merge` option above, but changes the way the
conflicting hunks are presented, overriding the
`merge.conflictStyle` configuration variable. Possible values are
"merge" (default) and "diff3" (in addition to what is shown by
"merge" style, shows the original contents).
--q::
---quiet::
+`-q`::
+`--quiet`::
Quiet, suppress feedback messages.
---progress::
---no-progress::
+`--progress`::
+`--no-progress`::
Progress status is reported on the standard error stream
by default when it is attached to a terminal, unless `--quiet`
is specified. This flag enables progress reporting even if not
attached to a terminal, regardless of `--quiet`.
--t::
---track::
+`-t`::
+`--track`::
When creating a new branch, set up "upstream" configuration.
`-c` is implied. See `--track` in linkgit:git-branch[1] for
details.
@@ -167,7 +167,7 @@ given name has no slash, or the above guessing results in an empty
name, the guessing is aborted. You can explicitly give a name with
`-c` in such a case.
---no-track::
+`--no-track`::
Do not set up "upstream" configuration, even if the
`branch.autoSetupMerge` configuration variable is true.
@@ -175,14 +175,14 @@ name, the guessing is aborted. You can explicitly give a name with
Create a new 'orphan' branch, named `<new-branch>`. All
tracked files are removed.
---ignore-other-worktrees::
+`--ignore-other-worktrees`::
`git switch` refuses when the wanted ref is already
checked out by another worktree. This option makes it check
the ref out anyway. In other words, the ref can be held by
more than one worktree.
---recurse-submodules::
---no-recurse-submodules::
+`--recurse-submodules`::
+`--no-recurse-submodules`::
Using `--recurse-submodules` will update the content of all
active submodules according to the commit recorded in the
superproject. If nothing (or `--no-recurse-submodules`) is
diff --git a/Documentation/git-symbolic-ref.txt b/Documentation/git-symbolic-ref.txt
index 0c19b1e70e..9fa1564a56 100644
--- a/Documentation/git-symbolic-ref.txt
+++ b/Documentation/git-symbolic-ref.txt
@@ -32,21 +32,21 @@ a regular file whose contents is `ref: refs/heads/master`.
OPTIONS
-------
--d::
---delete::
+`-d`::
+`--delete`::
Delete the symbolic ref <name>.
--q::
---quiet::
+`-q`::
+`--quiet`::
Do not issue an error message if the <name> is not a
symbolic ref but a detached `HEAD`; instead exit with
non-zero status silently.
---short::
+`--short`::
When showing the value of <name> as a symbolic ref, try to shorten the
value, e.g. from `refs/heads/master` to `master`.
--m::
+`-m`::
Update the reflog for <name> with <reason>. This is valid only
when creating or updating a symbolic ref.
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 6de16cec54..6f125deee3 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -57,38 +57,38 @@ lightweight tags by default.
OPTIONS
-------
--a::
---annotate::
+`-a`::
+`--annotate`::
Make an unsigned, annotated tag object
--s::
---sign::
+`-s`::
+`--sign`::
Make a GPG-signed tag, using the default e-mail address's key.
The default behavior of tag GPG-signing is controlled by `tag.gpgSign`
configuration variable if it exists, or disabled otherwise.
See linkgit:git-config[1].
---no-sign::
+`--no-sign`::
Override `tag.gpgSign` configuration variable that is
set to force each and every tag to be signed.
-u <keyid>::
---local-user=<keyid>::
+`--local-user=<keyid>`::
Make a GPG-signed tag, using the given key.
--f::
---force::
+`-f`::
+`--force`::
Replace an existing tag with the given name (instead of failing)
--d::
---delete::
+`-d`::
+`--delete`::
Delete existing tags with the given names.
--v::
---verify::
+`-v`::
+`--verify`::
Verify the GPG signature of the given tag names.
--n<num>::
+`-n<num>`::
<num> specifies how many lines from the annotation, if any,
are printed when using -l. Implies `--list`.
+
@@ -96,8 +96,8 @@ The default is not to print any annotation lines.
If no number is given to `-n`, only the first line is printed.
If the tag is not annotated, the commit message is displayed instead.
--l::
---list::
+`-l`::
+`--list`::
List tags. With optional `<pattern>...`, e.g. `git tag --list
'v-*'`, list only the tags that match the pattern(s).
+
@@ -109,7 +109,7 @@ This option is implicitly supplied if any other list-like option such
as `--contains` is provided. See the documentation for each of those
options for details.
---sort=<key>::
+`--sort=<key>`::
Sort based on the key given. Prefix `-` to sort in
descending order of the value. You may use the `--sort=<key>` option
multiple times, in which case the last key becomes the primary
@@ -122,17 +122,17 @@ options for details.
variable if it exists, or lexicographic order otherwise. See
linkgit:git-config[1].
---color[=<when>]::
+`--color[=<when>]`::
Respect any colors specified in the `--format` option. The
`<when>` field must be one of `always`, `never`, or `auto` (if
`<when>` is absent, behave as if `always` was given).
--i::
---ignore-case::
+`-i`::
+`--ignore-case`::
Sorting and filtering tags are case insensitive.
---column[=<options>]::
---no-column::
+`--column[=<options>]`::
+`--no-column`::
Display tag listing in columns. See configuration variable
`column.tag` for option syntax. `--column` and `--no-column`
without options are equivalent to 'always' and 'never' respectively.
@@ -160,7 +160,7 @@ This option is only applicable when listing tags without annotation lines.
specified). Implies `--list`.
-m <msg>::
---message=<msg>::
+`--message=<msg>`::
Use the given tag message (instead of prompting).
If multiple `-m` options are given, their values are
concatenated as separate paragraphs.
@@ -168,46 +168,46 @@ This option is only applicable when listing tags without annotation lines.
is given.
-F <file>::
---file=<file>::
+`--file=<file>`::
Take the tag message from the given file. Use '-' to
read the message from the standard input.
Implies `-a` if none of `-a`, `-s`, or `-u <keyid>`
is given.
--e::
---edit::
+`-e`::
+`--edit`::
The message taken from file with `-F` and command line with
`-m` are usually used as the tag message unmodified.
This option lets you further edit the message taken from these sources.
---cleanup=<mode>::
+`--cleanup=<mode>`::
This option sets how the tag message is cleaned up.
The '<mode>' can be one of 'verbatim', 'whitespace' and 'strip'. The
'strip' mode is default. The 'verbatim' mode does not change message at
all, 'whitespace' removes just leading/trailing whitespace lines and
'strip' removes both whitespace and commentary.
---create-reflog::
+`--create-reflog`::
Create a reflog for the tag. To globally enable reflogs for tags, see
`core.logAllRefUpdates` in linkgit:git-config[1].
The negated form `--no-create-reflog` only overrides an earlier
`--create-reflog`, but currently does not negate the setting of
`core.logAllRefUpdates`.
---format=<format>::
+`--format=<format>`::
A string that interpolates `%(fieldname)` from a tag ref being shown
and the object it points at. The format is the same as
that of linkgit:git-for-each-ref[1]. When unspecified,
defaults to `%(refname:strip=2)`.
-<tagname>::
+`<tagname>`::
The name of the tag to create, delete, or describe.
The new tag name must pass all checks defined by
linkgit:git-check-ref-format[1]. Some of these checks
may restrict the characters allowed in a tag name.
-<commit>::
-<object>::
+`<commit>`::
+`<object>`::
The object that the new tag will refer to, usually a commit.
Defaults to `HEAD`.
diff --git a/Documentation/git-unpack-objects.txt b/Documentation/git-unpack-objects.txt
index ad10299337..cb989b6aac 100644
--- a/Documentation/git-unpack-objects.txt
+++ b/Documentation/git-unpack-objects.txt
@@ -27,24 +27,24 @@ new packs and replace existing ones.
OPTIONS
-------
--n::
+`-n`::
Dry run. Check the pack file without actually unpacking
the objects.
--q::
+`-q`::
The command usually shows percentage progress. This
flag suppresses it.
--r::
+`-r`::
When unpacking a corrupt packfile, the command dies at
the first corruption. This flag tells it to keep going
and make the best effort to recover as many objects as
possible.
---strict::
+`--strict`::
Don't write objects with broken content or links.
---max-input-size=<size>::
+`--max-input-size=<size>`::
Die, if the pack is larger than <size>.
GIT
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index 02adf7aa81..7a4925b3c6 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -41,35 +41,35 @@ using the various options:
OPTIONS
-------
---add::
+`--add`::
If a specified file isn't in the index already then it's
added.
Default behaviour is to ignore new files.
---remove::
+`--remove`::
If a specified file is in the index but is missing then it's
removed.
Default behavior is to ignore removed file.
---refresh::
+`--refresh`::
Looks at the current index and checks to see if merges or
updates are needed by checking stat() information.
--q::
+`-q`::
Quiet. If `--refresh` finds that the index needs an update, the
default behavior is to error out. This option makes
`git update-index` continue anyway.
---ignore-submodules::
+`--ignore-submodules`::
Do not try to update submodules. This option is only respected
when passed before `--refresh`.
---unmerged::
+`--unmerged`::
If `--refresh` finds unmerged changes in the index, the default
behavior is to error out. This option makes `git update-index`
continue anyway.
---ignore-missing::
+`--ignore-missing`::
Ignores missing files during a `--refresh`
--cacheinfo <mode>,<object>,<path>::
@@ -79,13 +79,13 @@ OPTIONS
arguments as three separate parameters, but new users are
encouraged to use a single-parameter form.
---index-info::
+`--index-info`::
Read index information from stdin.
--chmod=(+|-)x::
Set the execute permissions on the updated files.
---[no-]assume-unchanged::
+`--[no-]assume-unchanged`::
When this flag is specified, the object names recorded
for the paths are not updated. Instead, this option
sets/unsets the "assume unchanged" bit for the
@@ -103,46 +103,46 @@ in the index e.g. when merging in a commit;
thus, in case the assumed-untracked file is changed upstream,
you will need to handle the situation manually.
---really-refresh::
+`--really-refresh`::
Like `--refresh`, but checks stat information unconditionally,
without regard to the "assume unchanged" setting.
---[no-]skip-worktree::
+`--[no-]skip-worktree`::
When one of these flags is specified, the object name recorded
for the paths are not updated. Instead, these options
set and unset the "skip-worktree" bit for the paths. See
section "Skip-worktree bit" below for more information.
---[no-]ignore-skip-worktree-entries::
+`--[no-]ignore-skip-worktree-entries`::
Do not remove skip-worktree (AKA "index-only") entries even when
the `--remove` option was specified.
---[no-]fsmonitor-valid::
+`--[no-]fsmonitor-valid`::
When one of these flags is specified, the object name recorded
for the paths are not updated. Instead, these options
set and unset the "fsmonitor valid" bit for the paths. See
section "File System Monitor" below for more information.
--g::
---again::
+`-g`::
+`--again`::
Runs `git update-index` itself on the paths whose index
entries are different from those from the `HEAD` commit.
---unresolve::
+`--unresolve`::
Restores the 'unmerged' or 'needs updating' state of a
file during a merge if it was cleared by accident.
---info-only::
+`--info-only`::
Do not create objects in the object database for all
<file> arguments that follow this flag; just insert
their object IDs into the index.
---force-remove::
+`--force-remove`::
Remove the file from the index even when the working directory
still has such a file. (Implies `--remove`.)
---replace::
+`--replace`::
By default, when a file `path` exists in the index,
`git update-index` refuses an attempt to add `path/file`.
Similarly if a file `path/file` exists, a file `path`
@@ -150,12 +150,12 @@ you will need to handle the situation manually.
that conflict with the entry being added are
automatically removed with warning messages.
---stdin::
+`--stdin`::
Instead of taking list of paths from the command line,
read list of paths from the standard input. Paths are
separated by LF (i.e. one path per line) by default.
---verbose::
+`--verbose`::
Report what is being added and removed from index.
--index-version <n>::
@@ -170,12 +170,12 @@ time. Version 4 is relatively young (first released in 1.8.0 in
October 2012). Other Git implementations such as JGit and libgit2
may not support it yet.
--z::
+`-z`::
Only meaningful with `--stdin` or `--index-info`; paths are
separated with NUL character instead of LF.
---split-index::
---no-split-index::
+`--split-index`::
+`--no-split-index`::
Enable or disable split index mode. If split-index mode is
already enabled and `--split-index` is given again, all
changes in `$GIT_DIR/index` are pushed back to the shared index
@@ -187,8 +187,8 @@ emitted when the change goes against the configured value, as the
configured value will take effect next time the index is read and this
will remove the intended effect of the option.
---untracked-cache::
---no-untracked-cache::
+`--untracked-cache`::
+`--no-untracked-cache`::
Enable or disable untracked cache feature. Please use
`--test-untracked-cache` before enabling it.
+
@@ -198,7 +198,7 @@ emitted when the change goes against the configured value, as the
configured value will take effect next time the index is read and this
will remove the intended effect of the option.
---test-untracked-cache::
+`--test-untracked-cache`::
Only perform tests on the working directory to make sure
untracked cache can be used. You have to manually enable
untracked cache using `--untracked-cache` or
@@ -208,14 +208,14 @@ will remove the intended effect of the option.
explains what is not working as needed, otherwise the exit
code is 0 and OK is printed.
---force-untracked-cache::
+`--force-untracked-cache`::
Same as `--untracked-cache`. Provided for backwards
compatibility with older versions of Git where
`--untracked-cache` used to imply `--test-untracked-cache` but
this option would enable the extension unconditionally.
---fsmonitor::
---no-fsmonitor::
+`--fsmonitor`::
+`--no-fsmonitor`::
Enable or disable files system monitor feature. These options
take effect whatever the value of the `core.fsmonitor`
configuration variable (see linkgit:git-config[1]). But a warning
@@ -226,7 +226,7 @@ will remove the intended effect of the option.
\--::
Do not interpret any more arguments as options.
-<file>::
+`<file>`::
Files to act on.
Note that files beginning with '.' are discarded. This includes
`./file` and `dir/./file`. If you don't want this, then use
diff --git a/Documentation/git-update-ref.txt b/Documentation/git-update-ref.txt
index 794dea70ec..7a81e39a4f 100644
--- a/Documentation/git-update-ref.txt
+++ b/Documentation/git-update-ref.txt
@@ -99,45 +99,45 @@ In either format, values can be specified in any form that Git
recognizes as an object name. Commands in any other format or a
repeated <ref> produce an error. Command meanings are:
-update::
+`update`::
Set <ref> to <newvalue> after verifying <oldvalue>, if given.
Specify a zero <newvalue> to ensure the ref does not exist
after the update and/or a zero <oldvalue> to make sure the
ref does not exist before the update.
-create::
+`create`::
Create <ref> with <newvalue> after verifying it does not
exist. The given <newvalue> may not be zero.
-delete::
+`delete`::
Delete <ref> after verifying it exists with <oldvalue>, if
given. If given, <oldvalue> may not be zero.
-verify::
+`verify`::
Verify <ref> against <oldvalue> but do not change it. If
<oldvalue> is zero or missing, the ref must not exist.
-option::
+`option`::
Modify behavior of the next command naming a <ref>.
The only valid option is `no-deref` to avoid dereferencing
a symbolic ref.
-start::
+`start`::
Start a transaction. In contrast to a non-transactional session, a
transaction will automatically abort if the session ends without an
explicit commit. This command may create a new empty transaction when
the current one has been committed or aborted already.
-prepare::
+`prepare`::
Prepare to commit the transaction. This will create lock files for all
queued reference updates. If one reference could not be locked, the
transaction will be aborted.
-commit::
+`commit`::
Commit all reference updates queued for the transaction, ending the
transaction.
-abort::
+`abort`::
Abort the transaction, releasing all locks if the transaction is in
prepared state.
diff --git a/Documentation/git-upload-pack.txt b/Documentation/git-upload-pack.txt
index fdb7edc727..98e5f7aa3f 100644
--- a/Documentation/git-upload-pack.txt
+++ b/Documentation/git-upload-pack.txt
@@ -25,23 +25,23 @@ repository. For push operations, see `git send-pack`.
OPTIONS
-------
---[no-]strict::
+`--[no-]strict`::
Do not try `<directory>/.git/` if <directory> is no Git directory.
---timeout=<n>::
+`--timeout=<n>`::
Interrupt transfer after <n> seconds of inactivity.
---stateless-rpc::
+`--stateless-rpc`::
Perform only a single read-write cycle with stdin and stdout.
This fits with the HTTP POST request processing model where
a program may read the request, write a response, and must exit.
---advertise-refs::
+`--advertise-refs`::
Only the initial ref advertisement is output, and the program exits
immediately. This fits with the HTTP GET request model, where
no request content is received but a response must be produced.
-<directory>::
+`<directory>`::
The repository to sync from.
SEE ALSO
diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt
index 1105e8a1cc..a33b76589a 100644
--- a/Documentation/git-var.txt
+++ b/Documentation/git-var.txt
@@ -17,7 +17,7 @@ Prints a Git logical variable.
OPTIONS
-------
--l::
+`-l`::
Cause the logical variables to be listed. In addition, all the
variables of the Git configuration file `.git/config` are listed
as well. (However, the configuration variables listing functionality
diff --git a/Documentation/git-verify-commit.txt b/Documentation/git-verify-commit.txt
index 87ed1cae5d..9e95556274 100644
--- a/Documentation/git-verify-commit.txt
+++ b/Documentation/git-verify-commit.txt
@@ -16,12 +16,12 @@ Validates the GPG signature created by `git commit -S`.
OPTIONS
-------
---raw::
+`--raw`::
Print the raw gpg status output to standard error instead of the normal
human-readable output.
--v::
---verbose::
+`-v`::
+`--verbose`::
Print the contents of the commit object before validating it.
<commit>...::
diff --git a/Documentation/git-verify-pack.txt b/Documentation/git-verify-pack.txt
index 8163a86940..6e0b6f6a62 100644
--- a/Documentation/git-verify-pack.txt
+++ b/Documentation/git-verify-pack.txt
@@ -23,13 +23,13 @@ OPTIONS
<pack>.idx ...::
The idx files to verify.
--v::
---verbose::
+`-v`::
+`--verbose`::
After verifying the pack, show list of objects contained
in the pack and a histogram of delta chain length.
--s::
---stat-only::
+`-s`::
+`--stat-only`::
Do not verify the pack contents; only show the histogram of delta
chain length. With `--verbose`, list of objects is also shown.
diff --git a/Documentation/git-verify-tag.txt b/Documentation/git-verify-tag.txt
index 343e209fc5..f89ca539c8 100644
--- a/Documentation/git-verify-tag.txt
+++ b/Documentation/git-verify-tag.txt
@@ -16,12 +16,12 @@ Validates the gpg signature created by `git tag`.
OPTIONS
-------
---raw::
+`--raw`::
Print the raw gpg status output to standard error instead of the normal
human-readable output.
--v::
---verbose::
+`-v`::
+`--verbose`::
Print the contents of the tag object before validating it.
<tag>...::
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index 95fa3b673c..d44084a7f4 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -92,7 +92,7 @@ checked out in the new working tree, if it's not checked out anywhere
else, otherwise the command will refuse to create the working tree (unless
`--force` is used).
-list::
+`list`::
List details of each working tree. The main working tree is listed first,
followed by each of the linked working trees. The output details include
@@ -101,7 +101,7 @@ branch currently checked out (or "detached `HEAD`" if none), "locked" if
the worktree is locked, "prunable" if the worktree can be pruned by `prune`
command.
-lock::
+`lock`::
If a working tree is on a portable device or network share which
is not always mounted, lock it to prevent its administrative
@@ -109,7 +109,7 @@ files from being pruned automatically. This also prevents it from
being moved or deleted. Optionally, specify a reason for the lock
with `--reason`.
-move::
+`move`::
Move a working tree to a new location. Note that the main working tree
or linked working trees containing submodules cannot be moved with this
@@ -117,11 +117,11 @@ command. (The `git worktree repair` command, however, can reestablish
the connection with linked working trees if you move the main working
tree manually.)
-prune::
+`prune`::
Prune working tree information in `$GIT_DIR/worktrees`.
-remove::
+`remove`::
Remove a working tree. Only clean working trees (no untracked files
and no modification in tracked files) can be removed. Unclean working
@@ -150,15 +150,15 @@ manually, then running `repair` in the main working tree and specifying the
new `<path>` of each linked working tree will reestablish all connections
in both directions.
-unlock::
+`unlock`::
Unlock a working tree, allowing it to be pruned, moved or deleted.
OPTIONS
-------
--f::
---force::
+`-f`::
+`--force`::
By default, `add` refuses to create a new working tree when
`<commit-ish>` is a branch name and is already checked out by
another working tree, or if `<path>` is already assigned to some
@@ -183,18 +183,18 @@ To remove a locked working tree, specify `--force` twice.
exists. `-B` overrides this safeguard, resetting `<new-branch>` to
`<commit-ish>`.
--d::
---detach::
+`-d`::
+`--detach`::
With `add`, detach `HEAD` in the new working tree. See "DETACHED HEAD"
in linkgit:git-checkout[1].
---[no-]checkout::
+`--[no-]checkout`::
By default, `add` checks out `<commit-ish>`, however, `--no-checkout` can
be used to suppress checkout in order to make customizations,
such as configuring sparse-checkout. See "Sparse checkout"
in linkgit:git-read-tree[1].
---[no-]guess-remote::
+`--[no-]guess-remote`::
With `worktree add <path>`, without `<commit-ish>`, instead
of creating a new branch from `HEAD`, if there exists a tracking
branch in exactly one remote matching the basename of `<path>`,
@@ -204,33 +204,33 @@ To remove a locked working tree, specify `--force` twice.
This can also be set up as the default behaviour by using the
`worktree.guessRemote` config option.
---[no-]track::
+`--[no-]track`::
When creating a new branch, if `<commit-ish>` is a branch,
mark it as "upstream" from the new branch. This is the
default if `<commit-ish>` is a remote-tracking branch. See
`--track` in linkgit:git-branch[1] for details.
---lock::
+`--lock`::
Keep the working tree locked after creation. This is the
equivalent of `git worktree lock` after `git worktree add`,
but without a race condition.
--n::
---dry-run::
+`-n`::
+`--dry-run`::
With `prune`, do not remove anything; just report what it would
remove.
---porcelain::
+`--porcelain`::
With `list`, output in an easy-to-parse format for scripts.
This format will remain stable across Git versions and regardless of user
configuration. See below for details.
--q::
---quiet::
+`-q`::
+`--quiet`::
With `add`, suppress feedback messages.
--v::
---verbose::
+`-v`::
+`--verbose`::
With `prune`, report all removals.
+
With `list`, output additional information about worktrees (see below).
@@ -244,7 +244,7 @@ older than `<time>`.
--reason <string>::
With `lock`, an explanation why the working tree is locked.
-<worktree>::
+`<worktree>`::
Working trees can be identified by path, either relative or
absolute.
+
diff --git a/Documentation/git-write-tree.txt b/Documentation/git-write-tree.txt
index 295a8715cb..6b0156286a 100644
--- a/Documentation/git-write-tree.txt
+++ b/Documentation/git-write-tree.txt
@@ -27,7 +27,7 @@ now, you need to have done a `git update-index` phase before you did the
OPTIONS
-------
---missing-ok::
+`--missing-ok`::
Normally `git write-tree` ensures that the objects referenced by the
directory exist in the object database. This option disables this
check.
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 4c6fca3128..d1389f92c1 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -39,10 +39,10 @@ or https://git-scm.com/docs.
OPTIONS
-------
---version::
+`--version`::
Prints the Git suite version that the `git` program came from.
---help::
+`--help`::
Prints the synopsis and a list of the most commonly used
commands. If the option `--all` or `-a` is given then all
available commands are printed. If a Git command is named this
@@ -80,7 +80,7 @@ config file). Including the equals but with an empty value (like `git -c
foo.bar= ...`) sets `foo.bar` to the empty string which `git config
--type=bool` will convert to `false`.
---config-env=<name>=<envvar>::
+`--config-env=<name>=<envvar>`::
Like `-c <name>=<value>`, give configuration variable
'<name>' a value, where <envvar> is the name of an
environment variable from which to retrieve the value. Unlike
@@ -102,36 +102,36 @@ Note that this might add security for variables such as
the value, but not e.g. `url.<base>.insteadOf` where the
sensitive information can be part of the key.
---exec-path[=<path>]::
+`--exec-path[=<path>]`::
Path to wherever your core Git programs are installed.
This can also be controlled by setting the GIT_EXEC_PATH
environment variable. If no path is given, `git` will print
the current setting and then exit.
---html-path::
+`--html-path`::
Print the path, without trailing slash, where Git's HTML
documentation is installed and exit.
---man-path::
+`--man-path`::
Print the manpath (see `man(1)`) for the man pages for
this version of Git and exit.
---info-path::
+`--info-path`::
Print the path where the Info files documenting this
version of Git are installed and exit.
--p::
---paginate::
+`-p`::
+`--paginate`::
Pipe all output into 'less' (or if set, `$PAGER`) if standard
output is a terminal. This overrides the `pager.<cmd>`
configuration options (see the "Configuration Mechanism" section
below).
--P::
---no-pager::
+`-P`::
+`--no-pager`::
Do not pipe Git output into a pager.
---git-dir=<path>::
+`--git-dir=<path>`::
Set the path to the repository (".git" directory). This can also be
controlled by setting the `GIT_DIR` environment variable. It can be
an absolute path or relative path to current working directory.
@@ -150,7 +150,7 @@ environment variable)
If you just want to run `git` as if it was started in `<path>` then use
`git -C <path>`.
---work-tree=<path>::
+`--work-tree=<path>`::
Set the path to the working tree. It can be an absolute path
or a path relative to the current working directory.
This can also be controlled by setting the GIT_WORK_TREE
@@ -158,47 +158,47 @@ If you just want to run `git` as if it was started in `<path>` then use
variable (see `core.worktree` in linkgit:git-config[1] for a
more detailed discussion).
---namespace=<path>::
+`--namespace=<path>`::
Set the Git namespace. See linkgit:gitnamespaces[7] for more
details. Equivalent to setting the `GIT_NAMESPACE` environment
variable.
---super-prefix=<path>::
+`--super-prefix=<path>`::
Currently for internal use only. Set a prefix which gives a path from
above a repository down to its root. One use is to give submodules
context about the superproject that invoked it.
---bare::
+`--bare`::
Treat the repository as a bare repository. If GIT_DIR
environment is not set, it is set to the current working
directory.
---no-replace-objects::
+`--no-replace-objects`::
Do not use replacement refs to replace Git objects. See
linkgit:git-replace[1] for more information.
---literal-pathspecs::
+`--literal-pathspecs`::
Treat pathspecs literally (i.e. no globbing, no pathspec magic).
This is equivalent to setting the `GIT_LITERAL_PATHSPECS` environment
variable to `1`.
---glob-pathspecs::
+`--glob-pathspecs`::
Add "glob" magic to all pathspec. This is equivalent to setting
the `GIT_GLOB_PATHSPECS` environment variable to `1`. Disabling
globbing on individual pathspecs can be done using pathspec
magic ":(literal)"
---noglob-pathspecs::
+`--noglob-pathspecs`::
Add "literal" magic to all pathspec. This is equivalent to setting
the `GIT_NOGLOB_PATHSPECS` environment variable to `1`. Enabling
globbing on individual pathspecs can be done using pathspec
magic ":(glob)"
---icase-pathspecs::
+`--icase-pathspecs`::
Add "icase" magic to all pathspec. This is equivalent to setting
the `GIT_ICASE_PATHSPECS` environment variable to `1`.
---no-optional-locks::
+`--no-optional-locks`::
Do not perform optional operations that require locks. This is
equivalent to setting the `GIT_OPTIONAL_LOCKS` to `0`.
@@ -365,35 +365,35 @@ list and more details about the configuration mechanism.
Identifier Terminology
----------------------
-<object>::
+`<object>`::
Indicates the object name for any type of object.
-<blob>::
+`<blob>`::
Indicates a blob object name.
-<tree>::
+`<tree>`::
Indicates a tree object name.
-<commit>::
+`<commit>`::
Indicates a commit object name.
-<tree-ish>::
+`<tree-ish>`::
Indicates a tree, commit or tag object name. A
command that takes a <tree-ish> argument ultimately wants to
operate on a <tree> object but automatically dereferences
<commit> and <tag> objects that point at a <tree>.
-<commit-ish>::
+`<commit-ish>`::
Indicates a commit or tag object name. A
command that takes a <commit-ish> argument ultimately wants to
operate on a <commit> object but automatically dereferences
<tag> objects that point at a <commit>.
-<type>::
+`<type>`::
Indicates that an object type is required.
Currently one of: `blob`, `tree`, `commit`, or `tag`.
-<file>::
+`<file>`::
Indicates a filename - almost always relative to the
root of the tree structure `GIT_INDEX_FILE` describes.
@@ -402,14 +402,14 @@ Symbolic Identifiers
Any Git command accepting any <object> can also use the following
symbolic notation:
-HEAD::
+`HEAD`::
indicates the head of the current branch.
-<tag>::
+`<tag>`::
a valid tag 'name'
(i.e. a `refs/tags/<tag>` reference).
-<head>::
+`<head>`::
a valid head 'name'
(i.e. a `refs/heads/<head>` reference).
diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
index a5cfef7f86..0440adf4fc 100644
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt
@@ -29,13 +29,13 @@ listed on the line are given to the path.
Each attribute can be in one of these states for a given path:
-Set::
+`Set`::
The path has the attribute with special value "true";
this is specified by listing only the name of the
attribute in the attribute list.
-Unset::
+`Unset`::
The path has the attribute with special value "false";
this is specified by listing the name of the attribute
@@ -48,7 +48,7 @@ Set to a value::
followed by an equal sign `=` and its value in the
attribute list.
-Unspecified::
+`Unspecified`::
No pattern matches the path, and nothing says if
the path has or does not have the attribute, the
@@ -129,13 +129,13 @@ Note that setting `core.autocrlf` to `true` or `input` overrides
`core.eol` (see the definitions of those options in
linkgit:git-config[1]).
-Set::
+`Set`::
Setting the `text` attribute on a path enables end-of-line
normalization and marks the path as a text file. End-of-line
conversion takes place without guessing the content type.
-Unset::
+`Unset`::
Unsetting the `text` attribute on a path tells Git not to
attempt any end-of-line conversion upon checkin or checkout.
@@ -147,7 +147,7 @@ Set to string value "auto"::
text, its line endings are converted to LF on checkin.
When the file has been committed with CRLF, no conversion is done.
-Unspecified::
+`Unspecified`::
If the `text` attribute is unspecified, Git uses the
`core.autocrlf` configuration variable to determine if the
@@ -707,26 +707,26 @@ shown on the hunk header `@@ -k,l +n,m @@` line, tell Git to use an
external command to generate the diff, or ask Git to convert binary
files to a text format before generating the diff.
-Set::
+`Set`::
A path to which the `diff` attribute is set is treated
as text, even when they contain byte values that
normally never appear in text files, such as NUL.
-Unset::
+`Unset`::
A path to which the `diff` attribute is unset will
generate `Binary files differ` (or a binary patch, if
binary patches are enabled).
-Unspecified::
+`Unspecified`::
A path to which the `diff` attribute is unspecified
first gets its contents inspected, and if it looks like
text and is smaller than `core.bigFileThreshold`, it is treated
as text. Otherwise it would generate `Binary files differ`.
-String::
+`String`::
Diff is shown using the specified diff driver. Each driver may
specify one or more options, as described in the following
@@ -1000,20 +1000,20 @@ The attribute `merge` affects how three versions of a file are
merged when a file-level merge is necessary during `git merge`,
and other commands such as `git revert` and `git cherry-pick`.
-Set::
+`Set`::
Built-in 3-way merge driver is used to merge the
contents in a way similar to 'merge' command of `RCS`
suite. This is suitable for ordinary text files.
-Unset::
+`Unset`::
Take the version from the current branch as the
tentative merge result, and declare that the merge has
conflicts. This is suitable for binary files that do
not have a well-defined merge semantics.
-Unspecified::
+`Unspecified`::
By default, this uses the same built-in 3-way merge
driver as is the case when the `merge` attribute is set.
@@ -1021,7 +1021,7 @@ Unspecified::
different merge driver to be used with paths for which the
`merge` attribute is unspecified.
-String::
+`String`::
3-way merge is performed using the specified custom
merge driver. The built-in 3-way merge driver can be
@@ -1036,7 +1036,7 @@ Built-in merge drivers
There are a few built-in low-level merge drivers defined that
can be asked for via the `merge` attribute.
-text::
+`text`::
Usual 3-way file level merge for text files. Conflicted
regions are marked with conflict markers `<<<<<<<`,
@@ -1045,13 +1045,13 @@ text::
from the merged branch appears after the `=======`
marker.
-binary::
+`binary`::
Keep the version from your branch in the work tree, but
leave the path in the conflicted state for the user to
sort out.
-union::
+`union`::
Run 3-way file level merge for text files, but take
lines from both versions, instead of leaving conflict
@@ -1132,22 +1132,22 @@ The `core.whitespace` configuration variable allows you to define what
the project (See linkgit:git-config[1]). This attribute gives you finer
control per path.
-Set::
+`Set`::
Notice all types of potential whitespace errors known to Git.
The tab width is taken from the value of the `core.whitespace`
configuration variable.
-Unset::
+`Unset`::
Do not notice anything as error.
-Unspecified::
+`Unspecified`::
Use the value of the `core.whitespace` configuration variable to
decide what to notice as error.
-String::
+`String`::
Specify a comma separate list of common whitespace problems to
notice in the same format as the `core.whitespace` configuration
diff --git a/Documentation/gitcli.txt b/Documentation/gitcli.txt
index 0fb18e3f35..d96e17ef5f 100644
--- a/Documentation/gitcli.txt
+++ b/Documentation/gitcli.txt
@@ -111,7 +111,7 @@ Magic Options
Commands which have the enhanced option parser activated all understand a
couple of magic command-line options:
--h::
+`-h`::
gives a pretty printed usage of the command.
+
---------------------------------------------
@@ -132,7 +132,7 @@ when there are things on the command line other than `-h`, but `git
subcmd -h` without anything else on the command line is meant to
consistently give the usage.
---help-all::
+`--help-all`::
Some Git commands take options that are only used for plumbing or that
are deprecated, and such options are hidden from the default usage. This
option gives the full list of options.
diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
index aa11b4562b..15c5ca122f 100644
--- a/Documentation/gitcore-tutorial.txt
+++ b/Documentation/gitcore-tutorial.txt
@@ -1011,7 +1011,7 @@ $ git fetch <remote-repository>
One of the following transports can be used to name the
repository to download from:
-SSH::
+`SSH`::
`remote.machine:/path/to/repo.git/` or
+
`ssh://remote.machine/path/to/repo.git/`
diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt
index a11e72ca4c..b3be044e9e 100644
--- a/Documentation/gitcredentials.txt
+++ b/Documentation/gitcredentials.txt
@@ -66,12 +66,12 @@ storage provided by the OS or other programs.
To use a helper, you must first select one to use. Git currently
includes the following helpers:
-cache::
+`cache`::
Cache credentials in memory for a short period of time. See
linkgit:git-credential-cache[1] for details.
-store::
+`store`::
Store credentials indefinitely on disk. See
linkgit:git-credential-store[1] for details.
@@ -152,7 +152,7 @@ above.
The following options are available in either location:
-helper::
+`helper`::
The name of an external credential helper, and any associated options.
If the helper name is not an absolute path, then the string `git
@@ -171,11 +171,11 @@ the helper list to empty (so you may override a helper set by a
lower-priority config file by configuring the empty-string helper,
followed by whatever set of helpers you would like).
-username::
+`username`::
A default username, if one is not provided in the URL.
-useHttpPath::
+`useHttpPath`::
By default, Git does not consider the "path" component of an http URL
to be worth matching via external helpers. This means that a credential
diff --git a/Documentation/githooks.txt b/Documentation/githooks.txt
index ce1aa25d5a..cf3e4b4011 100644
--- a/Documentation/githooks.txt
+++ b/Documentation/githooks.txt
@@ -571,7 +571,7 @@ thus has access to these notes.
The following command-specific comments apply:
-rebase::
+`rebase`::
For the 'squash' and 'fixup' operation, all commits that were
squashed are listed as being rewritten to the squashed commit.
This means that there will be several lines sharing the same
diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index bc0cb104cc..4fd7300cc4 100644
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -35,13 +35,13 @@ rev-list options and arguments
This manual page describes only the most frequently used options. See
linkgit:git-rev-list[1] for a complete list.
---all::
+`--all`::
Show all refs (branches, tags, etc.).
---branches[=<pattern>]::
---tags[=<pattern>]::
---remotes[=<pattern>]::
+`--branches[=<pattern>]`::
+`--tags[=<pattern>]`::
+`--remotes[=<pattern>]`::
Pretend as if all the branches (tags, remote branches, resp.)
are listed on the command line as '<commit>'. If '<pattern>'
@@ -49,38 +49,38 @@ linkgit:git-rev-list[1] for a complete list.
pattern lacks '?', '{asterisk}', or '[', '/{asterisk}' at the
end is implied.
---since=<date>::
+`--since=<date>`::
Show commits more recent than a specific date.
---until=<date>::
+`--until=<date>`::
Show commits older than a specific date.
---date-order::
+`--date-order`::
Sort commits by date when possible.
---merge::
+`--merge`::
After an attempt to merge stops with conflicts, show the commits on
the history between two branches (i.e. the `HEAD` and the `MERGE_HEAD`)
that modify the conflicted files and do not exist on all the heads
being merged.
---left-right::
+`--left-right`::
Mark which side of a symmetric difference a commit is reachable
from. Commits from the left side are prefixed with a `<`
symbol and those from the right with a `>` symbol.
---full-history::
+`--full-history`::
When filtering history with '<path>...', does not prune some
history. (See "History simplification" in linkgit:git-log[1]
for a more detailed explanation.)
---simplify-merges::
+`--simplify-merges`::
Additional option to `--full-history` to remove some needless
merges from the resulting history, as there are no selected
@@ -88,7 +88,7 @@ linkgit:git-rev-list[1] for a complete list.
simplification" in linkgit:git-log[1] for a more detailed
explanation.)
---ancestry-path::
+`--ancestry-path`::
When given a range of commits to display
(e.g. 'commit1..commit2' or 'commit2 {caret}commit1'), only
@@ -118,7 +118,7 @@ include::line-range-options.txt[]
`gitk`-specific options
~~~~~~~~~~~~~~~~~~~~~
---argscmd=<command>::
+`--argscmd=<command>`::
Command to be run each time `gitk` has to determine the revision
range to show. The command is expected to print on its
@@ -127,7 +127,7 @@ include::line-range-options.txt[]
'<revision range>' if the set of commits to show may vary
between refreshes.
---select-commit=<ref>::
+`--select-commit=<ref>`::
Select the specified commit after loading the graph.
Default behavior is equivalent to specifying `--select-commit=HEAD`.
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index ea6b4427c6..861a8ae778 100644
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -68,19 +68,19 @@ submodule.<name>.ignore::
a submodule as modified. The following values are supported:
+
--
- all;; The submodule will never be considered modified (but will
+ `all`;; The submodule will never be considered modified (but will
nonetheless show up in the output of status and commit when it has
been staged).
- dirty;; All changes to the submodule's work tree will be ignored, only
+ `dirty`;; All changes to the submodule's work tree will be ignored, only
committed differences between the `HEAD` of the submodule and its
recorded state in the superproject are taken into account.
- untracked;; Only untracked files in submodules will be ignored.
+ `untracked`;; Only untracked files in submodules will be ignored.
Committed differences and modifications to tracked files will show
up.
- none;; No modifications to submodules are ignored, all of committed
+ `none`;; No modifications to submodules are ignored, all of committed
differences, and modifications to tracked and untracked files are
shown. This is the default option.
diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
index e92b9113f2..80681ed5c0 100644
--- a/Documentation/gitremote-helpers.txt
+++ b/Documentation/gitremote-helpers.txt
@@ -94,7 +94,7 @@ must provide.
Capabilities for Pushing
^^^^^^^^^^^^^^^^^^^^^^^^
-'connect'::
+`connect`::
Can attempt to connect to `git receive-pack` (for pushing),
`git upload-pack`, etc for communication using
git's native packfile protocol. This
@@ -102,7 +102,7 @@ Capabilities for Pushing
+
Supported commands: 'connect'.
-'stateless-connect'::
+`stateless-connect`::
Experimental; for internal use only.
Can attempt to connect to a remote server for communication
using git's wire-protocol version 2. See the documentation
@@ -110,13 +110,13 @@ Supported commands: 'connect'.
+
Supported commands: 'stateless-connect'.
-'push'::
+`push`::
Can discover remote refs and push local commits and the
history leading up to them to new or existing remote refs.
+
Supported commands: 'list for-push', 'push'.
-'export'::
+`export`::
Can discover remote refs and push specified objects from a
fast-import stream to remote refs.
+
@@ -128,7 +128,7 @@ connecting (see the 'connect' command under COMMANDS).
When choosing between 'push' and 'export', Git prefers 'push'.
Other frontends may have some other order of preference.
-'no-private-update'::
+`no-private-update`::
When using the 'refspec' capability, `git` normally updates the
private ref on successful push. This update is disabled when
the remote-helper declares the capability 'no-private-update'.
@@ -136,7 +136,7 @@ Other frontends may have some other order of preference.
Capabilities for Fetching
^^^^^^^^^^^^^^^^^^^^^^^^^
-'connect'::
+`connect`::
Can try to connect to `git upload-pack` (for fetching),
`git receive-pack`, etc for communication using the
Git's native packfile protocol. This
@@ -144,7 +144,7 @@ Capabilities for Fetching
+
Supported commands: 'connect'.
-'stateless-connect'::
+`stateless-connect`::
Experimental; for internal use only.
Can attempt to connect to a remote server for communication
using git's wire-protocol version 2. See the documentation
@@ -152,19 +152,19 @@ Supported commands: 'connect'.
+
Supported commands: 'stateless-connect'.
-'fetch'::
+`fetch`::
Can discover remote refs and transfer objects reachable from
them to the local object store.
+
Supported commands: 'list', 'fetch'.
-'import'::
+`import`::
Can discover remote refs and output objects reachable from
them as a stream in fast-import format.
+
Supported commands: 'list', 'import'.
-'check-connectivity'::
+`check-connectivity`::
Can guarantee that when a clone is requested, the received
pack is self contained and is connected.
@@ -177,7 +177,7 @@ Other frontends may have some other order of preference.
Miscellaneous capabilities
^^^^^^^^^^^^^^^^^^^^^^^^^^
-'option'::
+`option`::
For specifying settings like `verbosity` (how much output to
write to stderr) and `depth` (how much history is wanted in the
case of a shallow clone) that affect how other commands are
@@ -208,7 +208,7 @@ interact with, and to let the private namespace refs point to this
local repository, while the refs/remotes namespace is used to track
the remote repository.
-'bidi-import'::
+`bidi-import`::
This modifies the 'import' capability.
The fast-import commands 'cat-blob' and 'ls' can be used by remote-helpers
to retrieve information about blobs and trees that already exist in
@@ -233,12 +233,12 @@ the remote repository.
marks specified in <file> before processing any input. For details,
read up on `--import-marks=<file>` in linkgit:git-fast-export[1].
-'signed-tags'::
+`signed-tags`::
This modifies the 'export' capability, instructing Git to pass
`--signed-tags=verbatim` to linkgit:git-fast-export[1]. In the
absence of this capability, Git will use `--signed-tags=warn-strip`.
-'object-format'::
+`object-format`::
This indicates that the helper is able to interact with the remote
side using an explicit hash algorithm extension.
@@ -248,7 +248,7 @@ COMMANDS
Commands are given by the caller on the helper's standard input, one per line.
-'capabilities'::
+`capabilities`::
Lists the capabilities of the helper, one per line, ending
with a blank line. Each capability may be preceded with '*',
which marks them mandatory for Git versions using the remote
@@ -257,7 +257,7 @@ Commands are given by the caller on the helper's standard input, one per line.
+
Support for this command is mandatory.
-'list'::
+`list`::
Lists the refs, one per line, in the format "<value> <name>
[<attr> ...]". The value may be a hex sha1 hash, "@<dest>" for
a symref, ":<keyword> <value>" for a key-value pair, or
@@ -370,7 +370,7 @@ stdin.
+
Supported if the helper has the "import" capability.
-'export'::
+`export`::
Instructs the remote helper that any subsequent input is
part of a fast-import stream (generated by `git fast-export`)
containing objects which should be pushed to the remote.
@@ -433,7 +433,7 @@ The 'list' command produces a list of refs in which each ref
may be followed by a list of attributes. The following ref list
attributes are defined.
-'unchanged'::
+`unchanged`::
This ref is unchanged since the last import or fetch, although
the helper cannot necessarily determine what value that produced.
@@ -443,7 +443,7 @@ REF LIST KEYWORDS
The 'list' command may produce a list of key-value pairs.
The following keys are defined.
-'object-format'::
+`object-format`::
The refs are using the given hash algorithm. This keyword is only
used if the server and client both support the object-format
extension.
diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt
index 95a98f7802..c639ea8cc6 100644
--- a/Documentation/gitrepository-layout.txt
+++ b/Documentation/gitrepository-layout.txt
@@ -31,7 +31,7 @@ submodule working tree, without losing the submodule repository.
These things may exist in a Git repository.
-objects::
+`objects`::
Object store associated with this repository. Usually
an object store is self sufficient (i.e. all the objects
that are referred to by an object found in it are also
@@ -91,7 +91,7 @@ objects/info/http-alternates::
this object store borrows objects from, to be used when
the repository is fetched over HTTP.
-refs::
+`refs`::
References are stored in subdirectories of this
directory. The `git prune` command knows to preserve
objects reachable from refs found in this directory and
@@ -117,13 +117,13 @@ refs/replace/`<obj-sha1>`::
maintained by linkgit:git-replace[1]. Such refs can be exchanged
between repositories while grafts are not.
-packed-refs::
+`packed-refs`::
records the same information as refs/heads/, refs/tags/,
and friends record in a more efficient way. See
linkgit:git-pack-refs[1]. This file is ignored if `$GIT_COMMON_DIR`
is set and `$GIT_COMMON_DIR/packed-refs` will be used instead.
-HEAD::
+`HEAD`::
A symref (see glossary) to the `refs/heads/` namespace
describing the currently active branch. It does not mean
much if the repository is not associated with any working tree
@@ -140,7 +140,7 @@ being a symref to point at the current branch. Such a state
is often called 'detached `HEAD`.' See linkgit:git-checkout[1]
for details.
-config::
+`config`::
Repository specific configuration file. This file is ignored
if `$GIT_COMMON_DIR` is set and `$GIT_COMMON_DIR/config` will be
used instead.
@@ -150,7 +150,7 @@ config.worktree::
working directory in multiple working directory setup (see
linkgit:git-worktree[1]).
-branches::
+`branches`::
A slightly deprecated way to store shorthands to be used
to specify a URL to `git fetch`, `git pull` and `git push`.
A file can be stored as `branches/<name>` and then
@@ -162,7 +162,7 @@ branches::
`$GIT_COMMON_DIR/branches` will be used instead.
-hooks::
+`hooks`::
Hooks are customization scripts used by various Git
commands. A handful of sample hooks are installed when
`git init` is run, but all of them are disabled by
@@ -172,13 +172,13 @@ hooks::
each hook. This directory is ignored if `$GIT_COMMON_DIR` is set
and `$GIT_COMMON_DIR/hooks` will be used instead.
-common::
+`common`::
When multiple working trees are used, most of files in
`$GIT_DIR` are per-worktree with a few known exceptions. All
files under 'common' however will be shared between all
working trees.
-index::
+`index`::
The current index file for the repository. It is
usually not found in a bare repository.
@@ -186,7 +186,7 @@ sharedindex.<SHA-1>::
The shared index part, to be referenced by `$GIT_DIR/index` and
other temporary index files. Only valid in split index mode.
-info::
+`info`::
Additional information about the repository is recorded
in this directory. This directory is ignored if `$GIT_COMMON_DIR`
is set and `$GIT_COMMON_DIR/info` will be used instead.
@@ -228,7 +228,7 @@ info/sparse-checkout::
This file stores sparse checkout patterns.
See also: linkgit:git-read-tree[1].
-remotes::
+`remotes`::
Stores shorthands for URL and default refnames for use
when interacting with remote repositories via `git fetch`,
`git pull` and `git push` commands. See the REMOTES section
@@ -237,7 +237,7 @@ remotes::
directory is ignored if `$GIT_COMMON_DIR` is set and
`$GIT_COMMON_DIR/remotes` will be used instead.
-logs::
+`logs`::
Records of changes made to refs are stored in this directory.
See linkgit:git-update-ref[1] for more information. This
directory is ignored (except logs/HEAD) if `$GIT_COMMON_DIR` is
@@ -249,24 +249,24 @@ logs/refs/heads/`name`::
logs/refs/tags/`name`::
Records all changes made to the tag named `name`.
-shallow::
+`shallow`::
This is similar to `info/grafts` but is internally used
and maintained by shallow clone mechanism. See `--depth`
option to linkgit:git-clone[1] and linkgit:git-fetch[1]. This
file is ignored if `$GIT_COMMON_DIR` is set and
`$GIT_COMMON_DIR/shallow` will be used instead.
-commondir::
+`commondir`::
If this file exists, `$GIT_COMMON_DIR` (see linkgit:git[1]) will
be set to the path specified in this file if it is not
explicitly set. If the specified path is relative, it is
relative to `$GIT_DIR`. The repository with commondir is
incomplete without the repository pointed by "commondir".
-modules::
+`modules`::
Contains the `git`-repositories of the submodules.
-worktrees::
+`worktrees`::
Contains administrative data for linked
working trees. Each subdirectory contains the working tree-related
part of a linked working tree. This directory is ignored if
diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt
index 8a8d3f9acf..9cd1e9dc67 100644
--- a/Documentation/gitweb.conf.txt
+++ b/Documentation/gitweb.conf.txt
@@ -624,7 +624,7 @@ As one can see it lacks the \'sub' element.
The meaning of each part of feature configuration is described
below:
-default::
+`default`::
List (array reference) of feature parameters (if there are any),
used also to toggle (enable or disable) given feature.
+
@@ -638,7 +638,7 @@ section.
To disable features that accept parameters (are configurable), you
need to set this element to empty list i.e. `[]`.
-override::
+`override`::
If this field has a true value then the given feature is
overridable, which means that it can be configured
(or enabled/disabled) on a per-repository basis.
@@ -648,7 +648,7 @@ config variable in the per-repository Git configuration file.
+
*Note* that no feature is overridable by default.
-sub::
+`sub`::
Internal detail of implementation. What is important is that
if this field is not present then per-repository override for
given feature is not supported.
@@ -663,7 +663,7 @@ below. This should be a complete list, but ultimately the authoritative
and complete list is in gitweb.cgi source code, with features described
in the comments.
-blame::
+`blame`::
Enable the "blame" and "blame_incremental" blob views, showing for
each line the last commit that modified it; see linkgit:git-blame[1].
This can be very CPU-intensive and is therefore disabled by default.
@@ -671,7 +671,7 @@ blame::
This feature can be configured on a per-repository basis via
repository's `gitweb.blame` configuration variable (boolean).
-snapshot::
+`snapshot`::
Enable and configure the "snapshot" action, which allows user to
download a compressed archive of any tree or commit, as produced
by linkgit:git-archive[1] and possibly additionally compressed.
@@ -688,7 +688,7 @@ repository's `gitweb.snapshot` configuration variable, which contains
a comma separated list of formats or "none" to disable snapshots.
Unknown values are ignored.
-grep::
+`grep`::
Enable grep search, which lists the files in currently selected
tree (directory) containing the given string; see linkgit:git-grep[1].
This can be potentially CPU-intensive, of course. Enabled by default.
@@ -696,7 +696,7 @@ grep::
This feature can be configured on a per-repository basis via
repository's `gitweb.grep` configuration variable (boolean).
-pickaxe::
+`pickaxe`::
Enable the so called pickaxe search, which will list the commits
that introduced or removed a given string in a file. This can be
practical and quite faster alternative to "blame" action, but it is
@@ -709,7 +709,7 @@ linkgit:gitdiffcore[7] for more details).
This feature can be configured on a per-repository basis by setting
repository's `gitweb.pickaxe` configuration variable (boolean).
-show-sizes::
+`show-sizes`::
Enable showing size of blobs (ordinary files) in a "tree" view, in a
separate column, similar to what `ls -l` does; see description of
`-l` option in linkgit:git-ls-tree[1] manpage. This costs a bit of
@@ -718,7 +718,7 @@ show-sizes::
This feature can be configured on a per-repository basis via
repository's `gitweb.showSizes` configuration variable (boolean).
-patches::
+`patches`::
Enable and configure "patches" view, which displays list of commits in email
(plain text) output format; see also linkgit:git-format-patch[1].
The value is the maximum number of patches in a patchset generated
@@ -730,7 +730,7 @@ patches::
This feature can be configured on a per-repository basis via
repository's `gitweb.patches` configuration variable (integer).
-avatar::
+`avatar`::
Avatar support. When this feature is enabled, views such as
"shortlog" or "commit" will display an avatar associated with
the email of each committer and author.
@@ -751,7 +751,7 @@ default font sizes or lineheights are changed (e.g. via adding extra
CSS stylesheet in `@stylesheets`), it may be appropriate to change
these values.
-highlight::
+`highlight`::
Server-side syntax highlight support in "blob" view. It requires
`$highlight_bin` program to be available (see the description of
this variable in the "Configuration variables" section above),
@@ -773,7 +773,7 @@ repository's `gitweb.remote_heads` configuration variable (boolean).
The remaining features cannot be overridden on a per project basis.
-search::
+`search`::
Enable text search, which will list the commits which match author,
committer or commit text to a given string; see the description of
`--author`, `--committer` and `--grep` options in linkgit:git-log[1]
@@ -781,7 +781,7 @@ search::
+
Project specific override is not supported.
-forks::
+`forks`::
If this feature is enabled, `gitweb` considers projects in
subdirectories of project root (basename) to be forks of existing
projects. For each project +$projname.git+, projects in the
@@ -797,7 +797,7 @@ in that file.
+
Project specific override is not supported.
-actions::
+`actions`::
Insert custom links to the action bar of all project pages. This
allows you to link to third-party scripts integrating into `gitweb`.
+
@@ -823,7 +823,7 @@ This adds a link titled "graphiclog" after the "summary" link, leading to
+
Project specific override is not supported.
-timed::
+`timed`::
Enable displaying how much time and how many Git commands it took to
generate and display each page in the page footer (at the bottom of
page). For example the footer might contain: "This page took 6.53325
@@ -831,7 +831,7 @@ timed::
+
Project specific override is not supported.
-javascript-timezone::
+`javascript-timezone`::
Enable and configure the ability to change a common time zone for dates
in `gitweb` output via JavaScript. Dates in `gitweb` output include
authordate and committerdate in "commit", "commitdiff" and "log"
@@ -859,7 +859,7 @@ time zones in the form of "+/-HHMM", such as "+0200".
+
Project specific override is not supported.
-extra-branch-refs::
+`extra-branch-refs`::
List of additional directories under `refs` which are going to
be used as branch refs. For example if you have a gerrit setup
where all branches under refs/heads/ are official,
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index f164857d83..3ade8b7d72 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -280,24 +280,24 @@ five components:
.../gitweb.cgi/<repo>/<action>/<revision>:/<path>?<arguments>
-----------------------------------------------------------------------
-repo::
+`repo`::
The repository the action will be performed on.
+
All actions except for those that list all available projects,
in whatever form, require this parameter.
-action::
+`action`::
The action that will be run. Defaults to 'projects_list' if repo
is not set, and to 'summary' otherwise.
-revision::
+`revision`::
Revision shown. Defaults to `HEAD`.
-path::
+`path`::
The path within the <repository> that the action is performed on,
for those actions that require it.
-arguments::
+`arguments`::
Any arguments that control the behaviour of the action.
Some actions require or allow to specify two revisions, and sometimes even two
@@ -327,21 +327,21 @@ project_list::
Lists the available Git repositories. This is the default command if no
repository is specified in the URL.
-summary::
+`summary`::
Displays summary about given repository. This is the default command if
no action is specified in URL, and only repository is specified.
-heads::
-remotes::
+`heads`::
+`remotes`::
Lists all local or all remote-tracking branches in given repository.
+
The latter is not available by default, unless configured.
-tags::
+`tags`::
List all tags (lightweight and annotated) in given repository.
-blob::
-tree::
+`blob`::
+`tree`::
Shows the files and directories in a given repository path, at given
revision. This is default command if no action is specified in the URL,
and path is given.
@@ -350,10 +350,10 @@ blob_plain::
Returns the raw data for the file in given repository, at given path and
revision. Links to this action are marked 'raw'.
-blobdiff::
+`blobdiff`::
Shows the difference between two revisions of the same file.
-blame::
+`blame`::
blame_incremental::
Shows the blame (also called annotation) information for a file. On a
per line basis it shows the revision in which that line was last changed
@@ -363,34 +363,34 @@ blame_incremental::
+
This action is disabled by default for performance reasons.
-commit::
-commitdiff::
+`commit`::
+`commitdiff`::
Shows information about a specific commit in a repository. The 'commit'
view shows information about commit in more detail, the 'commitdiff'
action shows changeset for given commit.
-patch::
+`patch`::
Returns the commit in plain text mail format, suitable for applying with
linkgit:git-am[1].
-tag::
+`tag`::
Display specific annotated tag (tag object).
-log::
-shortlog::
+`log`::
+`shortlog`::
Shows log information (commit message or just commit subject) for a
given branch (starting from given revision).
+
The 'shortlog' view is more compact; it shows one commit per line.
-history::
+`history`::
Shows history of the file or directory in a given repository path,
starting from given revision (defaults to `HEAD`, i.e. default branch).
+
This view is similar to 'shortlog' view.
-rss::
-atom::
+`rss`::
+`atom`::
Generates an RSS (or Atom) feed of changes to repository.
diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index cc8bfc5cfb..122b5a71ea 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -352,19 +352,19 @@ A pathspec with only a colon means "there is no pathspec". This form
should not be combined with other pathspec.
+
--
-top;;
+`top`;;
The magic word `top` (magic signature: `/`) makes the pattern
match from the root of the working tree, even when you are
running the command from inside a subdirectory.
-literal;;
+`literal`;;
Wildcards in the pattern such as `*` or `?` are treated
as literal characters.
-icase;;
+`icase`;;
Case insensitive match.
-glob;;
+`glob`;;
Git treats the pattern as a shell glob suitable for
consumption by fnmatch(3) with the FNM_PATHNAME flag:
wildcards in the pattern will not match a / in the pathname.
@@ -393,7 +393,7 @@ full pathname may have special meaning:
+
Glob magic is incompatible with literal magic.
-attr;;
+`attr`;;
After `attr:` comes a space separated list of "attribute
requirements", all of which must be met in order for the
path to be considered a match; this is in addition to the
@@ -416,7 +416,7 @@ these forms:
Note that when matching against a tree object, attributes are still
obtained from working tree, not from the given tree object.
-exclude;;
+`exclude`;;
After a path matches any non-exclude pathspec, it will be run
through all exclude pathspecs (magic signature: `!` or its
synonym `^`). If it matches, the path is ignored. When there
diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
index 6f6f31874b..ec6b02f79a 100644
--- a/Documentation/merge-options.txt
+++ b/Documentation/merge-options.txt
@@ -1,5 +1,5 @@
---commit::
---no-commit::
+`--commit`::
+`--no-commit`::
Perform the merge and commit the result. This option can
be used to override `--no-commit`.
+
@@ -12,9 +12,9 @@ therefore there is no way to stop those merges with `--no-commit`.
Thus, if you want to ensure your branch is not changed or updated
by the merge command, use `--no-ff` with `--no-commit`.
---edit::
--e::
---no-edit::
+`--edit`::
+`-e`::
+`--no-edit`::
Invoke an editor before committing successful mechanical merge to
further edit the auto-generated merge message, so that the user
can explain and justify the merge. The `--no-edit` option can be
@@ -32,16 +32,16 @@ they run `git merge`. To make it easier to adjust such scripts to the
updated behaviour, the environment variable `GIT_MERGE_AUTOEDIT` can be
set to `no` at the beginning of them.
---cleanup=<mode>::
+`--cleanup=<mode>`::
This option determines how the merge message will be cleaned up before
committing. See linkgit:git-commit[1] for more details. In addition, if
the '<mode>' is given a value of `scissors`, scissors will be appended
to `MERGE_MSG` before being passed on to the commit machinery in the
case of a merge conflict.
---ff::
---no-ff::
---ff-only::
+`--ff`::
+`--no-ff`::
+`--ff-only`::
Specifies how a merge is handled when the merged-in history is
already a descendant of the current history. `--ff` is the
default unless merging an annotated (and possibly signed) tag
@@ -59,17 +59,17 @@ could instead be resolved as a fast-forward.
With `--ff-only`, resolve the merge as a fast-forward when possible.
When not possible, refuse to merge and exit with a non-zero status.
--S[<keyid>]::
---gpg-sign[=<keyid>]::
---no-gpg-sign::
+`-S[<keyid>]`::
+`--gpg-sign[=<keyid>]`::
+`--no-gpg-sign`::
GPG-sign the resulting merge commit. The `keyid` argument is
optional and defaults to the committer identity; if specified,
it must be stuck to the option without a space. `--no-gpg-sign`
is useful to countermand both `commit.gpgSign` configuration variable,
and earlier `--gpg-sign`.
---log[=<n>]::
---no-log::
+`--log[=<n>]`::
+`--no-log`::
In addition to branch names, populate the log message with
one-line descriptions from at most <n> actual commits that are being
merged. See also linkgit:git-fmt-merge-msg[1].
@@ -79,17 +79,17 @@ actual commits being merged.
include::signoff-option.txt[]
---stat::
--n::
---no-stat::
+`--stat`::
+`-n`::
+`--no-stat`::
Show a diffstat at the end of the merge. The diffstat is also
controlled by the configuration option merge.stat.
+
With `-n` or `--no-stat` do not show a diffstat at the end of the
merge.
---squash::
---no-squash::
+`--squash`::
+`--no-squash`::
Produce the working tree and index state as if a real merge
happened (except for the merge information), but do not actually
make a commit, move the `HEAD`, or record `$GIT_DIR/MERGE_HEAD`
@@ -103,12 +103,12 @@ option can be used to override `--squash`.
+
With `--squash`, `--commit` is not allowed, and will fail.
---no-verify::
+`--no-verify`::
This option bypasses the pre-merge and commit-msg hooks.
See also linkgit:githooks[5].
-s <strategy>::
---strategy=<strategy>::
+`--strategy=<strategy>`::
Use the given merge strategy; can be supplied more than
once to specify them in the order they should be tried.
If there is no `-s` option, a built-in list of strategies
@@ -116,34 +116,34 @@ With `--squash`, `--commit` is not allowed, and will fail.
head, `git merge-octopus` otherwise).
-X <option>::
---strategy-option=<option>::
+`--strategy-option=<option>`::
Pass merge strategy specific option through to the merge
strategy.
---verify-signatures::
---no-verify-signatures::
+`--verify-signatures`::
+`--no-verify-signatures`::
Verify that the tip commit of the side branch being merged is
signed with a valid key, i.e. a key that has a valid uid: in the
default trust model, this means the signing key has been signed by
a trusted key. If the tip commit of the side branch is not signed
with a valid key, the merge is aborted.
---summary::
---no-summary::
+`--summary`::
+`--no-summary`::
Synonyms to `--stat` and `--no-stat`; these are deprecated and will be
removed in the future.
ifndef::git-pull[]
--q::
---quiet::
+`-q`::
+`--quiet`::
Operate quietly. Implies `--no-progress`.
--v::
---verbose::
+`-v`::
+`--verbose`::
Be verbose.
---progress::
---no-progress::
+`--progress`::
+`--no-progress`::
Turn progress on/off explicitly. If neither is specified,
progress is shown if standard error is connected to a terminal.
Note that not all merge strategies may support progress
@@ -151,15 +151,15 @@ ifndef::git-pull[]
endif::git-pull[]
---autostash::
---no-autostash::
+`--autostash`::
+`--no-autostash`::
Automatically create a temporary stash entry before the operation
begins, and apply it after the operation ends. This means
that you can run the operation on a dirty worktree. However, use
with care: the final stash application after a successful
merge might result in non-trivial conflicts.
---allow-unrelated-histories::
+`--allow-unrelated-histories`::
By default, `git merge` command refuses to merge histories
that do not share a common ancestor. This option can be
used to override this safety when merging histories of two
diff --git a/Documentation/merge-strategies.txt b/Documentation/merge-strategies.txt
index 2912de706b..49162dfc20 100644
--- a/Documentation/merge-strategies.txt
+++ b/Documentation/merge-strategies.txt
@@ -6,14 +6,14 @@ backend 'merge strategies' to be chosen with `-s` option. Some strategies
can also take their own options, which can be passed by giving `-X<option>`
arguments to `git merge` and/or `git pull`.
-resolve::
+`resolve`::
This can only resolve two heads (i.e. the current branch
and another branch you pulled from) using a 3-way merge
algorithm. It tries to carefully detect criss-cross
merge ambiguities and is considered generally safe and
fast.
-recursive::
+`recursive`::
This can only resolve two heads using a 3-way merge
algorithm. When there is more than one common
ancestor that can be used for 3-way merge, it creates a
@@ -29,7 +29,7 @@ recursive::
+
The 'recursive' strategy can take the following options:
-ours;;
+`ours`;;
This option forces conflicting hunks to be auto-resolved cleanly by
favoring 'our' version. Changes from the other tree that do not
conflict with our side are reflected in the merge result.
@@ -39,11 +39,11 @@ This should not be confused with the 'ours' merge strategy, which does not
even look at what the other tree contains at all. It discards everything
the other tree did, declaring 'our' history contains all that happened in it.
-theirs;;
+`theirs`;;
This is the opposite of 'ours'; note that, unlike 'ours', there is
no 'theirs' merge strategy to confuse this merge option with.
-patience;;
+`patience`;;
With this option, 'merge-recursive' spends a little extra time
to avoid mismerges that sometimes occur due to unimportant
matching lines (e.g., braces from distinct functions). Use
@@ -56,10 +56,10 @@ diff-algorithm=[patience|minimal|histogram|myers];;
lines (such as braces from distinct functions). See also
linkgit:git-diff[1] `--diff-algorithm`.
-ignore-space-change;;
-ignore-all-space;;
-ignore-space-at-eol;;
-ignore-cr-at-eol;;
+`ignore-space-change`;;
+`ignore-all-space`;;
+`ignore-space-at-eol`;;
+`ignore-cr-at-eol`;;
Treats lines with the indicated type of whitespace change as
unchanged for the sake of a three-way merge. Whitespace
changes mixed with other changes to a line are not ignored.
@@ -72,7 +72,7 @@ ignore-cr-at-eol;;
version includes a substantial change, 'their' version is used;
* Otherwise, the merge proceeds in the usual way.
-renormalize;;
+`renormalize`;;
This runs a virtual check-out and check-in of all three stages
of a file when resolving a three-way merge. This option is
meant to be used when merging branches with different clean
@@ -80,39 +80,39 @@ renormalize;;
branches with differing checkin/checkout attributes" in
linkgit:gitattributes[5] for details.
-no-renormalize;;
+`no-renormalize`;;
Disables the `renormalize` option. This overrides the
`merge.renormalize` configuration variable.
-no-renames;;
+`no-renames`;;
Turn off rename detection. This overrides the `merge.renames`
configuration variable.
See also linkgit:git-diff[1] `--no-renames`.
-find-renames[=<n>];;
+`find-renames[=<n>]`;;
Turn on rename detection, optionally setting the similarity
threshold. This is the default. This overrides the
'merge.renames' configuration variable.
See also linkgit:git-diff[1] `--find-renames`.
-rename-threshold=<n>;;
+`rename-threshold=<n>`;;
Deprecated synonym for `find-renames=<n>`.
-subtree[=<path>];;
+`subtree[=<path>]`;;
This option is a more advanced form of 'subtree' strategy, where
the strategy makes a guess on how two trees must be shifted to
match with each other when merging. Instead, the specified path
is prefixed (or stripped from the beginning) to make the shape of
two trees to match.
-octopus::
+`octopus`::
This resolves cases with more than two heads, but refuses to do
a complex merge that needs manual resolution. It is
primarily meant to be used for bundling topic branch
heads together. This is the default merge strategy when
pulling or merging more than one branch.
-ours::
+`ours`::
This resolves any number of heads, but the resulting tree of the
merge is always that of the current branch head, effectively
ignoring all changes from all other branches. It is meant to
@@ -120,7 +120,7 @@ ours::
branches. Note that this is different from the -Xours option to
the 'recursive' merge strategy.
-subtree::
+`subtree`::
This is a modified recursive strategy. When merging trees A and
B, if B corresponds to a subtree of A, B is first adjusted to
match the tree structure of A, instead of reading the trees at
diff --git a/Documentation/pretty-options.txt b/Documentation/pretty-options.txt
index f055f56c37..ccb85eabc0 100644
--- a/Documentation/pretty-options.txt
+++ b/Documentation/pretty-options.txt
@@ -1,5 +1,5 @@
---pretty[=<format>]::
---format=<format>::
+`--pretty[=<format>]`::
+`--format=<format>`::
Pretty-print the contents of the commit logs in a given format,
where '<format>' can be one of 'oneline', 'short', 'medium',
@@ -14,7 +14,7 @@ format. When '=<format>' part is omitted, it defaults to 'medium'.
Note: you can specify the default pretty format in the repository
configuration (see linkgit:git-config[1]).
---abbrev-commit::
+`--abbrev-commit`::
Instead of showing the full 40-byte hexadecimal commit object
name, show a prefix that names the object uniquely.
`--abbrev=<n>` (which also modifies diff output, if it is displayed)
@@ -23,16 +23,16 @@ configuration (see linkgit:git-config[1]).
This should make `--pretty=oneline` a whole lot more readable for
people using 80-column terminals.
---no-abbrev-commit::
+`--no-abbrev-commit`::
Show the full 40-byte hexadecimal commit object name. This negates
`--abbrev-commit`, either explicit or implied by other options such
as `--oneline`. It also overrides the `log.abbrevCommit` variable.
---oneline::
+`--oneline`::
This is a shorthand for `--pretty=oneline --abbrev-commit`
used together.
---encoding=<encoding>::
+`--encoding=<encoding>`::
The commit objects record the encoding used for the log message
in their encoding header; this option can be used to tell the
command to re-code the commit log message in the encoding
@@ -42,9 +42,9 @@ people using 80-column terminals.
verbatim; this means that invalid sequences in the original
commit may be copied to the output.
---expand-tabs=<n>::
---expand-tabs::
---no-expand-tabs::
+`--expand-tabs=<n>`::
+`--expand-tabs`::
+`--no-expand-tabs`::
Perform a tab expansion (replace each tab with enough spaces
to fill to the next display column that is multiple of '<n>')
in the log message before showing it in the output.
@@ -57,7 +57,7 @@ message by 4 spaces (i.e. 'medium', which is the default, 'full',
and 'fuller').
ifndef::git-rev-list[]
---notes[=<ref>]::
+`--notes[=<ref>]`::
Show the notes (see linkgit:git-notes[1]) that annotate the
commit, when showing the commit log message. This is the default
for `git log`, `git show` and `git whatchanged` commands when
@@ -78,19 +78,19 @@ being displayed. Examples: `--notes=foo` will show only notes from
`refs/notes/foo`; `--notes=foo --notes` will show both notes from
`refs/notes/foo` and from the default notes ref(s).
---no-notes::
+`--no-notes`::
Do not show notes. This negates the above `--notes` option, by
resetting the list of notes refs from which notes are shown.
Options are parsed in the order given on the command line, so e.g.
`--notes --notes=foo --no-notes --notes=bar` will only show notes
from `refs/notes/bar`.
---show-notes[=<ref>]::
---[no-]standard-notes::
+`--show-notes[=<ref>]`::
+`--[no-]standard-notes`::
These options are deprecated. Use the above `--notes`/`--no-notes`
options instead.
endif::git-rev-list[]
---show-signature::
+`--show-signature`::
Check the validity of a signed commit object by passing the signature
to `gpg --verify` and show the output.
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index fb491660d6..7053aa6170 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -13,44 +13,44 @@ has a line that matches `<pattern>`), unless otherwise noted.
Note that these are applied before commit
ordering and formatting options, such as `--reverse`.
--<number>::
+`-<number>`::
-n <number>::
---max-count=<number>::
+`--max-count=<number>`::
Limit the number of commits to output.
---skip=<number>::
+`--skip=<number>`::
Skip 'number' commits before starting to show the commit output.
---since=<date>::
---after=<date>::
+`--since=<date>`::
+`--after=<date>`::
Show commits more recent than a specific date.
---until=<date>::
---before=<date>::
+`--until=<date>`::
+`--before=<date>`::
Show commits older than a specific date.
ifdef::git-rev-list[]
---max-age=<timestamp>::
---min-age=<timestamp>::
+`--max-age=<timestamp>`::
+`--min-age=<timestamp>`::
Limit the commits output to specified time range.
endif::git-rev-list[]
---author=<pattern>::
---committer=<pattern>::
+`--author=<pattern>`::
+`--committer=<pattern>`::
Limit the commits output to ones with author/committer
header lines that match the specified pattern (regular
expression). With more than one `--author=<pattern>`,
commits whose author matches any of the given patterns are
chosen (similarly for multiple `--committer=<pattern>`).
---grep-reflog=<pattern>::
+`--grep-reflog=<pattern>`::
Limit the commits output to ones with reflog entries that
match the specified pattern (regular expression). With
more than one `--grep-reflog`, commits whose reflog message
matches any of the given patterns are chosen. It is an
error to use this option unless `--walk-reflogs` is in use.
---grep=<pattern>::
+`--grep=<pattern>`::
Limit the commits output to ones with log message that
matches the specified pattern (regular expression). With
more than one `--grep=<pattern>`, commits whose message
@@ -62,35 +62,35 @@ When `--notes` is in effect, the message from the notes is
matched as if it were part of the log message.
endif::git-rev-list[]
---all-match::
+`--all-match`::
Limit the commits output to ones that match all given `--grep`,
instead of ones that match at least one.
---invert-grep::
+`--invert-grep`::
Limit the commits output to ones with log message that do not
match the pattern specified with `--grep=<pattern>`.
--i::
---regexp-ignore-case::
+`-i`::
+`--regexp-ignore-case`::
Match the regular expression limiting patterns without regard to letter
case.
---basic-regexp::
+`--basic-regexp`::
Consider the limiting patterns to be basic regular expressions;
this is the default.
--E::
---extended-regexp::
+`-E`::
+`--extended-regexp`::
Consider the limiting patterns to be extended regular expressions
instead of the default basic regular expressions.
--F::
---fixed-strings::
+`-F`::
+`--fixed-strings`::
Consider the limiting patterns to be fixed strings (don't interpret
pattern as a regular expression).
--P::
---perl-regexp::
+`-P`::
+`--perl-regexp`::
Consider the limiting patterns to be Perl-compatible regular
expressions.
+
@@ -98,20 +98,20 @@ Support for these types of regular expressions is an optional
compile-time dependency. If Git wasn't compiled with support for them
providing this option will cause it to die.
---remove-empty::
+`--remove-empty`::
Stop when a given path disappears from the tree.
---merges::
+`--merges`::
Print only merge commits. This is exactly the same as `--min-parents=2`.
---no-merges::
+`--no-merges`::
Do not print commits with more than one parent. This is
exactly the same as `--max-parents=1`.
---min-parents=<number>::
---max-parents=<number>::
---no-min-parents::
---no-max-parents::
+`--min-parents=<number>`::
+`--max-parents=<number>`::
+`--no-min-parents`::
+`--no-max-parents`::
Show only commits which have at least (or at most) that many parent
commits. In particular, `--max-parents=1` is the same as `--no-merges`,
`--min-parents=2` is the same as `--merges`. `--max-parents=0`
@@ -121,7 +121,7 @@ providing this option will cause it to die.
again. Equivalent forms are `--min-parents=0` (any commit has 0 or more
parents) and `--max-parents=-1` (negative numbers denote no upper limit).
---first-parent::
+`--first-parent`::
Follow only the first parent commit upon seeing a merge
commit. This option can give a better overview when
viewing the evolution of a particular topic branch,
@@ -135,39 +135,39 @@ This option also changes default diff format for merge commits
to `first-parent`, see `--diff-merges=first-parent` for details.
endif::git-log[]
---not::
+`--not`::
Reverses the meaning of the '{caret}' prefix (or lack thereof)
for all following revision specifiers, up to the next `--not`.
---all::
+`--all`::
Pretend as if all the refs in `refs/`, along with `HEAD`, are
listed on the command line as '<commit>'.
---branches[=<pattern>]::
+`--branches[=<pattern>]`::
Pretend as if all the refs in `refs/heads` are listed
on the command line as '<commit>'. If '<pattern>' is given, limit
branches to ones matching given shell glob. If pattern lacks '?',
'{asterisk}', or '[', '/{asterisk}' at the end is implied.
---tags[=<pattern>]::
+`--tags[=<pattern>]`::
Pretend as if all the refs in `refs/tags` are listed
on the command line as '<commit>'. If '<pattern>' is given, limit
tags to ones matching given shell glob. If pattern lacks '?', '{asterisk}',
or '[', '/{asterisk}' at the end is implied.
---remotes[=<pattern>]::
+`--remotes[=<pattern>]`::
Pretend as if all the refs in `refs/remotes` are listed
on the command line as '<commit>'. If '<pattern>' is given, limit
remote-tracking branches to ones matching given shell glob.
If pattern lacks '?', '{asterisk}', or '[', '/{asterisk}' at the end is implied.
---glob=<glob-pattern>::
+`--glob=<glob-pattern>`::
Pretend as if all the refs matching shell glob '<glob-pattern>'
are listed on the command line as '<commit>'. Leading `refs/`,
is automatically prepended if missing. If pattern lacks '?', '{asterisk}',
or '[', '/{asterisk}' at the end is implied.
---exclude=<glob-pattern>::
+`--exclude=<glob-pattern>`::
Do not include refs matching '<glob-pattern>' that the next `--all`,
`--branches`, `--tags`, `--remotes`, or `--glob` would otherwise
@@ -182,11 +182,11 @@ respectively, and they must begin with `refs/` when applied to `--glob`
or `--all`. If a trailing '/{asterisk}' is intended, it must be given
explicitly.
---reflog::
+`--reflog`::
Pretend as if all objects mentioned by reflogs are listed on the
command line as `<commit>`.
---alternate-refs::
+`--alternate-refs`::
Pretend as if all objects mentioned as ref tips of alternate
repositories were listed on the command line. An alternate
repository is any repository whose object directory is specified
@@ -194,7 +194,7 @@ explicitly.
be modified by `core.alternateRefsCommand`, etc. See
linkgit:git-config[1].
---single-worktree::
+`--single-worktree`::
By default, all working trees will be examined by the
following options when there are more than one (see
linkgit:git-worktree[1]): `--all`, `--reflog` and
@@ -202,33 +202,33 @@ explicitly.
This option forces them to examine the current working tree
only.
---ignore-missing::
+`--ignore-missing`::
Upon seeing an invalid object name in the input, pretend as if
the bad input was not given.
ifndef::git-rev-list[]
---bisect::
+`--bisect`::
Pretend as if the bad bisection ref `refs/bisect/bad`
was listed and as if it was followed by `--not` and the good
bisection refs `refs/bisect/good-*` on the command
line.
endif::git-rev-list[]
---stdin::
+`--stdin`::
In addition to the '<commit>' listed on the command
line, read them from the standard input. If a `--` separator is
seen, stop reading commits and start reading paths to limit the
result.
ifdef::git-rev-list[]
---quiet::
+`--quiet`::
Don't print anything to standard output. This form
is primarily meant to allow the caller to
test the exit status to see if a range of objects is fully
connected (or not). It is faster than redirecting stdout
to `/dev/null` as the output does not have to be formatted.
---disk-usage::
+`--disk-usage`::
Suppress normal output; instead, print the sum of the bytes used
for on-disk storage by the selected commits or objects. This is
equivalent to piping the output into `git cat-file
@@ -238,11 +238,11 @@ ifdef::git-rev-list[]
"on-disk storage" means.
endif::git-rev-list[]
---cherry-mark::
+`--cherry-mark`::
Like `--cherry-pick` (see below) but mark equivalent commits
with `=` rather than omitting them, and inequivalent ones with `+`.
---cherry-pick::
+`--cherry-pick`::
Omit any commit that introduces the same change as
another commit on the ``other side'' when the set of
commits are limited with symmetric difference.
@@ -255,8 +255,8 @@ cherry-picked from the other branch (for example, ``3rd on b'' may be
cherry-picked from branch `A`). With this option, such pairs of commits are
excluded from the output.
---left-only::
---right-only::
+`--left-only`::
+`--right-only`::
List only commits on the respective side of a symmetric difference,
i.e. only those which would be marked `<` resp. `>` by
`--left-right`.
@@ -267,15 +267,15 @@ commits from `B` which are in `A` or are patch-equivalent to a commit in
More precisely, `--cherry-pick --right-only --no-merges` gives the exact
list.
---cherry::
+`--cherry`::
A synonym for `--right-only --cherry-mark --no-merges`; useful to
limit the output to the commits on our side and mark those that
have been applied to the other side of a forked history with
`git log --cherry upstream...mybranch`, similar to
`git cherry upstream mybranch`.
--g::
---walk-reflogs::
+`-g`::
+`--walk-reflogs`::
Instead of walking the commit ancestry chain, walk
reflog entries from the most recent one to older ones.
When this option is used you cannot specify commits to
@@ -309,22 +309,22 @@ See also linkgit:git-reflog[1].
+
Under `--pretty=reference`, this information will not be shown at all.
---merge::
+`--merge`::
After a failed merge, show refs that touch files having a
conflict and don't exist on all heads to merge.
---boundary::
+`--boundary`::
Output excluded boundary commits. Boundary commits are
prefixed with `-`.
ifdef::git-rev-list[]
---use-bitmap-index::
+`--use-bitmap-index`::
Try to speed up the traversal using the pack bitmap index (if
one is available). Note that when traversing with `--objects`,
trees and blobs will not have their associated path printed.
---progress=<header>::
+`--progress=<header>`::
Show progress reports on stderr as objects are considered. The
`<header>` text will be printed with each progress update.
endif::git-rev-list[]
@@ -339,10 +339,10 @@ is how to do it, as there are various strategies to simplify the history.
The following options select the commits to be shown:
-<paths>::
+`<paths>`::
Commits modifying the given <paths> are selected.
---simplify-by-decoration::
+`--simplify-by-decoration`::
Commits that are referred by some branch or tag are selected.
Note that extra commits can be shown to give a meaningful history.
@@ -355,28 +355,28 @@ Default mode::
branches if the end result is the same (i.e. merging branches
with the same content)
---show-pulls::
+`--show-pulls`::
Include all commits from the default mode, but also any merge
commits that are not TREESAME to the first parent but are
TREESAME to a later parent. This mode is helpful for showing
the merge commits that "first introduced" a change to a branch.
---full-history::
+`--full-history`::
Same as the default mode, but does not prune some history.
---dense::
+`--dense`::
Only the selected commits are shown, plus some to have a
meaningful history.
---sparse::
+`--sparse`::
All commits in the simplified history are shown.
---simplify-merges::
+`--simplify-merges`::
Additional option to `--full-history` to remove some needless
merges from the resulting history, as there are no selected
commits contributing to this merge.
---ancestry-path::
+`--ancestry-path`::
When given a range of commits to display (e.g. 'commit1..commit2'
or 'commit2 {caret}commit1'), only display commits that exist
directly on the ancestry chain between the 'commit1' and
@@ -497,18 +497,18 @@ rewritten to contain `E`'s parent `I`. The same happened for `C` and
In addition to the above settings, you can change whether TREESAME
affects inclusion:
---dense::
+`--dense`::
Commits that are walked are included if they are not TREESAME
to any parent.
---sparse::
+`--sparse`::
All commits that are walked are included.
+
Note that without `--full-history`, this still simplifies merges: if
one of the parents is TREESAME, we follow only that one, so the other
sides of the merge are never walked.
---simplify-merges::
+`--simplify-merges`::
First, build a history graph in the same way that
`--full-history` with parent rewriting does (see above).
+
@@ -555,7 +555,7 @@ Note the major differences in `N`, `P`, and `Q` over `--full-history`:
There is another simplification mode available:
---ancestry-path::
+`--ancestry-path`::
Limit the displayed commits to those directly on the ancestry
chain between the ``from'' and ``to'' commits in the given commit
range. I.e. only display commits that are ancestor of the ``to''
@@ -685,7 +685,7 @@ into the important branch. This commit may have information about why
the change `X` came to override the changes from `A` and `B` in its
commit message.
---show-pulls::
+`--show-pulls`::
In addition to the commits shown in the default history, show
each merge commit that is not TREESAME to its first parent but
is TREESAME to a later parent.
@@ -734,7 +734,7 @@ ifdef::git-rev-list[]
Bisection Helpers
~~~~~~~~~~~~~~~~~
---bisect::
+`--bisect`::
Limit output to the one commit object which is roughly halfway between
included and excluded commits. Note that the bad bisection ref
`refs/bisect/bad` is added to the included commits (if it
@@ -758,7 +758,7 @@ introduces a regression is thus reduced to a binary search: repeatedly
generate and test new 'midpoint's until the commit chain is of length
one.
---bisect-vars::
+`--bisect-vars`::
This calculates the same as `--bisect`, except that refs in
`refs/bisect/` are not used, and except that this outputs
text ready to be eval'ed by the shell. These lines will assign the
@@ -770,7 +770,7 @@ one.
`bisect_bad`, and the number of commits we are bisecting right now to
`bisect_all`.
---bisect-all::
+`--bisect-all`::
This outputs all the commit objects between the included and excluded
commits, ordered by their distance to the included and excluded
commits. Refs in `refs/bisect/` are not used. The farthest
@@ -793,15 +793,15 @@ Commit Ordering
By default, the commits are shown in reverse chronological order.
---date-order::
+`--date-order`::
Show no parents before all of its children are shown, but
otherwise show commits in the commit timestamp order.
---author-date-order::
+`--author-date-order`::
Show no parents before all of its children are shown, but
otherwise show commits in the author timestamp order.
---topo-order::
+`--topo-order`::
Show no parents before all of its children are shown, and
avoid showing commits on multiple lines of history
intermixed.
@@ -825,7 +825,7 @@ With `--topo-order`, they would show 8 6 5 3 7 4 2 1 (or 8 7 4 2 6 5
avoid showing the commits from two parallel development track mixed
together.
---reverse::
+`--reverse`::
Output the commits chosen to be shown (see Commit Limiting
section above) in reverse order. Cannot be combined with
`--walk-reflogs`.
@@ -838,49 +838,49 @@ Object Traversal
These options are mostly targeted for packing of Git repositories.
ifdef::git-rev-list[]
---objects::
+`--objects`::
Print the object IDs of any object referenced by the listed
commits. `--objects foo ^bar` thus means ``send me
all object IDs which I need to download if I have the commit
object _bar_ but not _foo_''.
---in-commit-order::
+`--in-commit-order`::
Print tree and blob ids in order of the commits. The tree
and blob ids are printed after they are first referenced
by a commit.
---objects-edge::
+`--objects-edge`::
Similar to `--objects`, but also print the IDs of excluded
commits prefixed with a ``-'' character. This is used by
linkgit:git-pack-objects[1] to build a ``thin'' pack, which records
objects in deltified form based on objects contained in these
excluded commits to reduce network traffic.
---objects-edge-aggressive::
+`--objects-edge-aggressive`::
Similar to `--objects-edge`, but it tries harder to find excluded
commits at the cost of increased time. This is used instead of
`--objects-edge` to build ``thin'' packs for shallow repositories.
---indexed-objects::
+`--indexed-objects`::
Pretend as if all trees and blobs used by the index are listed
on the command line. Note that you probably want to use
`--objects`, too.
---unpacked::
+`--unpacked`::
Only useful with `--objects`; print the object IDs that are not
in packs.
---object-names::
+`--object-names`::
Only useful with `--objects`; print the names of the object IDs
that are found. This is the default behavior.
---no-object-names::
+`--no-object-names`::
Only useful with `--objects`; does not print the names of the object
IDs that are found. This inverts `--object-names`. This flag allows
the output to be more easily parsed by commands such as
linkgit:git-cat-file[1].
---filter=<filter-spec>::
+`--filter=<filter-spec>`::
Only useful with one of the `--objects*`; omits objects (usually
blobs) from the list of printed objects. The '<filter-spec>'
may be one of the following:
@@ -927,14 +927,14 @@ Other arbitrary characters can also be encoded. For instance,
'combine:tree:3+blob:none' and 'combine:tree%3A3+blob%3Anone' are
equivalent.
---no-filter::
+`--no-filter`::
Turn off any previous `--filter=` argument.
---filter-print-omitted::
+`--filter-print-omitted`::
Only useful with `--filter=`; prints a list of the objects omitted
by the filter. Object IDs are prefixed with a ``~'' character.
---missing=<missing-action>::
+`--missing=<missing-action>`::
A debug option to help with future "partial clone" development.
This option specifies how missing objects are handled.
+
@@ -952,7 +952,7 @@ Unexpected missing objects will raise an error.
The form `--missing=print` is like 'allow-any', but will also print a
list of the missing objects. Object IDs are prefixed with a ``?'' character.
---exclude-promisor-objects::
+`--exclude-promisor-objects`::
(For internal use only.) Prefilter object traversal at
promisor boundary. This is used with partial clone. This is
stronger than `--missing=allow-promisor` because it limits the
@@ -969,7 +969,7 @@ endif::git-rev-list[]
by commit time.
Cannot be combined with `--graph`.
---do-walk::
+`--do-walk`::
Overrides a previous `--no-walk`.
endif::git-shortlog[]
@@ -985,10 +985,10 @@ endif::git-rev-list[]
include::pretty-options.txt[]
---relative-date::
+`--relative-date`::
Synonym for `--date=relative`.
---date=<format>::
+`--date=<format>`::
Only takes effect for dates shown in human-readable format, such
as when using `--pretty`. `log.date` config variable sets a default
value for the log command's `--date` option. By default, dates
@@ -1053,25 +1053,25 @@ format placeholders. When using `-local`, the correct syntax is
- the time zone is omitted when the local time zone is used
ifdef::git-rev-list[]
---header::
+`--header`::
Print the contents of the commit in raw-format; each record is
separated with a NUL character.
endif::git-rev-list[]
---parents::
+`--parents`::
Print also the parents of the commit (in the form "commit parent...").
Also enables parent rewriting, see 'History Simplification' above.
---children::
+`--children`::
Print also the children of the commit (in the form "commit child...").
Also enables parent rewriting, see 'History Simplification' above.
ifdef::git-rev-list[]
---timestamp::
+`--timestamp`::
Print the raw commit timestamp.
endif::git-rev-list[]
---left-right::
+`--left-right`::
Mark which side of a symmetric difference a commit is reachable from.
Commits from the left side are prefixed with `<` and those from
the right with `>`. If combined with `--boundary`, those
@@ -1100,7 +1100,7 @@ you would get an output like this:
-xxxxxxx... 1st on a
-----------------------------------------------------------------------
---graph::
+`--graph`::
Draw a text-based graphical representation of the commit history
on the left hand side of the output. This may cause extra lines
to be printed in between commits, in order for the graph history
@@ -1112,7 +1112,7 @@ This enables parent rewriting, see 'History Simplification' above.
This implies the `--topo-order` option by default, but the
`--date-order` option may also be specified.
---show-linear-break[=<barrier>]::
+`--show-linear-break[=<barrier>]`::
When `--graph` is not used, all history branches are flattened
which can make it hard to see that the two consecutive commits
do not belong to a linear branch. This option puts a barrier
@@ -1120,7 +1120,7 @@ This implies the `--topo-order` option by default, but the
is the string that will be shown instead of the default one.
ifdef::git-rev-list[]
---count::
+`--count`::
Print a number stating how many commits would have been
listed, and suppress all other output. When used together
with `--left-right`, instead print the counts for left and
diff --git a/Documentation/sequencer.txt b/Documentation/sequencer.txt
index 3bceb56474..093d09fcaf 100644
--- a/Documentation/sequencer.txt
+++ b/Documentation/sequencer.txt
@@ -1,16 +1,16 @@
---continue::
+`--continue`::
Continue the operation in progress using the information in
`.git/sequencer`. Can be used to continue after resolving
conflicts in a failed cherry-pick or revert.
---skip::
+`--skip`::
Skip the current commit and continue with the rest of the
sequence.
---quit::
+`--quit`::
Forget about the current operation in progress. Can be used
to clear the sequencer state after a failed cherry-pick or
revert.
---abort::
+`--abort`::
Cancel the operation and return to the pre-sequence state.
diff --git a/Documentation/signoff-option.txt b/Documentation/signoff-option.txt
index 597d057c6e..08daf5d568 100644
--- a/Documentation/signoff-option.txt
+++ b/Documentation/signoff-option.txt
@@ -1,8 +1,8 @@
ifdef::git-commit[]
--s::
+`-s`::
endif::git-commit[]
---signoff::
---no-signoff::
+`--signoff`::
+`--no-signoff`::
Add a `Signed-off-by` trailer by the committer at the end of the commit
log message. The meaning of a signoff depends on the project
to which you're committing. For example, it may certify that
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 10/13] doc: typeset more command entries in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
` (8 preceding siblings ...)
2021-04-09 4:02 ` [RFC PATCH v1 09/13] doc: typeset command/option/value entries " Firmin Martin
@ 2021-04-09 4:02 ` Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 11/13] doc: typeset config option " Firmin Martin
` (3 subsequent siblings)
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Wrap command-line option entries (i.e. something of the form
<entry>[::|;;]<description>) which contain space or number with
backticks as indicated in the CodingGuidelines. Additionaly, as
an intended effect, also wrap some subcommands and status values.
The following command and regex assisted the substitution
with manual intervention to exclude false positives.
REGEX="^([[:space:]]*?)[\"']?([][ 0-9a-zA-Z-=<>]+)[\"']?(::|;;)([[:space:]]+|\$)" &&
perl -pi -e "s/$REGEX/\$1\`\$2\`\$3\$4/g" $(grep -Pl "$REGEX" *.txt --exclude-dir=RelNotes)
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/blame-options.txt | 10 ++++-----
Documentation/diff-format.txt | 4 ++--
Documentation/fetch-options.txt | 12 +++++------
Documentation/git-add.txt | 2 +-
Documentation/git-am.txt | 10 ++++-----
Documentation/git-apply.txt | 4 ++--
Documentation/git-archimport.txt | 4 ++--
Documentation/git-archive.txt | 6 +++---
Documentation/git-branch.txt | 14 ++++++-------
Documentation/git-bugreport.txt | 8 ++++----
Documentation/git-bundle.txt | 8 ++++----
Documentation/git-check-ignore.txt | 6 +++---
Documentation/git-cherry-pick.txt | 4 ++--
Documentation/git-clean.txt | 8 ++++----
Documentation/git-clone.txt | 26 ++++++++++++------------
Documentation/git-column.txt | 14 ++++++-------
Documentation/git-commit-tree.txt | 6 +++---
Documentation/git-commit.txt | 10 ++++-----
Documentation/git-config.txt | 16 +++++++--------
Documentation/git-credential-cache.txt | 4 ++--
Documentation/git-credential-store.txt | 2 +-
Documentation/git-cvsexportcommit.txt | 2 +-
Documentation/git-cvsimport.txt | 24 +++++++++++-----------
Documentation/git-cvsserver.txt | 2 +-
Documentation/git-describe.txt | 4 ++--
Documentation/git-diff-files.txt | 8 ++++----
Documentation/git-diff.txt | 8 ++++----
Documentation/git-difftool.txt | 4 ++--
Documentation/git-filter-branch.txt | 24 +++++++++++-----------
Documentation/git-fmt-merge-msg.txt | 8 ++++----
Documentation/git-for-each-repo.txt | 2 +-
Documentation/git-format-patch.txt | 12 +++++------
Documentation/git-fsck.txt | 8 ++++----
Documentation/git-grep.txt | 18 ++++++++--------
Documentation/git-hash-object.txt | 2 +-
Documentation/git-http-fetch.txt | 2 +-
Documentation/git-index-pack.txt | 2 +-
Documentation/git-init.txt | 6 +++---
Documentation/git-interpret-trailers.txt | 6 +++---
Documentation/git-log.txt | 2 +-
Documentation/git-ls-files.txt | 4 ++--
Documentation/git-ls-remote.txt | 2 +-
Documentation/git-merge-file.txt | 4 ++--
Documentation/git-merge.txt | 4 ++--
Documentation/git-mergetool.txt | 2 +-
Documentation/git-notes.txt | 12 +++++------
Documentation/git-p4.txt | 22 ++++++++++----------
Documentation/git-prune.txt | 2 +-
Documentation/git-push.txt | 14 ++++++-------
Documentation/git-quiltimport.txt | 6 +++---
Documentation/git-range-diff.txt | 4 ++--
Documentation/git-rebase.txt | 10 ++++-----
Documentation/git-receive-pack.txt | 2 +-
Documentation/git-replace.txt | 6 +++---
Documentation/git-reset.txt | 6 +++---
Documentation/git-restore.txt | 2 +-
Documentation/git-rev-parse.txt | 8 ++++----
Documentation/git-revert.txt | 4 ++--
Documentation/git-send-email.txt | 2 +-
Documentation/git-shell.txt | 2 +-
Documentation/git-shortlog.txt | 2 +-
Documentation/git-show-branch.txt | 2 +-
Documentation/git-show-index.txt | 2 +-
Documentation/git-stash.txt | 4 ++--
Documentation/git-submodule.txt | 14 ++++++-------
Documentation/git-svn.txt | 16 +++++++--------
Documentation/git-switch.txt | 10 ++++-----
Documentation/git-tag.txt | 16 +++++++--------
Documentation/git-unpack-file.txt | 2 +-
Documentation/git-update-index.txt | 4 ++--
Documentation/git-upload-archive.txt | 2 +-
Documentation/git-web--browse.txt | 8 ++++----
Documentation/git-worktree.txt | 10 ++++-----
Documentation/git.txt | 4 ++--
Documentation/gitattributes.txt | 2 +-
Documentation/gitk.txt | 2 +-
Documentation/gitremote-helpers.txt | 10 ++++-----
Documentation/gitweb.txt | 4 ++--
Documentation/merge-options.txt | 4 ++--
Documentation/pull-fetch-param.txt | 6 +++---
Documentation/rev-list-options.txt | 6 +++---
Documentation/revisions.txt | 2 +-
82 files changed, 286 insertions(+), 286 deletions(-)
diff --git a/Documentation/blame-options.txt b/Documentation/blame-options.txt
index c58d30a648..15e50af424 100644
--- a/Documentation/blame-options.txt
+++ b/Documentation/blame-options.txt
@@ -26,7 +26,7 @@ include::line-range-format.txt[]
`-t`::
Show raw timestamp (Default: off).
--S <revs-file>::
+`-S <revs-file>`::
Use revisions from revs-file instead of calling linkgit:git-rev-list[1].
--reverse <rev>..<rev>::
@@ -63,14 +63,14 @@ include::line-range-format.txt[]
discussion about encoding in the linkgit:git-log[1]
manual page.
---contents <file>::
+`--contents <file>`::
When <rev> is not specified, the command annotates the
changes starting backwards from the working tree copy.
This flag makes the command pretend as if the working
tree copy has the contents of the named file (specify
`-` to make the command read from the standard input).
---date <format>::
+`--date <format>`::
Specifies the format used to output dates. If `--date` is not
provided, the value of the `blame.date` config variable is
used. If the `blame.date` config variable is also not set, the
@@ -117,7 +117,7 @@ commit. And the default value is 40. If there are more than one
`-C` options given, the <num> argument of the last `-C` will
take effect.
---ignore-rev <rev>::
+`--ignore-rev <rev>`::
Ignore changes made by the revision when assigning blame, as if the
change never happened. Lines that were changed or added by an ignored
commit will be blamed on the previous commit that changed that line or
@@ -129,7 +129,7 @@ take effect.
by an ignored commit that we could not attribute to another revision are
marked with a '*'.
---ignore-revs-file <file>::
+`--ignore-revs-file <file>`::
Ignore revisions listed in `file`, which must be in the same format as an
`fsck.skipList`. This option may be repeated, and these files will be
processed after any files specified with the `blame.ignoreRevsFile` config
diff --git a/Documentation/diff-format.txt b/Documentation/diff-format.txt
index 14ef11d552..ac0ecc266a 100644
--- a/Documentation/diff-format.txt
+++ b/Documentation/diff-format.txt
@@ -7,10 +7,10 @@ The raw output format from `git-diff-index`, `git-diff-tree`,
These commands all compare two sets of things; what is
compared differs:
-git-diff-index <tree-ish>::
+`git-diff-index <tree-ish>`::
compares the <tree-ish> and the files on the filesystem.
-git-diff-index --cached <tree-ish>::
+`git-diff-index --cached <tree-ish>`::
compares the <tree-ish> and the index.
git-diff-tree [-r] <tree-ish-1> <tree-ish-2> [<pattern>...]::
diff --git a/Documentation/fetch-options.txt b/Documentation/fetch-options.txt
index fcee0ad87d..98ffc052f0 100644
--- a/Documentation/fetch-options.txt
+++ b/Documentation/fetch-options.txt
@@ -231,7 +231,7 @@ ifndef::git-pull[]
use it.
endif::git-pull[]
---upload-pack <upload-pack>::
+`--upload-pack <upload-pack>`::
When given, and the repository to fetch from is handled
by `git fetch-pack`, `--exec=<upload-pack>` is passed to
the command to specify non-default path for the command
@@ -255,7 +255,7 @@ endif::git-pull[]
is specified. This flag forces progress status even if the
standard error stream is not directed to a terminal.
--o <option>::
+`-o <option>`::
`--server-option=<option>`::
Transmit the given string to the server when communicating using
protocol version 2. The given string must not contain a NUL or LF
@@ -277,10 +277,10 @@ endif::git-pull[]
'git-pull' the `--ff-only` option will still check for forced updates
before attempting a fast-forward update. See linkgit:git-config[1].
--4::
---ipv4::
+`-4`::
+`--ipv4`::
Use IPv4 addresses only, ignoring IPv6 addresses.
--6::
---ipv6::
+`-6`::
+`--ipv6`::
Use IPv6 addresses only, ignoring IPv4 addresses.
diff --git a/Documentation/git-add.txt b/Documentation/git-add.txt
index 646951cf7e..1bc86d8482 100644
--- a/Documentation/git-add.txt
+++ b/Documentation/git-add.txt
@@ -313,7 +313,7 @@ contents of working tree files for selected paths in the index.
information for selected paths are reverted to that of the
`HEAD` version. Reverting new paths makes them untracked.
-add untracked::
+`add untracked`::
This has a very similar UI to 'update' and
'revert', and lets you add untracked paths to the index.
diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
index c8560bacad..0d01c475ab 100644
--- a/Documentation/git-am.txt
+++ b/Documentation/git-am.txt
@@ -75,7 +75,7 @@ OPTIONS
Be quiet. Only print error messages.
`-u`::
---utf8::
+`--utf8`::
Pass `-u` flag to `git mailinfo` (see linkgit:git-mailinfo[1]).
The proposed commit log message taken from the e-mail
is re-coded into UTF-8 encoding (configuration variable
@@ -85,13 +85,13 @@ OPTIONS
This was optional in prior versions of git, but now it is the
default. You can use `--no-utf8` to override this.
---no-utf8::
+`--no-utf8`::
Pass `-n` flag to `git mailinfo` (see
linkgit:git-mailinfo[1]).
--3::
---3way::
---no-3way::
+`-3`::
+`--3way`::
+`--no-3way`::
When the patch does not apply cleanly, fall back on
3-way merge if the patch records the identity of blobs
it is supposed to apply to and we have those blobs
diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
index 88cdddb178..fd681659e8 100644
--- a/Documentation/git-apply.txt
+++ b/Documentation/git-apply.txt
@@ -82,8 +82,8 @@ OPTIONS
Note that `--index` could be implied by other options such
as `--cached` or `--3way`.
--3::
---3way::
+`-3`::
+`--3way`::
When the patch does not apply cleanly, fall back on 3-way merge if
the patch records the identity of blobs it is supposed to apply to,
and we have those blobs available locally, possibly leaving the
diff --git a/Documentation/git-archimport.txt b/Documentation/git-archimport.txt
index 8ea76463bf..3144cc1680 100644
--- a/Documentation/git-archimport.txt
+++ b/Documentation/git-archimport.txt
@@ -91,7 +91,7 @@ OPTIONS
on the command-line will override the automatically-generated
ones.
--D <depth>::
+`-D <depth>`::
Follow merge ancestry and attempt to import trees that have been
merged from. Specify a depth greater than 1 if patch logs have been
pruned.
@@ -100,7 +100,7 @@ OPTIONS
Attempt to auto-register archives at http://mirrors.sourcecontrol.net
This is particularly useful with the `-D` option.
--t <tmpdir>::
+`-t <tmpdir>`::
Override the default tempdir.
diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index d0ca1241a2..83ce330c9d 100644
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -51,7 +51,7 @@ OPTIONS
--prefix=<prefix>/::
Prepend <prefix>/ to each filename in the archive.
--o <file>::
+`-o <file>`::
`--output=<file>`::
Write the archive to <file> instead of stdout.
@@ -93,9 +93,9 @@ BACKEND EXTRA OPTIONS
zip
~~~
--0::
+`-0`::
Store the files instead of deflating them.
--9::
+`-9`::
Highest and slowest compression level. You can specify any
number from 1 to 9 to adjust compression speed and ratio.
diff --git a/Documentation/git-branch.txt b/Documentation/git-branch.txt
index b9f65c4d52..cefc94e440 100644
--- a/Documentation/git-branch.txt
+++ b/Documentation/git-branch.txt
@@ -228,7 +228,7 @@ start-point is either a local or remote-tracking branch.
As this option had confusing syntax, it is no longer supported.
Please use `--track` or `--set-upstream-to` instead.
--u <upstream>::
+`-u <upstream>`::
`--set-upstream-to=<upstream>`::
Set up <branchname>'s tracking information so <upstream> is
considered <branchname>'s upstream branch. If no <branchname>
@@ -244,19 +244,19 @@ start-point is either a local or remote-tracking branch.
`request-pull`, and `merge` (if enabled)). Multi-line explanations
may be used.
---contains [<commit>]::
+`--contains [<commit>]`::
Only list branches which contain the specified commit (HEAD
if not specified). Implies `--list`.
---no-contains [<commit>]::
+`--no-contains [<commit>]`::
Only list branches which don't contain the specified commit
(`HEAD` if not specified). Implies `--list`.
---merged [<commit>]::
+`--merged [<commit>]`::
Only list branches whose tips are reachable from the
specified commit (`HEAD` if not specified). Implies `--list`.
---no-merged [<commit>]::
+`--no-merged [<commit>]`::
Only list branches whose tips are not reachable from the
specified commit (`HEAD` if not specified). Implies `--list`.
@@ -290,10 +290,10 @@ start-point is either a local or remote-tracking branch.
finally remote-tracking branches. See linkgit:git-config[1].
---points-at <object>::
+`--points-at <object>`::
Only list branches of the given object.
---format <format>::
+`--format <format>`::
A string that interpolates `%(fieldname)` from a branch ref being shown
and the object it points at. The format is the same as
that of linkgit:git-for-each-ref[1].
diff --git a/Documentation/git-bugreport.txt b/Documentation/git-bugreport.txt
index 0d5ef36f90..1b24b53907 100644
--- a/Documentation/git-bugreport.txt
+++ b/Documentation/git-bugreport.txt
@@ -38,13 +38,13 @@ the kind of information listed above when manually asking for help.
OPTIONS
-------
--o <path>::
---output-directory <path>::
+`-o <path>`::
+`--output-directory <path>`::
Place the resulting bug report file in `<path>` instead of the root of
the Git repository.
--s <format>::
---suffix <format>::
+`-s <format>`::
+`--suffix <format>`::
Specify an alternate suffix for the bugreport name, to create a file
named `git-bugreport-<formatted suffix>`. This should take the form of a
strftime(3) format string; the current local time will be used.
diff --git a/Documentation/git-bundle.txt b/Documentation/git-bundle.txt
index 92499c452d..644f2bb9dd 100644
--- a/Documentation/git-bundle.txt
+++ b/Documentation/git-bundle.txt
@@ -37,13 +37,13 @@ destination repository.
OPTIONS
-------
-create [options] <file> <git-rev-list-args>::
+`create [options] <file> <git-rev-list-args>`::
Used to create a bundle named 'file'. This requires the
'<git-rev-list-args>' arguments to define the bundle contents.
'options' contains the options specific to the `git bundle create`
subcommand.
-verify <file>::
+`verify <file>`::
Used to check that a bundle file is valid and will apply
cleanly to the current repository. This includes checks on the
bundle format itself as well as checking that the prerequisite
@@ -51,12 +51,12 @@ verify <file>::
`git bundle` prints a list of missing commits, if any, and exits
with a non-zero status.
-list-heads <file>::
+`list-heads <file>`::
Lists the references defined in the bundle. If followed by a
list of references, only references matching those given are
printed out.
-unbundle <file>::
+`unbundle <file>`::
Passes the objects in the bundle to `git index-pack`
for storage in the repository, then prints the names of all
defined references. If a list of references is given, only
diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt
index eabe8467ef..ae7842c65d 100644
--- a/Documentation/git-check-ignore.txt
+++ b/Documentation/git-check-ignore.txt
@@ -106,13 +106,13 @@ buffer.
EXIT STATUS
-----------
-0::
+`0`::
One or more of the provided paths is ignored.
-1::
+`1`::
None of the provided paths are ignored.
-128::
+`128`::
A fatal error was encountered.
SEE ALSO
diff --git a/Documentation/git-cherry-pick.txt b/Documentation/git-cherry-pick.txt
index 5d6021e4ca..31937c16f8 100644
--- a/Documentation/git-cherry-pick.txt
+++ b/Documentation/git-cherry-pick.txt
@@ -81,8 +81,8 @@ OPTIONS
described above, and `-r` was to disable it. Now the
default is not to do `-x` so this option is a no-op.
--m parent-number::
---mainline parent-number::
+`-m parent-number`::
+`--mainline parent-number`::
Usually you cannot cherry-pick a merge because you do not know which
side of the merge should be considered the mainline. This
option specifies the parent number (starting from 1) of
diff --git a/Documentation/git-clean.txt b/Documentation/git-clean.txt
index e782f48c2c..55a77a31f5 100644
--- a/Documentation/git-clean.txt
+++ b/Documentation/git-clean.txt
@@ -55,7 +55,7 @@ OPTIONS
Be quiet, only report errors, but not the files that are
successfully removed.
--e <pattern>::
+`-e <pattern>`::
`--exclude=<pattern>`::
Use the given exclude pattern in addition to the standard ignore rules
(see linkgit:gitignore[5]).
@@ -98,7 +98,7 @@ The main command loop has 6 subcommands.
Start cleaning files and directories, and then quit.
-filter by pattern::
+`filter by pattern`::
This shows the files and directories to be deleted and issues an
"Input ignore patterns>>" prompt. You can input space-separated
@@ -107,7 +107,7 @@ filter by pattern::
deletion. When you are satisfied with the filtered result, press
ENTER (empty) back to the main menu.
-select by numbers::
+`select by numbers`::
This shows the files and directories to be deleted and issues an
"Select items to delete>>" prompt. When the prompt ends with double
@@ -119,7 +119,7 @@ select by numbers::
Also when you are satisfied with the filtered result, press ENTER
(empty) back to the main menu.
-ask each::
+`ask each`::
This will start to clean, and you must confirm one by one in order
to delete items. Please note that this action is not as efficient
diff --git a/Documentation/git-clone.txt b/Documentation/git-clone.txt
index 935d191ae1..a5861c0530 100644
--- a/Documentation/git-clone.txt
+++ b/Documentation/git-clone.txt
@@ -96,7 +96,7 @@ If you want to break the dependency of a repository cloned with `--shared` on
its source repository, you can simply run `git repack -a` to copy all
objects from the source repository into a pack in the cloned repository.
---reference[-if-able] <repository>::
+`--reference[-if-able] <repository>`::
If the reference repository is on the local machine,
automatically setup `.git/objects/info/alternates` to
obtain objects from the reference repository. Using
@@ -190,14 +190,14 @@ objects from the source repository into a pack in the cloned repository.
that all these refs are overwritten by a `git remote update` in the
target repository.
--o <name>::
---origin <name>::
+`-o <name>`::
+`--origin <name>`::
Instead of using the remote name `origin` to keep track of the upstream
repository, use `<name>`. Overrides `clone.defaultRemoteName` from the
config.
--b <name>::
---branch <name>::
+`-b <name>`::
+`--branch <name>`::
Instead of pointing the newly created `HEAD` to the branch pointed
to by the cloned repository's `HEAD`, point to `<name>` branch
instead. In a non-bare repository, this is the branch that will
@@ -205,8 +205,8 @@ objects from the source repository into a pack in the cloned repository.
`--branch` can also take tags and detaches the `HEAD` at that commit
in the resulting repository.
--u <upload-pack>::
---upload-pack <upload-pack>::
+`-u <upload-pack>`::
+`--upload-pack <upload-pack>`::
When given, and the repository to clone from is accessed
via ssh, this specifies a non-default path for the command
run on the other end.
@@ -215,8 +215,8 @@ objects from the source repository into a pack in the cloned repository.
Specify the directory from which templates will be used;
(See the "TEMPLATE DIRECTORY" section of linkgit:git-init[1].)
--c <key>=<value>::
---config <key>=<value>::
+`-c <key>=<value>`::
+`--config <key>=<value>`::
Set a configuration variable in the newly-created repository;
this takes effect immediately after the repository is
initialized, but before the remote history is fetched or any
@@ -232,7 +232,7 @@ Configuration variables known to not take effect are:
`remote.<name>.mirror` and `remote.<name>.tagOpt`. Use the
corresponding `--mirror` and `--no-tags` options instead.
---depth <depth>::
+`--depth <depth>`::
Create a 'shallow' clone with a history truncated to the
specified number of commits. Implies `--single-branch` unless
`--no-single-branch` is given to fetch the histories near the
@@ -294,15 +294,15 @@ or `--mirror` is given)
superproject's recorded SHA-1. Equivalent to passing `--remote` to
`git submodule update`.
---separate-git-dir=<git dir>::
+`--separate-git-dir=<git dir>`::
Instead of placing the cloned repository where it is supposed
to be, place the cloned repository at the specified directory,
then make a filesystem-agnostic Git symbolic link to there.
The result is Git repository can be separated from working
tree.
--j <n>::
---jobs <n>::
+`-j <n>`::
+`--jobs <n>`::
The number of submodules fetched at the same time.
Defaults to the `submodule.fetchJobs` option.
diff --git a/Documentation/git-column.txt b/Documentation/git-column.txt
index 0865d22bdc..b350018637 100644
--- a/Documentation/git-column.txt
+++ b/Documentation/git-column.txt
@@ -20,30 +20,30 @@ columns.
OPTIONS
-------
---command=<name>::
+`--command=<name>`::
Look up layout mode using configuration variable `column.<name>` and
`column.ui`.
---mode=<mode>::
+`--mode=<mode>`::
Specify layout mode. See configuration variable `column.ui` for option
syntax in linkgit:git-config[1].
---raw-mode=<n>::
+`--raw-mode=<n>`::
Same as `--mode` but take mode encoded as a number. This is mainly used
by other commands that have already parsed layout mode.
---width=<width>::
+`--width=<width>`::
Specify the terminal width. By default 'git column' will detect the
terminal width, or fall back to 80 if it is unable to do so.
---indent=<string>::
+`--indent=<string>`::
String to be printed at the beginning of each line.
---nl=<N>::
+`--nl=<N>`::
String to be printed at the end of each line,
including newline character.
---padding=<N>::
+`--padding=<N>`::
The number of spaces between columns. One space by default.
EXAMPLES
diff --git a/Documentation/git-commit-tree.txt b/Documentation/git-commit-tree.txt
index 47f21f4bcc..35b37e9d6d 100644
--- a/Documentation/git-commit-tree.txt
+++ b/Documentation/git-commit-tree.txt
@@ -47,14 +47,14 @@ OPTIONS
`<tree>`::
An existing tree object.
--p <parent>::
+`-p <parent>`::
Each `-p` indicates the id of a parent commit object.
--m <message>::
+`-m <message>`::
A paragraph in the commit log message. This can be given more than
once and each <message> becomes its own paragraph.
--F <file>::
+`-F <file>`::
Read the commit log message from the given file. Use `-` to read
from the standard input. This can be given more than once and the
content of each file becomes its own paragraph.
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 48be5646c4..0594ed1db5 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -76,13 +76,13 @@ OPTIONS
which changes to commit. See linkgit:git-add[1] for
details.
--C <commit>::
+`-C <commit>`::
`--reuse-message=<commit>`::
Take an existing commit object, and reuse the log message
and the authorship information (including the timestamp)
when creating the commit.
--c <commit>::
+`-c <commit>`::
`--reedit-message=<commit>`::
Like `-C`, but with `-c` the editor is invoked, so that
the user can further edit the commit message.
@@ -164,7 +164,7 @@ See linkgit:git-rebase[1] for details.
quoted as explained for the configuration variable `core.quotePath`
(see linkgit:git-config[1]).
--F <file>::
+`-F <file>`::
`--file=<file>`::
Take the commit message from the given file. Use '-' to
read the message from the standard input.
@@ -179,7 +179,7 @@ See linkgit:git-rebase[1] for details.
`--date=<date>`::
Override the author date used in the commit.
--m <msg>::
+`-m <msg>`::
`--message=<msg>`::
Use the given <msg> as the commit message.
If multiple `-m` options are given, their values are
@@ -187,7 +187,7 @@ See linkgit:git-rebase[1] for details.
+
The `-m` option is mutually exclusive with `-c`, `-C`, and `-F`.
--t <file>::
+`-t <file>`::
`--template=<file>`::
When editing the commit message, start the editor with the
contents in the given file. The `commit.template` configuration
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index b70aad6e0f..2201ce6058 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -98,7 +98,7 @@ OPTIONS
in which section and variable names are lowercased, but subsection
names are not.
---get-urlmatch name URL::
+`--get-urlmatch name URL`::
When given a two-part name `section.key`, the value for
`section.<url>.key` whose <url> part matches the best to the
given URL is returned (if no such key exists, the value for
@@ -141,11 +141,11 @@ See also <<FILES>>.
read from or written to if `extensions.worktreeConfig` is
present. If not it's the same as `--local`.
--f config-file::
---file config-file::
+`-f config-file`::
+`--file config-file`::
Use the given config file instead of the one specified by GIT_CONFIG.
---blob blob::
+`--blob blob`::
Similar to `--file` but use the given blob instead of a file. E.g.
you can use 'master:.gitmodules' to read values from the file
`.gitmodules` in the `master` branch. See "SPECIFYING REVISIONS"
@@ -174,7 +174,7 @@ See also <<FILES>>.
the name/value pairs that are matched to only those where the value
is exactly equal to the `value-pattern`.
---type <type>::
+`--type <type>`::
`git config` will ensure that any input or output is valid under the given
type constraint(s), and will canonicalize outgoing values in `<type>`'s
canonical form.
@@ -236,7 +236,7 @@ Valid `<type>`'s include:
all queried config options with the scope of that value
(local, global, system, command).
---get-colorbool name [stdout-is-tty]::
+`--get-colorbool name [stdout-is-tty]`::
Find the color setting for `name` (e.g. `color.diff`) and output
"true" or "false". `stdout-is-tty` should be either "true" or
@@ -247,7 +247,7 @@ Valid `<type>`'s include:
When the color setting for `name` is undefined, the command uses
`color.ui` as fallback.
---get-color name [default]::
+`--get-color name [default]`::
Find the color configured for `name` (e.g. `color.diff.new`) and
output it as the ANSI color escape sequence to the standard
@@ -269,7 +269,7 @@ Valid `<type>`'s include:
using `--file`, `--global`, etc) and `on` when searching all
config files.
---default <value>::
+`--default <value>`::
When using `--get`, and the requested variable is not found, behave as if
<value> were the value assigned to the that variable.
diff --git a/Documentation/git-credential-cache.txt b/Documentation/git-credential-cache.txt
index e9834b8b95..601f23685a 100644
--- a/Documentation/git-credential-cache.txt
+++ b/Documentation/git-credential-cache.txt
@@ -26,11 +26,11 @@ linkgit:gitcredentials[7] or `EXAMPLES` below.
OPTIONS
-------
---timeout <seconds>::
+`--timeout <seconds>`::
Number of seconds to cache credentials (default: 900).
---socket <path>::
+`--socket <path>`::
Use `<path>` to contact a running cache daemon (or start a new
cache daemon if one is not started).
diff --git a/Documentation/git-credential-store.txt b/Documentation/git-credential-store.txt
index 3d83420f0a..7fe4049130 100644
--- a/Documentation/git-credential-store.txt
+++ b/Documentation/git-credential-store.txt
@@ -29,7 +29,7 @@ linkgit:gitcredentials[7] or `EXAMPLES` below.
OPTIONS
-------
---file=<path>::
+`--file=<path>`::
Use `<path>` to lookup and store credentials. The file will have its
filesystem permissions set to prevent other users on the system
diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt
index 64e98c4f1d..8514bbd2b2 100644
--- a/Documentation/git-cvsexportcommit.txt
+++ b/Documentation/git-cvsexportcommit.txt
@@ -105,7 +105,7 @@ Merge one patch into CVS (`-c` and `-w` options). The working directory is withi
$ git cvsexportcommit -v -c -w ~/project_cvs_checkout <commit-sha1>
------------
-Merge pending patches into CVS automatically -- only if you really know what you are doing::
+`Merge pending patches into CVS automatically -- only if you really know what you are doing`::
+
------------
$ export GIT_DIR=~/project/.git
diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt
index 5caeed88ed..c5105348ec 100644
--- a/Documentation/git-cvsimport.txt
+++ b/Documentation/git-cvsimport.txt
@@ -52,7 +52,7 @@ OPTIONS
`-v`::
Verbosity: let 'cvsimport' report what it is doing.
--d <CVSROOT>::
+`-d <CVSROOT>`::
The root of the CVS archive. May be local (a simple path) or remote;
currently, only the :local:, :ext: and :pserver: access methods
are supported. If not given, `git cvsimport` will try to read it
@@ -64,16 +64,16 @@ OPTIONS
If not given, `git cvsimport` tries to read it from
`CVS/Repository`.
--C <target-dir>::
+`-C <target-dir>`::
The Git repository to import to. If the directory doesn't
exist, it will be created. Default is the current directory.
--r <remote>::
+`-r <remote>`::
The Git remote to import this CVS repository into.
Moves all CVS branches into remotes/<remote>/<branch>
akin to the way `git clone` uses `origin` by default.
--o <branch-for-HEAD>::
+`-o <branch-for-HEAD>`::
When no remote is specified (via `-r`) the `HEAD` branch
from CVS is imported to the `origin` branch within the Git
repository, as `HEAD` already has a special meaning for Git.
@@ -98,20 +98,20 @@ the old cvs2git tool.
`-u`::
Convert underscores in tag and branch names to dots.
--s <subst>::
+`-s <subst>`::
Substitute the character "/" in branch names with <subst>
--p <options-for-cvsps>::
+`-p <options-for-cvsps>`::
Additional options for cvsps.
The options `-u` and `-A` are implicit and should not be used here.
+
If you need to pass multiple options, separate them with a comma.
--z <fuzz>::
+`-z <fuzz>`::
Pass the timestamp fuzz factor to cvsps, in seconds. If unset,
cvsps defaults to 300s.
--P <cvsps-output-file>::
+`-P <cvsps-output-file>`::
Instead of calling cvsps, read the provided cvsps output file. Useful
for debugging or when cvsps is being handled outside cvsimport.
@@ -120,7 +120,7 @@ If you need to pass multiple options, separate them with a comma.
will enable default regexes that try to capture the source
branch name from the commit message.
--M <regex>::
+`-M <regex>`::
Attempt to detect merges based on the commit message with a custom
regex. It can be used with `-m` to enable the default regexes
as well. You must escape forward slashes.
@@ -129,18 +129,18 @@ The regex must capture the source branch name in $1.
+
This option can be used several times to provide several detection regexes.
--S <regex>::
+`-S <regex>`::
Skip paths matching the regex.
`-a`::
Import all commits, including recent ones. cvsimport by default
skips commits that have a timestamp less than 10 minutes ago.
--L <limit>::
+`-L <limit>`::
Limit the number of commits imported. Workaround for cases where
cvsimport leaks memory.
--A <author-conv-file>::
+`-A <author-conv-file>`::
CVS by default uses the Unix username when writing its
commit logs. Using this option and an author-conv-file
maps the name recorded in CVS to author name, e-mail and
diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
index 5b7bfe6dc0..23647e12b0 100644
--- a/Documentation/git-cvsserver.txt
+++ b/Documentation/git-cvsserver.txt
@@ -31,7 +31,7 @@ All these options obviously only make sense if enforced by the server side.
They have been implemented to resemble the linkgit:git-daemon[1] options as
closely as possible.
---base-path <path>::
+`--base-path <path>`::
Prepend 'path' to requested CVSROOT
`--strict-paths`::
diff --git a/Documentation/git-describe.txt b/Documentation/git-describe.txt
index 39cecb4ce6..69cc3b2db9 100644
--- a/Documentation/git-describe.txt
+++ b/Documentation/git-describe.txt
@@ -93,7 +93,7 @@ OPTIONS
describe such a commit as v1.2-0-gdeadbee (0th commit since tag v1.2
that points at object deadbee....).
---match <pattern>::
+`--match <pattern>`::
Only consider tags matching the given `glob(7)` pattern,
excluding the `refs/tags/` prefix. If used with `--all`, it also
considers local branches and remote-tracking references matching the
@@ -103,7 +103,7 @@ OPTIONS
matching any of the patterns will be considered. Use `--no-match` to
clear and reset the list of patterns.
---exclude <pattern>::
+`--exclude <pattern>`::
Do not consider tags matching the given `glob(7)` pattern, excluding
the `refs/tags/` prefix. If used with `--all`, it also does not consider
local branches and remote-tracking references matching the pattern,
diff --git a/Documentation/git-diff-files.txt b/Documentation/git-diff-files.txt
index 5a993a309f..9c90566859 100644
--- a/Documentation/git-diff-files.txt
+++ b/Documentation/git-diff-files.txt
@@ -22,10 +22,10 @@ OPTIONS
-------
include::diff-options.txt[]
--1 --base::
--2 --ours::
--3 --theirs::
--0::
+`-1 --base`::
+`-2 --ours`::
+`-3 --theirs`::
+`-0`::
Diff against the "base" version, "our branch" or "their
branch" respectively. With these options, diffs for
merged entries are not shown.
diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 7779631421..de1e14726c 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -117,16 +117,16 @@ OPTIONS
:git-diff: 1
include::diff-options.txt[]
--1 --base::
--2 --ours::
--3 --theirs::
+`-1 --base`::
+`-2 --ours`::
+`-3 --theirs`::
Compare the working tree with the "base" version (stage #1),
"our branch" (stage #2) or "their branch" (stage #3). The
index contains these stages only for unmerged entries i.e.
while resolving conflicts. See linkgit:git-read-tree[1]
section "3-Way Merge" for detailed information.
--0::
+`-0`::
Omit diff output for unmerged entries and just show
"Unmerged". Can be used only when comparing the working tree
with the index.
diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
index f8b1e83404..24a2b7cc36 100644
--- a/Documentation/git-difftool.txt
+++ b/Documentation/git-difftool.txt
@@ -42,7 +42,7 @@ OPTIONS
Start showing the diff for the given path, skipping all
the paths before it.
--t <tool>::
+`-t <tool>`::
`--tool=<tool>`::
Use the diff tool specified by <tool>. Valid values include
emerge, kompare, meld, and vimdiff. Run `git difftool --tool-help`
@@ -86,7 +86,7 @@ with custom merge tool commands and has the same value as `$MERGED`.
Specifying `--no-symlinks` instructs `git difftool` to create copies
instead. `--no-symlinks` is the default on Windows.
--x <command>::
+`-x <command>`::
`--extcmd=<command>`::
Specify a custom command for viewing diffs.
`git-difftool` ignores the configured defaults and runs
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 4a72e4ce44..01b572f565 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -95,25 +95,25 @@ multiple commits.
OPTIONS
-------
---setup <command>::
+`--setup <command>`::
This is not a real filter executed for each commit but a one
time setup just before the loop. Therefore no commit-specific
variables are defined yet. Functions or variables defined here
can be used or modified in the following filter steps except
the commit filter, for technical reasons.
---subdirectory-filter <directory>::
+`--subdirectory-filter <directory>`::
Only look at the history which touches the given subdirectory.
The result will contain that directory (and only that) as its
project root. Implies <<Remap_to_ancestor>>.
---env-filter <command>::
+`--env-filter <command>`::
This filter may be used if you only need to modify the environment
in which the commit will be performed. Specifically, you might
want to rewrite the author/committer name/email/time environment
variables (see linkgit:git-commit-tree[1] for details).
---tree-filter <command>::
+`--tree-filter <command>`::
This is the filter for rewriting the tree and its contents.
The argument is evaluated in shell with the working
directory set to the root of the checked out tree. The new tree
@@ -121,14 +121,14 @@ OPTIONS
are auto-removed - neither .gitignore files nor any other ignore
rules *HAVE ANY EFFECT*!).
---index-filter <command>::
+`--index-filter <command>`::
This is the filter for rewriting the index. It is similar to the
tree filter but does not check out the tree, which makes it much
faster. Frequently used with `git rm --cached
--ignore-unmatch ...`, see EXAMPLES below. For hairy
cases, see linkgit:git-update-index[1].
---parent-filter <command>::
+`--parent-filter <command>`::
This is the filter for rewriting the commit's parent list.
It will receive the parent string on stdin and shall output
the new parent string on stdout. The parent string is in
@@ -136,13 +136,13 @@ OPTIONS
the initial commit, `-p parent` for a normal commit and
`-p parent1 -p parent2 -p parent3 ...` for a merge commit.
---msg-filter <command>::
+`--msg-filter <command>`::
This is the filter for rewriting the commit messages.
The argument is evaluated in the shell with the original
commit message on standard input; its standard output is
used as the new commit message.
---commit-filter <command>::
+`--commit-filter <command>`::
This is the filter for performing the commit.
If this filter is specified, it will be called instead of the
`git commit-tree` command, with arguments of the form
@@ -162,7 +162,7 @@ You can also use the `git_commit_non_empty_tree "$@"` instead of
`git commit-tree "$@"` if you don't wish to keep commits with a single parent
and that makes no change to the tree.
---tag-name-filter <command>::
+`--tag-name-filter <command>`::
This is the filter for rewriting tag names. When passed,
it will be called for every tag ref that points to a rewritten
object (or to a tag object which points to a rewritten object).
@@ -193,11 +193,11 @@ to other tags will be rewritten to point to the underlying commit.
`--commit-filter`, though the same effect can be achieved by using the
provided `git_commit_non_empty_tree` function in a commit filter.
---original <namespace>::
+`--original <namespace>`::
Use this option to set the namespace where the original commits
will be stored. The default value is `refs/original`.
--d <directory>::
+`-d <directory>`::
Use this option to set the path to the temporary directory used for
rewriting. When applying a tree filter, the command needs to
temporarily check out the tree to some directory, which may consume
@@ -211,7 +211,7 @@ to other tags will be rewritten to point to the underlying commit.
directory or when there are already refs starting with
`refs/original/`, unless forced.
---state-branch <branch>::
+`--state-branch <branch>`::
This option will cause the mapping from old to new objects to
be loaded from named branch upon startup and saved as a new
commit to that branch upon exit, enabling incremental of large
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index 283bb59199..1ea37635d8 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -39,13 +39,13 @@ OPTIONS
Synonyms to `--log` and `--no-log`; these are deprecated and will be
removed in the future.
--m <message>::
---message <message>::
+`-m <message>`::
+`--message <message>`::
Use <message> instead of the branch names for the first line
of the log message. For use with `--log`.
--F <file>::
---file <file>::
+`-F <file>`::
+`--file <file>`::
Take the list of merged objects from <file> instead of
stdin.
diff --git a/Documentation/git-for-each-repo.txt b/Documentation/git-for-each-repo.txt
index c2d6cd6629..af959b1cd9 100644
--- a/Documentation/git-for-each-repo.txt
+++ b/Documentation/git-for-each-repo.txt
@@ -33,7 +33,7 @@ in the multi-valued config variable `maintenance.repo`.
OPTIONS
-------
---config=<config>::
+`--config=<config>`::
Use the given config variable as a multi-valued list storing
absolute path names. Iterate on that list of paths to run
the given arguments.
diff --git a/Documentation/git-format-patch.txt b/Documentation/git-format-patch.txt
index 3372e13868..fc2501c9e0 100644
--- a/Documentation/git-format-patch.txt
+++ b/Documentation/git-format-patch.txt
@@ -110,8 +110,8 @@ include::diff-options.txt[]
`-<n>`::
Prepare patches from the topmost <n> commits.
--o <dir>::
---output-directory <dir>::
+`-o <dir>`::
+`--output-directory <dir>`::
Use <dir> to store the resulting files, instead of the
current working directory.
@@ -123,7 +123,7 @@ include::diff-options.txt[]
`--no-numbered`::
Name output in '[PATCH]' format.
---start-number <n>::
+`--start-number <n>`::
Start numbering the patches at <n> instead of 1.
`--numbered-files`::
@@ -180,7 +180,7 @@ Beware that the default for `git send-email` is to thread emails
itself. If you want `git format-patch` to take care of threading, you
will want to ensure that threading is disabled for `git send-email`.
---in-reply-to=<message id>::
+`--in-reply-to=<message id>`::
Make the first mail (or all the mails with `--no-thread`) appear as a
reply to the given <message id>, which avoids breaking threads to
provide a new patch series.
@@ -212,7 +212,7 @@ is greater than 100 bytes, then the mode will be `message`, otherwise
If `<mode>` is `none`, both the cover letter subject and body will be
populated with placeholder text.
---subject-prefix=<subject prefix>::
+`--subject-prefix=<subject prefix>`::
Instead of the standard '[PATCH]' prefix in the subject
line, instead use '[<subject prefix>]'. This
allows for useful naming of a patch series, and can be
@@ -230,7 +230,7 @@ populated with placeholder text.
Comments"; use this when sending an experimental patch for
discussion rather than application.
--v <n>::
+`-v <n>`::
`--reroll-count=<n>`::
Mark the series as the <n>-th iteration of the topic. The
output filenames have `v<n>` prepended to them, and the
diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt
index f942c5a7a6..6c98485d8f 100644
--- a/Documentation/git-fsck.txt
+++ b/Documentation/git-fsck.txt
@@ -129,7 +129,7 @@ using `git commit-graph verify`. See linkgit:git-commit-graph[1].
Extracted Diagnostics
---------------------
-unreachable <type> <object>::
+`unreachable <type> <object>`::
The <type> object <object>, isn't actually referred to directly
or indirectly in any of the trees or commits seen. This can
mean that there's another root node that you're not specifying
@@ -137,15 +137,15 @@ unreachable <type> <object>::
then you might as well delete unreachable nodes since they
can't be used.
-missing <type> <object>::
+`missing <type> <object>`::
The <type> object <object>, is referred to but isn't present in
the database.
-dangling <type> <object>::
+`dangling <type> <object>`::
The <type> object <object>, is present in the database but never
'directly' used. A dangling commit could be a root node.
-hash mismatch <object>::
+`hash mismatch <object>`::
The database has an object whose hash doesn't match the
object database value.
This indicates a serious data integrity problem.
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 478abece38..6f71b659d0 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -118,7 +118,7 @@ OPTIONS
`-I`::
Don't match the pattern in binary files.
---max-depth <depth>::
+`--max-depth <depth>`::
For each <pathspec> given on command line, descend at most <depth>
levels of directories. A value of -1 means no limit.
This option is ignored if <pathspec> contains active wildcards.
@@ -246,18 +246,18 @@ providing this option will cause it to die.
linkgit:gitattributes[5]).
`-<num>`::
--C <num>::
---context <num>::
+`-C <num>`::
+`--context <num>`::
Show <num> leading and trailing lines, and place a line
containing `--` between contiguous groups of matches.
--A <num>::
---after-context <num>::
+`-A <num>`::
+`--after-context <num>`::
Show <num> trailing lines, and place a line containing
`--` between contiguous groups of matches.
--B <num>::
---before-context <num>::
+`-B <num>`::
+`--before-context <num>`::
Show <num> leading lines, and place a line containing
`--` between contiguous groups of matches.
@@ -270,11 +270,11 @@ providing this option will cause it to die.
`git diff` works out patch hunk headers (see 'Defining a
custom hunk-header' in linkgit:gitattributes[5]).
---threads <num>::
+`--threads <num>`::
Number of grep worker threads to use.
See `grep.threads` in 'CONFIGURATION' for more information.
--f <file>::
+`-f <file>`::
Read patterns from <file>, one per line.
+
Passing the pattern via <file> allows for providing a search pattern
diff --git a/Documentation/git-hash-object.txt b/Documentation/git-hash-object.txt
index 40f5574afe..b9f1081f6e 100644
--- a/Documentation/git-hash-object.txt
+++ b/Documentation/git-hash-object.txt
@@ -23,7 +23,7 @@ When <type> is not specified, it defaults to "blob".
OPTIONS
-------
--t <type>::
+`-t <type>`::
Specify the type (default: "blob").
`-w`::
diff --git a/Documentation/git-http-fetch.txt b/Documentation/git-http-fetch.txt
index 63e447642e..0bcdc90294 100644
--- a/Documentation/git-http-fetch.txt
+++ b/Documentation/git-http-fetch.txt
@@ -30,7 +30,7 @@ OPTIONS
`-v`::
Report what is downloaded.
--w <filename>::
+`-w <filename>`::
Writes the commit-id into the filename under `$GIT_DIR/refs/<filename>` on
the local end after the transfer is complete.
diff --git a/Documentation/git-index-pack.txt b/Documentation/git-index-pack.txt
index b42e095f3e..01a212a579 100644
--- a/Documentation/git-index-pack.txt
+++ b/Documentation/git-index-pack.txt
@@ -28,7 +28,7 @@ OPTIONS
`-v`::
Be verbose about what is going on, including progress status.
--o <index-file>::
+`-o <index-file>`::
Write the generated pack index into the specified
file. Without this option the name of pack index
file is constructed from the name of packed archive
diff --git a/Documentation/git-init.txt b/Documentation/git-init.txt
index cfa190859e..b537591829 100644
--- a/Documentation/git-init.txt
+++ b/Documentation/git-init.txt
@@ -62,7 +62,7 @@ include::object-format-disclaimer.txt[]
Specify the directory from which templates will be used. (See the "TEMPLATE
DIRECTORY" section below.)
---separate-git-dir=<git dir>::
+`--separate-git-dir=<git dir>`::
Instead of initializing the repository as a directory to either `$GIT_DIR` or
`./.git/`, create a text file there containing the path to the actual
@@ -71,7 +71,7 @@ repository.
+
If this is reinitialization, the repository will be moved to the specified path.
--b <branch-name>::
+`-b <branch-name>`::
`--initial-branch=<branch-name>`::
Use the specified name for the initial branch in the newly created
@@ -110,7 +110,7 @@ the repository permissions.
Same as 'group', but make the repository readable by all users.
-'0xxx'::
+`0xxx`::
'0xxx' is an octal number and each file will have mode '0xxx'. '0xxx' will
override users' umask(2) value (and not only loosen permissions as 'group' and
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index dc2974c611..be2ba5f545 100644
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -84,7 +84,7 @@ OPTIONS
trailer to the input messages. See the description of this
command.
---where <placement>::
+`--where <placement>`::
`--no-where`::
Specify where all new trailers will be added. A setting
provided with `--where` overrides all configuration variables
@@ -92,7 +92,7 @@ OPTIONS
`--where` or `--no-where`. Possible values are `after`, `before`,
`end` or `start`.
---if-exists <action>::
+`--if-exists <action>`::
`--no-if-exists`::
Specify what action will be performed when there is already at
least one trailer with the same <token> in the message. A setting
@@ -101,7 +101,7 @@ OPTIONS
`--if-exists` or `--no-if-exists`. Possible actions are `addIfDifferent`,
`addIfDifferentNeighbor`, `add`, `replace` and `doNothing`.
---if-missing <action>::
+`--if-missing <action>`::
`--no-if-missing`::
Specify what action will be performed when there is no other
trailer with the same <token> in the message. A setting
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 21f9328681..83555dc7dc 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -79,7 +79,7 @@ produced by `--stat`, etc.
include::line-range-options.txt[]
-<revision range>::
+`<revision range>`::
Show only commits in the specified revision range. When no
<revision range> is specified, it defaults to `HEAD` (i.e. the
whole history leading to the current commit). `origin..HEAD`
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 0e26aafc63..72f1f28902 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -88,13 +88,13 @@ OPTIONS
When any of the `-t`, `--unmerged`, or `--stage` option is
in use, this option has no effect.
--x <pattern>::
+`-x <pattern>`::
`--exclude=<pattern>`::
Skip untracked files matching pattern.
Note that pattern is a shell wildcard pattern. See EXCLUDE PATTERNS
below for more information.
--X <file>::
+`-X <file>`::
`--exclude-from=<file>`::
Read exclude patterns from <file>; 1 per line.
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index 6dc89de377..0bc6dbabf3 100644
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -72,7 +72,7 @@ OPTIONS
themselves will not work for refs whose objects have not yet been
fetched from the remote, and will give a `missing object` error.
--o <option>::
+`-o <option>`::
`--server-option=<option>`::
Transmit the given string to the server when communicating using
protocol version 2. The given string must not contain a NUL or LF
diff --git a/Documentation/git-merge-file.txt b/Documentation/git-merge-file.txt
index d7605b60f0..8caebefcc2 100644
--- a/Documentation/git-merge-file.txt
+++ b/Documentation/git-merge-file.txt
@@ -52,7 +52,7 @@ linkgit:git[1].
OPTIONS
-------
--L <label>::
+`-L <label>`::
This option may be given up to three times, and
specifies labels to be used in place of the
corresponding file names in conflict reports. That is,
@@ -67,7 +67,7 @@ OPTIONS
`-q`::
Quiet; do not warn about conflicts.
---diff3::
+`--diff3`::
Show conflicts in "diff3" style.
`--ours`::
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index de57a4fb54..ac5838dfb0 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -63,7 +63,7 @@ OPTIONS
-------
include::merge-options.txt[]
--m <msg>::
+`-m <msg>`::
Set the commit message to be used for the merge commit (in
case one is created).
+
@@ -74,7 +74,7 @@ The `git fmt-merge-msg` command can be
used to give a good default for automated `git merge`
invocations. The automated message can include the branch description.
--F <file>::
+`-F <file>`::
`--file=<file>`::
Read the commit message to be used for the merge commit (in
case one is created).
diff --git a/Documentation/git-mergetool.txt b/Documentation/git-mergetool.txt
index 1a5b30b293..28f5169268 100644
--- a/Documentation/git-mergetool.txt
+++ b/Documentation/git-mergetool.txt
@@ -24,7 +24,7 @@ the merge tool program on every file with merge conflicts.
OPTIONS
-------
--t <tool>::
+`-t <tool>`::
`--tool=<tool>`::
Use the merge resolution program specified by <tool>.
Valid values include emerge, gvimdiff, kdiff3,
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 16afea280d..9f22359707 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -129,7 +129,7 @@ OPTIONS
When adding notes to an object that already has notes,
overwrite the existing notes (instead of aborting).
--m <msg>::
+`-m <msg>`::
`--message=<msg>`::
Use the given note message (instead of prompting).
If multiple `-m` options are given, their values
@@ -137,20 +137,20 @@ OPTIONS
Lines starting with `#` and empty lines other than a
single line between paragraphs will be stripped out.
--F <file>::
+`-F <file>`::
`--file=<file>`::
Take the note message from the given file. Use '-' to
read the note message from the standard input.
Lines starting with `#` and empty lines other than a
single line between paragraphs will be stripped out.
--C <object>::
+`-C <object>`::
`--reuse-message=<object>`::
Take the given blob object (for example, another note) as the
note message. (Use `git notes copy <object>` instead to
copy notes between objects.)
--c <object>::
+`-c <object>`::
`--reedit-message=<object>`::
Like `-C`, but with `-c` the editor is invoked, so that
the user can further edit the note message.
@@ -159,7 +159,7 @@ OPTIONS
Allow an empty note object to be stored. The default behavior is
to automatically remove empty notes.
---ref <ref>::
+`--ref <ref>`::
Manipulate the notes tree in <ref>. This overrides
`GIT_NOTES_REF` and the `core.notesRef` configuration. The ref
specifies the full refname when it begins with `refs/notes/`; when it
@@ -180,7 +180,7 @@ OPTIONS
Do not remove anything; just report the object names whose notes
would be removed.
--s <strategy>::
+`-s <strategy>`::
`--strategy=<strategy>`::
When merging notes, resolve notes conflicts using the given
strategy. The following strategies are recognized: "manual"
diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index 90280af75b..812d0afd4c 100644
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -202,7 +202,7 @@ General options
~~~~~~~~~~~~~~~
All commands except clone accept these options.
---git-dir <dir>::
+`--git-dir <dir>`::
Set the `GIT_DIR` environment variable. See linkgit:git[1].
`-v`::
@@ -214,7 +214,7 @@ Sync options
These options can be used in the initial 'clone' as well as in
subsequent 'sync' operations.
---branch <ref>::
+`--branch <ref>`::
Import changes into <ref> instead of refs/remotes/p4/master.
If <ref> starts with refs/, it is used as is. Otherwise, if
it does not start with p4/, that prefix is added.
@@ -237,7 +237,7 @@ Git repository:
Use the branch detection algorithm to find new paths in p4. It is
documented below in "BRANCH DETECTION".
---changesfile <file>::
+`--changesfile <file>`::
Import exactly the p4 change numbers listed in 'file', one per
line. Normally, `git p4` inspects the current p4 repository
state and detects the changes it should import.
@@ -261,14 +261,14 @@ Git repository:
sync operations must specify `--import-local` as well so that
they can find the p4 branches in refs/heads.
---max-changes <n>::
+`--max-changes <n>`::
Import at most 'n' changes, rather than the entire range of
changes included in the given revision specifier. A typical
usage would be use '@all' as the revision specifier, but then
to use `--max-changes 1000` to import only the last 1000
revisions rather than the entire revision history.
---changes-block-size <n>::
+`--changes-block-size <n>`::
The internal block size to use when converting a revision
specifier such as '@all' into a list of specific change
numbers. Instead of using a single call to `p4 changes` to
@@ -297,7 +297,7 @@ Clone options
These options can be used in an initial 'clone', along with the 'sync'
options described above.
---destination <directory>::
+`--destination <directory>`::
Where to create the Git repository. If not provided, the last
component in the p4 depot path is used to create a new
directory.
@@ -309,7 +309,7 @@ Submit options
~~~~~~~~~~~~~~
These options can be used to modify `git p4 submit` behavior.
---origin <commit>::
+`--origin <commit>`::
Upstream location from which commits are identified to submit to
p4. By default, this is the most recent p4 commit reachable
from `HEAD`.
@@ -333,7 +333,7 @@ These options can be used to modify `git p4 submit` behavior.
Show just what commits would be submitted to p4; do not change
state in Git or p4.
---prepare-p4-only::
+`--prepare-p4-only`::
Apply a commit to the p4 workspace, opening, adding and deleting
files in p4 as for a normal submit operation. Do not issue the
final `p4 submit`, but instead print a message about how to
@@ -345,7 +345,7 @@ These options can be used to modify `git p4 submit` behavior.
After creating each shelve, the relevant files are reverted/deleted.
If you have multiple commits pending multiple shelves will be created.
---update-shelve CHANGELIST::
+`--update-shelve CHANGELIST`::
Update an existing shelved changelist with this commit. Implies
`--shelve`. Repeat for multiple shelved changelists.
@@ -356,7 +356,7 @@ These options can be used to modify `git p4 submit` behavior.
to bypass the prompt, causing conflicting commits to be automatically
skipped, or to quit trying to apply commits, without prompting.
---branch <branch>::
+`--branch <branch>`::
After submitting, sync this named branch instead of the default
p4/master. See the "Sync options" section above for more
information.
@@ -369,7 +369,7 @@ These options can be used to modify `git p4 submit` behavior.
Disable the automatic rebase after all commits have been successfully
submitted. Can also be set with `git-p4.disableRebase`.
---disable-p4sync::
+`--disable-p4sync`::
Disable the automatic sync of `p4/master` from Perforce after commits have
been submitted. Implies `--disable-rebase`. Can also be set with
`git-p4.disableP4Sync`. Sync with `origin/master` still goes ahead if possible.
diff --git a/Documentation/git-prune.txt b/Documentation/git-prune.txt
index 1e4a2a648f..ff5b13c029 100644
--- a/Documentation/git-prune.txt
+++ b/Documentation/git-prune.txt
@@ -45,7 +45,7 @@ OPTIONS
`--progress`::
Show progress.
---expire <time>::
+`--expire <time>`::
Only expire loose objects older than <time>.
\--::
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index c33ebe5f4a..fc805da72f 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -212,7 +212,7 @@ already exists on the remote side.
Either all refs are updated, or on error, no refs are updated.
If the server does not support atomic pushes the push will fail.
--o <option>::
+`-o <option>`::
`--push-option=<option>`::
Transmit the given string to the server, which passes them to
the pre-receive as well as the post-receive hook. The given string
@@ -419,12 +419,12 @@ Specifying `--no-force-if-includes` disables this behavior.
default is `--verify`, giving the hook a chance to prevent the
push. With `--no-verify`, the hook is bypassed completely.
--4::
---ipv4::
+`-4`::
+`--ipv4`::
Use IPv4 addresses only, ignoring IPv6 addresses.
--6::
---ipv6::
+`-6`::
+`--ipv6`::
Use IPv6 addresses only, ignoring IPv4 addresses.
include::urls-remotes.txt[]
@@ -474,7 +474,7 @@ For a failed update, more details are given:
Git did not try to send the ref at all, typically because it
is not a fast-forward and you did not force the update.
-remote rejected::
+`remote rejected`::
The remote end refused the update. Usually caused by a hook
on the remote side, or because the remote repository has one
of the following safety options in effect:
@@ -483,7 +483,7 @@ remote rejected::
non-fast-forward updates), `receive.denyDeletes` or
`receive.denyDeleteCurrent`. See linkgit:git-config[1].
-remote failure::
+`remote failure`::
The remote end did not report the successful update of the ref,
perhaps because of a temporary error on the remote side, a
break in the network connection, or other transient error.
diff --git a/Documentation/git-quiltimport.txt b/Documentation/git-quiltimport.txt
index c3ec9efe38..c6c64529e4 100644
--- a/Documentation/git-quiltimport.txt
+++ b/Documentation/git-quiltimport.txt
@@ -38,18 +38,18 @@ OPTIONS
a patch. At the time of this writing only missing author
information is warned about.
---author Author Name <Author Email>::
+`--author Author Name <Author Email>`::
The author name and email address to use when no author
information can be found in the patch description.
---patches <dir>::
+`--patches <dir>`::
The directory to find the quilt patches.
+
The default for the patch directory is patches
or the value of the `$QUILT_PATCHES` environment
variable.
---series <file>::
+`--series <file>`::
The quilt series file.
+
The default for the series file is <patches>/series
diff --git a/Documentation/git-range-diff.txt b/Documentation/git-range-diff.txt
index 8703bef8ef..5f20b86e57 100644
--- a/Documentation/git-range-diff.txt
+++ b/Documentation/git-range-diff.txt
@@ -81,14 +81,14 @@ to revert to color all lines according to the outer diff markers
This flag is passed to the `git log` program
(see linkgit:git-log[1]) that generates the patches.
-<range1> <range2>::
+`<range1> <range2>`::
Compare the commits specified by the two ranges, where
`<range1>` is considered an older version of `<range2>`.
<rev1>...<rev2>::
Equivalent to passing `<rev2>..<rev1>` and `<rev1>..<rev2>`.
-<base> <rev1> <rev2>::
+`<base> <rev1> <rev2>`::
Equivalent to passing `<base>..<rev1>` and `<base>..<rev2>`.
Note that `<base>` does not need to be the exact branch point
of the branches. Example: after rebasing a branch `my-topic`,
diff --git a/Documentation/git-rebase.txt b/Documentation/git-rebase.txt
index f32ffaa011..589b2d17c9 100644
--- a/Documentation/git-rebase.txt
+++ b/Documentation/git-rebase.txt
@@ -208,7 +208,7 @@ include::config/sequencer.txt[]
OPTIONS
-------
---onto <newbase>::
+`--onto <newbase>`::
Starting point at which to create the new commits. If the
`--onto` option is not specified, the starting point is
<upstream>. May be any valid commit, and not just an
@@ -358,7 +358,7 @@ other words, the sides are swapped.
+
See also INCOMPATIBLE OPTIONS below.
--s <strategy>::
+`-s <strategy>`::
`--strategy=<strategy>`::
Use the given merge strategy.
If there is no `-s` option `git merge-recursive` is used
@@ -371,7 +371,7 @@ which makes little sense.
+
See also INCOMPATIBLE OPTIONS below.
--X <strategy-option>::
+`-X <strategy-option>`::
`--strategy-option=<strategy-option>`::
Pass the <strategy-option> through to the merge strategy.
This implies `--merge` and, if no strategy has been
@@ -554,8 +554,8 @@ idea unless you know what you are doing (see BUGS below).
+
See also INCOMPATIBLE OPTIONS below.
--x <cmd>::
---exec <cmd>::
+`-x <cmd>`::
+`--exec <cmd>`::
Append "exec <cmd>" after each line creating a commit in the
final history. <cmd> will be interpreted as one or more shell
commands. Any command that fails will interrupt the rebase,
diff --git a/Documentation/git-receive-pack.txt b/Documentation/git-receive-pack.txt
index 921f658bd8..6756a819e9 100644
--- a/Documentation/git-receive-pack.txt
+++ b/Documentation/git-receive-pack.txt
@@ -38,7 +38,7 @@ its behavior, see linkgit:git-config[1].
OPTIONS
-------
-<directory>::
+`<directory>`::
The repository to sync into.
PRE-RECEIVE HOOK
diff --git a/Documentation/git-replace.txt b/Documentation/git-replace.txt
index fc6fc6ae6f..5c6c4892ef 100644
--- a/Documentation/git-replace.txt
+++ b/Documentation/git-replace.txt
@@ -66,7 +66,7 @@ OPTIONS
`--delete`::
Delete existing replace refs for the given objects.
---edit <object>::
+`--edit <object>`::
Edit an object's content interactively. The existing content
for <object> is pretty-printed into a temporary file, an
editor is launched on the file, and the result is parsed to
@@ -96,8 +96,8 @@ OPTIONS
and deletes that file upon success. The purpose is to help users
with transitioning off of the now-deprecated graft file.
--l <pattern>::
---list <pattern>::
+`-l <pattern>`::
+`--list <pattern>`::
List replace refs for objects that match the given pattern (or
all if no pattern is given).
Typing `git replace` without arguments, also lists all replace
diff --git a/Documentation/git-reset.txt b/Documentation/git-reset.txt
index 7e44572383..cf524cd1e5 100644
--- a/Documentation/git-reset.txt
+++ b/Documentation/git-reset.txt
@@ -203,7 +203,7 @@ $ git reset --hard HEAD~3 <1>
"RECOVERING FROM UPSTREAM REBASE" section in linkgit:git-rebase[1]
for the implications of doing so.)
-Undo a merge or pull::
+`Undo a merge or pull`::
+
------------
$ git pull <1>
@@ -253,7 +253,7 @@ $ git reset --merge ORIG_HEAD <2>
want. `git reset --merge` keeps your local changes.
-Interrupted workflow::
+`Interrupted workflow`::
+
Suppose you are interrupted by an urgent fix request while you
are in the middle of a large change. The files in your
@@ -298,7 +298,7 @@ $ git add frotz.c <3>
<2> This commits all other changes in the index.
<3> Adds the file to the index again.
-Keep changes in working tree while discarding some previous commits::
+`Keep changes in working tree while discarding some previous commits`::
+
Suppose you are working on something and you commit it, and then you
continue working a bit more, but now you think that what you have in
diff --git a/Documentation/git-restore.txt b/Documentation/git-restore.txt
index 25a7160aab..e2dfad0b69 100644
--- a/Documentation/git-restore.txt
+++ b/Documentation/git-restore.txt
@@ -32,7 +32,7 @@ THIS COMMAND IS EXPERIMENTAL. THE BEHAVIOR MAY CHANGE.
OPTIONS
-------
--s <tree>::
+`-s <tree>`::
`--source=<tree>`::
Restore the working tree files with the content from the given
tree. It is common to specify the source tree by naming a
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index d84a853018..191ec94ec7 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -74,11 +74,11 @@ Options for Filtering
Options for Output
~~~~~~~~~~~~~~~~~~
---default <arg>::
+`--default <arg>`::
If there is no parameter given by the user, use `<arg>`
instead.
---prefix <arg>::
+`--prefix <arg>`::
Behave as if `git rev-parse` was invoked from the `<arg>`
subdirectory of the working tree. Any relative filenames are
resolved as if they are prefixed by `<arg>` and will be printed
@@ -236,13 +236,13 @@ print a message to stderr and exit with nonzero status.
`--git-common-dir`::
Show `$GIT_COMMON_DIR` if defined, else `$GIT_DIR`.
---resolve-git-dir <path>::
+`--resolve-git-dir <path>`::
Check if <path> is a valid repository or a gitfile that
points at a valid repository, and print the location of the
repository. If <path> is a gitfile then the resolved path
to the real repository is printed.
---git-path <path>::
+`--git-path <path>`::
Resolve `$GIT_DIR/<path>` and takes other path relocation
variables such as `$GIT_OBJECT_DIRECTORY`,
`$GIT_INDEX_FILE`... into account. For example, if
diff --git a/Documentation/git-revert.txt b/Documentation/git-revert.txt
index 5fde44478f..e1f7b574ba 100644
--- a/Documentation/git-revert.txt
+++ b/Documentation/git-revert.txt
@@ -47,8 +47,8 @@ OPTIONS
message prior to committing the revert. This is the default if
you run the command from a terminal.
--m parent-number::
---mainline parent-number::
+`-m parent-number`::
+`--mainline parent-number`::
Usually you cannot revert a merge because you do not know which
side of the merge should be considered the mainline. This
option specifies the parent number (starting from 1) of
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 6e96c23492..958ab5018b 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -124,7 +124,7 @@ is not set, this will be prompted for.
+
This option may be specified multiple times.
---8bit-encoding=<encoding>::
+`--8bit-encoding=<encoding>`::
When encountering a non-ASCII message or subject that does not
declare its encoding, add headers/quoting to indicate it is
encoded in <encoding>. Default is the value of the
diff --git a/Documentation/git-shell.txt b/Documentation/git-shell.txt
index 5b72dc53d6..a52db35d2b 100644
--- a/Documentation/git-shell.txt
+++ b/Documentation/git-shell.txt
@@ -32,7 +32,7 @@ COMMANDS
Call the corresponding server-side command to support
the client's `git push`, `git fetch`, or `git archive --remote`
request.
-'cvs server'::
+`cvs server`::
Imitate a CVS server. See linkgit:git-cvsserver[1].
If a `~/git-shell-commands` directory is present, `git shell` will
diff --git a/Documentation/git-shortlog.txt b/Documentation/git-shortlog.txt
index c3f6997d2e..2d1cdf62d7 100644
--- a/Documentation/git-shortlog.txt
+++ b/Documentation/git-shortlog.txt
@@ -89,7 +89,7 @@ counts both authors and co-authors.
If width is `0` (zero) then indent the lines of the output without wrapping
them.
-<revision range>::
+`<revision range>`::
Show only commits in the specified revision range. When no
<revision range> is specified, it defaults to `HEAD` (i.e. the
whole history leading to the current commit). `origin..HEAD`
diff --git a/Documentation/git-show-branch.txt b/Documentation/git-show-branch.txt
index 017390e1ed..de05271a77 100644
--- a/Documentation/git-show-branch.txt
+++ b/Documentation/git-show-branch.txt
@@ -94,7 +94,7 @@ OPTIONS
`--no-name`::
Do not show naming strings for each commit.
---sha1-name::
+`--sha1-name`::
Instead of naming the commits using the path to reach
them from heads (e.g. "master~2" to mean the grandparent
of "master"), name them with the unique prefix of their
diff --git a/Documentation/git-show-index.txt b/Documentation/git-show-index.txt
index 0d4b36859d..c0304de730 100644
--- a/Documentation/git-show-index.txt
+++ b/Documentation/git-show-index.txt
@@ -39,7 +39,7 @@ index file itself, it's both faster and more flexible.
OPTIONS
-------
---object-format=<hash-algorithm>::
+`--object-format=<hash-algorithm>`::
Specify the given object format (hash algorithm) for the index file. The
valid values are 'sha1' and (if enabled) 'sha256'. The default is the
algorithm for the current repository (set by `extensions.objectFormat`), or
diff --git a/Documentation/git-stash.txt b/Documentation/git-stash.txt
index 974b16963c..9b7c9a5398 100644
--- a/Documentation/git-stash.txt
+++ b/Documentation/git-stash.txt
@@ -67,7 +67,7 @@ save [-p|--patch] [-k|--[no-]keep-index] [-u|--include-untracked] [-a|--all] [-q
Instead, all non-option arguments are concatenated to form the stash
message.
-list [<log-options>]::
+`list [<log-options>]`::
List the stash entries that you currently have. Each 'stash entry' is
listed with its name (e.g. `stash@{0}` is the latest entry, `stash@{1}` is
@@ -111,7 +111,7 @@ apply [--index] [-q|--quiet] [<stash>]::
`<stash>` may be any commit that looks like a commit created by
`stash push` or `stash create`.
-branch <branchname> [<stash>]::
+`branch <branchname> [<stash>]`::
Creates and checks out a new branch named `<branchname>` starting from
the commit at which the `<stash>` was originally created, applies the
diff --git a/Documentation/git-submodule.txt b/Documentation/git-submodule.txt
index 95868792c9..107b3a581e 100644
--- a/Documentation/git-submodule.txt
+++ b/Documentation/git-submodule.txt
@@ -185,7 +185,7 @@ set-branch (-d|--default) [--] <path>::
`--default` option removes the `submodule.<name>.branch` configuration
key, which causes the tracking branch to default to the remote `HEAD`.
-set-url [--] <path> <newurl>::
+`set-url [--] <path> <newurl>`::
Sets the URL of the specified submodule to <newurl>. Then, it will
automatically synchronize the submodule's new remote URL
configuration.
@@ -203,7 +203,7 @@ summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] [<path>...]:
Using the `--submodule=log` option with linkgit:git-diff[1] will provide that
information too.
-foreach [--recursive] <command>::
+`foreach [--recursive] <command>`::
Evaluates an arbitrary shell command in each checked out submodule.
The command has access to the variables `$name`, `$sm_path`, `$displaypath`,
`$sha1` and `$toplevel`:
@@ -277,8 +277,8 @@ OPTIONS
This option is only valid for the deinit command. Unregister all
submodules in the working tree.
--b <branch>::
---branch <branch>::
+`-b <branch>`::
+`--branch <branch>`::
Branch of repository to add as submodule.
The name of the branch is recorded as `submodule.<name>.branch` in
`.gitmodules` for `update --remote`. A special value of `.` is used to
@@ -391,7 +391,7 @@ the submodule itself.
name to the given string instead of defaulting to its path. The name
must be valid as a directory name and may not end with a '/'.
---reference <repository>::
+`--reference <repository>`::
This option is only valid for add and update commands. These
commands sometimes need to clone a remote repository. In this case,
this option will be passed to the linkgit:git-clone[1] command.
@@ -424,8 +424,8 @@ options carefully.
`submodule.<name>.shallow` as provided by the `.gitmodules` file
by default. To ignore the suggestions use `--no-recommend-shallow`.
--j <n>::
---jobs <n>::
+`-j <n>`::
+`--jobs <n>`::
This option is only valid for the update command.
Clone new submodules in parallel with as many jobs.
Defaults to the `submodule.fetchJobs` option.
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 6fca35c8cb..d484152b7a 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -260,7 +260,7 @@ Use of `dcommit` is preferred to `set-tree` (below).
+
`--no-rebase`;;
After committing, do not rebase or reset.
---commit-url <URL>;;
+`--commit-url <URL>`;;
Commit to this SVN URL (the full path). This is intended to
allow existing `git svn` repositories created with one transport
method (e.g. `svn://` or `http://` for anonymous read) to be
@@ -465,12 +465,12 @@ option, or indirectly from the tag or commit when the second tree-ish
denotes such an object, or it is requested by invoking an editor (see
`--edit` option below).
--m <msg>;;
+`-m <msg>`;;
`--message=<msg>`;;
Use the given `msg` as the commit message. This option
disables the `--edit` option.
--F <filename>;;
+`-F <filename>`;;
`--file=<filename>`;;
Take the commit message from the given file. This option
disables the `--edit` option.
@@ -528,7 +528,7 @@ Only the rev_map and refs/remotes/git-svn are changed (see
Follow 'reset' with a `fetch` and then `git reset` or `git rebase` to
move local branches onto the new tree.
--r <n>;;
+`-r <n>`;;
`--revision=<n>`;;
Specify the most recent revision to keep. All later revisions
are discarded.
@@ -579,8 +579,8 @@ OPTIONS
Only used with the `init` command.
These are passed directly to `git init`.
--r <arg>::
---revision <arg>::
+`-r <arg>`::
+`--revision <arg>`::
Used with the `fetch` command.
+
This allows revision ranges for partial/cauterized history
@@ -727,8 +727,8 @@ ADVANCED OPTIONS
when tracking a single URL. The `log` and `dcommit` commands
no longer require this switch as an argument.
--R<remote name>::
---svn-remote <remote name>::
+`-R<remote name>`::
+`--svn-remote <remote name>`::
Specify the [svn-remote "<remote name>"] section to use,
this allows SVN multiple repositories to be tracked.
Default: "svn"
diff --git a/Documentation/git-switch.txt b/Documentation/git-switch.txt
index 44ae45e838..307e2fa097 100644
--- a/Documentation/git-switch.txt
+++ b/Documentation/git-switch.txt
@@ -56,8 +56,8 @@ As a special case, you may use `A...B` as a shortcut for the merge
base of `A` and `B` if there is exactly one merge base. You can leave
out at most one of `A` and `B`, in which case it defaults to `HEAD`.
--c <new-branch>::
---create <new-branch>::
+`-c <new-branch>`::
+`--create <new-branch>`::
Create a new branch named `<new-branch>` starting at
`<start-point>` before switching to the branch. This is a
convenient shortcut for:
@@ -67,8 +67,8 @@ $ git branch <new-branch>
$ git switch <new-branch>
------------
--C <new-branch>::
---force-create <new-branch>::
+`-C <new-branch>`::
+`--force-create <new-branch>`::
Similar to `--create` except that if `<new-branch>` already
exists, it will be reset to `<start-point>`. This is a
convenient shortcut for:
@@ -171,7 +171,7 @@ name, the guessing is aborted. You can explicitly give a name with
Do not set up "upstream" configuration, even if the
`branch.autoSetupMerge` configuration variable is true.
---orphan <new-branch>::
+`--orphan <new-branch>`::
Create a new 'orphan' branch, named `<new-branch>`. All
tracked files are removed.
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 6f125deee3..8c6a00d0aa 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -72,7 +72,7 @@ OPTIONS
Override `tag.gpgSign` configuration variable that is
set to force each and every tag to be signed.
--u <keyid>::
+`-u <keyid>`::
`--local-user=<keyid>`::
Make a GPG-signed tag, using the given key.
@@ -139,27 +139,27 @@ options for details.
+
This option is only applicable when listing tags without annotation lines.
---contains [<commit>]::
+`--contains [<commit>]`::
Only list tags which contain the specified commit (HEAD if not
specified). Implies `--list`.
---no-contains [<commit>]::
+`--no-contains [<commit>]`::
Only list tags which don't contain the specified commit (HEAD if
not specified). Implies `--list`.
---merged [<commit>]::
+`--merged [<commit>]`::
Only list tags whose commits are reachable from the specified
commit (`HEAD` if not specified).
---no-merged [<commit>]::
+`--no-merged [<commit>]`::
Only list tags whose commits are not reachable from the specified
commit (`HEAD` if not specified).
---points-at <object>::
+`--points-at <object>`::
Only list tags of the given object (HEAD if not
specified). Implies `--list`.
--m <msg>::
+`-m <msg>`::
`--message=<msg>`::
Use the given tag message (instead of prompting).
If multiple `-m` options are given, their values are
@@ -167,7 +167,7 @@ This option is only applicable when listing tags without annotation lines.
Implies `-a` if none of `-a`, `-s`, or `-u <keyid>`
is given.
--F <file>::
+`-F <file>`::
`--file=<file>`::
Take the tag message from the given file. Use '-' to
read the message from the standard input.
diff --git a/Documentation/git-unpack-file.txt b/Documentation/git-unpack-file.txt
index 85c5f120e5..f295b26ec7 100644
--- a/Documentation/git-unpack-file.txt
+++ b/Documentation/git-unpack-file.txt
@@ -20,7 +20,7 @@ returns the name of the temporary file in the following format:
OPTIONS
-------
-<blob>::
+`<blob>`::
Must be a blob id
GIT
diff --git a/Documentation/git-update-index.txt b/Documentation/git-update-index.txt
index 7a4925b3c6..8b513910d0 100644
--- a/Documentation/git-update-index.txt
+++ b/Documentation/git-update-index.txt
@@ -73,7 +73,7 @@ OPTIONS
Ignores missing files during a `--refresh`
--cacheinfo <mode>,<object>,<path>::
---cacheinfo <mode> <object> <path>::
+`--cacheinfo <mode> <object> <path>`::
Directly insert the specified info into the index. For
backward compatibility, you can also give these three
arguments as three separate parameters, but new users are
@@ -158,7 +158,7 @@ you will need to handle the situation manually.
`--verbose`::
Report what is being added and removed from index.
---index-version <n>::
+`--index-version <n>`::
Write the resulting index out in the named on-disk format version.
Supported versions are 2, 3 and 4. The current default version is 2
or 3, depending on whether extra features are used, such as
diff --git a/Documentation/git-upload-archive.txt b/Documentation/git-upload-archive.txt
index 36f7901adb..6fb5aa1ba0 100644
--- a/Documentation/git-upload-archive.txt
+++ b/Documentation/git-upload-archive.txt
@@ -54,7 +54,7 @@ access via non-smart-http.
OPTIONS
-------
-<directory>::
+`<directory>`::
The repository to get a tar archive from.
GIT
diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt
index 0e788b1208..5aebb3093d 100644
--- a/Documentation/git-web--browse.txt
+++ b/Documentation/git-web--browse.txt
@@ -41,13 +41,13 @@ Custom commands may also be specified.
OPTIONS
-------
--b <browser>::
---browser=<browser>::
+`-b <browser>`::
+`--browser=<browser>`::
Use the specified browser. It must be in the list of supported
browsers.
--t <browser>::
---tool=<browser>::
+`-t <browser>`::
+`--tool=<browser>`::
Same as above.
-c <conf.var>::
diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt
index d44084a7f4..9dc105f08f 100644
--- a/Documentation/git-worktree.txt
+++ b/Documentation/git-worktree.txt
@@ -58,7 +58,7 @@ specifying `--reason` to explain why the working tree is locked.
COMMANDS
--------
-add <path> [<commit-ish>]::
+`add <path> [<commit-ish>]`::
Create `<path>` and checkout `<commit-ish>` into it. The new working directory
is linked to the current repository, sharing everything except working
@@ -174,8 +174,8 @@ allows the move to proceed; use `--force` twice if the destination is locked.
`remove` refuses to remove an unclean working tree unless `--force` is used.
To remove a locked working tree, specify `--force` twice.
--b <new-branch>::
--B <new-branch>::
+`-b <new-branch>`::
+`-B <new-branch>`::
With `add`, create a new branch named `<new-branch>` starting at
`<commit-ish>`, and check out `<new-branch>` into the new working tree.
If `<commit-ish>` is omitted, it defaults to `HEAD`.
@@ -235,13 +235,13 @@ This can also be set up as the default behaviour by using the
+
With `list`, output additional information about worktrees (see below).
---expire <time>::
+`--expire <time>`::
With `prune`, only expire unused working trees older than `<time>`.
+
With `list`, annotate missing working trees as prunable if they are
older than `<time>`.
---reason <string>::
+`--reason <string>`::
With `lock`, an explanation why the working tree is locked.
`<worktree>`::
diff --git a/Documentation/git.txt b/Documentation/git.txt
index d1389f92c1..8e511669fe 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -53,7 +53,7 @@ displayed. See linkgit:git-help[1] for more information,
because `git --help ...` is converted internally into `git
help ...`.
--C <path>::
+`-C <path>`::
Run as if `git` was started in '<path>' instead of the current working
directory. When multiple `-C` options are given, each subsequent
non-absolute `-C <path>` is interpreted relative to the preceding `-C
@@ -68,7 +68,7 @@ example the following invocations are equivalent:
git --git-dir=a.git --work-tree=b -C c status
git --git-dir=c/a.git --work-tree=c/b status
--c <name>=<value>::
+`-c <name>=<value>`::
Pass a configuration parameter to the command. The value
given will override values from configuration files.
The <name> is expected in the same format as listed by
diff --git a/Documentation/gitattributes.txt b/Documentation/gitattributes.txt
index 0440adf4fc..50397236d2 100644
--- a/Documentation/gitattributes.txt
+++ b/Documentation/gitattributes.txt
@@ -41,7 +41,7 @@ Each attribute can be in one of these states for a given path:
this is specified by listing the name of the attribute
prefixed with a dash `-` in the attribute list.
-Set to a value::
+`Set to a value`::
The path has the attribute with specified string value;
this is specified by listing the name of the attribute
diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index 4fd7300cc4..d4879237f2 100644
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -100,7 +100,7 @@ linkgit:git-rev-list[1] for a complete list.
include::line-range-options.txt[]
-<revision range>::
+`<revision range>`::
Limit the revisions to show. This can be either a single revision
meaning show from the given revision and back, or it can be a range in
diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
index 80681ed5c0..02ae4993bc 100644
--- a/Documentation/gitremote-helpers.txt
+++ b/Documentation/gitremote-helpers.txt
@@ -271,7 +271,7 @@ See REF LIST KEYWORDS for a list of currently defined keywords.
+
Supported if the helper has the "fetch" or "import" capability.
-'list for-push'::
+`list for-push`::
Similar to 'list', except that it is used if and only if
the caller wants to the resulting ref list to prepare
push commands.
@@ -470,10 +470,10 @@ set by Git if the remote helper has the 'option' capability.
'option depth' <depth>::
Deepens the history of a shallow repository.
-'option deepen-since <timestamp>::
+`option deepen-since <timestamp>`::
Deepens the history of a shallow repository based on time.
-'option deepen-not <ref>::
+`option deepen-not <ref>`::
Deepens the history of a shallow repository excluding ref.
Multiple options add up.
@@ -494,7 +494,7 @@ set by Git if the remote helper has the 'option' capability.
but don't actually change any repository data. For most
helpers this only applies to the 'push', if supported.
-'option servpath <c-style-quoted-path>'::
+`option servpath <c-style-quoted-path>`::
Sets service path (--upload-pack, --receive-pack etc.) for
next connect. Remote helper may support this option, but
must not rely on this option being set before
@@ -517,7 +517,7 @@ set by Git if the remote helper has the 'option' capability.
'option pushcert' {'true'|'false'}::
GPG sign pushes.
-'option push-option <string>::
+`option push-option <string>`::
Transmit <string> as a push option. As the push option
must not contain LF or NUL characters, the string is not encoded.
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index 3ade8b7d72..057038bb6d 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -92,9 +92,9 @@ encode SPACE), all whitespace characters as defined in Perl, including SP,
TAB and LF, (used to separate fields in a record).
* Currently recognized fields are:
-<repository path>::
+`<repository path>`::
path to repository GIT_DIR, relative to `$projectroot`
-<repository owner>::
+`<repository owner>`::
displayed as repository owner, preferably full name, or email,
or both
diff --git a/Documentation/merge-options.txt b/Documentation/merge-options.txt
index ec6b02f79a..0812eb032a 100644
--- a/Documentation/merge-options.txt
+++ b/Documentation/merge-options.txt
@@ -107,7 +107,7 @@ With `--squash`, `--commit` is not allowed, and will fail.
This option bypasses the pre-merge and commit-msg hooks.
See also linkgit:githooks[5].
--s <strategy>::
+`-s <strategy>`::
`--strategy=<strategy>`::
Use the given merge strategy; can be supplied more than
once to specify them in the order they should be tried.
@@ -115,7 +115,7 @@ With `--squash`, `--commit` is not allowed, and will fail.
is used instead (`git merge-recursive` when merging a single
head, `git merge-octopus` otherwise).
--X <option>::
+`-X <option>`::
`--strategy-option=<option>`::
Pass merge strategy specific option through to the merge
strategy.
diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt
index b062400072..cfea4f14b4 100644
--- a/Documentation/pull-fetch-param.txt
+++ b/Documentation/pull-fetch-param.txt
@@ -1,17 +1,17 @@
-<repository>::
+`<repository>`::
The "remote" repository that is the source of a fetch
or pull operation. This parameter can be either a URL
(see the section <<URLS,GIT URLS>> below) or the name
of a remote (see the section <<REMOTES,REMOTES>> below).
ifndef::git-pull[]
-<group>::
+`<group>`::
A name referring to a list of repositories as the value
of `remotes.<group>` in the configuration file.
(See linkgit:git-config[1]).
endif::git-pull[]
-<refspec>::
+`<refspec>`::
Specifies which refs to fetch and which local refs to update.
When no <refspec>s appear on the command line, the refs to fetch
are read from `remote.<repository>.fetch` variables instead
diff --git a/Documentation/rev-list-options.txt b/Documentation/rev-list-options.txt
index 7053aa6170..b68f1c19c5 100644
--- a/Documentation/rev-list-options.txt
+++ b/Documentation/rev-list-options.txt
@@ -14,7 +14,7 @@ Note that these are applied before commit
ordering and formatting options, such as `--reverse`.
`-<number>`::
--n <number>::
+`-n <number>`::
`--max-count=<number>`::
Limit the number of commits to output.
@@ -454,7 +454,7 @@ Parent/child relations are only visible with `--parents`, but that does
not affect the commits selected in default mode, so we have shown the
parent lines.
---full-history without parent rewriting::
+`--full-history without parent rewriting`::
This mode differs from the default in one point: always follow
all parents of a merge, even if it is TREESAME to one of them.
Even if more than one side of the merge has commits that are
@@ -473,7 +473,7 @@ Note that without parent rewriting, it is not really possible to talk
about the parent/child relationships between the commits, so we show
them disconnected.
---full-history with parent rewriting::
+`--full-history with parent rewriting`::
Ordinary commits are only included if they are !TREESAME
(though this can be changed, see `--sparse` below).
+
diff --git a/Documentation/revisions.txt b/Documentation/revisions.txt
index 0614772a76..4e9afd9a7d 100644
--- a/Documentation/revisions.txt
+++ b/Documentation/revisions.txt
@@ -318,7 +318,7 @@ three notations also consider its parents. For example you can say
Revision Range Summary
----------------------
-'<rev>'::
+`<rev>`::
Include commits that are reachable from <rev> (i.e. <rev> and its
ancestors).
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 11/13] doc: typeset config option entries in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
` (9 preceding siblings ...)
2021-04-09 4:02 ` [RFC PATCH v1 10/13] doc: typeset more command " Firmin Martin
@ 2021-04-09 4:02 ` Firmin Martin
2021-04-09 4:03 ` [RFC PATCH v1 12/13] doc: typeset environment vars without $ " Firmin Martin
` (2 subsequent siblings)
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:02 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Automatically wrap configuration option entries (i.e. something of the form
<entry>[::|;;]<description>) with backticks as indicated in the
CodingGuidelines.
The following command and regex has performed the whole substitution
(without manual intervention).
REGEX="^([[:space:]]*?)[\"']?([-0-9a-z]+?(?:\.[][ [:alnum:]-=<>]+)+)[\"']?(::|;;)([[:space:]]+|\$)" &&
perl -pi -e "s/$REGEX/\$1\`\$2\`\$3\$4/g" $(grep -Pl "$REGEX" *.txt --exclude-dir=RelNotes)
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/git-apply.txt | 4 +-
Documentation/git-archive.txt | 6 +-
Documentation/git-cvsexportcommit.txt | 2 +-
Documentation/git-cvsserver.txt | 10 ++--
Documentation/git-difftool.txt | 12 ++--
Documentation/git-fast-import.txt | 2 +-
Documentation/git-fmt-merge-msg.txt | 2 +-
Documentation/git-grep.txt | 14 ++---
Documentation/git-http-backend.txt | 6 +-
Documentation/git-interpret-trailers.txt | 18 +++---
Documentation/git-log.txt | 14 ++---
Documentation/git-merge.txt | 2 +-
Documentation/git-notes.txt | 14 ++---
Documentation/git-p4.txt | 72 ++++++++++++------------
Documentation/git-send-email.txt | 8 +--
Documentation/git-svn.txt | 24 ++++----
Documentation/gitmodules.txt | 14 ++---
Documentation/gitrepository-layout.txt | 4 +-
Documentation/gitweb.txt | 2 +-
19 files changed, 115 insertions(+), 115 deletions(-)
diff --git a/Documentation/git-apply.txt b/Documentation/git-apply.txt
index fd681659e8..6fafe4a3b3 100644
--- a/Documentation/git-apply.txt
+++ b/Documentation/git-apply.txt
@@ -253,11 +253,11 @@ has no effect when `--index` or `--cached` is in use.
CONFIGURATION
-------------
-apply.ignoreWhitespace::
+`apply.ignoreWhitespace`::
Set to 'change' if you want changes in whitespace to be ignored by default.
Set to one of: no, none, never, false if you want changes in
whitespace to be significant.
-apply.whitespace::
+`apply.whitespace`::
When no `--whitespace` flag is given from the command
line, this configuration item is used as the default.
diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index 83ce330c9d..830ff2b680 100644
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -103,7 +103,7 @@ zip
CONFIGURATION
-------------
-tar.umask::
+`tar.umask`::
This variable can be used to restrict the permission bits of
tar archive entries. The default is 0002, which turns off the
world write bit. The special value "user" indicates that the
@@ -111,7 +111,7 @@ tar.umask::
details. If `--remote` is used then only the configuration of
the remote repository takes effect.
-tar.<format>.command::
+`tar.<format>.command`::
This variable specifies a shell command through which the tar
output generated by `git archive` should be piped. The command
is executed using the shell with the generated tar file on its
@@ -124,7 +124,7 @@ tar.<format>.command::
The "tar.gz" and "tgz" formats are defined automatically and default to
`gzip -cn`. You may override them with custom commands.
-tar.<format>.remote::
+`tar.<format>.remote`::
If true, enable `<format>` for use by remote clients via
linkgit:git-upload-archive[1]. Defaults to false for
user-defined formats, but true for the "tar.gz" and "tgz"
diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt
index 8514bbd2b2..a9ef265a34 100644
--- a/Documentation/git-cvsexportcommit.txt
+++ b/Documentation/git-cvsexportcommit.txt
@@ -84,7 +84,7 @@ OPTIONS
CONFIGURATION
-------------
-cvsexportcommit.cvsdir::
+`cvsexportcommit.cvsdir`::
The default location of the CVS checkout to use for the export.
EXAMPLES
diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
index 23647e12b0..bd8930eb2b 100644
--- a/Documentation/git-cvsserver.txt
+++ b/Documentation/git-cvsserver.txt
@@ -254,14 +254,14 @@ Configuring database backend
its documentation if changing these variables, especially
about `DBI->connect()`.
-gitcvs.dbName::
+`gitcvs.dbName`::
Database name. The exact meaning depends on the
selected database driver, for SQLite this is a filename.
Supports variable substitution (see below). May
not contain semicolons (`;`).
Default: '%Ggitcvs.%m.sqlite'
-gitcvs.dbDriver::
+`gitcvs.dbDriver`::
Used DBI driver. You can specify any available driver
for this here, but it might not work. cvsserver is tested
with 'DBD::SQLite', reported to work with
@@ -270,16 +270,16 @@ gitcvs.dbDriver::
contain colons (`:`).
Default: 'SQLite'
-gitcvs.dbuser::
+`gitcvs.dbuser`::
Database user. Only useful if setting `dbDriver`, since
SQLite has no concept of database users. Supports variable
substitution (see below).
-gitcvs.dbPass::
+`gitcvs.dbPass`::
Database password. Only useful if setting `dbDriver`, since
SQLite has no concept of database passwords.
-gitcvs.dbTableNamePrefix::
+`gitcvs.dbTableNamePrefix`::
Database table name prefix. Supports variable substitution
(see below). Any non-alphabetic characters will be replaced
with underscores.
diff --git a/Documentation/git-difftool.txt b/Documentation/git-difftool.txt
index 24a2b7cc36..4b895fe7f9 100644
--- a/Documentation/git-difftool.txt
+++ b/Documentation/git-difftool.txt
@@ -118,25 +118,25 @@ CONFIG VARIABLES
`git difftool` falls back to `git mergetool` config variables when the
difftool equivalents have not been defined.
-diff.tool::
+`diff.tool`::
The default diff tool to use.
-diff.guitool::
+`diff.guitool`::
The default diff tool to use when `--gui` is specified.
-difftool.<tool>.path::
+`difftool.<tool>.path`::
Override the path for the given tool. This is useful in case
your tool is not in the PATH.
-difftool.<tool>.cmd::
+`difftool.<tool>.cmd`::
Specify the command to invoke the specified diff tool.
+
See the `--tool=<tool>` option above for more details.
-difftool.prompt::
+`difftool.prompt`::
Prompt before each invocation of the diff tool.
-difftool.trustExitCode::
+`difftool.trustExitCode`::
Exit difftool if the invoked diff tool returns a non-zero exit status.
+
See the `--trust-exit-code` option above for more details.
diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt
index cfbb47665f..6830332297 100644
--- a/Documentation/git-fast-import.txt
+++ b/Documentation/git-fast-import.txt
@@ -172,7 +172,7 @@ Performance and Compression Tuning
Maximum size of each output packfile.
The default is unlimited.
-fastimport.unpackLimit::
+`fastimport.unpackLimit`::
See linkgit:git-config[1]
PERFORMANCE
diff --git a/Documentation/git-fmt-merge-msg.txt b/Documentation/git-fmt-merge-msg.txt
index 1ea37635d8..fc9076377c 100644
--- a/Documentation/git-fmt-merge-msg.txt
+++ b/Documentation/git-fmt-merge-msg.txt
@@ -53,7 +53,7 @@ CONFIGURATION
-------------
include::config/fmt-merge-msg.txt[]
-merge.summary::
+`merge.summary`::
Synonym to `merge.log`; this is deprecated and will be removed in
the future.
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 6f71b659d0..0a0d0f3f57 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -41,31 +41,31 @@ characters. An empty string as search expression matches all lines.
CONFIGURATION
-------------
-grep.lineNumber::
+`grep.lineNumber`::
If set to true, enable `-n` option by default.
-grep.column::
+`grep.column`::
If set to true, enable the `--column` option by default.
-grep.patternType::
+`grep.patternType`::
Set the default matching behavior. Using a value of 'basic', 'extended',
'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
`--fixed-strings`, or `--perl-regexp` option accordingly, while the
value 'default' will return to the default matching behavior.
-grep.extendedRegexp::
+`grep.extendedRegexp`::
If set to true, enable `--extended-regexp` option by default. This
option is ignored when the `grep.patternType` option is set to a value
other than 'default'.
-grep.threads::
+`grep.threads`::
Number of grep worker threads to use. If unset (or set to 0), Git will
use as many threads as the number of logical cores available.
-grep.fullName::
+`grep.fullName`::
If set to true, enable `--full-name` option by default.
-grep.fallbackToNoIndex::
+`grep.fallbackToNoIndex`::
If set to true, fall back to `git grep --no-index` if `git grep`
is executed outside of a `git` repository. Defaults to false.
diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt
index d512add556..a286c3648f 100644
--- a/Documentation/git-http-backend.txt
+++ b/Documentation/git-http-backend.txt
@@ -34,7 +34,7 @@ SERVICES
These services can be enabled/disabled using the per-repository
configuration file:
-http.getanyfile::
+`http.getanyfile`::
This serves Git clients older than version 1.6.6 that are unable to use the
upload pack service. When enabled, clients are able to read
any file within the repository, including objects that are
@@ -42,12 +42,12 @@ http.getanyfile::
It is enabled by default, but a repository can disable it
by setting this configuration item to `false`.
-http.uploadpack::
+`http.uploadpack`::
This serves `git fetch-pack` and `git ls-remote` clients.
It is enabled by default, but a repository can disable it
by setting this configuration item to `false`.
-http.receivepack::
+`http.receivepack`::
This serves `git send-pack` clients, allowing push. It is
disabled by default for anonymous users, and enabled by
default for users authenticated by the web server. It can be
diff --git a/Documentation/git-interpret-trailers.txt b/Documentation/git-interpret-trailers.txt
index be2ba5f545..54c69ea087 100644
--- a/Documentation/git-interpret-trailers.txt
+++ b/Documentation/git-interpret-trailers.txt
@@ -134,7 +134,7 @@ OPTIONS
CONFIGURATION VARIABLES
-----------------------
-trailer.separators::
+`trailer.separators`::
This option tells which characters are recognized as trailer
separators. By default only ':' is recognized as a trailer
separator, except that '=' is always accepted on the command
@@ -151,7 +151,7 @@ the default separator used, so by default trailers will appear like:
'<token>% <value>' (one percent sign and one space will appear between
the token and the value).
-trailer.where::
+`trailer.where`::
This option tells where a new trailer will be added.
+
This can be `end`, which is the default, `start`, `after` or `before`.
@@ -168,7 +168,7 @@ last trailer with the same <token>.
If it is `before`, then each new trailer will appear just before the
first trailer with the same <token>.
-trailer.ifexists::
+`trailer.ifexists`::
This option makes it possible to choose what action will be
performed when there is already at least one trailer with the
same <token> in the message.
@@ -194,7 +194,7 @@ will be added.
With `doNothing`, nothing will be done; that is no new trailer will be
added if there is already one with the same <token> in the message.
-trailer.ifmissing::
+`trailer.ifmissing`::
This option makes it possible to choose what action will be
performed when there is not yet any trailer with the same
<token> in the message.
@@ -206,7 +206,7 @@ With `add`, a new trailer will be added.
+
With `doNothing`, nothing will be done.
-trailer.<token>.key::
+`trailer.<token>.key`::
This `key` will be used instead of <token> in the trailer. At
the end of this key, a separator can appear and then some
space characters. By default the only valid separator is ':',
@@ -216,22 +216,22 @@ trailer.<token>.key::
If there is a separator, then the key will be used instead of both the
<token> and the default separator when adding the trailer.
-trailer.<token>.where::
+`trailer.<token>.where`::
This option takes the same values as the `trailer.where`
configuration variable and it overrides what is specified by
that option for trailers with the specified <token>.
-trailer.<token>.ifexists::
+`trailer.<token>.ifexists`::
This option takes the same values as the `trailer.ifexists`
configuration variable and it overrides what is specified by
that option for trailers with the specified <token>.
-trailer.<token>.ifmissing::
+`trailer.<token>.ifmissing`::
This option takes the same values as the `trailer.ifmissing`
configuration variable and it overrides what is specified by
that option for trailers with the specified <token>.
-trailer.<token>.command::
+`trailer.<token>.command`::
This option can be used to specify a shell command that will
be called to automatically add or modify a trailer with the
specified <token>.
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 83555dc7dc..e8b1033f50 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -188,16 +188,16 @@ CONFIGURATION
See linkgit:git-config[1] for core variables and linkgit:git-diff[1]
for settings related to diff generation.
-format.pretty::
+`format.pretty`::
Default for the `--format` option. (See 'Pretty Formats' above.)
Defaults to `medium`.
-i18n.logOutputEncoding::
+`i18n.logOutputEncoding`::
Encoding to use when displaying logs. (See 'Discussion' above.)
Defaults to the value of `i18n.commitEncoding` if set, and UTF-8
otherwise.
-log.date::
+`log.date`::
Default format for human-readable dates. (Compare the
`--date` option.) Defaults to "default", which means to write
dates like `Sat May 8 19:35:34 2010 -0500`.
@@ -206,26 +206,26 @@ If the format is set to "auto:foo" and the pager is in use, format
"foo" will be the used for the date format. Otherwise "default" will
be used.
-log.follow::
+`log.follow`::
If `true`, `git log` will act as if the `--follow` option was used when
a single <path> is given. This has the same limitations as `--follow`,
i.e. it cannot be used to follow multiple files and does not work well
on non-linear history.
-log.showRoot::
+`log.showRoot`::
If `false`, `git log` and related commands will not treat the
initial commit as a big creation event. Any root commits in
`git log -p` output would be shown without a diff attached.
The default is `true`.
-log.showSignature::
+`log.showSignature`::
If `true`, `git log` and related commands will act as if the
`--show-signature` option was passed to them.
mailmap.*::
See linkgit:git-shortlog[1].
-notes.displayRef::
+`notes.displayRef`::
Which refs, in addition to the default set by `core.notesRef`
or `GIT_NOTES_REF`, to read notes from when showing commit
messages with the `log` family of commands. See
diff --git a/Documentation/git-merge.txt b/Documentation/git-merge.txt
index ac5838dfb0..226ec907c1 100644
--- a/Documentation/git-merge.txt
+++ b/Documentation/git-merge.txt
@@ -358,7 +358,7 @@ CONFIGURATION
-------------
include::config/merge.txt[]
-branch.<name>.mergeOptions::
+`branch.<name>.mergeOptions`::
Sets default options for merging into branch <name>. The syntax and
supported options are the same as those of `git merge`, but option
values containing whitespace characters are currently not supported.
diff --git a/Documentation/git-notes.txt b/Documentation/git-notes.txt
index 9f22359707..50f76c7c69 100644
--- a/Documentation/git-notes.txt
+++ b/Documentation/git-notes.txt
@@ -310,13 +310,13 @@ some special-purpose tools to do something useful with them.
CONFIGURATION
-------------
-core.notesRef::
+`core.notesRef`::
Notes ref to read and manipulate instead of
`refs/notes/commits`. Must be an unabbreviated ref name.
This setting can be overridden through the environment and
command line.
-notes.mergeStrategy::
+`notes.mergeStrategy`::
Which merge strategy to choose by default when resolving notes
conflicts. Must be one of `manual`, `ours`, `theirs`, `union`, or
`cat_sort_uniq`. Defaults to `manual`. See "NOTES MERGE STRATEGIES"
@@ -324,13 +324,13 @@ notes.mergeStrategy::
+
This setting can be overridden by passing the `--strategy` option.
-notes.<name>.mergeStrategy::
+`notes.<name>.mergeStrategy`::
Which merge strategy to choose when doing a notes merge into
refs/notes/<name>. This overrides the more general
`notes.mergeStrategy`. See the "NOTES MERGE STRATEGIES" section above
for more information on each available strategy.
-notes.displayRef::
+`notes.displayRef`::
Which ref (or refs, if a glob or specified more than once), in
addition to the default set by `core.notesRef` or
`GIT_NOTES_REF`, to read notes from when showing commit
@@ -339,7 +339,7 @@ notes.displayRef::
`GIT_NOTES_DISPLAY_REF` environment variable.
See linkgit:git-log[1].
-notes.rewrite.<command>::
+`notes.rewrite.<command>`::
When rewriting commits with <command> (currently `amend` or
`rebase`), if this variable is `false`, `git` will not copy
notes from the original to the rewritten commit. Defaults to
@@ -348,7 +348,7 @@ notes.rewrite.<command>::
This setting can be overridden by the `GIT_NOTES_REWRITE_REF`
environment variable.
-notes.rewriteMode::
+`notes.rewriteMode`::
When copying notes during a rewrite, what to do if the target
commit already has a note. Must be one of `overwrite`,
`concatenate`, `cat_sort_uniq`, or `ignore`. Defaults to
@@ -357,7 +357,7 @@ notes.rewriteMode::
This setting can be overridden with the `GIT_NOTES_REWRITE_MODE`
environment variable.
-notes.rewriteRef::
+`notes.rewriteRef`::
When copying notes during a rewrite, specifies the (fully
qualified) ref whose notes should be copied. May be a glob,
in which case notes in all matching refs will be copied. You
diff --git a/Documentation/git-p4.txt b/Documentation/git-p4.txt
index 812d0afd4c..f7666634c0 100644
--- a/Documentation/git-p4.txt
+++ b/Documentation/git-p4.txt
@@ -559,30 +559,30 @@ They all are in the `git-p4` section.
General variables
~~~~~~~~~~~~~~~~~
-git-p4.user::
+`git-p4.user`::
User specified as an option to all p4 commands, with `-u <user>`.
The environment variable `P4USER` can be used instead.
-git-p4.password::
+`git-p4.password`::
Password specified as an option to all p4 commands, with
`-P <password>`.
The environment variable `P4PASS` can be used instead.
-git-p4.port::
+`git-p4.port`::
Port specified as an option to all p4 commands, with
`-p <port>`.
The environment variable `P4PORT` can be used instead.
-git-p4.host::
+`git-p4.host`::
Host specified as an option to all p4 commands, with
`-h <host>`.
The environment variable `P4HOST` can be used instead.
-git-p4.client::
+`git-p4.client`::
Client specified as an option to all p4 commands, with
`-c <client>`, including the client spec.
-git-p4.retries::
+`git-p4.retries`::
Specifies the number of times to retry a p4 command (notably,
`p4 sync`) if the network times out. The default value is 3.
Set the value to 0 to disable retries or if your p4 version
@@ -590,20 +590,20 @@ git-p4.retries::
Clone and sync variables
~~~~~~~~~~~~~~~~~~~~~~~~
-git-p4.syncFromOrigin::
+`git-p4.syncFromOrigin`::
Because importing commits from other Git repositories is much faster
than importing them from p4, a mechanism exists to find p4 changes
first in Git remotes. If branches exist under `refs/remote/origin/p4`,
those will be fetched and used when syncing from p4. This
variable can be set to 'false' to disable this behavior.
-git-p4.branchUser::
+`git-p4.branchUser`::
One phase in branch detection involves looking at p4 branches
to find new ones to import. By default, all branches are
inspected. This option limits the search to just those owned
by the single user named in the variable.
-git-p4.branchList::
+`git-p4.branchList`::
List of branches to be imported when branch detection is
enabled. Each entry should be a pair of branch names separated
by a colon (:). This example declares that both branchA and
@@ -614,31 +614,31 @@ git config git-p4.branchList main:branchA
git config --add git-p4.branchList main:branchB
-------------
-git-p4.ignoredP4Labels::
+`git-p4.ignoredP4Labels`::
List of p4 labels to ignore. This is built automatically as
unimportable labels are discovered.
-git-p4.importLabels::
+`git-p4.importLabels`::
Import p4 labels into `git`, as per `--import-labels`.
-git-p4.labelImportRegexp::
+`git-p4.labelImportRegexp`::
Only p4 labels matching this regular expression will be imported. The
default value is '[a-zA-Z0-9_\-.]+$'.
-git-p4.useClientSpec::
+`git-p4.useClientSpec`::
Specify that the p4 client spec should be used to identify p4
depot paths of interest. This is equivalent to specifying the
option `--use-client-spec`. See the "CLIENT SPEC" section above.
This variable is a boolean, not the name of a p4 client.
-git-p4.pathEncoding::
+`git-p4.pathEncoding`::
Perforce keeps the encoding of a path as given by the originating OS.
Git expects paths encoded as UTF-8. Use this config to tell `git-p4`
what encoding Perforce had used for the paths. This encoding is used
to transcode the paths to UTF-8. As an example, Perforce on Windows
often uses "cp1252" to encode path names.
-git-p4.largeFileSystem::
+`git-p4.largeFileSystem`::
Specify the system that is used for large (binary) files. Please note
that large file systems do not support the `git p4 submit` command.
Only Git LFS is implemented right now (see https://git-lfs.github.com/
@@ -649,30 +649,30 @@ git-p4.largeFileSystem::
git config git-p4.largeFileSystem GitLFS
-------------
-git-p4.largeFileExtensions::
+`git-p4.largeFileExtensions`::
All files matching a file extension in the list will be processed
by the large file system. Do not prefix the extensions with '.'.
-git-p4.largeFileThreshold::
+`git-p4.largeFileThreshold`::
All files with an uncompressed size exceeding the threshold will be
processed by the large file system. By default the threshold is
defined in bytes. Add the suffix k, m, or g to change the unit.
-git-p4.largeFileCompressedThreshold::
+`git-p4.largeFileCompressedThreshold`::
All files with a compressed size exceeding the threshold will be
processed by the large file system. This option might slow down
your clone/sync process. By default the threshold is defined in
bytes. Add the suffix k, m, or g to change the unit.
-git-p4.largeFilePush::
+`git-p4.largeFilePush`::
Boolean variable which defines if large files are automatically
pushed to a server.
-git-p4.keepEmptyCommits::
+`git-p4.keepEmptyCommits`::
A changelist that contains only excluded files will be imported
as an empty commit if this boolean option is set to true.
-git-p4.mapUser::
+`git-p4.mapUser`::
Map a P4 user to a name and email address in Git. Use a string
with the following format to create a mapping:
+
@@ -685,69 +685,69 @@ multiple P4 user can be defined.
Submit variables
~~~~~~~~~~~~~~~~
-git-p4.detectRenames::
+`git-p4.detectRenames`::
Detect renames. See linkgit:git-diff[1]. This can be true,
false, or a score as expected by `git diff -M`.
-git-p4.detectCopies::
+`git-p4.detectCopies`::
Detect copies. See linkgit:git-diff[1]. This can be true,
false, or a score as expected by `git diff -C`.
-git-p4.detectCopiesHarder::
+`git-p4.detectCopiesHarder`::
Detect copies harder. See linkgit:git-diff[1]. A boolean.
-git-p4.preserveUser::
+`git-p4.preserveUser`::
On submit, re-author changes to reflect the Git author,
regardless of who invokes `git p4 submit`.
-git-p4.allowMissingP4Users::
+`git-p4.allowMissingP4Users`::
When 'preserveUser' is true, `git p4` normally dies if it
cannot find an author in the p4 user map. This setting
submits the change regardless.
-git-p4.skipSubmitEdit::
+`git-p4.skipSubmitEdit`::
The submit process invokes the editor before each p4 change
is submitted. If this setting is true, though, the editing
step is skipped.
-git-p4.skipSubmitEditCheck::
+`git-p4.skipSubmitEditCheck`::
After editing the p4 change message, `git p4` makes sure that
the description really was changed by looking at the file
modification time. This option disables that test.
-git-p4.allowSubmit::
+`git-p4.allowSubmit`::
By default, any branch can be used as the source for a `git p4
submit` operation. This configuration variable, if set, permits only
the named branches to be used as submit sources. Branch names
must be the short names (no `refs/heads/`), and should be
separated by commas (","), with no spaces.
-git-p4.skipUserNameCheck::
+`git-p4.skipUserNameCheck`::
If the user running `git p4 submit` does not exist in the p4
user map, `git p4` exits. This option can be used to force
submission regardless.
-git-p4.attemptRCSCleanup::
+`git-p4.attemptRCSCleanup`::
If enabled, `git p4 submit` will attempt to cleanup RCS keywords
($Header$, etc). These would otherwise cause merge conflicts and prevent
the submit going ahead. This option should be considered experimental at
present.
-git-p4.exportLabels::
+`git-p4.exportLabels`::
Export Git tags to p4 labels, as per `--export-labels`.
-git-p4.labelExportRegexp::
+`git-p4.labelExportRegexp`::
Only p4 labels matching this regular expression will be exported. The
default value is '[a-zA-Z0-9_\-.]+$'.
-git-p4.conflict::
+`git-p4.conflict`::
Specify submit behavior when a conflict with p4 is found, as per
`--conflict`. The default behavior is 'ask'.
-git-p4.disableRebase::
+`git-p4.disableRebase`::
Do not rebase the tree against p4/master following a submit.
-git-p4.disableP4Sync::
+`git-p4.disableP4Sync`::
Do not sync p4/master with Perforce following a submit. Implies `git-p4.disableRebase`.
IMPLEMENTATION DETAILS
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 958ab5018b..abd617524c 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -443,11 +443,11 @@ Information
CONFIGURATION
-------------
-sendemail.aliasesFile::
+`sendemail.aliasesFile`::
To avoid typing long email addresses, point this to one or more
email aliases files. You must also supply `sendemail.aliasFileType`.
-sendemail.aliasFileType::
+`sendemail.aliasFileType`::
Format of the file(s) specified in `sendemail.aliasesFile`. Must be
one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus', or 'sendmail'.
+
@@ -468,13 +468,13 @@ described below:
recognized by the parser.
--
-sendemail.multiEdit::
+`sendemail.multiEdit`::
If true (default), a single editor instance will be spawned to edit
files you have to edit (patches when `--annotate` is used, and the
summary when `--compose` is used). If false, files will be edited one
after the other, spawning a new editor each time.
-sendemail.confirm::
+`sendemail.confirm`::
Sets the default for whether to confirm before sending. Must be
one of 'always', 'never', 'cc', 'compose', or 'auto'. See `--confirm`
in the previous section for the meaning of these values.
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index d484152b7a..5e31bd8088 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -755,8 +755,8 @@ config key: `svn.followparent`
CONFIG FILE-ONLY OPTIONS
------------------------
-svn.noMetadata::
-svn-remote.<name>.noMetadata::
+`svn.noMetadata`::
+`svn-remote.<name>.noMetadata`::
This gets rid of the 'git-svn-id:' lines at the end of every commit.
+
This option can only be used for one-shot imports as `git svn`
@@ -776,8 +776,8 @@ https://github.com/newren/git-filter-repo[git-filter-repo] instead.
filter-repo also allows reformatting of metadata for ease-of-reading
and rewriting authorship info for non-`svn.authorsFile` users.
-svn.useSvmProps::
-svn-remote.<name>.useSvmProps::
+`svn.useSvmProps`::
+`svn-remote.<name>.useSvmProps`::
This allows `git svn` to re-map repository URLs and UUIDs from
mirrors created using SVN::Mirror (or svk) for metadata.
+
@@ -789,26 +789,26 @@ introduce a helper function that returns the original identity
URL and UUID, and use it when generating metadata in commit
messages.
-svn.useSvnsyncProps::
-svn-remote.<name>.useSvnsyncprops::
+`svn.useSvnsyncProps`::
+`svn-remote.<name>.useSvnsyncprops`::
Similar to the useSvmProps option; this is for users
of the svnsync(1) command distributed with SVN 1.4.x and
later.
-svn-remote.<name>.rewriteRoot::
+`svn-remote.<name>.rewriteRoot`::
This allows users to create repositories from alternate
URLs. For example, an administrator could run `git svn` on the
server locally (accessing via `file://`) but wish to distribute
the repository with a public `http://` or `svn://` URL in the
metadata so users of it will see the public URL.
-svn-remote.<name>.rewriteUUID::
+`svn-remote.<name>.rewriteUUID`::
Similar to the useSvmProps option; this is for users who need
to remap the UUID manually. This may be useful in situations
where the original UUID is not available via either useSvmProps
or useSvnsyncProps.
-svn-remote.<name>.pushurl::
+`svn-remote.<name>.pushurl`::
Similar to Git's `remote.<name>.pushurl`, this key is designed
to be used in cases where 'url' points to an SVN repository
@@ -818,7 +818,7 @@ svn-remote.<name>.pushurl::
either 'commiturl' or 'pushurl' could be used, 'commiturl'
takes precedence.
-svn.brokenSymlinkWorkaround::
+`svn.brokenSymlinkWorkaround`::
This disables potentially expensive checks to workaround
broken symlinks checked into SVN by broken clients. Set this
option to "false" if you track a SVN repository with many
@@ -827,13 +827,13 @@ svn.brokenSymlinkWorkaround::
revision fetched. If unset, `git svn` assumes this option to
be "true".
-svn.pathnameencoding::
+`svn.pathnameencoding`::
This instructs `git svn` to recode pathnames to a given encoding.
It can be used by windows users and by those who work in non-utf8
locales to avoid corrupted file names with non-ASCII characters.
Valid encodings are the ones supported by Perl's Encode module.
-svn-remote.<name>.automkdirs::
+`svn-remote.<name>.automkdirs`::
Normally, the `git svn clone` and `git svn rebase` commands
attempt to recreate empty directories that are in the
Subversion repository. If this option is set to "false", then
diff --git a/Documentation/gitmodules.txt b/Documentation/gitmodules.txt
index 861a8ae778..e4e5ecded2 100644
--- a/Documentation/gitmodules.txt
+++ b/Documentation/gitmodules.txt
@@ -23,13 +23,13 @@ submodule has been added unless it was customized with the `--name`
option of `git submodule add`. Each submodule section also contains the
following required keys:
-submodule.<name>.path::
+`submodule.<name>.path`::
Defines the path, relative to the top-level directory of the Git
working tree, where the submodule is expected to be checked out.
The path name must not end with a `/`. All submodule paths must
be unique within the `.gitmodules` file.
-submodule.<name>.url::
+`submodule.<name>.url`::
Defines a URL from which the submodule repository can be cloned.
This may be either an absolute URL ready to be passed to
linkgit:git-clone[1] or (if it begins with `./` or `../`) a location
@@ -37,7 +37,7 @@ submodule.<name>.url::
In addition, there are a number of optional keys:
-submodule.<name>.update::
+`submodule.<name>.update`::
Defines the default update procedure for the named submodule,
i.e. how the submodule is updated by the `git submodule update`
command in the superproject. This is only used by `git
@@ -47,7 +47,7 @@ submodule.<name>.update::
linkgit:git-submodule[1] for their meaning. For security
reasons, the '!command' form is not accepted here.
-submodule.<name>.branch::
+`submodule.<name>.branch`::
A remote branch name for tracking updates in the upstream submodule.
If the option is not specified, it defaults to the remote `HEAD`.
A special value of `.` is used to indicate that the name of the branch
@@ -55,7 +55,7 @@ submodule.<name>.branch::
current repository. See the `--remote` documentation in
linkgit:git-submodule[1] for details.
-submodule.<name>.fetchRecurseSubmodules::
+`submodule.<name>.fetchRecurseSubmodules`::
This option can be used to control recursive fetching of this
submodule. If this option is also present in the submodule's entry in
`.git/config` of the superproject, the setting there will override the
@@ -63,7 +63,7 @@ submodule.<name>.fetchRecurseSubmodules::
Both settings can be overridden on the command line by using the
`--[no-]recurse-submodules` option to `git fetch` and `git pull`.
-submodule.<name>.ignore::
+`submodule.<name>.ignore`::
Defines under what circumstances `git status` and the diff family show
a submodule as modified. The following values are supported:
+
@@ -93,7 +93,7 @@ Both settings can be overridden on the command line by using the
affected by this setting.
--
-submodule.<name>.shallow::
+`submodule.<name>.shallow`::
When set to true, a clone of this submodule will be performed as a
shallow clone (with a history depth of 1) unless the user explicitly
asks for a non-shallow clone.
diff --git a/Documentation/gitrepository-layout.txt b/Documentation/gitrepository-layout.txt
index c639ea8cc6..8d2cc46d44 100644
--- a/Documentation/gitrepository-layout.txt
+++ b/Documentation/gitrepository-layout.txt
@@ -145,7 +145,7 @@ for details.
if `$GIT_COMMON_DIR` is set and `$GIT_COMMON_DIR/config` will be
used instead.
-config.worktree::
+`config.worktree`::
Working directory specific configuration file for the main
working directory in multiple working directory setup (see
linkgit:git-worktree[1]).
@@ -182,7 +182,7 @@ config.worktree::
The current index file for the repository. It is
usually not found in a bare repository.
-sharedindex.<SHA-1>::
+`sharedindex.<SHA-1>`::
The shared index part, to be referenced by `$GIT_DIR/index` and
other temporary index files. Only valid in split index mode.
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index 057038bb6d..e863f739b1 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -254,7 +254,7 @@ This is per-repository enhancement / version of global prefix-based
`@git_base_url_list` `gitweb` configuration variable (see
linkgit:gitweb.conf[5]).
-gitweb.owner::
+`gitweb.owner`::
You can use the `gitweb.owner` repository configuration variable to set
repository's owner. It is displayed in the project list and summary
page.
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 12/13] doc: typeset environment vars without $ in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
` (10 preceding siblings ...)
2021-04-09 4:02 ` [RFC PATCH v1 11/13] doc: typeset config option " Firmin Martin
@ 2021-04-09 4:03 ` Firmin Martin
2021-04-09 4:03 ` [RFC PATCH v1 13/13] doc: typeset common programs " Firmin Martin
2021-04-12 13:37 ` [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Jean-Noël Avila
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:03 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Wrap environment variables without $ with backticks as indicated in the
CodingGuidelines.
The following command and regex assisted the substitution with manual
intervention to exclude false positives.
REGEX="(^|[[:space:]]+)['\"]?([A-Z]+)(_[A-Z0-9]+)+['\"]?([[:punct:]]|[[:space:]]+|$)" &&
for f in $(grep -Pl "$REGEX" *.txt --exclude-dir=RelNotes); do
emacsclient $f;
done
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/diff-options.txt | 2 +-
Documentation/git-commit.txt | 12 ++++++------
Documentation/git-config.txt | 18 +++++++++---------
Documentation/git-cvsexportcommit.txt | 4 ++--
Documentation/git-cvsimport.txt | 4 ++--
Documentation/git-cvsserver.txt | 22 +++++++++++-----------
Documentation/git-daemon.txt | 8 ++++----
Documentation/git-filter-branch.txt | 6 +++---
Documentation/git-for-each-ref.txt | 2 +-
Documentation/git-fsck.txt | 10 +++++-----
Documentation/git-http-backend.txt | 22 +++++++++++-----------
Documentation/git-imap-send.txt | 4 ++--
Documentation/git-ls-remote.txt | 2 +-
Documentation/git-remote-ext.txt | 6 +++---
Documentation/git-remote-fd.txt | 2 +-
Documentation/git-rev-parse.txt | 4 ++--
Documentation/git-send-email.txt | 4 ++--
Documentation/git-sh-setup.txt | 4 ++--
Documentation/git-svn.txt | 2 +-
Documentation/git-tag.txt | 2 +-
Documentation/git-var.txt | 8 ++++----
Documentation/git.txt | 12 ++++++------
Documentation/gitignore.txt | 2 +-
Documentation/gitnamespaces.txt | 6 +++---
Documentation/gitweb.conf.txt | 10 +++++-----
Documentation/gitweb.txt | 10 +++++-----
Documentation/glossary-content.txt | 2 +-
27 files changed, 95 insertions(+), 95 deletions(-)
diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 1b594732aa..0e44e9c2db 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -695,7 +695,7 @@ the normal order.
--
+
Patterns have the same syntax and semantics as patterns used for
-fnmatch(3) without the FNM_PATHNAME flag, except a pathname also
+fnmatch(3) without the `FNM_PATHNAME` flag, except a pathname also
matches a pattern if removing any number of the final pathname
components matches the pattern. For example, the pattern "`foo*bar`"
matches "`fooasdfbar`" and "`foo/bar/baz/asdf`" but not "`foobarx`".
diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
index 0594ed1db5..b58eda6bfb 100644
--- a/Documentation/git-commit.txt
+++ b/Documentation/git-commit.txt
@@ -504,12 +504,12 @@ COMMIT INFORMATION
Author and committer information is taken from the following environment
variables, if set:
- GIT_AUTHOR_NAME
- GIT_AUTHOR_EMAIL
- GIT_AUTHOR_DATE
- GIT_COMMITTER_NAME
- GIT_COMMITTER_EMAIL
- GIT_COMMITTER_DATE
+ `GIT_AUTHOR_NAME`
+ `GIT_AUTHOR_EMAIL`
+ `GIT_AUTHOR_DATE`
+ `GIT_COMMITTER_NAME`
+ `GIT_COMMITTER_EMAIL`
+ `GIT_COMMITTER_DATE`
(nb "<", ">" and "\n"s are stripped)
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index 2201ce6058..e2e0c51535 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -143,7 +143,7 @@ See also <<FILES>>.
`-f config-file`::
`--file config-file`::
- Use the given config file instead of the one specified by GIT_CONFIG.
+ Use the given config file instead of the one specified by `GIT_CONFIG`.
`--blob blob`::
Similar to `--file` but use the given blob instead of a file. E.g.
@@ -335,25 +335,25 @@ can specify any filename you want.
ENVIRONMENT
-----------
-GIT_CONFIG::
+`GIT_CONFIG`::
Take the configuration from the given file instead of `.git/config`.
Using the `--global` option forces this to `~/.gitconfig`. Using the
`--system` option forces this to `$(prefix)/etc/gitconfig`.
-GIT_CONFIG_NOSYSTEM::
+`GIT_CONFIG_NOSYSTEM`::
Whether to skip reading settings from the system-wide
`$(prefix)/etc/gitconfig` file. See linkgit:git[1] for details.
See also <<FILES>>.
-GIT_CONFIG_COUNT::
-GIT_CONFIG_KEY_<n>::
-GIT_CONFIG_VALUE_<n>::
- If GIT_CONFIG_COUNT is set to a positive number, all environment pairs
- GIT_CONFIG_KEY_<n> and GIT_CONFIG_VALUE_<n> up to that number will be
+`GIT_CONFIG_COUNT`::
+`GIT_CONFIG_KEY_`<n>::
+`GIT_CONFIG_VALUE_`<n>::
+ If `GIT_CONFIG_COUNT` is set to a positive number, all environment pairs
+ `GIT_CONFIG_KEY_`<n> and `GIT_CONFIG_VALUE_`<n> up to that number will be
added to the process's runtime configuration. The config pairs are
zero-indexed. Any missing key or value is treated as an error. An empty
- GIT_CONFIG_COUNT is treated the same as GIT_CONFIG_COUNT=0, namely no
+ `GIT_CONFIG_COUNT` is treated the same as `GIT_CONFIG_COUNT`=0, namely no
pairs are processed. These environment variables will override values
in configuration files, but will be overridden by any explicit options
passed via `git -c`.
diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt
index a9ef265a34..bc4a82822a 100644
--- a/Documentation/git-cvsexportcommit.txt
+++ b/Documentation/git-cvsexportcommit.txt
@@ -19,7 +19,7 @@ Exports a commit from Git to a CVS checkout, making it easier
to merge patches from a Git repository into a CVS repository.
Specify the name of a CVS checkout using the `-w` switch or execute it
-from the root of the CVS working copy. In the latter case GIT_DIR must
+from the root of the CVS working copy. In the latter case `GIT_DIR` must
be defined. See examples below.
It does its best to do the safe thing, it will check that the files are
@@ -70,7 +70,7 @@ OPTIONS
`-w`::
Specify the location of the CVS checkout to use for the export. This
- option does not require GIT_DIR to be set before execution if the
+ option does not require `GIT_DIR` to be set before execution if the
current directory is within a Git repository. The default is the
value of `cvsexportcommit.cvsdir`.
diff --git a/Documentation/git-cvsimport.txt b/Documentation/git-cvsimport.txt
index c5105348ec..9bed5e943f 100644
--- a/Documentation/git-cvsimport.txt
+++ b/Documentation/git-cvsimport.txt
@@ -153,8 +153,8 @@ This option can be used several times to provide several detection regexes.
---------
+
`git cvsimport` will make it appear as those authors had
-their GIT_AUTHOR_NAME and GIT_AUTHOR_EMAIL set properly
-all along. If a time zone is specified, GIT_AUTHOR_DATE will
+their `GIT_AUTHOR_NAME` and `GIT_AUTHOR_EMAIL` set properly
+all along. If a time zone is specified, `GIT_AUTHOR_DATE` will
have the corresponding offset applied.
+
For convenience, this data is saved to `$GIT_DIR/cvs-authors`
diff --git a/Documentation/git-cvsserver.txt b/Documentation/git-cvsserver.txt
index bd8930eb2b..2ec7fae1ee 100644
--- a/Documentation/git-cvsserver.txt
+++ b/Documentation/git-cvsserver.txt
@@ -11,7 +11,7 @@ SYNOPSIS
SSH:
[verse]
-export CVS_SERVER="git cvsserver"
+export `CVS_SERVER`="git cvsserver"
'cvs' -d :ext:user@server/path/repo.git co <HEAD_name>
pserver (/etc/inetd.conf):
@@ -131,11 +131,11 @@ Then provide your password via the pserver method, for example:
cvs -d:pserver:someuser:somepassword <at> server/path/repo.git co <HEAD_name>
------
No special setup is needed for SSH access, other than having Git tools
-in the PATH. If you have clients that do not accept the CVS_SERVER
+in the PATH. If you have clients that do not accept the `CVS_SERVER`
environment variable, you can rename `git-cvsserver` to `cvs`.
Note: Newer CVS versions (>= 1.12.11) also support specifying
-CVS_SERVER directly in CVSROOT like
+`CVS_SERVER` directly in CVSROOT like
------
cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co <HEAD_name>
@@ -143,7 +143,7 @@ cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co <HEAD_name>
This has the advantage that it will be saved in your 'CVS/Root' files and
you don't need to worry about always setting the correct environment
variable. SSH users restricted to `git-shell` don't need to override the default
-with CVS_SERVER (and shouldn't) as `git-shell` understands `cvs` to mean
+with `CVS_SERVER` (and shouldn't) as `git-shell` understands `cvs` to mean
`git-cvsserver` and pretends that the other end runs the real 'cvs' better.
--
2. For each repo that you want accessible from CVS you need to edit config in
@@ -182,7 +182,7 @@ allowing access over SSH.
automatically saving it in your 'CVS/Root' files, then you need to set them
explicitly in your environment. CVSROOT should be set as per normal, but the
directory should point at the appropriate Git repo. As above, for SSH clients
- _not_ restricted to `git-shell`, CVS_SERVER should be set to `git-cvsserver`.
+ _not_ restricted to `git-shell`, `CVS_SERVER` should be set to `git-cvsserver`.
+
--
------
@@ -192,8 +192,8 @@ allowing access over SSH.
--
4. For SSH clients that will make commits, make sure their server-side
.ssh/environment files (or .bashrc, etc., according to their specific shell)
- export appropriate values for GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL,
- GIT_COMMITTER_NAME, and GIT_COMMITTER_EMAIL. For SSH clients whose login
+ export appropriate values for `GIT_AUTHOR_NAME`, `GIT_AUTHOR_EMAIL`,
+ `GIT_COMMITTER_NAME`, and `GIT_COMMITTER_EMAIL`. For SSH clients whose login
shell is bash, .bashrc may be a reasonable alternative.
5. Clients should now be able to check out the project. Use the CVS 'module'
@@ -312,9 +312,9 @@ ENVIRONMENT
These variables obviate the need for command-line options in some
circumstances, allowing easier restricted usage through `git-shell`.
-GIT_CVSSERVER_BASE_PATH takes the place of the argument to `--base-path`.
+`GIT_CVSSERVER_BASE_PATH` takes the place of the argument to `--base-path`.
-GIT_CVSSERVER_ROOT specifies a single-directory whitelist. The
+`GIT_CVSSERVER_ROOT` specifies a single-directory whitelist. The
repository must still be configured to allow access through
`git-cvsserver`, as described above.
@@ -337,12 +337,12 @@ To get a checkout with the Eclipse CVS client:
Protocol notes: If you are using anonymous access via pserver, just select that.
Those using SSH access should choose the 'ext' protocol, and configure 'ext'
-access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to
+access on the Preferences->Team->CVS->ExtConnection pane. Set `CVS_SERVER` to
"`git cvsserver`". Note that password support is not good when using 'ext',
you will definitely want to have SSH keys setup.
Alternatively, you can just use the non-standard extssh protocol that Eclipse
-offer. In that case CVS_SERVER is ignored, and you will have to replace
+offer. In that case `CVS_SERVER` is ignored, and you will have to replace
the cvs utility on the server with `git-cvsserver` or manipulate your `.bashrc`
so that calling 'cvs' effectively calls `git-cvsserver`.
diff --git a/Documentation/git-daemon.txt b/Documentation/git-daemon.txt
index 533be2b997..e4006d0459 100644
--- a/Documentation/git-daemon.txt
+++ b/Documentation/git-daemon.txt
@@ -25,7 +25,7 @@ SYNOPSIS
DESCRIPTION
-----------
-A really simple TCP Git daemon that normally listens on port "DEFAULT_GIT_PORT"
+A really simple TCP Git daemon that normally listens on port `DEFAULT_GIT_PORT`
aka 9418. It waits for a connection asking for a service, and will serve
that service if it is enabled.
@@ -149,7 +149,7 @@ otherwise `stderr`.
Log details about the incoming connections and requested files.
`--reuseaddr`::
- Use SO_REUSEADDR when binding the listening socket.
+ Use `SO_REUSEADDR` when binding the listening socket.
This allows the server to restart without waiting for
old connections to time out.
@@ -330,8 +330,8 @@ selectively enable/disable services per repository::
ENVIRONMENT
-----------
-`git daemon` will set REMOTE_ADDR to the IP address of the client
-that connected to it, if the IP address is available. REMOTE_ADDR will
+`git daemon` will set `REMOTE_ADDR` to the IP address of the client
+that connected to it, if the IP address is available. `REMOTE_ADDR` will
be available in the environment of hooks called when
services are performed.
diff --git a/Documentation/git-filter-branch.txt b/Documentation/git-filter-branch.txt
index 01b572f565..34e36493fe 100644
--- a/Documentation/git-filter-branch.txt
+++ b/Documentation/git-filter-branch.txt
@@ -75,9 +75,9 @@ The filters are applied in the order as listed below. The <command>
argument is always evaluated in the shell context using the 'eval' command
(with the notable exception of the commit filter, for technical reasons).
Prior to that, the `$GIT_COMMIT` environment variable will be set to contain
-the id of the commit being rewritten. Also, GIT_AUTHOR_NAME,
-GIT_AUTHOR_EMAIL, GIT_AUTHOR_DATE, GIT_COMMITTER_NAME, GIT_COMMITTER_EMAIL,
-and GIT_COMMITTER_DATE are taken from the current commit and exported to
+the id of the commit being rewritten. Also, `GIT_AUTHOR_NAME`,
+`GIT_AUTHOR_EMAIL`, `GIT_AUTHOR_DATE`, `GIT_COMMITTER_NAME`, `GIT_COMMITTER_EMAIL`,
+and `GIT_COMMITTER_DATE` are taken from the current commit and exported to
the environment, in order to affect the author and committer identities of
the replacement commit created by linkgit:git-commit-tree[1] after the
filters have run.
diff --git a/Documentation/git-for-each-ref.txt b/Documentation/git-for-each-ref.txt
index 74be946d9d..5f52b386c1 100644
--- a/Documentation/git-for-each-ref.txt
+++ b/Documentation/git-for-each-ref.txt
@@ -132,7 +132,7 @@ For all objects, the following names can be used:
The object name (aka SHA-1).
For a non-ambiguous abbreviation of the object name append `:short`.
For an abbreviation of the object name with desired length append
- `:short=<length>`, where the minimum length is MINIMUM_ABBREV. The
+ `:short=<length>`, where the minimum length is `MINIMUM_ABBREV`. The
length may be exceeded to ensure unique object names.
`deltabase`::
This expands to the object name of the delta base for the
diff --git a/Documentation/git-fsck.txt b/Documentation/git-fsck.txt
index 6c98485d8f..7ab9123d58 100644
--- a/Documentation/git-fsck.txt
+++ b/Documentation/git-fsck.txt
@@ -52,9 +52,9 @@ index file, all SHA-1 references in `refs` namespace, and all reflogs
now aren't, but are still in that corresponding reflog.
`--full`::
- Check not just objects in GIT_OBJECT_DIRECTORY
+ Check not just objects in `GIT_OBJECT_DIRECTORY`
(`$GIT_DIR/objects`), but also the ones found in alternate
- object pools listed in GIT_ALTERNATE_OBJECT_DIRECTORIES
+ object pools listed in `GIT_ALTERNATE_OBJECT_DIRECTORIES`
or `$GIT_DIR/objects/info/alternates`,
and in packed Git archives found in `$GIT_DIR/objects/pack`
and corresponding pack subdirectories in alternate
@@ -153,13 +153,13 @@ Extracted Diagnostics
Environment Variables
---------------------
-GIT_OBJECT_DIRECTORY::
+`GIT_OBJECT_DIRECTORY`::
used to specify the object database root (usually `$GIT_DIR/objects`)
-GIT_INDEX_FILE::
+`GIT_INDEX_FILE`::
used to specify the index file of the index
-GIT_ALTERNATE_OBJECT_DIRECTORIES::
+`GIT_ALTERNATE_OBJECT_DIRECTORIES`::
used to specify additional object database roots (usually unset)
GIT
diff --git a/Documentation/git-http-backend.txt b/Documentation/git-http-backend.txt
index a286c3648f..6fcbc88567 100644
--- a/Documentation/git-http-backend.txt
+++ b/Documentation/git-http-backend.txt
@@ -57,10 +57,10 @@ configuration file:
URL TRANSLATION
---------------
To determine the location of the repository on disk, `git http-backend`
-concatenates the environment variables PATH_INFO, which is set
-automatically by the web server, and GIT_PROJECT_ROOT, which must be set
-manually in the web server configuration. If GIT_PROJECT_ROOT is not
-set, `git http-backend` reads PATH_TRANSLATED, which is also set
+concatenates the environment variables `PATH_INFO`, which is set
+automatically by the web server, and `GIT_PROJECT_ROOT`, which must be set
+manually in the web server configuration. If `GIT_PROJECT_ROOT` is not
+set, `git http-backend` reads `PATH_TRANSLATED`, which is also set
automatically by the web server.
EXAMPLES
@@ -70,7 +70,7 @@ to `/var/www/git/foo/bar.git`.
Apache 2.x::
Ensure mod_cgi, mod_alias, and mod_env are enabled, set
- GIT_PROJECT_ROOT (or DocumentRoot) appropriately, and
+ `GIT_PROJECT_ROOT` (or DocumentRoot) appropriately, and
create a ScriptAlias to the CGI:
+
----------------------------------------------------------------
@@ -244,12 +244,12 @@ ENVIRONMENT
`git http-backend` relies upon the `CGI` environment variables set
by the invoking web server, including:
-* PATH_INFO (if GIT_PROJECT_ROOT is set, otherwise PATH_TRANSLATED)
-* REMOTE_USER
-* REMOTE_ADDR
-* CONTENT_TYPE
-* QUERY_STRING
-* REQUEST_METHOD
+* `PATH_INFO` (if `GIT_PROJECT_ROOT` is set, otherwise `PATH_TRANSLATED`)
+* `REMOTE_USER`
+* `REMOTE_ADDR`
+* `CONTENT_TYPE`
+* `QUERY_STRING`
+* `REQUEST_METHOD`
The `GIT_HTTP_EXPORT_ALL` environmental variable may be passed to
`git-http-backend` to bypass the check for the `git-daemon-export-ok`
diff --git a/Documentation/git-imap-send.txt b/Documentation/git-imap-send.txt
index 644fa7e847..b1eae4550f 100644
--- a/Documentation/git-imap-send.txt
+++ b/Documentation/git-imap-send.txt
@@ -39,12 +39,12 @@ OPTIONS
`--curl`::
Use libcurl to communicate with the IMAP server, unless tunneling
- into it. Ignored if Git was built without the USE_CURL_FOR_IMAP_SEND
+ into it. Ignored if Git was built without the `USE_CURL_FOR_IMAP_SEND`
option set.
`--no-curl`::
Talk to the IMAP server using git's own IMAP routines instead of
- using libcurl. Ignored if Git was built with the NO_OPENSSL option
+ using libcurl. Ignored if Git was built with the `NO_OPENSSL` option
set.
diff --git a/Documentation/git-ls-remote.txt b/Documentation/git-ls-remote.txt
index 0bc6dbabf3..929749e6c0 100644
--- a/Documentation/git-ls-remote.txt
+++ b/Documentation/git-ls-remote.txt
@@ -42,7 +42,7 @@ OPTIONS
`--upload-pack=<exec>`::
Specify the full path of `git-upload-pack` on the remote
host. This allows listing references from repositories accessed via
- SSH and where the SSH daemon does not use the PATH configured by the
+ SSH and where the SSH daemon does not use the `PATH` configured by the
user.
`--exit-code`::
diff --git a/Documentation/git-remote-ext.txt b/Documentation/git-remote-ext.txt
index 49057434cd..bc0f315078 100644
--- a/Documentation/git-remote-ext.txt
+++ b/Documentation/git-remote-ext.txt
@@ -58,17 +58,17 @@ some tunnel.
ENVIRONMENT VARIABLES
---------------------
-GIT_TRANSLOOP_DEBUG::
+`GIT_TRANSLOOP_DEBUG`::
If set, prints debugging information about various reads/writes.
ENVIRONMENT VARIABLES PASSED TO COMMAND
---------------------------------------
-GIT_EXT_SERVICE::
+`GIT_EXT_SERVICE`::
Set to long name (`git-upload-pack`, etc...) of service helper needs
to invoke.
-GIT_EXT_SERVICE_NOPREFIX::
+`GIT_EXT_SERVICE_NOPREFIX`::
Set to long name (upload-pack, etc...) of service helper needs
to invoke.
diff --git a/Documentation/git-remote-fd.txt b/Documentation/git-remote-fd.txt
index 239844f827..ce61ae4165 100644
--- a/Documentation/git-remote-fd.txt
+++ b/Documentation/git-remote-fd.txt
@@ -30,7 +30,7 @@ context.
ENVIRONMENT VARIABLES
---------------------
-GIT_TRANSLOOP_DEBUG::
+`GIT_TRANSLOOP_DEBUG`::
If set, prints debugging information about various reads/writes.
EXAMPLES
diff --git a/Documentation/git-rev-parse.txt b/Documentation/git-rev-parse.txt
index 191ec94ec7..8d7b157429 100644
--- a/Documentation/git-rev-parse.txt
+++ b/Documentation/git-rev-parse.txt
@@ -208,7 +208,7 @@ Options for Files
`--local-env-vars`::
List the GIT_* environment variables that are local to the
- repository (e.g. GIT_DIR or GIT_WORK_TREE, but not GIT_EDITOR).
+ repository (e.g. `GIT_DIR` or `GIT_WORK_TREE`, but not `GIT_EDITOR`).
Only the names of the variables are listed, not their value,
even if they are set.
@@ -385,7 +385,7 @@ Example
~~~~~~~
------------
-OPTS_SPEC="\
+`OPTS_SPEC`="\
some-command [<options>] <args>...
some-command does foo and bar!
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index abd617524c..87ef1ceff3 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -63,7 +63,7 @@ This option may be specified multiple times.
This option may be specified multiple times.
`--compose`::
- Invoke a text editor (see GIT_EDITOR in linkgit:git-var[1])
+ Invoke a text editor (see `GIT_EDITOR` in linkgit:git-var[1])
to edit an introductory message for the patch series.
+
When `--compose` is used, `git send-email` will use the From, Subject, and
@@ -81,7 +81,7 @@ See the CONFIGURATION section for `sendemail.multiEdit`.
the value of the `sendemail.from` configuration option is used. If
neither the command-line option nor `sendemail.from` are set, then the
user will be prompted for the value. The default for the prompt will be
- the value of GIT_AUTHOR_IDENT, or GIT_COMMITTER_IDENT if that is not
+ the value of `GIT_AUTHOR_IDENT`, or `GIT_COMMITTER_IDENT` if that is not
set, as returned by `git var -l`.
`--reply-to=<address>`::
diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt
index d1e999d60e..2cd438ca1b 100644
--- a/Documentation/git-sh-setup.txt
+++ b/Documentation/git-sh-setup.txt
@@ -81,8 +81,8 @@ require_clean_work_tree rebase "Please commit or stash them."
----------------
get_author_ident_from_commit::
- outputs code for use with eval to set the GIT_AUTHOR_NAME,
- GIT_AUTHOR_EMAIL and GIT_AUTHOR_DATE variables for a given commit.
+ outputs code for use with eval to set the `GIT_AUTHOR_NAME`,
+ `GIT_AUTHOR_EMAIL` and `GIT_AUTHOR_DATE` variables for a given commit.
create_virtual_base::
modifies the first file so only lines in common with the
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 5e31bd8088..0185ff1d1b 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -722,7 +722,7 @@ ADVANCED OPTIONS
-i<GIT_SVN_ID>::
--id <GIT_SVN_ID>::
- This sets GIT_SVN_ID (instead of using the environment). This
+ This sets `GIT_SVN_ID` (instead of using the environment). This
allows the user to override the default refname to fetch from
when tracking a single URL. The `log` and `dcommit` commands
no longer require this switch as an argument.
diff --git a/Documentation/git-tag.txt b/Documentation/git-tag.txt
index 8c6a00d0aa..23b259fc60 100644
--- a/Documentation/git-tag.txt
+++ b/Documentation/git-tag.txt
@@ -366,7 +366,7 @@ the tag object affects, for example, the ordering of tags in the
`gitweb` interface.
To set the date used in future tag objects, set the environment
-variable GIT_COMMITTER_DATE (see the later discussion of possible
+variable `GIT_COMMITTER_DATE` (see the later discussion of possible
values; the most common form is "YYYY-MM-DD HH:MM").
For example:
diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt
index a33b76589a..82448d40a4 100644
--- a/Documentation/git-var.txt
+++ b/Documentation/git-var.txt
@@ -31,13 +31,13 @@ EXAMPLES
VARIABLES
---------
-GIT_AUTHOR_IDENT::
+`GIT_AUTHOR_IDENT`::
The author of a piece of code.
-GIT_COMMITTER_IDENT::
+`GIT_COMMITTER_IDENT`::
The person who put a piece of code into Git.
-GIT_EDITOR::
+`GIT_EDITOR`::
Text editor for use by Git commands. The value is meant to be
interpreted by the shell when it is used. Examples: `~/bin/vi`,
`$SOME_ENVIRONMENT_VARIABLE`, `"C:\Program Files\Vim\gvim.exe"
@@ -49,7 +49,7 @@ ifdef::git-default-editor[]
The build you are using chose '{git-default-editor}' as the default.
endif::git-default-editor[]
-GIT_PAGER::
+`GIT_PAGER`::
Text viewer for use by Git commands (e.g., 'less'). The value
is meant to be interpreted by the shell. The order of preference
is the `$GIT_PAGER` environment variable, then `core.pager`
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 8e511669fe..2328f8bd0b 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -104,7 +104,7 @@ sensitive information can be part of the key.
`--exec-path[=<path>]`::
Path to wherever your core Git programs are installed.
- This can also be controlled by setting the GIT_EXEC_PATH
+ This can also be controlled by setting the `GIT_EXEC_PATH`
environment variable. If no path is given, `git` will print
the current setting and then exit.
@@ -153,7 +153,7 @@ If you just want to run `git` as if it was started in `<path>` then use
`--work-tree=<path>`::
Set the path to the working tree. It can be an absolute path
or a path relative to the current working directory.
- This can also be controlled by setting the GIT_WORK_TREE
+ This can also be controlled by setting the `GIT_WORK_TREE`
environment variable and the `core.worktree` configuration
variable (see `core.worktree` in linkgit:git-config[1] for a
more detailed discussion).
@@ -169,7 +169,7 @@ If you just want to run `git` as if it was started in `<path>` then use
context about the superproject that invoked it.
`--bare`::
- Treat the repository as a bare repository. If GIT_DIR
+ Treat the repository as a bare repository. If `GIT_DIR`
environment is not set, it is set to the current working
directory.
@@ -493,7 +493,7 @@ double-quotes and respecting backslash escapes. E.g., the value
set, it is a list of directories that Git should not chdir up
into while looking for a repository directory (useful for
excluding slow-loading network directories). It will not
- exclude the current working directory or a GIT_DIR set on the
+ exclude the current working directory or a `GIT_DIR` set on the
command line or in the environment. Normally, Git has to read
the entries in this list and resolve any symlink that
might be present in order to compare them with the current
@@ -520,7 +520,7 @@ double-quotes and respecting backslash escapes. E.g., the value
taken from `$GIT_DIR`. See linkgit:gitrepository-layout[5] and
linkgit:git-worktree[1] for
details. This variable has lower precedence than other path
- variables such as GIT_INDEX_FILE, GIT_OBJECT_DIRECTORY...
+ variables such as `GIT_INDEX_FILE`, `GIT_OBJECT_DIRECTORY`...
`GIT_DEFAULT_HASH`::
If this variable is set, the default hash algorithm for new
@@ -582,7 +582,7 @@ Git Diffs
+
where:
- <old|new>-file:: are files GIT_EXTERNAL_DIFF can use to read the
+ <old|new>-file:: are files `GIT_EXTERNAL_DIFF` can use to read the
contents of <old|new>,
<old|new>-hex:: are the 40-hexdigit SHA-1 hashes,
<old|new>-mode:: are the octal representation of the file modes.
diff --git a/Documentation/gitignore.txt b/Documentation/gitignore.txt
index 6dd09bd290..c969961e32 100644
--- a/Documentation/gitignore.txt
+++ b/Documentation/gitignore.txt
@@ -110,7 +110,7 @@ PATTERN FORMAT
The character "`?`" matches any one character except "`/`".
The range notation, e.g. `[a-zA-Z]`, can be used to match
one of the characters in a range. See fnmatch(3) and the
- FNM_PATHNAME flag for a more detailed description.
+ `FNM_PATHNAME` flag for a more detailed description.
Two consecutive asterisks ("`**`") in patterns matched against
full pathname may have special meaning:
diff --git a/Documentation/gitnamespaces.txt b/Documentation/gitnamespaces.txt
index 6a273464a4..eb9f8d9801 100644
--- a/Documentation/gitnamespaces.txt
+++ b/Documentation/gitnamespaces.txt
@@ -8,8 +8,8 @@ gitnamespaces - Git namespaces
SYNOPSIS
--------
[verse]
-GIT_NAMESPACE=<namespace> `git upload-pack`
-GIT_NAMESPACE=<namespace> `git receive-pack`
+`GIT_NAMESPACE`=<namespace> `git upload-pack`
+`GIT_NAMESPACE`=<namespace> `git receive-pack`
DESCRIPTION
@@ -51,7 +51,7 @@ names of refs as specified by `GIT_NAMESPACE`. `git-upload-pack` and
namespace.
The smart HTTP server, linkgit:git-http-backend[1], will pass
-GIT_NAMESPACE through to the backend programs; see
+`GIT_NAMESPACE` through to the backend programs; see
linkgit:git-http-backend[1] for sample configuration to expose
repository namespaces as repositories.
diff --git a/Documentation/gitweb.conf.txt b/Documentation/gitweb.conf.txt
index 9cd1e9dc67..0acca768e0 100644
--- a/Documentation/gitweb.conf.txt
+++ b/Documentation/gitweb.conf.txt
@@ -591,7 +591,7 @@ header.
Base URL for relative URLs in pages generated by `gitweb`,
(e.g. `$logo`, `$favicon`, `@stylesheets` if they are relative URLs),
needed and used '<base href="$base_url">' only for URLs with nonempty
- PATH_INFO. Usually `gitweb` sets its value correctly,
+ `PATH_INFO`. Usually `gitweb` sets its value correctly,
and there is no need to set this variable, e.g. to `$my_uri` or "/".
See `$per_request_config` if you need to override it anyway.
@@ -902,7 +902,7 @@ EXAMPLES
To enable blame, pickaxe search, and snapshot support (allowing "tar.gz" and
"zip" snapshots), while allowing individual projects to turn them off, put
-the following in your GITWEB_CONFIG file:
+the following in your `GITWEB_CONFIG` file:
--------------------------------------------------------------------------------
$feature{'blame'}{'default'} = [1];
@@ -936,12 +936,12 @@ ENVIRONMENT
The location of per-instance and system-wide configuration files can be
overridden using the following environment variables:
-GITWEB_CONFIG::
+`GITWEB_CONFIG`::
Sets location of per-instance configuration file.
-GITWEB_CONFIG_SYSTEM::
+`GITWEB_CONFIG_SYSTEM`::
Sets location of fallback system-wide configuration file.
This file is read only if per-instance one does not exist.
-GITWEB_CONFIG_COMMON::
+`GITWEB_CONFIG_COMMON`::
Sets location of common system-wide configuration file.
diff --git a/Documentation/gitweb.txt b/Documentation/gitweb.txt
index e863f739b1..0325c82ed1 100644
--- a/Documentation/gitweb.txt
+++ b/Documentation/gitweb.txt
@@ -93,7 +93,7 @@ TAB and LF, (used to separate fields in a record).
* Currently recognized fields are:
`<repository path>`::
- path to repository GIT_DIR, relative to `$projectroot`
+ path to repository `GIT_DIR`, relative to `$projectroot`
`<repository owner>`::
displayed as repository owner, preferably full name, or email,
or both
@@ -122,7 +122,7 @@ listed in projects list file will be accessible).
Generating projects list using `gitweb`
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-We assume that GITWEB_CONFIG has its default Makefile value, namely
+We assume that `GITWEB_CONFIG` has its default Makefile value, namely
'gitweb_config.perl'. Put the following in 'gitweb_make_index.perl' file:
----------------------------------------------------------------------------
read_config_file("gitweb_config.perl");
@@ -130,7 +130,7 @@ $projects_list = $projectroot;
----------------------------------------------------------------------------
Then create the following script to get list of project in the format
-suitable for GITWEB_LIST build configuration variable (or
+suitable for `GITWEB_LIST` build configuration variable (or
`$projects_list` variable in `gitweb` config):
----------------------------------------------------------------------------
@@ -603,7 +603,7 @@ the third and the fourth.
PATH_INFO usage
~~~~~~~~~~~~~~~
-If you enable PATH_INFO usage in `gitweb` by putting
+If you enable `PATH_INFO` usage in `gitweb` by putting
----------------------------------------------------------------------------
$feature{'pathinfo'}{'default'} = [1];
----------------------------------------------------------------------------
@@ -637,7 +637,7 @@ complementary static files (stylesheet, favicon, JavaScript):
</VirtualHost>
----------------------------------------------------------------------------
The rewrite rule guarantees that existing static files will be properly
-served, whereas any other URL will be passed to `gitweb` as PATH_INFO
+served, whereas any other URL will be passed to `gitweb` as `PATH_INFO`
parameter.
*Notice* that in this case you don't need special settings for
diff --git a/Documentation/glossary-content.txt b/Documentation/glossary-content.txt
index 122b5a71ea..e4db76fd04 100644
--- a/Documentation/glossary-content.txt
+++ b/Documentation/glossary-content.txt
@@ -366,7 +366,7 @@ should not be combined with other pathspec.
`glob`;;
Git treats the pattern as a shell glob suitable for
- consumption by fnmatch(3) with the FNM_PATHNAME flag:
+ consumption by fnmatch(3) with the `FNM_PATHNAME` flag:
wildcards in the pattern will not match a / in the pathname.
For example, "Documentation/{asterisk}.html" matches
"Documentation/git.html" but not "Documentation/ppc/ppc.html"
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* [RFC PATCH v1 13/13] doc: typeset common programs in monospace
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
` (11 preceding siblings ...)
2021-04-09 4:03 ` [RFC PATCH v1 12/13] doc: typeset environment vars without $ " Firmin Martin
@ 2021-04-09 4:03 ` Firmin Martin
2021-04-12 13:37 ` [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Jean-Noël Avila
13 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-09 4:03 UTC (permalink / raw)
To: git; +Cc: Firmin Martin
Wrap common programs with backticks as indicated in the
CodingGuidelines.
The following command and regex helped to find out a partial list of
such program.
grep -RPoh "'[a-z]+'" *.txt | sort | uniq | less
Signed-off-by: Firmin Martin <firminmartin24@gmail.com>
---
Documentation/git-archive.txt | 2 +-
Documentation/git-bisect-lk2009.txt | 2 +-
Documentation/git-fast-import.txt | 4 ++--
Documentation/git-grep.txt | 4 ++--
Documentation/git-help.txt | 24 ++++++++++++------------
Documentation/git-send-email.txt | 2 +-
Documentation/git-var.txt | 6 +++---
Documentation/git-web--browse.txt | 6 +++---
Documentation/git.txt | 4 ++--
Documentation/gitcore-tutorial.txt | 6 +++---
Documentation/gitremote-helpers.txt | 2 +-
11 files changed, 31 insertions(+), 31 deletions(-)
diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt
index 830ff2b680..2139a96e48 100644
--- a/Documentation/git-archive.txt
+++ b/Documentation/git-archive.txt
@@ -34,7 +34,7 @@ OPTIONS
-------
`--format=<fmt>`::
- Format of the resulting archive: 'tar' or 'zip'. If this option
+ Format of the resulting archive: `tar` or `zip`. If this option
is not given, and the output file is specified, the format is
inferred from the filename if possible (e.g. writing to "foo.zip"
makes the output to be in the zip format). Otherwise the output
diff --git a/Documentation/git-bisect-lk2009.txt b/Documentation/git-bisect-lk2009.txt
index de5f221613..bcee1bb298 100644
--- a/Documentation/git-bisect-lk2009.txt
+++ b/Documentation/git-bisect-lk2009.txt
@@ -1355,4 +1355,4 @@ References
- [[[6]]] https://lwn.net/Articles/277872/[Jonathan Corbet. 'Bisection divides users and developers'. LWN.net.]
- [[[7]]] https://lore.kernel.org/lkml/20071207113734.GA14598@elte.hu/[Ingo Molnar. 'Re: BUG 2.6.23-rc3 can't see sd partitions on Alpha'. Linux-kernel mailing list.]
- [[[8]]] https://www.kernel.org/pub/software/scm/git/docs/git-bisect.html[Junio C Hamano and the git-list. 'git-bisect(1) Manual Page'. Linux Kernel Archives.]
-- [[[9]]] https://github.com/Ealdwulf/bbchop[Ealdwulf. 'bbchop'. GitHub.]
+- [[[9]]] https://github.com/Ealdwulf/bbchop[Ealdwulf. `bbchop`. GitHub.]
diff --git a/Documentation/git-fast-import.txt b/Documentation/git-fast-import.txt
index 6830332297..f304c6ff18 100644
--- a/Documentation/git-fast-import.txt
+++ b/Documentation/git-fast-import.txt
@@ -1118,7 +1118,7 @@ Output uses the same format as `git ls-tree <tree> -- <path>`:
The <dataref> represents the blob, tree, or commit object at <path>
and can be used in later 'get-mark', 'cat-blob', 'filemodify', or
-'ls' commands.
+`ls` commands.
If there is no file or subtree at that path, `git fast-import` will
instead report
@@ -1164,7 +1164,7 @@ The <feature> part of the command may be any one of the following:
`cat-blob`::
`ls`::
Require that the backend support the 'get-mark', 'cat-blob',
- or 'ls' command respectively.
+ or `ls` command respectively.
Versions of fast-import not supporting the specified command
will exit with a message indicating so.
This lets the import error out early with a clear message,
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 0a0d0f3f57..f1186a6685 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -49,7 +49,7 @@ CONFIGURATION
`grep.patternType`::
Set the default matching behavior. Using a value of 'basic', 'extended',
- 'fixed', or 'perl' will enable the `--basic-regexp`, `--extended-regexp`,
+ 'fixed', or `perl` will enable the `--basic-regexp`, `--extended-regexp`,
`--fixed-strings`, or `--perl-regexp` option accordingly, while the
value 'default' will return to the default matching behavior.
@@ -196,7 +196,7 @@ providing this option will cause it to die.
`-O[<pager>]`::
`--open-files-in-pager[=<pager>]`::
- Open the matching files in the pager (not the output of 'grep').
+ Open the matching files in the pager (not the output of `grep`).
If the pager happens to be `less` or `vi`, and the user
specified only one pattern, the first file is positioned at
the first match automatically. The `pager` argument is
diff --git a/Documentation/git-help.txt b/Documentation/git-help.txt
index 070ef46a8d..eb5e843efc 100644
--- a/Documentation/git-help.txt
+++ b/Documentation/git-help.txt
@@ -25,7 +25,7 @@ If the option `--guides` or `-g` is given, a list of the
Git concept guides is also printed on the standard output.
If a command, or a guide, is given, a manual page for that command or
-guide is brought up. The 'man' program is used by default for this
+guide is brought up. The `man` program is used by default for this
purpose, but this can be overridden by other options or configuration
variables.
@@ -68,11 +68,11 @@ OPTIONS
`-m`::
`--man`::
- Display manual page for the command in the 'man' format. This
+ Display manual page for the command in the `man` format. This
option may be used to override a value set in the
`help.format` configuration variable.
+
-By default the 'man' program will be used to display the manual page,
+By default the `man` program will be used to display the manual page,
but the `man.viewer` configuration variable may be used to choose
other display programs (see below).
@@ -113,13 +113,13 @@ section above and linkgit:git-web{litdd}browse[1].
man.viewer
~~~~~~~~~~
-The `man.viewer` configuration variable will be checked if the 'man'
+The `man.viewer` configuration variable will be checked if the `man`
format is chosen. The following values are currently supported:
-* "man": use the 'man' program as usual,
-* "woman": use 'emacsclient' to launch the "woman" mode in emacs
- (this only works starting with emacsclient versions 22),
-* "konqueror": use 'kfmclient' to open the man page in a new konqueror
+* `man`: use the `man` program as usual,
+* `woman`: use `emacsclient` to launch the `woman` mode in emacs
+ (this only works starting with `emacsclient` versions 22),
+* `konqueror`: use `kfmclient` to open the man page in a new `konqueror`
tab (see 'Note about konqueror' below).
Values for other tools can be used if there is a corresponding
@@ -142,7 +142,7 @@ DISPLAY is not set) and in that case emacs' woman mode will be tried.
If everything fails, or if no viewer is configured, the viewer specified
in the `GIT_MAN_VIEWER` environment variable will be tried. If that
-fails too, the 'man' program will be tried anyway.
+fails too, the `man` program will be tried anyway.
man.<tool>.path
~~~~~~~~~~~~~~~
@@ -166,15 +166,15 @@ page passed as arguments.
Note about konqueror
~~~~~~~~~~~~~~~~~~~~
-When 'konqueror' is specified in the `man.viewer` configuration
-variable, we launch 'kfmclient' to try to open the man page on an
+When `konqueror` is specified in the `man.viewer` configuration
+variable, we launch `kfmclient` to try to open the man page on an
already opened konqueror in a new tab if possible.
For consistency, we also try such a trick if `man.konqueror.path` is
set to something like `A_PATH_TO/konqueror`. That means we will try to
launch `A_PATH_TO/kfmclient` instead.
-If you really want to use 'konqueror', then you can use something like
+If you really want to use `konqueror`, then you can use something like
the following:
------------------------------------------------
diff --git a/Documentation/git-send-email.txt b/Documentation/git-send-email.txt
index 87ef1ceff3..bec5b881b3 100644
--- a/Documentation/git-send-email.txt
+++ b/Documentation/git-send-email.txt
@@ -449,7 +449,7 @@ CONFIGURATION
`sendemail.aliasFileType`::
Format of the file(s) specified in `sendemail.aliasesFile`. Must be
- one of 'mutt', 'mailrc', 'pine', 'elm', or 'gnus', or 'sendmail'.
+ one of `mutt`, `mailrc`, `pine`, `elm`, or `gnus`, or `sendmail`.
+
What an alias file in each format looks like can be found in
the documentation of the email program of the same name. The
diff --git a/Documentation/git-var.txt b/Documentation/git-var.txt
index 82448d40a4..4de20c2de7 100644
--- a/Documentation/git-var.txt
+++ b/Documentation/git-var.txt
@@ -44,17 +44,17 @@ VARIABLES
--nofork`. The order of preference is the `$GIT_EDITOR`
environment variable, then `core.editor` configuration, then
`$VISUAL`, then `$EDITOR`, and then the default chosen at compile
- time, which is usually 'vi'.
+ time, which is usually `vi`.
ifdef::git-default-editor[]
The build you are using chose '{git-default-editor}' as the default.
endif::git-default-editor[]
`GIT_PAGER`::
- Text viewer for use by Git commands (e.g., 'less'). The value
+ Text viewer for use by Git commands (e.g., `less`). The value
is meant to be interpreted by the shell. The order of preference
is the `$GIT_PAGER` environment variable, then `core.pager`
configuration, then `$PAGER`, and then the default chosen at
- compile time (usually 'less').
+ compile time (usually `less`).
ifdef::git-default-pager[]
The build you are using chose '{git-default-pager}' as the default.
endif::git-default-pager[]
diff --git a/Documentation/git-web--browse.txt b/Documentation/git-web--browse.txt
index 5aebb3093d..93706059bc 100644
--- a/Documentation/git-web--browse.txt
+++ b/Documentation/git-web--browse.txt
@@ -87,15 +87,15 @@ the URLs passed as arguments.
NOTE ABOUT KONQUEROR
--------------------
-When 'konqueror' is specified by a command-line option or a
-configuration variable, we launch 'kfmclient' to try to open the HTML
+When `konqueror` is specified by a command-line option or a
+configuration variable, we launch `kfmclient` to try to open the HTML
man page on an already opened konqueror in a new tab if possible.
For consistency, we also try such a trick if `browser.konqueror.path` is
set to something like `A_PATH_TO/konqueror`. That means we will try to
launch `A_PATH_TO/kfmclient` instead.
-If you really want to use 'konqueror', then you can use something like
+If you really want to use `konqueror`, then you can use something like
the following:
------------------------------------------------
diff --git a/Documentation/git.txt b/Documentation/git.txt
index 2328f8bd0b..1e03ac1d91 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -122,7 +122,7 @@ sensitive information can be part of the key.
`-p`::
`--paginate`::
- Pipe all output into 'less' (or if set, `$PAGER`) if standard
+ Pipe all output into `less` (or if set, `$PAGER`) if standard
output is a terminal. This overrides the `pager.<cmd>`
configuration options (see the "Configuration Mechanism" section
below).
@@ -637,7 +637,7 @@ other
`GIT_SSH`::
`GIT_SSH_COMMAND`::
If either of these environment variables is set then `git fetch`
- and `git push` will use the specified command instead of 'ssh'
+ and `git push` will use the specified command instead of `ssh`
when they need to connect to a remote system.
The command-line parameters passed to the configured command are
determined by the ssh variant. See `ssh.variant` option in
diff --git a/Documentation/gitcore-tutorial.txt b/Documentation/gitcore-tutorial.txt
index 15c5ca122f..c9f2d75aef 100644
--- a/Documentation/gitcore-tutorial.txt
+++ b/Documentation/gitcore-tutorial.txt
@@ -69,7 +69,7 @@ Initialized empty Git repository in .git/
which is just Git's way of saying that you haven't been doing anything
strange, and that it will have created a local `.git` directory setup for
your new project. You will now have a `.git` directory, and you can
-inspect that with 'ls'. For your new empty project, it should show you
+inspect that with `ls`. For your new empty project, it should show you
three entries, among other things:
- a file called `HEAD`, that has `ref: refs/heads/master` in it.
@@ -635,7 +635,7 @@ in the new repository to make sure that the index file is up to date.
Note that the second point is true even across machines. You can
duplicate a remote Git repository with *any* regular copy mechanism, be it
-'scp', 'rsync' or 'wget'.
+`scp`, `rsync` or `wget`.
When copying a remote repository, you'll want to at a minimum update the
index cache when you do this, and especially with other peoples'
@@ -1028,7 +1028,7 @@ Local directory::
+
This transport is the same as SSH transport but uses 'sh' to run
both ends on the local machine instead of running other end on
-the remote machine via 'ssh'.
+the remote machine via `ssh`.
Git Native::
`git://remote.machine/path/to/repo.git/`
diff --git a/Documentation/gitremote-helpers.txt b/Documentation/gitremote-helpers.txt
index 02ae4993bc..145179b788 100644
--- a/Documentation/gitremote-helpers.txt
+++ b/Documentation/gitremote-helpers.txt
@@ -210,7 +210,7 @@ the remote repository.
`bidi-import`::
This modifies the 'import' capability.
- The fast-import commands 'cat-blob' and 'ls' can be used by remote-helpers
+ The fast-import commands 'cat-blob' and `ls` can be used by remote-helpers
to retrieve information about blobs and trees that already exist in
fast-import's memory. This requires a channel from fast-import to the
remote-helper.
--
2.31.1.133.g84d06cdc06
^ permalink raw reply related [flat|nested] 20+ messages in thread
* Re: [RFC PATCH v1 01/13] doc: typeset command-line options in monospace
2021-04-09 4:02 ` [RFC PATCH v1 01/13] doc: typeset command-line options in monospace Firmin Martin
@ 2021-04-09 9:49 ` Bagas Sanjaya
2021-04-10 1:12 ` Firmin Martin
0 siblings, 1 reply; 20+ messages in thread
From: Bagas Sanjaya @ 2021-04-09 9:49 UTC (permalink / raw)
To: Firmin Martin; +Cc: Git Users
On 09/04/21 11.02, Firmin Martin wrote:
> help.browser, web.browser and browser.<tool>.path
> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> The `help.browser`, `web.browser` and `browser.<tool>.path` will also
> be checked if the 'web' format is chosen (either by command-line
> -option or configuration variable). See '-w|--web' in the OPTIONS
> +option or configuration variable). See `-w`|`--web` in the OPTIONS
Why not `-w | --web`?
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [RFC PATCH v1 01/13] doc: typeset command-line options in monospace
2021-04-09 9:49 ` Bagas Sanjaya
@ 2021-04-10 1:12 ` Firmin Martin
0 siblings, 0 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-10 1:12 UTC (permalink / raw)
To: Bagas Sanjaya; +Cc: Git Users
Hi Bagas,
Bagas Sanjaya <bagasdotme@gmail.com> writes:
> On 09/04/21 11.02, Firmin Martin wrote:
>> help.browser, web.browser and browser.<tool>.path
>> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>>
>> The `help.browser`, `web.browser` and `browser.<tool>.path` will also
>> be checked if the 'web' format is chosen (either by command-line
>> -option or configuration variable). See '-w|--web' in the OPTIONS
>> +option or configuration variable). See `-w`|`--web` in the OPTIONS
>
> Why not `-w | --web`?
Good question.
There are multiple justifications:
- The "|" is a meta-character not included in the option name.
- If you run
grep -Pn "'.*\|.*?'" *.txt
under the Documentation/ directory, you will notice that we have
already done something like this, but in italic:
- In git-rerere.txt's Synopsis: `git rerere` ['clear'|'forget' <pathspec>|'diff'|'remaining'|'status'|'gc']
- In gitremote-helpers.txt: 'option dry-run' {'true'|'false'}:
- That is exactly what "man man" or some other man pages do (e.g. "man
tar"). Of course, some man pages do not follow this convention
(e.g. "man 7z").
Best,
Firmin
>
> --
> An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
` (12 preceding siblings ...)
2021-04-09 4:03 ` [RFC PATCH v1 13/13] doc: typeset common programs " Firmin Martin
@ 2021-04-12 13:37 ` Jean-Noël Avila
2021-04-13 20:42 ` Firmin Martin
13 siblings, 1 reply; 20+ messages in thread
From: Jean-Noël Avila @ 2021-04-12 13:37 UTC (permalink / raw)
To: git
Le 09/04/2021 à 06:02, Firmin Martin a écrit :
> This patch series aims to make the documentation fully compliant to the
> CodingGuidelines regarding monospace font. After it, new contributors
> who just want to change a little portion of the documention could just
> look around how it has been done without being confused by the
> inconsistency between the documentation and the CodingGuidelines.
Thank you for tackling the task of formating the docu and directing to
CodingGuidelines for some markup rules. It appears that the last rule
about backticks is wrong with late Asciidoctor, for which backticks are
only a font switcher and no longer hold any semantic meaning. This means
that double-hyphens may need escaping (see:
https://asciidoctor.org/docs/migration/#migration-cheatsheet) when
switching style and tools.
One other rule worth adding would be that tabs are banned from asciidoc
because they cannot always be matched with correct indentation.
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale
2021-04-12 13:37 ` [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Jean-Noël Avila
@ 2021-04-13 20:42 ` Firmin Martin
2021-04-19 9:04 ` Jean-Noël Avila
2021-04-19 9:33 ` Jean-Noël Avila
0 siblings, 2 replies; 20+ messages in thread
From: Firmin Martin @ 2021-04-13 20:42 UTC (permalink / raw)
To: Jean-Noël Avila, git
Hi Jean-Noël,
Jean-Noël Avila <avila.jn@gmail.com> writes:
> Le 09/04/2021 à 06:02, Firmin Martin a écrit :
>> This patch series aims to make the documentation fully compliant to the
>> CodingGuidelines regarding monospace font. After it, new contributors
>> who just want to change a little portion of the documention could just
>> look around how it has been done without being confused by the
>> inconsistency between the documentation and the CodingGuidelines.
>
>
> Thank you for tackling the task of formating the docu and directing to
> CodingGuidelines for some markup rules. It appears that the last rule
> about backticks is wrong with late Asciidoctor, for which backticks are
Thanks. As a new Git contributor, I used to think that we don't use asciidoctor,
until I see in Documentation/Makefile:
ifdef USE_ASCIIDOCTOR
ASCIIDOC = asciidoctor
...
ASCIIDOC_EXTRA += -acompat-mode -atabsize=8
...
endif
So, we actually use both depending the variable USE_ASCIIDOCTOR.
> only a font switcher and no longer hold any semantic meaning. This means
> that double-hyphens may need escaping (see:
> https://asciidoctor.org/docs/migration/#migration-cheatsheet) when
> switching style and tools.
In the helpful link that you provide, it says that the "setext-style
(i.e., two-line) section title" enables compatibility mode. As far as I
can tell, most man pages (git.*.txt) fall under this category, except
the most important one: user-manual.txt. But this is in fact not
relevant, because the snippet above of the Makefile suggests that we
actually explicitly running asciidoctor in compatibility mode.
> One other rule worth adding would be that tabs are banned from asciidoc
> because they cannot always be matched with correct indentation.
I'm an absolute novice regarding AsciiDoc vs. Asciidoctor. But from the
user guide of AsciiDoc (https://asciidoc.org/userguide.html#_tabs), it says
By default tab characters input files will translated to 8
spaces. Tab expansion is set with the tabsize entry in the
configuration file [miscellaneous] section and can be overridden in
included files by setting a tabsize attribute in the include macro’s
attribute list. For example:
include::addendum.txt[tabsize=2] The tab size can also be set using
the attribute command-line option, for example --attribute tabsize=4
... and we also explicitly set it to 8 spaces (see above). Could you
elaborate a bit on the matter ?
Thanks,
Firmin
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale
2021-04-13 20:42 ` Firmin Martin
@ 2021-04-19 9:04 ` Jean-Noël Avila
2021-04-19 9:33 ` Jean-Noël Avila
1 sibling, 0 replies; 20+ messages in thread
From: Jean-Noël Avila @ 2021-04-19 9:04 UTC (permalink / raw)
To: git
Le 13/04/2021 à 22:42, Firmin Martin a écrit :
> Hi Jean-Noël,
>
> Jean-Noël Avila <avila.jn@gmail.com> writes:
>
>> Le 09/04/2021 à 06:02, Firmin Martin a écrit :
>>> This patch series aims to make the documentation fully compliant to the
>>> CodingGuidelines regarding monospace font. After it, new contributors
>>> who just want to change a little portion of the documention could just
>>> look around how it has been done without being confused by the
>>> inconsistency between the documentation and the CodingGuidelines.
>>
>> Thank you for tackling the task of formating the docu and directing to
>> CodingGuidelines for some markup rules. It appears that the last rule
>> about backticks is wrong with late Asciidoctor, for which backticks are
> Thanks. As a new Git contributor, I used to think that we don't use asciidoctor,
> until I see in Documentation/Makefile:
>
> ifdef USE_ASCIIDOCTOR
> ASCIIDOC = asciidoctor
> ...
> ASCIIDOC_EXTRA += -acompat-mode -atabsize=8
> ...
> endif
>
> So, we actually use both depending the variable USE_ASCIIDOCTOR.
>
>> only a font switcher and no longer hold any semantic meaning. This means
>> that double-hyphens may need escaping (see:
>> https://asciidoctor.org/docs/migration/#migration-cheatsheet) when
>> switching style and tools.
> In the helpful link that you provide, it says that the "setext-style
> (i.e., two-line) section title" enables compatibility mode. As far as I
> can tell, most man pages (git.*.txt) fall under this category, except
> the most important one: user-manual.txt. But this is in fact not
> relevant, because the snippet above of the Makefile suggests that we
> actually explicitly running asciidoctor in compatibility mode.
If we are to continue using asciidoctor, I guess this compatibility mode
will be removed at some point in the future. I don't have all the
required inputs for how asciidoc and asciidoctor will evolve and may
split in their behavior, but here is how I see it:
There's now a working group whose interest is in standardizing asciidoc
and making the format evolve
(https://www.eclipse.org/org/workinggroups/asciidoc-charter.php). It is
led by the authors of asciidoctor, so I guess most of the path forward
for asciidoc format is asciidoctor and leaving compatibility mode behind
as a legacy format.
>
>> One other rule worth adding would be that tabs are banned from asciidoc
>> because they cannot always be matched with correct indentation.
> I'm an absolute novice regarding AsciiDoc vs. Asciidoctor. But from the
> user guide of AsciiDoc (https://asciidoc.org/userguide.html#_tabs), it says
>
> By default tab characters input files will translated to 8
> spaces. Tab expansion is set with the tabsize entry in the
> configuration file [miscellaneous] section and can be overridden in
> included files by setting a tabsize attribute in the include macro’s
> attribute list. For example:
>
> include::addendum.txt[tabsize=2] The tab size can also be set using
> the attribute command-line option, for example --attribute tabsize=4
>
> ... and we also explicitly set it to 8 spaces (see above). Could you
> elaborate a bit on the matter ?
Tab management in asciidoc and asciidoctor was the source of a number of
bugs, because the markup relies on "visual" alignment instead of
semantic alignment. So you have to define tabsize in order for tabs to
be correctly interpreted. Instead of having to add specification, my
approach would be to just get rid of the source and the solution of the
issue at the same time.
^ permalink raw reply [flat|nested] 20+ messages in thread
* Re: [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale
2021-04-13 20:42 ` Firmin Martin
2021-04-19 9:04 ` Jean-Noël Avila
@ 2021-04-19 9:33 ` Jean-Noël Avila
1 sibling, 0 replies; 20+ messages in thread
From: Jean-Noël Avila @ 2021-04-19 9:33 UTC (permalink / raw)
To: git
Le 13/04/2021 à 22:42, Firmin Martin a écrit :
> I'm an absolute novice regarding AsciiDoc vs. Asciidoctor.
Here are some news:
https://groups.google.com/g/asciidoc/c/kaqYgpmWrJk
^ permalink raw reply [flat|nested] 20+ messages in thread
end of thread, other threads:[~2021-04-19 9:33 UTC | newest]
Thread overview: 20+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-09 4:02 [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 01/13] doc: typeset command-line options in monospace Firmin Martin
2021-04-09 9:49 ` Bagas Sanjaya
2021-04-10 1:12 ` Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 02/13] doc: typeset branches and remotes " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 03/13] doc: typeset configuration options " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 04/13] doc: typeset git-related commands " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 05/13] doc: typeset git-svn subcommands " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 06/13] doc: typeset dummy URLs and protocols " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 07/13] doc: typeset git dotfiles " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 08/13] doc: typeset filepath and $variables " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 09/13] doc: typeset command/option/value entries " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 10/13] doc: typeset more command " Firmin Martin
2021-04-09 4:02 ` [RFC PATCH v1 11/13] doc: typeset config option " Firmin Martin
2021-04-09 4:03 ` [RFC PATCH v1 12/13] doc: typeset environment vars without $ " Firmin Martin
2021-04-09 4:03 ` [RFC PATCH v1 13/13] doc: typeset common programs " Firmin Martin
2021-04-12 13:37 ` [RFC PATCH v1 00/13][GSoC] doc: (monospace) apply CodingGuidelines on a large-scale Jean-Noël Avila
2021-04-13 20:42 ` Firmin Martin
2021-04-19 9:04 ` Jean-Noël Avila
2021-04-19 9:33 ` Jean-Noël Avila
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).