summaryrefslogtreecommitdiff
path: root/Documentation/git-write-tree.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/git-write-tree.txt')
-rw-r--r--Documentation/git-write-tree.txt30
1 files changed, 14 insertions, 16 deletions
diff --git a/Documentation/git-write-tree.txt b/Documentation/git-write-tree.txt
index 77e12cb949..f22041a9dc 100644
--- a/Documentation/git-write-tree.txt
+++ b/Documentation/git-write-tree.txt
@@ -3,42 +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]
+[verse]
+'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.
-Author
-------
-Written by Linus Torvalds <torvalds@osdl.org>
-
-Documentation
---------------
-Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
+--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 gitlink:git[7] suite
-
+Part of the linkgit:git[1] suite