Leave an empty line between log and sign-off.
[git/jrn.git] / Documentation / git-commit-tree.txt
blob895f7336487696254c1e34611226f725ae58bd87
1 git-commit-tree(1)
2 ==================
3 v0.1, May 2005
5 NAME
6 ----
7 git-commit-tree - Creates a new commit object
10 SYNOPSIS
11 --------
12 'git-commit-tree' <tree> [-p <parent commit>]\   < changelog
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.
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.
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.
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.
33 OPTIONS
34 -------
35 <tree>::
36         An existing tree object
38 -p <parent commit>::
39         Each '-p' indicates a the id of a parent commit object.
40         
42 Commit Information
43 ------------------
45 A commit encapsulates:
47 - all parent object ids
48 - author name, email and date
49 - committer name and email and the commit time.
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.
55         GIT_AUTHOR_NAME
56         GIT_AUTHOR_EMAIL
57         GIT_AUTHOR_DATE
58         GIT_COMMITTER_NAME
59         GIT_COMMITTER_EMAIL
61 (nb "<", ">" and "\n"s are stripped)
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.
67 Diagnostics
68 -----------
69 You don't exist. Go away!::
70     The passwd(5) gecos field couldn't be read
71 Your parents must have hated you!::
72     The password(5) gecos field is longer than a giant static buffer.
73 Your sysadmin must hate you!::
74     The password(5) name field is longer than a giant static buffer.
76 See Also
77 --------
78 gitlink:git-write-tree[1]
81 Author
82 ------
83 Written by Linus Torvalds <torvalds@osdl.org>
85 Documentation
86 --------------
87 Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
89 GIT
90 ---
91 Part of the gitlink:git[7] suite