mktree --missing: updated usage message and man page

[git.git] / Documentation / git-mktree.txt

diff --git a/Documentation/git-mktree.txt b/Documentation/git-mktree.txt
index af19f06ed738bdecc7ab9a72a5c9a216b816f4c2..7336f48bd1e90dabf8e735dc27023b65309e1aef 100644 (file)
--- a/Documentation/git-mktree.txt
+++ b/Documentation/git-mktree.txt
@@ -8,12 +8,13 @@ git-mktree - Build a tree-object from ls-tree formatted text
 
 SYNOPSIS
 --------
-'git mktree' [-z]
+'git mktree' [-z] [--missing]
 
 DESCRIPTION
 -----------
-Reads standard input in non-recursive `ls-tree` output format,
-and creates a tree object.  The object name of the tree object
+Reads standard input in non-recursive `ls-tree` output format, and creates
+a tree object.  The order of the tree entries is normalised by mktree so
+pre-sorting the input is not required.  The object name of the tree object
 built is written to the standard output.
 
 OPTIONS
@@ -21,6 +22,12 @@ OPTIONS
 -z::
        Read the NUL-terminated `ls-tree -z` output instead.
 
+--missing::
+       Allow missing objects.  The default behaviour (without this option)
+       is to verify that each tree entry's sha1 identifies an existing
+       object.  This option has no effect on the treatment of gitlink entries
+       (aka "submodules") which are always allowed to be missing.
+
 Author
 ------
 Written by Junio C Hamano <gitster@pobox.com>