| blob | 885732872f4c96d1c91bcbe674b1f2d8d76da9bc |
1 '\" t
2 .\" Title: git-commit-tree
3 .\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
4 .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
5 .\" Date: 2024-09-20
6 .\" Manual: Git Manual
7 .\" Source: Git 2.46.1.603.g94b60adee3
8 .\" Language: English
9 .\"
10 .TH "GIT\-COMMIT\-TREE" "1" "2024-09-20" "Git 2\&.46\&.1\&.603\&.g94b60a" "Git Manual"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
30 .SH "NAME"
31 git-commit-tree \- Create a new commit object
32 .SH "SYNOPSIS"
33 .sp
34 .nf
35 \fIgit commit\-tree\fR <tree> [(\-p <parent>)\&...\:]
36 \fIgit commit\-tree\fR [(\-p <parent>)\&...\:] [\-S[<keyid>]] [(\-m <message>)\&...\:]
37 [(\-F <file>)\&...\:] <tree>
38 .fi
39 .SH "DESCRIPTION"
40 .sp
41 This is usually not what an end user wants to run directly\&. See \fBgit-commit\fR(1) instead\&.
42 .sp
43 Creates a new commit object based on the provided tree object and emits the new commit object id on stdout\&. The log message is read from the standard input, unless \fB\-m\fR or \fB\-F\fR options are given\&.
44 .sp
45 The \fB\-m\fR and \fB\-F\fR options can be given any number of times, in any order\&. The commit log message will be composed in the order in which the options are given\&.
46 .sp
47 A commit object may have any number of parents\&. With exactly one parent, it is an ordinary commit\&. Having more than one parent makes the commit a merge between several lines of history\&. Initial (root) commits have no parents\&.
48 .sp
49 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\&.
50 .sp
51 Normally a commit would identify a new "HEAD" state, and while Git doesn\(cqt 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 \fB\&.git/HEAD\fR, so that we can always see what the last committed state was\&.
52 .SH "OPTIONS"
53 .PP
54 <tree>
55 .RS 4
56 An existing tree object\&.
57 .RE
58 .PP
59 \-p <parent>
60 .RS 4
61 Each
62 \fB\-p\fR
63 indicates the id of a parent commit object\&.
64 .RE
65 .PP
66 \-m <message>
67 .RS 4
68 A paragraph in the commit log message\&. This can be given more than once and each <message> becomes its own paragraph\&.
69 .RE
70 .PP
71 \-F <file>
72 .RS 4
73 Read the commit log message from the given file\&. Use
74 \fB\-\fR
75 to read from the standard input\&. This can be given more than once and the content of each file becomes its own paragraph\&.
76 .RE
77 .PP
78 \-S[<keyid>], \-\-gpg\-sign[=<keyid>], \-\-no\-gpg\-sign
79 .RS 4
80 GPG\-sign commits\&. The
81 \fBkeyid\fR
82 argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
83 \fB\-\-no\-gpg\-sign\fR
84 is useful to countermand a
85 \fB\-\-gpg\-sign\fR
86 option given earlier on the command line\&.
87 .RE
88 .SH "COMMIT INFORMATION"
89 .sp
90 A commit encapsulates:
91 .sp
92 .RS 4
93 .ie n \{\
94 \h'-04'\(bu\h'+03'\c
95 .\}
96 .el \{\
97 .sp -1
98 .IP \(bu 2.3
99 .\}
100 all parent object ids
101 .RE
102 .sp
103 .RS 4
104 .ie n \{\
105 \h'-04'\(bu\h'+03'\c
106 .\}
107 .el \{\
108 .sp -1
109 .IP \(bu 2.3
110 .\}
111 author name, email and date
112 .RE
113 .sp
114 .RS 4
115 .ie n \{\
116 \h'-04'\(bu\h'+03'\c
117 .\}
118 .el \{\
119 .sp -1
120 .IP \(bu 2.3
121 .\}
122 committer name and email and the commit time\&.
123 .RE
124 .sp
125 A commit comment is read from stdin\&. If a changelog entry is not provided via "<" redirection, \fIgit commit\-tree\fR will just wait for one to be entered and terminated with ^D\&.
126 .SH "DATE FORMATS"
127 .sp
128 The \fBGIT_AUTHOR_DATE\fR and \fBGIT_COMMITTER_DATE\fR environment variables support the following date formats:
129 .PP
130 Git internal format
131 .RS 4
132 It is
133 \fB<unix\-timestamp> <time\-zone\-offset>\fR, where
134 \fB<unix\-timestamp>\fR
135 is the number of seconds since the UNIX epoch\&.
136 \fB<time\-zone\-offset>\fR
137 is a positive or negative offset from UTC\&. For example CET (which is 1 hour ahead of UTC) is
138 \fB+0100\fR\&.
139 .RE
140 .PP
141 RFC 2822
142 .RS 4
143 The standard date format as described by RFC 2822, for example
144 \fBThu, 07 Apr 2005 22:13:13 +0200\fR\&.
145 .RE
146 .PP
147 ISO 8601
148 .RS 4
149 Time and date specified by the ISO 8601 standard, for example
150 \fB2005\-04\-07T22:13:13\fR\&. The parser accepts a space instead of the
151 \fBT\fR
152 character as well\&. Fractional parts of a second will be ignored, for example
153 \fB2005\-04\-07T22:13:13\&.019\fR
154 will be treated as
155 \fB2005\-04\-07T22:13:13\fR\&.
156 .if n \{\
157 .sp
158 .\}
159 .RS 4
160 .it 1 an-trap
161 .nr an-no-space-flag 1
162 .nr an-break-flag 1
163 .br
164 .ps +1
165 \fBNote\fR
166 .ps -1
167 .br
168 In addition, the date part is accepted in the following formats:
169 \fBYYYY\&.MM\&.DD\fR,
170 \fBMM/DD/YYYY\fR
171 and
172 \fBDD\&.MM\&.YYYY\fR\&.
173 .sp .5v
174 .RE
175 .RE
176 .SH "DISCUSSION"
177 .sp
178 Git is to some extent character encoding agnostic\&.
179 .sp
180 .RS 4
181 .ie n \{\
182 \h'-04'\(bu\h'+03'\c
183 .\}
184 .el \{\
185 .sp -1
186 .IP \(bu 2.3
187 .\}
188 The contents of the blob objects are uninterpreted sequences of bytes\&. There is no encoding translation at the core level\&.
189 .RE
190 .sp
191 .RS 4
192 .ie n \{\
193 \h'-04'\(bu\h'+03'\c
194 .\}
195 .el \{\
196 .sp -1
197 .IP \(bu 2.3
198 .\}
199 Path names are encoded in UTF\-8 normalization form C\&. This applies to tree objects, the index file, ref names, as well as path names in command line arguments, environment variables and config files (\fB\&.git/config\fR
200 (see
201 \fBgit-config\fR(1)),
202 \fBgitignore\fR(5),
203 \fBgitattributes\fR(5)
204 and
205 \fBgitmodules\fR(5))\&.
206 .sp
207 Note that Git at the core level treats path names simply as sequences of non\-NUL bytes, there are no path name encoding conversions (except on Mac and Windows)\&. Therefore, using non\-ASCII path names will mostly work even on platforms and file systems that use legacy extended ASCII encodings\&. However, repositories created on such systems will not work properly on UTF\-8\-based systems (e\&.g\&. Linux, Mac, Windows) and vice versa\&. Additionally, many Git\-based tools simply assume path names to be UTF\-8 and will fail to display other encodings correctly\&.
208 .RE
209 .sp
210 .RS 4
211 .ie n \{\
212 \h'-04'\(bu\h'+03'\c
213 .\}
214 .el \{\
215 .sp -1
216 .IP \(bu 2.3
217 .\}
218 Commit log messages are typically encoded in UTF\-8, but other extended ASCII encodings are also supported\&. This includes ISO\-8859\-x, CP125x and many others, but
219 \fInot\fR
220 UTF\-16/32, EBCDIC and CJK multi\-byte encodings (GBK, Shift\-JIS, Big5, EUC\-x, CP9xx etc\&.)\&.
221 .RE
222 .sp
223 Although we encourage that the commit log messages are encoded in UTF\-8, both the core and Git Porcelain are designed not to force UTF\-8 on projects\&. If all participants of a particular project find it more convenient to use legacy encodings, Git does not forbid it\&. However, there are a few things to keep in mind\&.
224 .sp
225 .RS 4
226 .ie n \{\
227 \h'-04' 1.\h'+01'\c
228 .\}
229 .el \{\
230 .sp -1
231 .IP " 1." 4.2
232 .\}
233 \fIgit commit\fR
234 and
235 \fIgit commit\-tree\fR
236 issue a warning if the commit log message given to it does not look like a valid UTF\-8 string, unless you explicitly say your project uses a legacy encoding\&. The way to say this is to have
237 \fBi18n\&.commitEncoding\fR
238 in
239 \fB\&.git/config\fR
240 file, like this:
241 .sp
242 .if n \{\
243 .RS 4
244 .\}
245 .nf
246 [i18n]
247 commitEncoding = ISO\-8859\-1
248 .fi
249 .if n \{\
250 .RE
251 .\}
252 .sp
253 Commit objects created with the above setting record the value of
254 \fBi18n\&.commitEncoding\fR
255 in their
256 \fBencoding\fR
257 header\&. This is to help other people who look at them later\&. Lack of this header implies that the commit log message is encoded in UTF\-8\&.
258 .RE
259 .sp
260 .RS 4
261 .ie n \{\
262 \h'-04' 2.\h'+01'\c
263 .\}
264 .el \{\
265 .sp -1
266 .IP " 2." 4.2
267 .\}
268 \fIgit log\fR,
269 \fIgit show\fR,
270 \fIgit blame\fR
271 and friends look at the
272 \fBencoding\fR
273 header of a commit object, and try to re\-code the log message into UTF\-8 unless otherwise specified\&. You can specify the desired output encoding with
274 \fBi18n\&.logOutputEncoding\fR
275 in
276 \fB\&.git/config\fR
277 file, like this:
278 .sp
279 .if n \{\
280 .RS 4
281 .\}
282 .nf
283 [i18n]
284 logOutputEncoding = ISO\-8859\-1
285 .fi
286 .if n \{\
287 .RE
288 .\}
289 .sp
290 If you do not have this configuration variable, the value of
291 \fBi18n\&.commitEncoding\fR
292 is used instead\&.
293 .RE
294 .sp
295 Note that we deliberately chose not to re\-code the commit log message when a commit is made to force UTF\-8 at the commit object level, because re\-coding to UTF\-8 is not necessarily a reversible operation\&.
296 .SH "FILES"
297 .sp
298 /etc/mailname
299 .SH "SEE ALSO"
300 .sp
301 \fBgit-write-tree\fR(1) \fBgit-commit\fR(1)
302 .SH "GIT"
303 .sp
304 Part of the \fBgit\fR(1) suite