Skip to content

Commit 914c549

Browse files
committed
git-{var,write-tree} docs: update mark-up of synopsis option descriptions
To unify mark-up used in our documentation to a newer convention, started by 2229389 (doc: apply synopsis simplification on git-clone and git-init, 2024-09-24), update the documentation for 'git var' and 'git write-tree' to * use [synopsis], not [verse] in the SYNOPSIS section * enclose `--option=<value>` in backquotes Signed-off-by: Junio C Hamano <[email protected]> Helped-by: Jean-Noël Avila <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 88ce8df commit 914c549

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

Documentation/git-var.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ git-var - Show a Git logical variable
88

99
SYNOPSIS
1010
--------
11-
[verse]
12-
'git var' (-l | <variable>)
11+
[synopsis]
12+
git var (-l | <variable>)
1313

1414
DESCRIPTION
1515
-----------
@@ -18,7 +18,7 @@ no value.
1818

1919
OPTIONS
2020
-------
21-
-l::
21+
`-l`::
2222
Display the logical variables. In addition, all the
2323
variables of the Git configuration file .git/config are listed
2424
as well. (However, the configuration variables listing functionality

Documentation/git-write-tree.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ git-write-tree - Create a tree object from the current index
88

99
SYNOPSIS
1010
--------
11-
[verse]
12-
'git write-tree' [--missing-ok] [--prefix=<prefix>/]
11+
[synopsis]
12+
git write-tree [--missing-ok] [--prefix=<prefix>/]
1313

1414
DESCRIPTION
1515
-----------
@@ -18,23 +18,23 @@ tree object is printed to standard output.
1818

1919
The index must be in a fully merged state.
2020

21-
Conceptually, 'git write-tree' sync()s the current index contents
21+
Conceptually, `git write-tree` sync()s the current index contents
2222
into a set of tree files.
2323
In order to have that match what is actually in your directory right
24-
now, you need to have done a 'git update-index' phase before you did the
25-
'git write-tree'.
24+
now, you need to have done a `git update-index` phase before you did the
25+
`git write-tree`.
2626

2727

2828
OPTIONS
2929
-------
30-
--missing-ok::
31-
Normally 'git write-tree' ensures that the objects referenced by the
30+
`--missing-ok`::
31+
Normally `git write-tree` ensures that the objects referenced by the
3232
directory exist in the object database. This option disables this
3333
check.
3434

35-
--prefix=<prefix>/::
35+
`--prefix=<prefix>/`::
3636
Writes a tree object that represents a subdirectory
37-
`<prefix>`. This can be used to write the tree object
37+
_<prefix>_. This can be used to write the tree object
3838
for a subproject that is in the named subdirectory.
3939

4040
GIT

0 commit comments

Comments
 (0)