Draft release notes to 1.6.5 before -rc0
[git/gitweb.git] / Documentation / git-commit-tree.txt
blobb8834baced4b25d6df47eb578c4d745d23e8cc73
1 git-commit-tree(1)
2 ==================
4 NAME
5 ----
6 git-commit-tree - Create a new commit object
9 SYNOPSIS
10 --------
11 'git commit-tree' <tree> [-p <parent commit>]\* < changelog
13 DESCRIPTION
14 -----------
15 This is usually not what an end user wants to run directly.  See
16 linkgit:git-commit[1] instead.
18 Creates a new commit object based on the provided tree object and
19 emits the new commit object id on stdout.
21 A commit object may have any number of parents. With exactly one
22 parent, it is an ordinary commit. Having more than one parent makes
23 the commit a merge between several lines of history. Initial (root)
24 commits have no parents.
26 While a tree represents a particular directory state of a working
27 directory, a commit represents that state in "time", and explains how
28 to get there.
30 Normally a commit would identify a new "HEAD" state, and while git
31 doesn't care where you save the note about that state, in practice we
32 tend to just write the result to the file that is pointed at by
33 `.git/HEAD`, so that we can always see what the last committed
34 state was.
36 OPTIONS
37 -------
38 <tree>::
39         An existing tree object
41 -p <parent commit>::
42         Each '-p' indicates the id of a parent commit object.
45 Commit Information
46 ------------------
48 A commit encapsulates:
50 - all parent object ids
51 - author name, email and date
52 - committer name and email and the commit time.
54 While parent object ids are provided on the command line, author and
55 committer information is taken from the following environment variables,
56 if set:
58         GIT_AUTHOR_NAME
59         GIT_AUTHOR_EMAIL
60         GIT_AUTHOR_DATE
61         GIT_COMMITTER_NAME
62         GIT_COMMITTER_EMAIL
63         GIT_COMMITTER_DATE
64         EMAIL
66 (nb "<", ">" and "\n"s are stripped)
68 In case (some of) these environment variables are not set, the information
69 is taken from the configuration items user.name and user.email, or, if not
70 present, system user name and fully qualified hostname.
72 A commit comment is read from stdin. If a changelog
73 entry is not provided via "<" redirection, 'git-commit-tree' will just wait
74 for one to be entered and terminated with ^D.
77 Diagnostics
78 -----------
79 You don't exist. Go away!::
80     The passwd(5) gecos field couldn't be read
81 Your parents must have hated you!::
82     The passwd(5) gecos field is longer than a giant static buffer.
83 Your sysadmin must hate you!::
84     The passwd(5) name field is longer than a giant static buffer.
86 Discussion
87 ----------
89 include::i18n.txt[]
91 SEE ALSO
92 --------
93 linkgit:git-write-tree[1]
96 Author
97 ------
98 Written by Linus Torvalds <torvalds@osdl.org>
100 Documentation
101 --------------
102 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
106 Part of the linkgit:git[1] suite