Merge branch 'maint'
[gitweb.git] / Documentation / git-write-tree.txt
index 77e12cb949201445ab33992f9ff155f647ce167c..c8899d528adfe37459b9301e16faab90e7a7e63d 100644 (file)
@@ -3,33 +3,40 @@ git-write-tree(1)
 
 NAME
 ----
-git-write-tree - Creates a tree object from the current index
+git-write-tree - Create a tree object from the current index
 
 
 SYNOPSIS
 --------
-'git-write-tree' [--missing-ok]
+'git write-tree' [--missing-ok] [--prefix=<prefix>/]
 
 DESCRIPTION
 -----------
-Creates a tree object using the current index.
+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
+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`.
+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
+       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.
+
+
 Author
 ------
 Written by Linus Torvalds <torvalds@osdl.org>
@@ -40,5 +47,4 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
 
 GIT
 ---
-Part of the gitlink:git[7] suite
-
+Part of the linkgit:git[1] suite