Documentation: improve "add", "pull" and "format-patch" examples
[gitweb.git] / Documentation / git-write-tree.txt
index 51be44d1f24cb3195fa1784b2f29b7c6f9392708..461c813f5ad19ac718b09cfae247eaac74d4d845 100644 (file)
@@ -3,30 +3,38 @@ git-write-tree(1)
 
 NAME
 ----
-git-write-tree - Creates a tree object from the current cache
+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 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-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
-       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
 ------
@@ -38,5 +46,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[7] suite