| blob | 9ce68dd0ec20eddf34699240ece6672311c94e57 |
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 vsnapshot <http://docbook.sf.net/>
5 .\" Date: 2023-07-14
6 .\" Manual: Git Manual
7 .\" Source: Git 2.41.0.337.g830b4a04c4
8 .\" Language: English
9 .\"
10 .TH "GIT\-COMMIT\-TREE" "1" "2023\-07\-14" "Git 2\&.41\&.0\&.337\&.g830b4a" "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 .sp
40 .SH "DESCRIPTION"
41 .sp
42 This is usually not what an end user wants to run directly\&. See \fBgit-commit\fR(1) instead\&.
43 .sp
44 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\&.
45 .sp
46 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\&.
47 .sp
48 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\&.
49 .sp
50 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\&.
51 .sp
52 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\&.
53 .SH "OPTIONS"
54 .PP
55 <tree>
56 .RS 4
57 An existing tree object\&.
58 .RE
59 .PP
60 \-p <parent>
61 .RS 4
62 Each
63 \fB\-p\fR
64 indicates the id of a parent commit object\&.
65 .RE
66 .PP
67 \-m <message>
68 .RS 4
69 A paragraph in the commit log message\&. This can be given more than once and each <message> becomes its own paragraph\&.
70 .RE
71 .PP
72 \-F <file>
73 .RS 4
74 Read the commit log message from the given file\&. Use
75 \fB\-\fR
76 to read from the standard input\&. This can be given more than once and the content of each file becomes its own paragraph\&.
77 .RE
78 .PP
79 \-S[<keyid>], \-\-gpg\-sign[=<keyid>], \-\-no\-gpg\-sign
80 .RS 4
81 GPG\-sign commits\&. The
82 \fBkeyid\fR
83 argument is optional and defaults to the committer identity; if specified, it must be stuck to the option without a space\&.
84 \fB\-\-no\-gpg\-sign\fR
85 is useful to countermand a
86 \fB\-\-gpg\-sign\fR
87 option given earlier on the command line\&.
88 .RE
89 .SH "COMMIT INFORMATION"
90 .sp
91 A commit encapsulates:
92 .sp
93 .RS 4
94 .ie n \{\
95 \h'-04'\(bu\h'+03'\c
96 .\}
97 .el \{\
98 .sp -1
99 .IP \(bu 2.3
100 .\}
101 all parent object ids
102 .RE
103 .sp
104 .RS 4
105 .ie n \{\
106 \h'-04'\(bu\h'+03'\c
107 .\}
108 .el \{\
109 .sp -1
110 .IP \(bu 2.3
111 .\}
112 author name, email and date
113 .RE
114 .sp
115 .RS 4
116 .ie n \{\
117 \h'-04'\(bu\h'+03'\c
118 .\}
119 .el \{\
120 .sp -1
121 .IP \(bu 2.3
122 .\}
123 committer name and email and the commit time\&.
124 .RE
125 .sp
126 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\&.
127 .SH "DATE FORMATS"
128 .sp
129 The \fBGIT_AUTHOR_DATE\fR and \fBGIT_COMMITTER_DATE\fR environment variables support the following date formats:
130 .PP
131 Git internal format
132 .RS 4
133 It is
134 \fB<unix\-timestamp> <time\-zone\-offset>\fR, where
135 \fB<unix\-timestamp>\fR
136 is the number of seconds since the UNIX epoch\&.
137 \fB<time\-zone\-offset>\fR
138 is a positive or negative offset from UTC\&. For example CET (which is 1 hour ahead of UTC) is
139 \fB+0100\fR\&.
140 .RE
141 .PP
142 RFC 2822
143 .RS 4
144 The standard email format as described by RFC 2822, for example
145 \fBThu, 07 Apr 2005 22:13:13 +0200\fR\&.
146 .RE
147 .PP
148 ISO 8601
149 .RS 4
150 Time and date specified by the ISO 8601 standard, for example
151 \fB2005\-04\-07T22:13:13\fR\&. The parser accepts a space instead of the
152 \fBT\fR
153 character as well\&. Fractional parts of a second will be ignored, for example
154 \fB2005\-04\-07T22:13:13\&.019\fR
155 will be treated as
156 \fB2005\-04\-07T22:13:13\fR\&.
157 .if n \{\
158 .sp
159 .\}
160 .RS 4
161 .it 1 an-trap
162 .nr an-no-space-flag 1
163 .nr an-break-flag 1
164 .br
165 .ps +1
166 \fBNote\fR
167 .ps -1
168 .br
169 In addition, the date part is accepted in the following formats:
170 \fBYYYY\&.MM\&.DD\fR,
171 \fBMM/DD/YYYY\fR
172 and
173 \fBDD\&.MM\&.YYYY\fR\&.
174 .sp .5v
175 .RE
176 .RE
177 .SH "DISCUSSION"
178 .sp
179 Git is to some extent character encoding agnostic\&.
180 .sp
181 .RS 4
182 .ie n \{\
183 \h'-04'\(bu\h'+03'\c
184 .\}
185 .el \{\
186 .sp -1
187 .IP \(bu 2.3
188 .\}
189 The contents of the blob objects are uninterpreted sequences of bytes\&. There is no encoding translation at the core level\&.
190 .RE
191 .sp
192 .RS 4
193 .ie n \{\
194 \h'-04'\(bu\h'+03'\c
195 .\}
196 .el \{\
197 .sp -1
198 .IP \(bu 2.3
199 .\}
200 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
201 (see
202 \fBgit-config\fR(1)),
203 \fBgitignore\fR(5),
204 \fBgitattributes\fR(5)
205 and
206 \fBgitmodules\fR(5))\&.
207 .sp
208 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\&.
209 .RE
210 .sp
211 .RS 4
212 .ie n \{\
213 \h'-04'\(bu\h'+03'\c
214 .\}
215 .el \{\
216 .sp -1
217 .IP \(bu 2.3
218 .\}
219 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
220 \fInot\fR
221 UTF\-16/32, EBCDIC and CJK multi\-byte encodings (GBK, Shift\-JIS, Big5, EUC\-x, CP9xx etc\&.)\&.
222 .RE
223 .sp
224 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\&.
225 .sp
226 .RS 4
227 .ie n \{\
228 \h'-04' 1.\h'+01'\c
229 .\}
230 .el \{\
231 .sp -1
232 .IP " 1." 4.2
233 .\}
234 \fIgit commit\fR
235 and
236 \fIgit commit\-tree\fR
237 issues 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
238 \fBi18n\&.commitEncoding\fR
239 in
240 \fB\&.git/config\fR
241 file, like this:
242 .sp
243 .if n \{\
244 .RS 4
245 .\}
246 .nf
247 [i18n]
248 commitEncoding = ISO\-8859\-1
249 .fi
250 .if n \{\
251 .RE
252 .\}
253 .sp
254 Commit objects created with the above setting record the value of
255 \fBi18n\&.commitEncoding\fR
256 in its
257 \fBencoding\fR
258 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\&.
259 .RE
260 .sp
261 .RS 4
262 .ie n \{\
263 \h'-04' 2.\h'+01'\c
264 .\}
265 .el \{\
266 .sp -1
267 .IP " 2." 4.2
268 .\}
269 \fIgit log\fR,
270 \fIgit show\fR,
271 \fIgit blame\fR
272 and friends look at the
273 \fBencoding\fR
274 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
275 \fBi18n\&.logOutputEncoding\fR
276 in
277 \fB\&.git/config\fR
278 file, like this:
279 .sp
280 .if n \{\
281 .RS 4
282 .\}
283 .nf
284 [i18n]
285 logOutputEncoding = ISO\-8859\-1
286 .fi
287 .if n \{\
288 .RE
289 .\}
290 .sp
291 If you do not have this configuration variable, the value of
292 \fBi18n\&.commitEncoding\fR
293 is used instead\&.
294 .RE
295 .sp
296 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\&.
297 .SH "FILES"
298 .sp
299 /etc/mailname
300 .SH "SEE ALSO"
301 .sp
302 \fBgit-write-tree\fR(1) \fBgit-commit\fR(1)
303 .SH "GIT"
304 .sp
305 Part of the \fBgit\fR(1) suite