Autogenerated man pages for 36de72aa9dc3b7daf8cf2770c840f39bb0d2ae70
[git.git] / man1 / git-commit-tree.1
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "GIT-COMMIT-TREE" 1 "" "" ""
21 .SH NAME
22 git-commit-tree \- Creates a new commit object
23 .SH "SYNOPSIS"
24
25
26 git\-commit\-tree <tree> [\-p <parent commit>]* < changelog
27
28 .SH "DESCRIPTION"
29
30
31 Creates a new commit object based on the provided tree object and emits the new commit object id on stdout\&. If no parent is given then it is considered to be an initial tree\&.
32
33
34 A commit object usually has 1 parent (a commit after a change) or up to 16 parents\&. More than one parent represents a merge of branches that led to them\&.
35
36
37 While a tree represents a particular directory state of a working directory, a commit represents that state in "time", and explains how to get there\&.
38
39
40 Normally a commit would identify a new "HEAD" state, and while git doesn't care where you save the note about that state, in practice we tend to just write the result to the file that is pointed at by \&.git/HEAD, so that we can always see what the last committed state was\&.
41
42 .SH "OPTIONS"
43
44 .TP
45 <tree>
46 An existing tree object
47
48 .TP
49 \-p <parent commit>
50 Each \-p indicates the id of a parent commit object\&.
51
52 .SH "COMMIT INFORMATION"
53
54
55 A commit encapsulates:
56
57 .TP 3
58 \(bu
59 all parent object ids
60 .TP
61 \(bu
62 author name, email and date
63 .TP
64 \(bu
65 committer name and email and the commit time\&.
66 .LP
67
68
69 If not provided, "git\-commit\-tree" uses your name, hostname and domain to provide author and committer info\&. This can be overridden by either \&.git/config file, or using the following environment variables\&.
70
71 .nf
72 GIT_AUTHOR_NAME
73 GIT_AUTHOR_EMAIL
74 GIT_AUTHOR_DATE
75 GIT_COMMITTER_NAME
76 GIT_COMMITTER_EMAIL
77 .fi
78
79
80 (nb "<", ">" and "\\n"s are stripped)
81
82
83 In \&.git/config file, the following items are used:
84
85 .nf
86 [user]
87         name = "Your Name"
88         email = "your@email\&.address\&.xz"
89 .fi
90
91
92 A commit comment is read from stdin (max 999 chars)\&. If a changelog entry is not provided via "<" redirection, "git\-commit\-tree" will just wait for one to be entered and terminated with ^D\&.
93
94 .SH "DIAGNOSTICS"
95
96 .TP
97 You don't exist\&. Go away!
98 The passwd(5) gecos field couldn't be read
99
100 .TP
101 Your parents must have hated you!
102 The password(5) gecos field is longer than a giant static buffer\&.
103
104 .TP
105 Your sysadmin must hate you!
106 The password(5) name field is longer than a giant static buffer\&.
107
108 .SH "SEE ALSO"
109
110
111 \fBgit\-write\-tree\fR(1)
112
113 .SH "AUTHOR"
114
115
116 Written by Linus Torvalds <torvalds@osdl\&.org>
117
118 .SH "DOCUMENTATION"
119
120
121 Documentation by David Greaves, Junio C Hamano and the git\-list <git@vger\&.kernel\&.org>\&.
122
123 .SH "GIT"
124
125
126 Part of the \fBgit\fR(7) suite
127