git-commit-vandalism/Documentation/git-write-tree.txt
Jeff King 48bb914ed6 doc: drop author/documentation sections from most pages
The point of these sections is generally to:

  1. Give credit where it is due.

  2. Give the reader an idea of where to ask questions or
     file bug reports.

But they don't do a good job of either case. For (1), they
are out of date and incomplete. A much more accurate answer
can be gotten through shortlog or blame.  For (2), the
correct contact point is generally git@vger, and even if you
wanted to cc the contact point, the out-of-date and
incomplete fields mean you're likely sending to somebody
useless.

So let's drop the fields entirely from all manpages except
git(1) itself. We already point people to the mailing list
for bug reports there, and we can update the Authors section
to give credit to the major contributors and point to
shortlog and blame for more information.

Each page has a "This is part of git" footer, so people can
follow that to the main git manpage.
2011-03-11 10:59:16 -05:00

42 lines
1018 B
Plaintext

git-write-tree(1)
=================
NAME
----
git-write-tree - Create a tree object from the current index
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