Skip to content

Commit fd4f96f

Browse files
committed
Merge branch 'jn/doc-synopsis' into next
Doc-mark-up modernization continues. * jn/doc-synopsis: doc: convert git worktree to synopsis style doc: convert git tag to synopsis style doc: convert git-stash.adoc to synopis style
2 parents 6d19910 + 0ae23ab commit fd4f96f

File tree

6 files changed

+280
-253
lines changed

6 files changed

+280
-253
lines changed

Documentation/config/stash.adoc

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,28 @@
1-
stash.index::
1+
ifndef::git-stash[]
2+
:see-show: See the description of the 'show' command in linkgit:git-stash[1].
3+
endif::git-stash[]
4+
5+
ifdef::git-stash[]
6+
:see-show:
7+
endif::git-stash[]
8+
9+
`stash.index`::
210
If this is set to true, `git stash apply` and `git stash pop` will
3-
behave as if `--index` was supplied. Defaults to false. See the
4-
descriptions in linkgit:git-stash[1].
11+
behave as if `--index` was supplied. Defaults to false.
12+
ifndef::git-stash[]
13+
See the descriptions in linkgit:git-stash[1].
14+
endif::git-stash[]
515

6-
stash.showIncludeUntracked::
16+
`stash.showIncludeUntracked`::
717
If this is set to true, the `git stash show` command will show
8-
the untracked files of a stash entry. Defaults to false. See
9-
the description of the 'show' command in linkgit:git-stash[1].
18+
the untracked files of a stash entry. Defaults to false. {see-show}
1019

11-
stash.showPatch::
20+
`stash.showPatch`::
1221
If this is set to true, the `git stash show` command without an
1322
option will show the stash entry in patch form. Defaults to false.
14-
See the description of the 'show' command in linkgit:git-stash[1].
23+
{see-show}
1524

16-
stash.showStat::
25+
`stash.showStat`::
1726
If this is set to true, the `git stash show` command without an
1827
option will show a diffstat of the stash entry. Defaults to true.
19-
See the description of the 'show' command in linkgit:git-stash[1].
28+
{see-show}

Documentation/config/tag.adoc

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,23 @@
1-
tag.forceSignAnnotated::
1+
`tag.forceSignAnnotated`::
22
A boolean to specify whether annotated tags created should be GPG signed.
33
If `--annotate` is specified on the command line, it takes
44
precedence over this option.
55

6-
tag.sort::
7-
This variable controls the sort ordering of tags when displayed by
8-
linkgit:git-tag[1]. Without the "--sort=<value>" option provided, the
9-
value of this variable will be used as the default.
6+
`tag.sort`::
7+
ifdef::git-tag[]
8+
This variable controls the sort ordering of tags when displayed by `git-tag`.
9+
endif::git-tag[]
10+
ifndef::git-tag[]
11+
This variable controls the sort ordering of tags when displayed by
12+
linkgit:git-tag[1].
13+
endif::git-tag[]
14+
Without the `--sort=<value>` option provided, the value of this variable will
15+
be used as the default.
1016

11-
tag.gpgSign::
17+
`tag.gpgSign`::
1218
A boolean to specify whether all tags should be GPG signed.
1319
Use of this option when running in an automated script can
1420
result in a large number of tags being signed. It is therefore
15-
convenient to use an agent to avoid typing your gpg passphrase
21+
convenient to use an agent to avoid typing your GPG passphrase
1622
several times. Note that this option doesn't affect tag signing
17-
behavior enabled by "-u <keyid>" or "--local-user=<keyid>" options.
23+
behavior enabled by `-u <keyid>` or `--local-user=<keyid>` options.

Documentation/config/worktree.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
1-
worktree.guessRemote::
1+
`worktree.guessRemote`::
22
If no branch is specified and neither `-b` nor `-B` nor
33
`--detach` is used, then `git worktree add` defaults to
44
creating a new branch from HEAD. If `worktree.guessRemote` is
55
set to true, `worktree add` tries to find a remote-tracking
66
branch whose name uniquely matches the new branch name. If
77
such a branch exists, it is checked out and set as "upstream"
88
for the new branch. If no such match can be found, it falls
9-
back to creating a new branch from the current HEAD.
9+
back to creating a new branch from the current `HEAD`.
1010

11-
worktree.useRelativePaths::
12-
Link worktrees using relative paths (when "true") or absolute
13-
paths (when "false"). This is particularly useful for setups
11+
`worktree.useRelativePaths`::
12+
Link worktrees using relative paths (when "`true`") or absolute
13+
paths (when "`false`"). This is particularly useful for setups
1414
where the repository and worktrees may be moved between
15-
different locations or environments. Defaults to "false".
15+
different locations or environments. Defaults to "`false`".
1616
+
17-
Note that setting `worktree.useRelativePaths` to "true" implies enabling the
17+
Note that setting `worktree.useRelativePaths` to "`true`" implies enabling the
1818
`extensions.relativeWorktrees` config (see linkgit:git-config[1]),
1919
thus making it incompatible with older versions of Git.

0 commit comments

Comments
 (0)