]> git.ipfire.org Git - thirdparty/git.git/blame - Documentation/git-commit-tree.txt
diff-delta: use realloc instead of xrealloc
[thirdparty/git.git] / Documentation / git-commit-tree.txt
CommitLineData
2cf565c5
DG
1git-commit-tree(1)
2==================
2cf565c5
DG
3
4NAME
5----
c3f0baac 6git-commit-tree - Create a new commit object
2cf565c5
DG
7
8
9SYNOPSIS
10--------
7acab8f1 11'git-commit-tree' <tree> [-p <parent commit>]\* < changelog
2cf565c5
DG
12
13DESCRIPTION
14-----------
5cb545fa
JH
15This is usually not what an end user wants to run directly. See
16gitlink:git-commit[1] instead.
17
2cf565c5
DG
18Creates a new commit object based on the provided tree object and
19emits the new commit object id on stdout. If no parent is given then
20it is considered to be an initial tree.
21
22A commit object usually has 1 parent (a commit after a change) or up
23to 16 parents. More than one parent represents a merge of branches
24that led to them.
25
26While a tree represents a particular directory state of a working
27directory, a commit represents that state in "time", and explains how
28to get there.
29
30Normally a commit would identify a new "HEAD" state, and while git
31doesn't care where you save the note about that state, in practice we
27dedf0c
JH
32tend 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
34state was.
2cf565c5
DG
35
36OPTIONS
37-------
38<tree>::
39 An existing tree object
40
41-p <parent commit>::
f73ae1fc 42 Each '-p' indicates the id of a parent commit object.
2cf565c5
DG
43
44
45Commit Information
46------------------
47
48A commit encapsulates:
49
50- all parent object ids
51- author name, email and date
52- committer name and email and the commit time.
53
54If not provided, "git-commit-tree" uses your name, hostname and domain to
5773c9f2
JH
55provide author and committer info. This can be overridden by
56either `.git/config` file, or using the following environment variables.
2cf565c5
DG
57
58 GIT_AUTHOR_NAME
59 GIT_AUTHOR_EMAIL
60 GIT_AUTHOR_DATE
61 GIT_COMMITTER_NAME
62 GIT_COMMITTER_EMAIL
4e58bf97 63 GIT_COMMITTER_DATE
28a94f88 64 EMAIL
2cf565c5 65
df8baa42 66(nb "<", ">" and "\n"s are stripped)
2cf565c5 67
50b4e0c1
AR
68In `.git/config` file, the following items are used for GIT_AUTHOR_NAME and
69GIT_AUTHOR_EMAIL:
5773c9f2
JH
70
71 [user]
72 name = "Your Name"
73 email = "your@email.address.xz"
74
2cf565c5 75A commit comment is read from stdin (max 999 chars). If a changelog
df8baa42
JF
76entry is not provided via "<" redirection, "git-commit-tree" will just wait
77for one to be entered and terminated with ^D.
2cf565c5 78
5773c9f2 79
c1bdacf9
DG
80Diagnostics
81-----------
82You don't exist. Go away!::
83 The passwd(5) gecos field couldn't be read
9153368d
EB
84Your parents must have hated you!::
85 The password(5) gecos field is longer than a giant static buffer.
86Your sysadmin must hate you!::
87 The password(5) name field is longer than a giant static buffer.
c1bdacf9 88
5dc7bcc2
JH
89Discussion
90----------
91
92include::i18n.txt[]
93
c1bdacf9
DG
94See Also
95--------
a7154e91 96gitlink:git-write-tree[1]
2cf565c5
DG
97
98
99Author
100------
101Written by Linus Torvalds <torvalds@osdl.org>
102
103Documentation
104--------------
105Documentation by David Greaves, Junio C Hamano and the git-list <git@vger.kernel.org>.
106
107GIT
108---
a7154e91 109Part of the gitlink:git[7] suite
2cf565c5 110