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