Merge branch 'ew/send-email' into next
[gitweb.git] / Documentation / git-write-tree.txt
index 3cf8c934c1f3c2fe504d867fde1190b88f915fc7..c85fa89c30e25ed026d2e95a2b537798f878e50f 100644 (file)
@@ -1,33 +1,40 @@
 git-write-tree(1)
 =================
-v0.1, May 2005
 
 NAME
 ----
-git-write-tree - Creates a tree object from the current cache
+git-write-tree - Creates 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 cache.
+Creates a tree object using the current index.
 
-The cache must be merged.
+The index must be in a fully merged state.
 
-Conceptually, "git-write-tree" sync()s the current directory cache 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-cache" 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
-       directory exist in the object database.  This option disables this check.
+       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
 ------
@@ -39,5 +46,5 @@ Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel
 
 GIT
 ---
-Part of the link:git.html[git] suite
+Part of the gitlink:git[7] suite