Merge http://www.kernel.org/pub/scm/gitk/gitk
[git/git.git] / Documentation / git-commit-tree.txt
1 git-commit-tree(1)
2 ==================
3
4 NAME
5 ----
6 git-commit-tree - Creates a new commit object
7
8
9 SYNOPSIS
10 --------
11 'git-commit-tree' <tree> [-p <parent commit>]\ < changelog
12
13 DESCRIPTION
14 -----------
15 Creates a new commit object based on the provided tree object and
16 emits the new commit object id on stdout. If no parent is given then
17 it is considered to be an initial tree.
18
19 A commit object usually has 1 parent (a commit after a change) or up
20 to 16 parents. More than one parent represents a merge of branches
21 that led to them.
22
23 While a tree represents a particular directory state of a working
24 directory, a commit represents that state in "time", and explains how
25 to get there.
26
27 Normally a commit would identify a new "HEAD" state, and while git
28 doesn't care where you save the note about that state, in practice we
29 tend to just write the result to the file `.git/HEAD`, so that we can
30 always see what the last committed state was.
31
32 OPTIONS
33 -------
34 <tree>::
35 An existing tree object
36
37 -p <parent commit>::
38 Each '-p' indicates the id of a parent commit object.
39
40
41 Commit Information
42 ------------------
43
44 A commit encapsulates:
45
46 - all parent object ids
47 - author name, email and date
48 - committer name and email and the commit time.
49
50 If not provided, "git-commit-tree" uses your name, hostname and domain to
51 provide author and committer info. This can be overridden using the
52 following environment variables.
53
54 GIT_AUTHOR_NAME
55 GIT_AUTHOR_EMAIL
56 GIT_AUTHOR_DATE
57 GIT_COMMITTER_NAME
58 GIT_COMMITTER_EMAIL
59
60 (nb "<", ">" and "\n"s are stripped)
61
62 A commit comment is read from stdin (max 999 chars). If a changelog
63 entry is not provided via "<" redirection, "git-commit-tree" will just wait
64 for one to be entered and terminated with ^D.
65
66 Diagnostics
67 -----------
68 You don't exist. Go away!::
69 The passwd(5) gecos field couldn't be read
70 Your parents must have hated you!::
71 The password(5) gecos field is longer than a giant static buffer.
72 Your sysadmin must hate you!::
73 The password(5) name field is longer than a giant static buffer.
74
75 See Also
76 --------
77 gitlink:git-write-tree[1]
78
79
80 Author
81 ------
82 Written by Linus Torvalds <torvalds@osdl.org>
83
84 Documentation
85 --------------
86 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
87
88 GIT
89 ---
90 Part of the gitlink:git[7] suite
91