kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

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>
Junio C Hamano 2025-05-01 14:00:31 -07:00
parent 3336ddf23f
commit 2f44304374
2 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Documentation/git-var.adoc
View File

@ -8,8 +8,8 @@ git-var - Show a Git logical variable


SYNOPSIS SYNOPSIS
-------- --------
[verse] [synopsis]
'git var' (-l | <variable>) git var (-l | <variable>)


DESCRIPTION DESCRIPTION
----------- -----------
@ -18,7 +18,7 @@ no value.


OPTIONS OPTIONS
------- -------
-l:: `-l`::
Display the logical variables. In addition, all the Display the logical variables. 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 as well. (However, the configuration variables listing functionality

16
Documentation/git-write-tree.adoc
View File

@ -8,8 +8,8 @@ git-write-tree - Create a tree object from the current index


SYNOPSIS SYNOPSIS
-------- --------
[verse] [synopsis]
'git write-tree' [--missing-ok] [--prefix=<prefix>/] git write-tree [--missing-ok] [--prefix=<prefix>/]


DESCRIPTION DESCRIPTION
----------- -----------
@ -18,21 +18,21 @@ tree object is printed to standard output.


The index must be in a fully merged state. 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. into a set of tree files.
In order to have that match what is actually in your directory right 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 now, you need to have done a `git update-index` phase before you did the
'git write-tree'. `git write-tree`.




OPTIONS OPTIONS
------- -------
--missing-ok:: `--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 directory exist in the object database. This option disables this
check. check.


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