SubmittingPatches: clarify the expected commit log description
[git/mjg.git] / Documentation / git-mktree.txt
blob81e3326772d94464708cc2037715e1e62eae5f11
1 git-mktree(1)
2 =============
4 NAME
5 ----
6 git-mktree - Build a tree-object from ls-tree formatted text
9 SYNOPSIS
10 --------
11 'git mktree' [-z] [--missing] [--batch]
13 DESCRIPTION
14 -----------
15 Reads standard input in non-recursive `ls-tree` output format, and creates
16 a tree object.  The order of the tree entries is normalised by mktree so
17 pre-sorting the input is not required.  The object name of the tree object
18 built is written to the standard output.
20 OPTIONS
21 -------
22 -z::
23         Read the NUL-terminated `ls-tree -z` output instead.
25 --missing::
26         Allow missing objects.  The default behaviour (without this option)
27         is to verify that each tree entry's sha1 identifies an existing
28         object.  This option has no effect on the treatment of gitlink entries
29         (aka "submodules") which are always allowed to be missing.
31 --batch::
32         Allow building of more than one tree object before exiting.  Each
33         tree is separated by as single blank line. The final new-line is
34         optional.  Note - if the '-z' option is used, lines are terminated
35         with NUL.
37 Author
38 ------
39 Written by Junio C Hamano <gitster@pobox.com>
41 Documentation
42 --------------
43 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
45 GIT
46 ---
47 Part of the linkgit:git[1] suite