user-manual: use pithier example commit
[gitweb.git] / Documentation / git-write-tree.txt
index 4c7db5f59ad39ccf42ef2e85f2d40a4ffc03bd1b..96d5e07b112aa2a87eb6433f7cbeb8ce5f10205a 100644 (file)
@@ -1,48 +1,41 @@
 git-write-tree(1)
 =================
-v0.1, May 2005
 
 NAME
 ----
-git-write-tree - Creates a tree 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-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.
-
-
-////////////////////////////////////////////////////////////////
-
-Producing man pages and html
-
-To create a set of html pages run:
-  perl split-docs.pl -html < core-git.txt
+       Normally `git-write-tree` ensures that the objects referenced by the
+       directory exist in the object database.  This option disables this
+       check.
 
-To create a set of man pages run:
-  perl split-docs.pl -man < core-git.txt
+--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>
@@ -53,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