Files
git/Documentation/git-write-tree.adoc
Junio C Hamano 914c549ac1 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>
2025-05-12 09:25:26 -07:00

43 lines
1.0 KiB
Plaintext

git-write-tree(1)
=================
NAME
----
git-write-tree - Create a tree object from the current index
SYNOPSIS
--------
[synopsis]
git write-tree [--missing-ok] [--prefix=<prefix>/]
DESCRIPTION
-----------
Creates a tree object using the current index. The name of the new
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
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`.
OPTIONS
-------
`--missing-ok`::
Normally `git write-tree` ensures that the objects referenced by the
directory exist in the object database. This option disables this
check.
`--prefix=<prefix>/`::
Writes a tree object that represents a subdirectory
_<prefix>_. This can be used to write the tree object
for a subproject that is in the named subdirectory.
GIT
---
Part of the linkgit:git[1] suite