git/Documentation/git-write-tree.txt
Martin von Zweigbergk 7791a1d9b9 Documentation: use [verse] for SYNOPSIS sections
The SYNOPSIS sections of most commands that span several lines already
use [verse] to retain line breaks. Most commands that don't span
several lines seem not to use [verse]. In the HTML output, [verse]
does not only preserve line breaks, but also makes the section
indented, which causes a slight inconsistency between commands that
use [verse] and those that don't. Use [verse] in all SYNOPSIS sections
for consistency.

Also remove the blank lines from git-fetch.txt and git-rebase.txt to
align with the other man pages. In the case of git-rebase.txt, which
already uses [verse], the blank line makes the [verse] not apply to
the last line, so removing the blank line also makes the formatting
within the document more consistent.

While at it, add single quotes to 'git cvsimport' for consistency with
other commands.

Signed-off-by: Martin von Zweigbergk <martin.von.zweigbergk@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-07-06 14:26: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
--------
[verse]
'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