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 22293895 (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 <gitster@pobox.com> Helped-by: Jean-Noël Avila <jn.avila@free.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Junio C Hamano committed
May 10, 2025 at 14:33 UTC
914c549ac161c3393dd760be5af4d290620a27e8
2 files changed
+12
-12
Documentation/git-var.adoc
+3
-3
@@ -8,8 +8,8 @@ git-var - Show a Git logical variable
8
9
SYNOPSIS
10
--------
11
-[verse]
12
-'git var' (-l | <variable>)
11
+[synopsis]
12
+git var (-l | <variable>)
13
14
DESCRIPTION
15
-----------
@@ -18,7 +18,7 @@ no value.
18
19
OPTIONS
20
-------
21
--l::
21
+`-l`::
22
Display the logical variables. In addition, all the
23
variables of the Git configuration file .git/config are listed
24
as well. (However, the configuration variables listing functionality
Documentation/git-write-tree.adoc
+9
-9
@@ -8,8 +8,8 @@ git-write-tree - Create a tree object from the current index
8
9
SYNOPSIS
10
--------
11
-[verse]
12
-'git write-tree' [--missing-ok] [--prefix=<prefix>/]
11
+[synopsis]
12
+git write-tree [--missing-ok] [--prefix=<prefix>/]
13
14
DESCRIPTION
15
-----------
@@ -18,23 +18,23 @@ tree object is printed to standard output.
18
19
The index must be in a fully merged state.
20
21
-Conceptually, 'git write-tree' sync()s the current index contents
21
+Conceptually, `git write-tree` sync()s the current index contents
22
into a set of tree files.
23
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`.
26
27
28
OPTIONS
29
-------
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
32
directory exist in the object database. This option disables this
33
check.
34
35
---prefix=<prefix>/::
35
+`--prefix=<prefix>/`::
36
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
38
for a subproject that is in the named subdirectory.
39
40
GIT