blob: 3f450422951dfd7513dfa997f7399cbb9f6ea23e [file] [log] [blame]
Junio C Hamano1a4e8412005-12-27 08:17:231<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
4<head>
Junio C Hamano9d971152012-12-19 00:43:115<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
Junio C Hamanoc14e6ad2014-10-31 20:25:536<meta name="generator" content="AsciiDoc 8.6.9" />
Junio C Hamano60186642010-12-02 14:18:267<title>git-commit(1)</title>
Junio C Hamano1a4e8412005-12-27 08:17:238<style type="text/css">
Junio C Hamano9d971152012-12-19 00:43:119/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
10
11/* Default font. */
12body {
13 font-family: Georgia,serif;
14}
15
16/* Title font. */
17h1, h2, h3, h4, h5, h6,
18div.title, caption.title,
19thead, p.table.header,
20#toctitle,
21#author, #revnumber, #revdate, #revremark,
22#footer {
23 font-family: Arial,Helvetica,sans-serif;
Junio C Hamano1a4e8412005-12-27 08:17:2324}
25
26body {
27 margin: 1em 5% 1em 5%;
28}
29
Junio C Hamanoba4b9282008-07-06 05:20:3130a {
31 color: blue;
32 text-decoration: underline;
33}
34a:visited {
35 color: fuchsia;
36}
Junio C Hamano1a4e8412005-12-27 08:17:2337
38em {
39 font-style: italic;
Junio C Hamano60186642010-12-02 14:18:2640 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:2341}
42
43strong {
44 font-weight: bold;
Junio C Hamano60186642010-12-02 14:18:2645 color: #083194;
Junio C Hamano1a4e8412005-12-27 08:17:2346}
47
Junio C Hamano1a4e8412005-12-27 08:17:2348h1, h2, h3, h4, h5, h6 {
49 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:2350 margin-top: 1.2em;
51 margin-bottom: 0.5em;
52 line-height: 1.3;
53}
54
Junio C Hamanoba4b9282008-07-06 05:20:3155h1, h2, h3 {
Junio C Hamano1a4e8412005-12-27 08:17:2356 border-bottom: 2px solid silver;
57}
58h2 {
Junio C Hamano1a4e8412005-12-27 08:17:2359 padding-top: 0.5em;
60}
Junio C Hamanoba4b9282008-07-06 05:20:3161h3 {
62 float: left;
63}
64h3 + * {
65 clear: left;
66}
Junio C Hamano9d971152012-12-19 00:43:1167h5 {
68 font-size: 1.0em;
69}
Junio C Hamano1a4e8412005-12-27 08:17:2370
71div.sectionbody {
Junio C Hamano1a4e8412005-12-27 08:17:2372 margin-left: 0;
73}
74
75hr {
76 border: 1px solid silver;
77}
78
79p {
80 margin-top: 0.5em;
81 margin-bottom: 0.5em;
82}
83
Junio C Hamano60186642010-12-02 14:18:2684ul, ol, li > p {
85 margin-top: 0;
86}
Junio C Hamano9d971152012-12-19 00:43:1187ul > li { color: #aaa; }
88ul > li > * { color: black; }
Junio C Hamano60186642010-12-02 14:18:2689
Junio C Hamanoc14e6ad2014-10-31 20:25:5390.monospaced, code, pre {
91 font-family: "Courier New", Courier, monospace;
92 font-size: inherit;
93 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:2394 padding: 0;
95 margin: 0;
96}
Junio C Hamanoc14e6ad2014-10-31 20:25:5397pre {
98 white-space: pre-wrap;
99}
Junio C Hamano1a4e8412005-12-27 08:17:23100
Junio C Hamano9d971152012-12-19 00:43:11101#author {
Junio C Hamano1a4e8412005-12-27 08:17:23102 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23103 font-weight: bold;
Junio C Hamanoba4b9282008-07-06 05:20:31104 font-size: 1.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23105}
Junio C Hamano9d971152012-12-19 00:43:11106#email {
Junio C Hamano1a4e8412005-12-27 08:17:23107}
Junio C Hamano9d971152012-12-19 00:43:11108#revnumber, #revdate, #revremark {
Junio C Hamano1a4e8412005-12-27 08:17:23109}
110
Junio C Hamano9d971152012-12-19 00:43:11111#footer {
Junio C Hamano1a4e8412005-12-27 08:17:23112 font-size: small;
113 border-top: 2px solid silver;
114 padding-top: 0.5em;
115 margin-top: 4.0em;
116}
Junio C Hamano9d971152012-12-19 00:43:11117#footer-text {
Junio C Hamano1a4e8412005-12-27 08:17:23118 float: left;
119 padding-bottom: 0.5em;
120}
Junio C Hamano9d971152012-12-19 00:43:11121#footer-badges {
Junio C Hamano1a4e8412005-12-27 08:17:23122 float: right;
123 padding-bottom: 0.5em;
124}
125
Junio C Hamano9d971152012-12-19 00:43:11126#preamble {
Junio C Hamano60186642010-12-02 14:18:26127 margin-top: 1.5em;
128 margin-bottom: 1.5em;
129}
Junio C Hamano9d971152012-12-19 00:43:11130div.imageblock, div.exampleblock, div.verseblock,
Junio C Hamano1a4e8412005-12-27 08:17:23131div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
132div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22133 margin-top: 1.0em;
Junio C Hamano1a4e8412005-12-27 08:17:23134 margin-bottom: 1.5em;
135}
136div.admonitionblock {
Junio C Hamano7bd050f2011-09-22 06:32:22137 margin-top: 2.0em;
138 margin-bottom: 2.0em;
139 margin-right: 10%;
140 color: #606060;
Junio C Hamano1a4e8412005-12-27 08:17:23141}
142
143div.content { /* Block element content. */
144 padding: 0;
145}
146
147/* Block element titles. */
148div.title, caption.title {
Junio C Hamano60186642010-12-02 14:18:26149 color: #527bbd;
Junio C Hamano1a4e8412005-12-27 08:17:23150 font-weight: bold;
151 text-align: left;
152 margin-top: 1.0em;
153 margin-bottom: 0.5em;
154}
155div.title + * {
156 margin-top: 0;
157}
158
159td div.title:first-child {
160 margin-top: 0.0em;
161}
162div.content div.title:first-child {
163 margin-top: 0.0em;
164}
165div.content + div.title {
166 margin-top: 0.0em;
167}
168
169div.sidebarblock > div.content {
170 background: #ffffee;
Junio C Hamano9d971152012-12-19 00:43:11171 border: 1px solid #dddddd;
172 border-left: 4px solid #f0f0f0;
Junio C Hamano1a4e8412005-12-27 08:17:23173 padding: 0.5em;
174}
175
176div.listingblock > div.content {
Junio C Hamano9d971152012-12-19 00:43:11177 border: 1px solid #dddddd;
178 border-left: 5px solid #f0f0f0;
179 background: #f8f8f8;
Junio C Hamano1a4e8412005-12-27 08:17:23180 padding: 0.5em;
181}
182
Junio C Hamano7bd050f2011-09-22 06:32:22183div.quoteblock, div.verseblock {
184 padding-left: 1.0em;
185 margin-left: 1.0em;
Junio C Hamano60186642010-12-02 14:18:26186 margin-right: 10%;
Junio C Hamano9d971152012-12-19 00:43:11187 border-left: 5px solid #f0f0f0;
188 color: #888;
Junio C Hamano1a4e8412005-12-27 08:17:23189}
Junio C Hamano7bd050f2011-09-22 06:32:22190
Junio C Hamano60186642010-12-02 14:18:26191div.quoteblock > div.attribution {
192 padding-top: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23193 text-align: right;
194}
Junio C Hamano60186642010-12-02 14:18:26195
Junio C Hamano9d971152012-12-19 00:43:11196div.verseblock > pre.content {
197 font-family: inherit;
198 font-size: inherit;
Junio C Hamano60186642010-12-02 14:18:26199}
200div.verseblock > div.attribution {
201 padding-top: 0.75em;
202 text-align: left;
203}
204/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
Junio C Hamanoba4b9282008-07-06 05:20:31205div.verseblock + div.attribution {
206 text-align: left;
207}
Junio C Hamano1a4e8412005-12-27 08:17:23208
209div.admonitionblock .icon {
210 vertical-align: top;
211 font-size: 1.1em;
212 font-weight: bold;
213 text-decoration: underline;
214 color: #527bbd;
215 padding-right: 0.5em;
216}
217div.admonitionblock td.content {
218 padding-left: 0.5em;
Junio C Hamano7bd050f2011-09-22 06:32:22219 border-left: 3px solid #dddddd;
Junio C Hamano1a4e8412005-12-27 08:17:23220}
221
222div.exampleblock > div.content {
Junio C Hamano7bd050f2011-09-22 06:32:22223 border-left: 3px solid #dddddd;
224 padding-left: 0.5em;
Junio C Hamano1a4e8412005-12-27 08:17:23225}
226
Junio C Hamano1a4e8412005-12-27 08:17:23227div.imageblock div.content { padding-left: 0; }
Junio C Hamanoc14e6ad2014-10-31 20:25:53228span.image img { border-style: none; vertical-align: text-bottom; }
Junio C Hamano60186642010-12-02 14:18:26229a.image:visited { color: white; }
Junio C Hamano1a4e8412005-12-27 08:17:23230
231dl {
232 margin-top: 0.8em;
233 margin-bottom: 0.8em;
234}
235dt {
236 margin-top: 0.5em;
237 margin-bottom: 0;
Junio C Hamano60186642010-12-02 14:18:26238 font-style: normal;
239 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23240}
241dd > *:first-child {
Junio C Hamano60186642010-12-02 14:18:26242 margin-top: 0.1em;
Junio C Hamano1a4e8412005-12-27 08:17:23243}
244
245ul, ol {
246 list-style-position: outside;
247}
Junio C Hamano60186642010-12-02 14:18:26248ol.arabic {
249 list-style-type: decimal;
250}
251ol.loweralpha {
Junio C Hamano1a4e8412005-12-27 08:17:23252 list-style-type: lower-alpha;
253}
Junio C Hamano60186642010-12-02 14:18:26254ol.upperalpha {
255 list-style-type: upper-alpha;
256}
257ol.lowerroman {
258 list-style-type: lower-roman;
259}
260ol.upperroman {
261 list-style-type: upper-roman;
262}
263
264div.compact ul, div.compact ol,
265div.compact p, div.compact p,
266div.compact div, div.compact div {
267 margin-top: 0.1em;
268 margin-bottom: 0.1em;
269}
Junio C Hamano1a4e8412005-12-27 08:17:23270
Junio C Hamano1a4e8412005-12-27 08:17:23271tfoot {
272 font-weight: bold;
273}
Junio C Hamano60186642010-12-02 14:18:26274td > div.verse {
275 white-space: pre;
276}
Junio C Hamano60186642010-12-02 14:18:26277
278div.hdlist {
Junio C Hamano1a4e8412005-12-27 08:17:23279 margin-top: 0.8em;
280 margin-bottom: 0.8em;
281}
Junio C Hamano60186642010-12-02 14:18:26282div.hdlist tr {
283 padding-bottom: 15px;
Junio C Hamanoba4b9282008-07-06 05:20:31284}
Junio C Hamano60186642010-12-02 14:18:26285dt.hdlist1.strong, td.hdlist1.strong {
286 font-weight: bold;
287}
288td.hdlist1 {
Junio C Hamano1a4e8412005-12-27 08:17:23289 vertical-align: top;
Junio C Hamano60186642010-12-02 14:18:26290 font-style: normal;
Junio C Hamano1a4e8412005-12-27 08:17:23291 padding-right: 0.8em;
Junio C Hamano60186642010-12-02 14:18:26292 color: navy;
Junio C Hamano1a4e8412005-12-27 08:17:23293}
Junio C Hamano60186642010-12-02 14:18:26294td.hdlist2 {
Junio C Hamano1a4e8412005-12-27 08:17:23295 vertical-align: top;
296}
Junio C Hamano60186642010-12-02 14:18:26297div.hdlist.compact tr {
298 margin: 0;
299 padding-bottom: 0;
300}
301
302.comment {
303 background: yellow;
304}
Junio C Hamano1a4e8412005-12-27 08:17:23305
Junio C Hamano7bd050f2011-09-22 06:32:22306.footnote, .footnoteref {
307 font-size: 0.8em;
308}
309
310span.footnote, span.footnoteref {
311 vertical-align: super;
312}
313
314#footnotes {
315 margin: 20px 0 20px 0;
316 padding: 7px 0 0 0;
317}
318
319#footnotes div.footnote {
320 margin: 0 0 5px 0;
321}
322
323#footnotes hr {
324 border: none;
325 border-top: 1px solid silver;
326 height: 1px;
327 text-align: left;
328 margin-left: 0;
329 width: 20%;
330 min-width: 100px;
331}
332
Junio C Hamano9d971152012-12-19 00:43:11333div.colist td {
334 padding-right: 0.5em;
335 padding-bottom: 0.3em;
336 vertical-align: top;
337}
338div.colist td img {
339 margin-top: 0.3em;
Junio C Hamano1a4e8412005-12-27 08:17:23340}
Junio C Hamanoba4b9282008-07-06 05:20:31341
Junio C Hamano9d971152012-12-19 00:43:11342@media print {
343 #footer-badges { display: none; }
344}
345
346#toc {
Junio C Hamano7bd050f2011-09-22 06:32:22347 margin-bottom: 2.5em;
348}
349
Junio C Hamano9d971152012-12-19 00:43:11350#toctitle {
Junio C Hamanoba4b9282008-07-06 05:20:31351 color: #527bbd;
Junio C Hamanoba4b9282008-07-06 05:20:31352 font-size: 1.1em;
353 font-weight: bold;
354 margin-top: 1.0em;
355 margin-bottom: 0.1em;
356}
357
Junio C Hamanoc14e6ad2014-10-31 20:25:53358div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
Junio C Hamanoba4b9282008-07-06 05:20:31359 margin-top: 0;
360 margin-bottom: 0;
361}
362div.toclevel2 {
363 margin-left: 2em;
364 font-size: 0.9em;
365}
366div.toclevel3 {
367 margin-left: 4em;
368 font-size: 0.9em;
369}
370div.toclevel4 {
371 margin-left: 6em;
372 font-size: 0.9em;
373}
Junio C Hamano9d971152012-12-19 00:43:11374
375span.aqua { color: aqua; }
376span.black { color: black; }
377span.blue { color: blue; }
378span.fuchsia { color: fuchsia; }
379span.gray { color: gray; }
380span.green { color: green; }
381span.lime { color: lime; }
382span.maroon { color: maroon; }
383span.navy { color: navy; }
384span.olive { color: olive; }
385span.purple { color: purple; }
386span.red { color: red; }
387span.silver { color: silver; }
388span.teal { color: teal; }
389span.white { color: white; }
390span.yellow { color: yellow; }
391
392span.aqua-background { background: aqua; }
393span.black-background { background: black; }
394span.blue-background { background: blue; }
395span.fuchsia-background { background: fuchsia; }
396span.gray-background { background: gray; }
397span.green-background { background: green; }
398span.lime-background { background: lime; }
399span.maroon-background { background: maroon; }
400span.navy-background { background: navy; }
401span.olive-background { background: olive; }
402span.purple-background { background: purple; }
403span.red-background { background: red; }
404span.silver-background { background: silver; }
405span.teal-background { background: teal; }
406span.white-background { background: white; }
407span.yellow-background { background: yellow; }
408
409span.big { font-size: 2em; }
410span.small { font-size: 0.6em; }
411
412span.underline { text-decoration: underline; }
413span.overline { text-decoration: overline; }
414span.line-through { text-decoration: line-through; }
415
Junio C Hamanoc14e6ad2014-10-31 20:25:53416div.unbreakable { page-break-inside: avoid; }
417
Junio C Hamano9d971152012-12-19 00:43:11418
419/*
420 * xhtml11 specific
421 *
422 * */
423
424div.tableblock {
425 margin-top: 1.0em;
426 margin-bottom: 1.5em;
427}
428div.tableblock > table {
429 border: 3px solid #527bbd;
430}
431thead, p.table.header {
432 font-weight: bold;
433 color: #527bbd;
434}
435p.table {
436 margin-top: 0;
437}
438/* Because the table frame attribute is overriden by CSS in most browsers. */
439div.tableblock > table[frame="void"] {
440 border-style: none;
441}
442div.tableblock > table[frame="hsides"] {
443 border-left-style: none;
444 border-right-style: none;
445}
446div.tableblock > table[frame="vsides"] {
447 border-top-style: none;
448 border-bottom-style: none;
449}
450
451
452/*
453 * html5 specific
454 *
455 * */
456
457table.tableblock {
458 margin-top: 1.0em;
459 margin-bottom: 1.5em;
460}
461thead, p.tableblock.header {
462 font-weight: bold;
463 color: #527bbd;
464}
465p.tableblock {
466 margin-top: 0;
467}
468table.tableblock {
469 border-width: 3px;
470 border-spacing: 0px;
471 border-style: solid;
472 border-color: #527bbd;
473 border-collapse: collapse;
474}
475th.tableblock, td.tableblock {
476 border-width: 1px;
477 padding: 4px;
478 border-style: solid;
479 border-color: #527bbd;
480}
481
482table.tableblock.frame-topbot {
483 border-left-style: hidden;
484 border-right-style: hidden;
485}
486table.tableblock.frame-sides {
487 border-top-style: hidden;
488 border-bottom-style: hidden;
489}
490table.tableblock.frame-none {
491 border-style: hidden;
492}
493
494th.tableblock.halign-left, td.tableblock.halign-left {
495 text-align: left;
496}
497th.tableblock.halign-center, td.tableblock.halign-center {
498 text-align: center;
499}
500th.tableblock.halign-right, td.tableblock.halign-right {
501 text-align: right;
502}
503
504th.tableblock.valign-top, td.tableblock.valign-top {
505 vertical-align: top;
506}
507th.tableblock.valign-middle, td.tableblock.valign-middle {
508 vertical-align: middle;
509}
510th.tableblock.valign-bottom, td.tableblock.valign-bottom {
511 vertical-align: bottom;
512}
513
514
515/*
516 * manpage specific
517 *
518 * */
519
520body.manpage h1 {
Junio C Hamano60186642010-12-02 14:18:26521 padding-top: 0.5em;
522 padding-bottom: 0.5em;
523 border-top: 2px solid silver;
524 border-bottom: 2px solid silver;
525}
Junio C Hamano9d971152012-12-19 00:43:11526body.manpage h2 {
Junio C Hamano60186642010-12-02 14:18:26527 border-style: none;
528}
Junio C Hamano9d971152012-12-19 00:43:11529body.manpage div.sectionbody {
530 margin-left: 3em;
Junio C Hamano60186642010-12-02 14:18:26531}
532
533@media print {
Junio C Hamano9d971152012-12-19 00:43:11534 body.manpage div#toc { display: none; }
Junio C Hamano60186642010-12-02 14:18:26535}
Junio C Hamanoc14e6ad2014-10-31 20:25:53536
537
Junio C Hamano1a4e8412005-12-27 08:17:23538</style>
Junio C Hamano7bd050f2011-09-22 06:32:22539<script type="text/javascript">
540/*<![CDATA[*/
Junio C Hamano7bd050f2011-09-22 06:32:22541var asciidoc = { // Namespace.
542
543/////////////////////////////////////////////////////////////////////
544// Table Of Contents generator
545/////////////////////////////////////////////////////////////////////
546
547/* Author: Mihai Bazon, September 2002
548 * http://students.infoiasi.ro/~mishoo
549 *
550 * Table Of Content generator
551 * Version: 0.4
552 *
553 * Feel free to use this script under the terms of the GNU General Public
554 * License, as long as you do not remove or alter this notice.
555 */
556
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
559
560// toclevels = 1..4.
561toc: function (toclevels) {
562
563 function getText(el) {
564 var text = "";
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
567 text += i.data;
568 else if (i.firstChild != null)
569 text += getText(i);
570 }
571 return text;
572 }
573
574 function TocEntry(el, text, toclevel) {
575 this.element = el;
576 this.text = text;
577 this.toclevel = toclevel;
578 }
579
580 function tocEntries(el, toclevels) {
581 var result = new Array;
Junio C Hamanoc14e6ad2014-10-31 20:25:53582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
Junio C Hamano7bd050f2011-09-22 06:32:22583 // Function that scans the DOM tree for header elements (the DOM2
584 // nodeIterator API would be a better technique but not supported by all
585 // browsers).
586 var iterate = function (el) {
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
589 var mo = re.exec(i.tagName);
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
592 }
593 iterate(i);
594 }
595 }
596 }
597 iterate(el);
598 return result;
599 }
600
601 var toc = document.getElementById("toc");
Junio C Hamano9d971152012-12-19 00:43:11602 if (!toc) {
603 return;
604 }
605
606 // Delete existing TOC entries in case we're reloading the TOC.
607 var tocEntriesToRemove = [];
608 var i;
609 for (i = 0; i < toc.childNodes.length; i++) {
610 var entry = toc.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53611 if (entry.nodeName.toLowerCase() == 'div'
Junio C Hamano9d971152012-12-19 00:43:11612 && entry.getAttribute("class")
613 && entry.getAttribute("class").match(/^toclevel/))
614 tocEntriesToRemove.push(entry);
615 }
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
617 toc.removeChild(tocEntriesToRemove[i]);
618 }
619
620 // Rebuild TOC entries.
Junio C Hamano7bd050f2011-09-22 06:32:22621 var entries = tocEntries(document.getElementById("content"), toclevels);
622 for (var i = 0; i < entries.length; ++i) {
623 var entry = entries[i];
624 if (entry.element.id == "")
625 entry.element.id = "_toc_" + i;
626 var a = document.createElement("a");
627 a.href = "#" + entry.element.id;
628 a.appendChild(document.createTextNode(entry.text));
629 var div = document.createElement("div");
630 div.appendChild(a);
631 div.className = "toclevel" + entry.toclevel;
632 toc.appendChild(div);
633 }
634 if (entries.length == 0)
635 toc.parentNode.removeChild(toc);
636},
637
638
639/////////////////////////////////////////////////////////////////////
640// Footnotes generator
641/////////////////////////////////////////////////////////////////////
642
643/* Based on footnote generation code from:
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
645 */
646
647footnotes: function () {
Junio C Hamano9d971152012-12-19 00:43:11648 // Delete existing footnote entries in case we're reloading the footnodes.
649 var i;
Junio C Hamano7bd050f2011-09-22 06:32:22650 var noteholder = document.getElementById("footnotes");
Junio C Hamano9d971152012-12-19 00:43:11651 if (!noteholder) {
652 return;
653 }
654 var entriesToRemove = [];
655 for (i = 0; i < noteholder.childNodes.length; i++) {
656 var entry = noteholder.childNodes[i];
Junio C Hamanoc14e6ad2014-10-31 20:25:53657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
Junio C Hamano9d971152012-12-19 00:43:11658 entriesToRemove.push(entry);
659 }
660 for (i = 0; i < entriesToRemove.length; i++) {
661 noteholder.removeChild(entriesToRemove[i]);
662 }
663
664 // Rebuild footnote entries.
665 var cont = document.getElementById("content");
Junio C Hamano7bd050f2011-09-22 06:32:22666 var spans = cont.getElementsByTagName("span");
667 var refs = {};
668 var n = 0;
669 for (i=0; i<spans.length; i++) {
670 if (spans[i].className == "footnote") {
671 n++;
Junio C Hamano9d971152012-12-19 00:43:11672 var note = spans[i].getAttribute("data-note");
673 if (!note) {
674 // Use [\s\S] in place of . so multi-line matches work.
675 // Because JavaScript has no s (dotall) regex flag.
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
677 spans[i].innerHTML =
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
680 spans[i].setAttribute("data-note", note);
681 }
Junio C Hamano7bd050f2011-09-22 06:32:22682 noteholder.innerHTML +=
683 "<div class='footnote' id='_footnote_" + n + "'>" +
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
685 n + "</a>. " + note + "</div>";
Junio C Hamano7bd050f2011-09-22 06:32:22686 var id =spans[i].getAttribute("id");
687 if (id != null) refs["#"+id] = n;
688 }
689 }
690 if (n == 0)
691 noteholder.parentNode.removeChild(noteholder);
692 else {
693 // Process footnoterefs.
694 for (i=0; i<spans.length; i++) {
695 if (spans[i].className == "footnoteref") {
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
698 n = refs[href];
699 spans[i].innerHTML =
700 "[<a href='#_footnote_" + n +
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
702 }
703 }
704 }
Junio C Hamano9d971152012-12-19 00:43:11705},
706
707install: function(toclevels) {
708 var timerId;
709
710 function reinstall() {
711 asciidoc.footnotes();
712 if (toclevels) {
713 asciidoc.toc(toclevels);
714 }
715 }
716
717 function reinstallAndRemoveTimer() {
718 clearInterval(timerId);
719 reinstall();
720 }
721
722 timerId = setInterval(reinstall, 500);
723 if (document.addEventListener)
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
725 else
726 window.onload = reinstallAndRemoveTimer;
Junio C Hamano7bd050f2011-09-22 06:32:22727}
728
729}
Junio C Hamano9d971152012-12-19 00:43:11730asciidoc.install();
Junio C Hamano7bd050f2011-09-22 06:32:22731/*]]>*/
732</script>
Junio C Hamano1a4e8412005-12-27 08:17:23733</head>
Junio C Hamano9d971152012-12-19 00:43:11734<body class="manpage">
Junio C Hamano1a4e8412005-12-27 08:17:23735<div id="header">
736<h1>
737git-commit(1) Manual Page
738</h1>
739<h2>NAME</h2>
740<div class="sectionbody">
741<p>git-commit -
Junio C Hamano7c73c662007-01-19 00:37:50742 Record changes to the repository
Junio C Hamano1a4e8412005-12-27 08:17:23743</p>
744</div>
745</div>
Junio C Hamano7bd050f2011-09-22 06:32:22746<div id="content">
Junio C Hamano9d971152012-12-19 00:43:11747<div class="sect1">
Junio C Hamano60186642010-12-02 14:18:26748<h2 id="_synopsis">SYNOPSIS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23749<div class="sectionbody">
Junio C Hamano235a91e2006-01-07 01:13:58750<div class="verseblock">
Junio C Hamano9d971152012-12-19 00:43:11751<pre class="content"><em>git commit</em> [-a | --interactive | --patch] [-s] [-v] [-u&lt;mode&gt;] [--amend]
Junio C Hamano3d050d62011-05-17 06:43:34752 [--dry-run] [(-c | -C | --fixup | --squash) &lt;commit&gt;]
753 [-F &lt;file&gt; | -m &lt;msg&gt;] [--reset-author] [--allow-empty]
754 [--allow-empty-message] [--no-verify] [-e] [--author=&lt;author&gt;]
Junio C Hamano3d1b5a12013-05-17 23:34:02755 [--date=&lt;date&gt;] [--cleanup=&lt;mode&gt;] [--[no-]status]
Junio C Hamano1eb56092015-10-05 20:39:53756 [-i | -o] [-S[&lt;keyid&gt;]] [--] [&lt;file&gt;&#8230;]</pre>
Junio C Hamano9d971152012-12-19 00:43:11757<div class="attribution">
Junio C Hamano60186642010-12-02 14:18:26758</div></div>
Junio C Hamano1a4e8412005-12-27 08:17:23759</div>
Junio C Hamano9d971152012-12-19 00:43:11760</div>
761<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31762<h2 id="_description">DESCRIPTION</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23763<div class="sectionbody">
Junio C Hamano60186642010-12-02 14:18:26764<div class="paragraph"><p>Stores the current contents of the index in a new commit along
Junio C Hamanoba4b9282008-07-06 05:20:31765with a log message from the user describing the changes.</p></div>
Junio C Hamano60186642010-12-02 14:18:26766<div class="paragraph"><p>The content to be added can be specified in several ways:</p></div>
767<div class="olist arabic"><ol class="arabic">
Junio C Hamanoe7935c42006-12-13 21:32:17768<li>
769<p>
Junio C Hamano1aa40d22010-01-21 17:46:43770by using <em>git add</em> to incrementally "add" changes to the
Junio C Hamanob515b6a2007-08-08 09:21:16771 index before using the <em>commit</em> command (Note: even modified
772 files must be "added");
773</p>
774</li>
775<li>
776<p>
Junio C Hamano1aa40d22010-01-21 17:46:43777by using <em>git rm</em> to remove files from the working tree
Junio C Hamanobd2b4bb2007-08-06 06:42:24778 and the index, again before using the <em>commit</em> command;
Junio C Hamanoe7935c42006-12-13 21:32:17779</p>
780</li>
781<li>
782<p>
Junio C Hamanoc0859f72016-10-17 22:22:57783by listing files as arguments to the <em>commit</em> command
784 (without --interactive or --patch switch), in which
Junio C Hamanobd2b4bb2007-08-06 06:42:24785 case the commit will ignore changes staged in the index, and instead
Junio C Hamano50819852008-11-19 02:07:56786 record the current content of the listed files (which must already
Junio C Hamano076ffcc2013-02-06 05:13:21787 be known to Git);
Junio C Hamanoe7935c42006-12-13 21:32:17788</p>
789</li>
790<li>
791<p>
Junio C Hamanobd2b4bb2007-08-06 06:42:24792by using the -a switch with the <em>commit</em> command to automatically
793 "add" changes from all known files (i.e. all files that are already
794 listed in the index) and to automatically "rm" files in the index
795 that have been removed from the working tree, and then perform the
796 actual commit;
Junio C Hamanoe7935c42006-12-13 21:32:17797</p>
798</li>
Junio C Hamanoc51fede2007-03-12 07:29:20799<li>
800<p>
Junio C Hamano3d050d62011-05-17 06:43:34801by using the --interactive or --patch switches with the <em>commit</em> command
Junio C Hamanoc0859f72016-10-17 22:22:57802 to decide one by one which files or hunks should be part of the commit
803 in addition to contents in the index,
Junio C Hamanob76a6862012-05-02 22:02:46804 before finalizing the operation. See the &#8220;Interactive Mode&#8221; section of
Junio C Hamanoa28a9202012-06-21 07:08:23805 <a href="git-add.html">git-add(1)</a> to learn how to operate these modes.
Junio C Hamanoc51fede2007-03-12 07:29:20806</p>
807</li>
Junio C Hamanoba4b9282008-07-06 05:20:31808</ol></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:53809<div class="paragraph"><p>The <code>--dry-run</code> option can be used to obtain a
Junio C Hamanoe7935c42006-12-13 21:32:17810summary of what is included by any of the above for the next
Junio C Hamano1bb31992009-08-29 04:24:08811commit by giving the same set of parameters (options and paths).</p></div>
Junio C Hamano60186642010-12-02 14:18:26812<div class="paragraph"><p>If you make a commit and then find a mistake immediately after
Junio C Hamano1aa40d22010-01-21 17:46:43813that, you can recover from it with <em>git reset</em>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:23814</div>
Junio C Hamano9d971152012-12-19 00:43:11815</div>
816<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:31817<h2 id="_options">OPTIONS</h2>
Junio C Hamano1a4e8412005-12-27 08:17:23818<div class="sectionbody">
Junio C Hamano60186642010-12-02 14:18:26819<div class="dlist"><dl>
820<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47821-a
822</dt>
Junio C Hamano60186642010-12-02 14:18:26823<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47824--all
Junio C Hamano1a4e8412005-12-27 08:17:23825</dt>
826<dd>
827<p>
Junio C Hamanoe7935c42006-12-13 21:32:17828 Tell the command to automatically stage files that have
829 been modified and deleted, but new files you have not
Junio C Hamano076ffcc2013-02-06 05:13:21830 told Git about are not affected.
Junio C Hamano1a4e8412005-12-27 08:17:23831</p>
832</dd>
Junio C Hamano60186642010-12-02 14:18:26833<dt class="hdlist1">
Junio C Hamano3d050d62011-05-17 06:43:34834-p
835</dt>
836<dt class="hdlist1">
837--patch
838</dt>
839<dd>
840<p>
841 Use the interactive patch selection interface to chose
Junio C Hamanoa28a9202012-06-21 07:08:23842 which changes to commit. See <a href="git-add.html">git-add(1)</a> for
Junio C Hamano3d050d62011-05-17 06:43:34843 details.
844</p>
845</dd>
846<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47847-C &lt;commit&gt;
848</dt>
Junio C Hamano60186642010-12-02 14:18:26849<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47850--reuse-message=&lt;commit&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23851</dt>
852<dd>
853<p>
Junio C Hamanoeb415992008-06-08 22:49:47854 Take an existing commit object, and reuse the log message
Junio C Hamano1a4e8412005-12-27 08:17:23855 and the authorship information (including the timestamp)
Junio C Hamanoeb415992008-06-08 22:49:47856 when creating the commit.
857</p>
858</dd>
Junio C Hamano60186642010-12-02 14:18:26859<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47860-c &lt;commit&gt;
861</dt>
Junio C Hamano60186642010-12-02 14:18:26862<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47863--reedit-message=&lt;commit&gt;
864</dt>
865<dd>
866<p>
Junio C Hamano92d80372016-07-13 22:00:05867 Like <em>-C</em>, but with <code>-c</code> the editor is invoked, so that
Junio C Hamanoeb415992008-06-08 22:49:47868 the user can further edit the commit message.
Junio C Hamano1a4e8412005-12-27 08:17:23869</p>
870</dd>
Junio C Hamano60186642010-12-02 14:18:26871<dt class="hdlist1">
Junio C Hamano2e6ded82010-12-05 06:20:48872--fixup=&lt;commit&gt;
873</dt>
874<dd>
875<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53876 Construct a commit message for use with <code>rebase --autosquash</code>.
Junio C Hamano2e6ded82010-12-05 06:20:48877 The commit message will be the subject line from the specified
Junio C Hamanoa28a9202012-06-21 07:08:23878 commit with a prefix of "fixup! ". See <a href="git-rebase.html">git-rebase(1)</a>
Junio C Hamano2e6ded82010-12-05 06:20:48879 for details.
880</p>
881</dd>
882<dt class="hdlist1">
883--squash=&lt;commit&gt;
884</dt>
885<dd>
886<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:53887 Construct a commit message for use with <code>rebase --autosquash</code>.
Junio C Hamano2e6ded82010-12-05 06:20:48888 The commit message subject line is taken from the specified
889 commit with a prefix of "squash! ". Can be used with additional
Junio C Hamanoc14e6ad2014-10-31 20:25:53890 commit message options (<code>-m</code>/<code>-c</code>/<code>-C</code>/<code>-F</code>). See
Junio C Hamanoa28a9202012-06-21 07:08:23891 <a href="git-rebase.html">git-rebase(1)</a> for details.
Junio C Hamano2e6ded82010-12-05 06:20:48892</p>
893</dd>
894<dt class="hdlist1">
Junio C Hamano2bd8a742009-12-01 21:16:59895--reset-author
896</dt>
897<dd>
898<p>
Junio C Hamanoa8cc1d82011-03-10 01:18:12899 When used with -C/-c/--amend options, or when committing after a
Junio C Hamano4c60d9a2017-05-04 14:36:22900 conflicting cherry-pick, declare that the authorship of the
Junio C Hamano85f1fde2015-06-01 20:37:32901 resulting commit now belongs to the committer. This also renews
Junio C Hamanoa8cc1d82011-03-10 01:18:12902 the author timestamp.
Junio C Hamano2bd8a742009-12-01 21:16:59903</p>
904</dd>
Junio C Hamano60186642010-12-02 14:18:26905<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50906--short
907</dt>
908<dd>
909<p>
910 When doing a dry-run, give the output in the short-format. See
Junio C Hamanoc14e6ad2014-10-31 20:25:53911 <a href="git-status.html">git-status(1)</a> for details. Implies <code>--dry-run</code>.
Junio C Hamanoa0fae262009-12-28 09:33:50912</p>
913</dd>
Junio C Hamano60186642010-12-02 14:18:26914<dt class="hdlist1">
Junio C Hamano9257a332012-06-25 20:01:02915--branch
916</dt>
917<dd>
918<p>
919 Show the branch and tracking info even in short-format.
920</p>
921</dd>
922<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50923--porcelain
924</dt>
925<dd>
926<p>
927 When doing a dry-run, give the output in a porcelain-ready
Junio C Hamanoa28a9202012-06-21 07:08:23928 format. See <a href="git-status.html">git-status(1)</a> for details. Implies
Junio C Hamanoc14e6ad2014-10-31 20:25:53929 <code>--dry-run</code>.
Junio C Hamanoa0fae262009-12-28 09:33:50930</p>
931</dd>
Junio C Hamano60186642010-12-02 14:18:26932<dt class="hdlist1">
Junio C Hamanoa1295452012-11-13 22:32:04933--long
934</dt>
935<dd>
936<p>
Junio C Hamano4c60d9a2017-05-04 14:36:22937 When doing a dry-run, give the output in the long-format.
Junio C Hamanoc14e6ad2014-10-31 20:25:53938 Implies <code>--dry-run</code>.
Junio C Hamanoa1295452012-11-13 22:32:04939</p>
940</dd>
941<dt class="hdlist1">
Junio C Hamanoa0fae262009-12-28 09:33:50942-z
943</dt>
Junio C Hamano9257a332012-06-25 20:01:02944<dt class="hdlist1">
945--null
946</dt>
Junio C Hamanoa0fae262009-12-28 09:33:50947<dd>
948<p>
Junio C Hamano0f6f3bf2017-03-13 07:01:53949 When showing <code>short</code> or <code>porcelain</code> status output, print the
950 filename verbatim and terminate the entries with NUL, instead of LF.
951 If no format is given, implies the <code>--porcelain</code> output format.
952 Without the <code>-z</code> option, filenames with "unusual" characters are
953 quoted as explained for the configuration variable <code>core.quotePath</code>
954 (see <a href="git-config.html">git-config(1)</a>).
Junio C Hamanoa0fae262009-12-28 09:33:50955</p>
956</dd>
Junio C Hamano60186642010-12-02 14:18:26957<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:23958-F &lt;file&gt;
959</dt>
Junio C Hamano60186642010-12-02 14:18:26960<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47961--file=&lt;file&gt;
962</dt>
Junio C Hamano1a4e8412005-12-27 08:17:23963<dd>
964<p>
965 Take the commit message from the given file. Use <em>-</em> to
966 read the message from the standard input.
967</p>
968</dd>
Junio C Hamano60186642010-12-02 14:18:26969<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47970--author=&lt;author&gt;
Junio C Hamano40f2f8d2006-02-07 08:04:39971</dt>
972<dd>
973<p>
Junio C Hamano13002fb2010-06-08 05:53:58974 Override the commit author. Specify an explicit author using the
Junio C Hamanoc14e6ad2014-10-31 20:25:53975 standard <code>A U Thor &lt;author@example.com&gt;</code> format. Otherwise &lt;author&gt;
Junio C Hamano13002fb2010-06-08 05:53:58976 is assumed to be a pattern and is used to search for an existing
977 commit by that author (i.e. rev-list --all -i --author=&lt;author&gt;);
978 the commit author is then copied from the first such commit found.
Junio C Hamano40f2f8d2006-02-07 08:04:39979</p>
980</dd>
Junio C Hamano60186642010-12-02 14:18:26981<dt class="hdlist1">
Junio C Hamanoae05fee2010-01-08 07:39:46982--date=&lt;date&gt;
983</dt>
984<dd>
985<p>
986 Override the author date used in the commit.
987</p>
988</dd>
Junio C Hamano60186642010-12-02 14:18:26989<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47990-m &lt;msg&gt;
991</dt>
Junio C Hamano60186642010-12-02 14:18:26992<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:47993--message=&lt;msg&gt;
Junio C Hamano1a4e8412005-12-27 08:17:23994</dt>
995<dd>
996<p>
997 Use the given &lt;msg&gt; as the commit message.
Junio C Hamanoc14e6ad2014-10-31 20:25:53998 If multiple <code>-m</code> options are given, their values are
Junio C Hamano09cfe6f2013-03-27 22:10:42999 concatenated as separate paragraphs.
Junio C Hamano1a4e8412005-12-27 08:17:231000</p>
Junio C Hamano7b9cce92018-01-23 22:34:271001<div class="paragraph"><p>The <code>-m</code> option is mutually exclusive with <code>-c</code>, <code>-C</code>, and <code>-F</code>.</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:231002</dd>
Junio C Hamano60186642010-12-02 14:18:261003<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471004-t &lt;file&gt;
1005</dt>
Junio C Hamano60186642010-12-02 14:18:261006<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471007--template=&lt;file&gt;
Junio C Hamanoa3770f92007-07-25 08:53:331008</dt>
1009<dd>
1010<p>
Junio C Hamano51f87de2012-04-16 21:18:541011 When editing the commit message, start the editor with the
Junio C Hamanoc14e6ad2014-10-31 20:25:531012 contents in the given file. The <code>commit.template</code> configuration
Junio C Hamano51f87de2012-04-16 21:18:541013 variable is often used to give this option implicitly to the
1014 command. This mechanism can be used by projects that want to
1015 guide participants with some hints on what to write in the message
1016 in what order. If the user exits the editor without editing the
1017 message, the commit is aborted. This has no effect when a message
Junio C Hamanoc14e6ad2014-10-31 20:25:531018 is given by other means, e.g. with the <code>-m</code> or <code>-F</code> options.
Junio C Hamanoa3770f92007-07-25 08:53:331019</p>
1020</dd>
Junio C Hamano60186642010-12-02 14:18:261021<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471022-s
1023</dt>
Junio C Hamano60186642010-12-02 14:18:261024<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471025--signoff
Junio C Hamano1a4e8412005-12-27 08:17:231026</dt>
1027<dd>
1028<p>
Junio C Hamano610d1762008-11-28 06:27:131029 Add Signed-off-by line by the committer at the end of the commit
Junio C Hamano4e6ba272016-01-20 23:23:191030 log message. The meaning of a signoff depends on the project,
1031 but it typically certifies that committer has
1032 the rights to submit this work under the same license and
1033 agrees to a Developer Certificate of Origin
1034 (see <a href="http://developercertificate.org/">http://developercertificate.org/</a> for more information).
Junio C Hamano1a4e8412005-12-27 08:17:231035</p>
1036</dd>
Junio C Hamano60186642010-12-02 14:18:261037<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471038-n
1039</dt>
Junio C Hamano60186642010-12-02 14:18:261040<dt class="hdlist1">
Junio C Hamanoe7935c42006-12-13 21:32:171041--no-verify
Junio C Hamano1a4e8412005-12-27 08:17:231042</dt>
1043<dd>
1044<p>
Junio C Hamano942b35e2007-12-09 10:19:331045 This option bypasses the pre-commit and commit-msg hooks.
Junio C Hamanoa28a9202012-06-21 07:08:231046 See also <a href="githooks.html">githooks(5)</a>.
Junio C Hamano1a4e8412005-12-27 08:17:231047</p>
1048</dd>
Junio C Hamano60186642010-12-02 14:18:261049<dt class="hdlist1">
Junio C Hamano0c999702007-12-03 09:57:551050--allow-empty
1051</dt>
1052<dd>
1053<p>
1054 Usually recording a commit that has the exact same tree as its
Junio C Hamano58256872007-12-04 08:31:131055 sole parent commit is a mistake, and the command prevents you
1056 from making such a commit. This option bypasses the safety, and
Junio C Hamano619596a2010-08-18 22:15:351057 is primarily for use by foreign SCM interface scripts.
Junio C Hamano0c999702007-12-03 09:57:551058</p>
1059</dd>
Junio C Hamano60186642010-12-02 14:18:261060<dt class="hdlist1">
Junio C Hamanocb39aea2010-05-09 07:24:481061--allow-empty-message
1062</dt>
1063<dd>
1064<p>
1065 Like --allow-empty this command is primarily for use by foreign
Junio C Hamano619596a2010-08-18 22:15:351066 SCM interface scripts. It allows you to create a commit with an
Junio C Hamanocb39aea2010-05-09 07:24:481067 empty commit message without using plumbing commands like
Junio C Hamanoa28a9202012-06-21 07:08:231068 <a href="git-commit-tree.html">git-commit-tree(1)</a>.
Junio C Hamanocb39aea2010-05-09 07:24:481069</p>
1070</dd>
Junio C Hamano60186642010-12-02 14:18:261071<dt class="hdlist1">
Junio C Hamano554da792007-12-27 03:29:581072--cleanup=&lt;mode&gt;
1073</dt>
1074<dd>
1075<p>
Junio C Hamano5e7f1312013-03-21 22:49:011076 This option determines how the supplied commit message should be
Junio C Hamanoc14e6ad2014-10-31 20:25:531077 cleaned up before committing. The <em>&lt;mode&gt;</em> can be <code>strip</code>,
1078 <code>whitespace</code>, <code>verbatim</code>, <code>scissors</code> or <code>default</code>.
Junio C Hamano554da792007-12-27 03:29:581079</p>
Junio C Hamano5e7f1312013-03-21 22:49:011080<div class="openblock">
1081<div class="content">
1082<div class="dlist"><dl>
1083<dt class="hdlist1">
1084strip
1085</dt>
1086<dd>
1087<p>
Junio C Hamanoe1b28592015-05-19 21:26:171088 Strip leading and trailing empty lines, trailing whitespace,
1089 commentary and collapse consecutive empty lines.
Junio C Hamano5e7f1312013-03-21 22:49:011090</p>
1091</dd>
1092<dt class="hdlist1">
1093whitespace
1094</dt>
1095<dd>
1096<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531097 Same as <code>strip</code> except #commentary is not removed.
Junio C Hamano5e7f1312013-03-21 22:49:011098</p>
1099</dd>
1100<dt class="hdlist1">
1101verbatim
1102</dt>
1103<dd>
1104<p>
1105 Do not change the message at all.
1106</p>
1107</dd>
1108<dt class="hdlist1">
Junio C Hamano3214e5f2014-03-25 19:54:381109scissors
1110</dt>
1111<dd>
1112<p>
Junio C Hamanobb34c102017-07-21 22:42:281113 Same as <code>whitespace</code> except that everything from (and including)
1114 the line found below is truncated, if the message is to be edited.
1115 "<code>#</code>" can be customized with core.commentChar.
Junio C Hamano3214e5f2014-03-25 19:54:381116</p>
Junio C Hamanobb34c102017-07-21 22:42:281117<div class="literalblock">
1118<div class="content">
1119<pre><code># ------------------------ &gt;8 ------------------------</code></pre>
1120</div></div>
Junio C Hamano3214e5f2014-03-25 19:54:381121</dd>
1122<dt class="hdlist1">
Junio C Hamano5e7f1312013-03-21 22:49:011123default
1124</dt>
1125<dd>
1126<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531127 Same as <code>strip</code> if the message is to be edited.
1128 Otherwise <code>whitespace</code>.
Junio C Hamano5e7f1312013-03-21 22:49:011129</p>
1130</dd>
1131</dl></div>
1132</div></div>
Junio C Hamano042f2142016-06-27 18:05:051133<div class="paragraph"><p>The default can be changed by the <code>commit.cleanup</code> configuration
Junio C Hamano5e7f1312013-03-21 22:49:011134variable (see <a href="git-config.html">git-config(1)</a>).</p></div>
Junio C Hamano554da792007-12-27 03:29:581135</dd>
Junio C Hamano60186642010-12-02 14:18:261136<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471137-e
1138</dt>
Junio C Hamano60186642010-12-02 14:18:261139<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471140--edit
Junio C Hamano1a4e8412005-12-27 08:17:231141</dt>
1142<dd>
1143<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531144 The message taken from file with <code>-F</code>, command line with
1145 <code>-m</code>, and from commit object with <code>-C</code> are usually used as
Junio C Hamanoc097e562013-05-03 23:06:121146 the commit log message unmodified. This option lets you
Junio C Hamano1a4e8412005-12-27 08:17:231147 further edit the message taken from these sources.
1148</p>
1149</dd>
Junio C Hamano60186642010-12-02 14:18:261150<dt class="hdlist1">
Junio C Hamano4eb2b9c2012-11-15 21:12:291151--no-edit
1152</dt>
1153<dd>
1154<p>
1155 Use the selected commit message without launching an editor.
Junio C Hamanoc14e6ad2014-10-31 20:25:531156 For example, <code>git commit --amend --no-edit</code> amends a commit
Junio C Hamano4eb2b9c2012-11-15 21:12:291157 without changing its commit message.
1158</p>
1159</dd>
1160<dt class="hdlist1">
Junio C Hamanobfe9e752006-04-05 21:43:281161--amend
1162</dt>
1163<dd>
1164<p>
Junio C Hamano63b6fdb2013-04-07 23:37:131165 Replace the tip of the current branch by creating a new
1166 commit. The recorded tree is prepared as usual (including
Junio C Hamanoc14e6ad2014-10-31 20:25:531167 the effect of the <code>-i</code> and <code>-o</code> options and explicit
Junio C Hamano63b6fdb2013-04-07 23:37:131168 pathspec), and the message from the original commit is used
1169 as the starting point, instead of an empty message, when no
1170 other message is specified from the command line via options
Junio C Hamanoc14e6ad2014-10-31 20:25:531171 such as <code>-m</code>, <code>-F</code>, <code>-c</code>, etc. The new commit has the same
1172 parents and author as the current one (the <code>--reset-author</code>
Junio C Hamano63b6fdb2013-04-07 23:37:131173 option can countermand this).
Junio C Hamanobfe9e752006-04-05 21:43:281174</p>
Junio C Hamano9d971152012-12-19 00:43:111175<div class="openblock">
1176<div class="content">
Junio C Hamano4eb2b9c2012-11-15 21:12:291177<div class="paragraph"><p>It is a rough equivalent for:</p></div>
1178<div class="listingblock">
1179<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:531180<pre><code> $ git reset --soft HEAD^
Junio C Hamano4eb2b9c2012-11-15 21:12:291181 $ ... do something else to come up with the right tree ...
Junio C Hamanoc14e6ad2014-10-31 20:25:531182 $ git commit -c ORIG_HEAD</code></pre>
Junio C Hamano4eb2b9c2012-11-15 21:12:291183</div></div>
1184<div class="paragraph"><p>but can be used to amend a merge commit.</p></div>
Junio C Hamano9d971152012-12-19 00:43:111185</div></div>
Junio C Hamano4eb2b9c2012-11-15 21:12:291186<div class="paragraph"><p>You should understand the implications of rewriting history if you
1187amend a commit that has already been published. (See the "RECOVERING
1188FROM UPSTREAM REBASE" section in <a href="git-rebase.html">git-rebase(1)</a>.)</p></div>
Junio C Hamano9257a332012-06-25 20:01:021189</dd>
1190<dt class="hdlist1">
1191--no-post-rewrite
1192</dt>
1193<dd>
1194<p>
1195 Bypass the post-rewrite hook.
1196</p>
1197</dd>
Junio C Hamano60186642010-12-02 14:18:261198<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471199-i
1200</dt>
Junio C Hamano60186642010-12-02 14:18:261201<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471202--include
Junio C Hamano40f2f8d2006-02-07 08:04:391203</dt>
1204<dd>
1205<p>
Junio C Hamanoe7935c42006-12-13 21:32:171206 Before making a commit out of staged contents so far,
1207 stage the contents of paths given on the command line
1208 as well. This is usually not what you want unless you
1209 are concluding a conflicted merge.
Junio C Hamano6697ac52006-02-14 08:00:231210</p>
1211</dd>
Junio C Hamano60186642010-12-02 14:18:261212<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471213-o
1214</dt>
Junio C Hamano60186642010-12-02 14:18:261215<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471216--only
Junio C Hamanoe79159d2008-04-12 08:23:171217</dt>
1218<dd>
1219<p>
Junio C Hamano19a0f4e2014-11-18 21:46:361220 Make a commit by taking the updated working tree contents
1221 of the paths specified on the
Junio C Hamanoe79159d2008-04-12 08:23:171222 command line, disregarding any contents that have been
Junio C Hamano19a0f4e2014-11-18 21:46:361223 staged for other paths. This is the default mode of operation of
Junio C Hamano1aa40d22010-01-21 17:46:431224 <em>git commit</em> if any paths are given on the command line,
Junio C Hamanoe79159d2008-04-12 08:23:171225 in which case this option can be omitted.
Junio C Hamano92d80372016-07-13 22:00:051226 If this option is specified together with <code>--amend</code>, then
Junio C Hamano54bf1e22008-12-20 06:30:111227 no paths need to be specified, which can be used to amend
Junio C Hamanoe79159d2008-04-12 08:23:171228 the last commit without committing changes that have
Junio C Hamano52b1cfb2016-12-20 00:18:361229 already been staged. If used together with <code>--allow-empty</code>
1230 paths are also not required, and an empty commit will be created.
Junio C Hamanoe79159d2008-04-12 08:23:171231</p>
1232</dd>
Junio C Hamano60186642010-12-02 14:18:261233<dt class="hdlist1">
Junio C Hamano4224f992008-06-23 07:14:081234-u[&lt;mode&gt;]
Junio C Hamanoeb415992008-06-08 22:49:471235</dt>
Junio C Hamano60186642010-12-02 14:18:261236<dt class="hdlist1">
Junio C Hamano4224f992008-06-23 07:14:081237--untracked-files[=&lt;mode&gt;]
Junio C Hamano1e6e0062007-07-13 05:33:251238</dt>
1239<dd>
1240<p>
Junio C Hamano36a4dbc2011-02-22 07:51:321241 Show untracked files.
Junio C Hamano1e6e0062007-07-13 05:33:251242</p>
Junio C Hamano36a4dbc2011-02-22 07:51:321243<div class="paragraph"><p>The mode parameter is optional (defaults to <em>all</em>), and is used to
1244specify the handling of untracked files; when -u is not used, the
1245default is <em>normal</em>, i.e. show untracked files and directories.</p></div>
Junio C Hamano60186642010-12-02 14:18:261246<div class="paragraph"><p>The possible options are:</p></div>
1247<div class="ulist"><ul>
Junio C Hamano4224f992008-06-23 07:14:081248<li>
1249<p>
1250<em>no</em> - Show no untracked files
1251</p>
1252</li>
1253<li>
1254<p>
1255<em>normal</em> - Shows untracked files and directories
1256</p>
1257</li>
1258<li>
1259<p>
1260<em>all</em> - Also shows individual files in untracked directories.
1261</p>
Junio C Hamano36a4dbc2011-02-22 07:51:321262<div class="paragraph"><p>The default can be changed using the status.showUntrackedFiles
Junio C Hamanoa28a9202012-06-21 07:08:231263configuration variable documented in <a href="git-config.html">git-config(1)</a>.</p></div>
Junio C Hamanoe1cca182010-02-20 20:01:231264</li>
1265</ul></div>
Junio C Hamano1e6e0062007-07-13 05:33:251266</dd>
Junio C Hamano60186642010-12-02 14:18:261267<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471268-v
1269</dt>
Junio C Hamano60186642010-12-02 14:18:261270<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471271--verbose
Junio C Hamano1e6e0062007-07-13 05:33:251272</dt>
1273<dd>
1274<p>
1275 Show unified diff between the HEAD commit and what
1276 would be committed at the bottom of the commit message
Junio C Hamanoe1b28592015-05-19 21:26:171277 template to help the user describe the commit by reminding
1278 what changes the commit has.
1279 Note that this diff output doesn&#8217;t have its
1280 lines prefixed with <em>#</em>. This diff will not be a part
Junio C Hamanof2a3a752016-05-23 22:54:391281 of the commit message. See the <code>commit.verbose</code> configuration
1282 variable in <a href="git-config.html">git-config(1)</a>.
Junio C Hamano1e6e0062007-07-13 05:33:251283</p>
Junio C Hamano5992a252015-03-17 23:39:301284<div class="paragraph"><p>If specified twice, show in addition the unified diff between
1285what would be committed and the worktree files, i.e. the unstaged
1286changes to tracked files.</p></div>
Junio C Hamano1e6e0062007-07-13 05:33:251287</dd>
Junio C Hamano60186642010-12-02 14:18:261288<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471289-q
1290</dt>
Junio C Hamano60186642010-12-02 14:18:261291<dt class="hdlist1">
Junio C Hamanoeb415992008-06-08 22:49:471292--quiet
Junio C Hamano7d23f5e2006-12-16 07:44:041293</dt>
1294<dd>
1295<p>
Junio C Hamanof9771f62007-01-17 17:42:301296 Suppress commit summary message.
Junio C Hamano7d23f5e2006-12-16 07:44:041297</p>
1298</dd>
Junio C Hamano60186642010-12-02 14:18:261299<dt class="hdlist1">
Junio C Hamano1bb31992009-08-29 04:24:081300--dry-run
1301</dt>
1302<dd>
1303<p>
1304 Do not create a commit, but show a list of paths that are
1305 to be committed, paths with local changes that will be left
1306 uncommitted and paths that are untracked.
1307</p>
1308</dd>
Junio C Hamano60186642010-12-02 14:18:261309<dt class="hdlist1">
Junio C Hamano6ce6b6c2010-01-18 01:25:501310--status
1311</dt>
1312<dd>
1313<p>
Junio C Hamanoa28a9202012-06-21 07:08:231314 Include the output of <a href="git-status.html">git-status(1)</a> in the commit
Junio C Hamano6ce6b6c2010-01-18 01:25:501315 message template when using an editor to prepare the commit
1316 message. Defaults to on, but can be used to override
1317 configuration variable commit.status.
1318</p>
1319</dd>
Junio C Hamano60186642010-12-02 14:18:261320<dt class="hdlist1">
Junio C Hamano6ce6b6c2010-01-18 01:25:501321--no-status
1322</dt>
1323<dd>
1324<p>
Junio C Hamanoa28a9202012-06-21 07:08:231325 Do not include the output of <a href="git-status.html">git-status(1)</a> in the
Junio C Hamano6ce6b6c2010-01-18 01:25:501326 commit message template when using an editor to prepare the
1327 default commit message.
1328</p>
1329</dd>
Junio C Hamano60186642010-12-02 14:18:261330<dt class="hdlist1">
Junio C Hamanoa1295452012-11-13 22:32:041331-S[&lt;keyid&gt;]
1332</dt>
1333<dt class="hdlist1">
1334--gpg-sign[=&lt;keyid&gt;]
1335</dt>
1336<dd>
1337<p>
Junio C Hamano1eb56092015-10-05 20:39:531338 GPG-sign commits. The <code>keyid</code> argument is optional and
1339 defaults to the committer identity; if specified, it must be
1340 stuck to the option without a space.
Junio C Hamanoa1295452012-11-13 22:32:041341</p>
1342</dd>
1343<dt class="hdlist1">
Junio C Hamano5b3533d2014-02-27 23:07:151344--no-gpg-sign
1345</dt>
1346<dd>
1347<p>
Junio C Hamano322c6242015-03-23 21:32:461348 Countermand <code>commit.gpgSign</code> configuration variable that is
Junio C Hamano5b3533d2014-02-27 23:07:151349 set to force each and every commit to be signed.
1350</p>
1351</dd>
1352<dt class="hdlist1">
Junio C Hamano1bb569e2006-05-05 23:14:251353--
Junio C Hamano1a4e8412005-12-27 08:17:231354</dt>
1355<dd>
1356<p>
1357 Do not interpret any more arguments as options.
1358</p>
1359</dd>
Junio C Hamano60186642010-12-02 14:18:261360<dt class="hdlist1">
Junio C Hamano1a4e8412005-12-27 08:17:231361&lt;file&gt;&#8230;
1362</dt>
1363<dd>
1364<p>
Junio C Hamanoe7935c42006-12-13 21:32:171365 When files are given on the command line, the command
1366 commits the contents of the named files, without
1367 recording the changes already staged. The contents of
1368 these files are also staged for the next commit on top
1369 of what have been staged before.
Junio C Hamano1a4e8412005-12-27 08:17:231370</p>
1371</dd>
Junio C Hamanoba4b9282008-07-06 05:20:311372</dl></div>
Junio C Hamano1a4e8412005-12-27 08:17:231373</div>
Junio C Hamano9d971152012-12-19 00:43:111374</div>
1375<div class="sect1">
Junio C Hamanoae05fee2010-01-08 07:39:461376<h2 id="_date_formats">DATE FORMATS</h2>
1377<div class="sectionbody">
Junio C Hamano042f2142016-06-27 18:05:051378<div class="paragraph"><p>The <code>GIT_AUTHOR_DATE</code>, <code>GIT_COMMITTER_DATE</code> environment variables
Junio C Hamanoc14e6ad2014-10-31 20:25:531379and the <code>--date</code> option
Junio C Hamanoae05fee2010-01-08 07:39:461380support the following date formats:</p></div>
Junio C Hamano60186642010-12-02 14:18:261381<div class="dlist"><dl>
1382<dt class="hdlist1">
Junio C Hamanoae05fee2010-01-08 07:39:461383Git internal format
1384</dt>
1385<dd>
1386<p>
Junio C Hamanoc14e6ad2014-10-31 20:25:531387 It is <code>&lt;unix timestamp&gt; &lt;time zone offset&gt;</code>, where <code>&lt;unix
1388 timestamp&gt;</code> is the number of seconds since the UNIX epoch.
1389 <code>&lt;time zone offset&gt;</code> is a positive or negative offset from UTC.
Junio C Hamano52b1cfb2016-12-20 00:18:361390 For example CET (which is 1 hour ahead of UTC) is <code>+0100</code>.
Junio C Hamanoae05fee2010-01-08 07:39:461391</p>
1392</dd>
Junio C Hamano60186642010-12-02 14:18:261393<dt class="hdlist1">
Junio C Hamanoae05fee2010-01-08 07:39:461394RFC 2822
1395</dt>
1396<dd>
1397<p>
1398 The standard email format as described by RFC 2822, for example
Junio C Hamanoc14e6ad2014-10-31 20:25:531399 <code>Thu, 07 Apr 2005 22:13:13 +0200</code>.
Junio C Hamanoae05fee2010-01-08 07:39:461400</p>
1401</dd>
Junio C Hamano60186642010-12-02 14:18:261402<dt class="hdlist1">
Junio C Hamanoae05fee2010-01-08 07:39:461403ISO 8601
1404</dt>
1405<dd>
1406<p>
1407 Time and date specified by the ISO 8601 standard, for example
Junio C Hamanoc14e6ad2014-10-31 20:25:531408 <code>2005-04-07T22:13:13</code>. The parser accepts a space instead of the
1409 <code>T</code> character as well.
Junio C Hamanoae05fee2010-01-08 07:39:461410</p>
1411<div class="admonitionblock">
1412<table><tr>
1413<td class="icon">
1414<div class="title">Note</div>
1415</td>
1416<td class="content">In addition, the date part is accepted in the following formats:
Junio C Hamanoc14e6ad2014-10-31 20:25:531417<code>YYYY.MM.DD</code>, <code>MM/DD/YYYY</code> and <code>DD.MM.YYYY</code>.</td>
Junio C Hamanoae05fee2010-01-08 07:39:461418</tr></table>
1419</div>
1420</dd>
1421</dl></div>
1422</div>
Junio C Hamano9d971152012-12-19 00:43:111423</div>
1424<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311425<h2 id="_examples">EXAMPLES</h2>
Junio C Hamano40f2f8d2006-02-07 08:04:391426<div class="sectionbody">
Junio C Hamano60186642010-12-02 14:18:261427<div class="paragraph"><p>When recording your own work, the contents of modified files in
Junio C Hamanoe7935c42006-12-13 21:32:171428your working tree are temporarily stored to a staging area
Junio C Hamano1aa40d22010-01-21 17:46:431429called the "index" with <em>git add</em>. A file can be
Junio C Hamano361c1332007-11-14 12:17:221430reverted back, only in the index but not in the working tree,
Junio C Hamanoc14e6ad2014-10-31 20:25:531431to that of the last commit with <code>git reset HEAD -- &lt;file&gt;</code>,
Junio C Hamano1aa40d22010-01-21 17:46:431432which effectively reverts <em>git add</em> and prevents the changes to
Junio C Hamano361c1332007-11-14 12:17:221433this file from participating in the next commit. After building
1434the state to be committed incrementally with these commands,
Junio C Hamanoc14e6ad2014-10-31 20:25:531435<code>git commit</code> (without any pathname parameter) is used to record what
Junio C Hamanoe7935c42006-12-13 21:32:171436has been staged so far. This is the most basic form of the
Junio C Hamanoba4b9282008-07-06 05:20:311437command. An example:</p></div>
Junio C Hamanoe7935c42006-12-13 21:32:171438<div class="listingblock">
Junio C Hamano40f2f8d2006-02-07 08:04:391439<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:531440<pre><code>$ edit hello.c
Junio C Hamanoe7935c42006-12-13 21:32:171441$ git rm goodbye.c
1442$ git add hello.c
Junio C Hamanoc14e6ad2014-10-31 20:25:531443$ git commit</code></pre>
Junio C Hamano40f2f8d2006-02-07 08:04:391444</div></div>
Junio C Hamano60186642010-12-02 14:18:261445<div class="paragraph"><p>Instead of staging files after each individual change, you can
Junio C Hamanoc14e6ad2014-10-31 20:25:531446tell <code>git commit</code> to notice the changes to the files whose
Junio C Hamanoe7935c42006-12-13 21:32:171447contents are tracked in
Junio C Hamanoc14e6ad2014-10-31 20:25:531448your working tree and do corresponding <code>git add</code> and <code>git rm</code>
Junio C Hamanoe7935c42006-12-13 21:32:171449for you. That is, this example does the same as the earlier
Junio C Hamanoba4b9282008-07-06 05:20:311450example if there is no other change in your working tree:</p></div>
Junio C Hamanoe7935c42006-12-13 21:32:171451<div class="listingblock">
1452<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:531453<pre><code>$ edit hello.c
Junio C Hamanoe7935c42006-12-13 21:32:171454$ rm goodbye.c
Junio C Hamanoc14e6ad2014-10-31 20:25:531455$ git commit -a</code></pre>
Junio C Hamanoe7935c42006-12-13 21:32:171456</div></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:531457<div class="paragraph"><p>The command <code>git commit -a</code> first looks at your working tree,
Junio C Hamanoe7935c42006-12-13 21:32:171458notices that you have modified hello.c and removed goodbye.c,
Junio C Hamanoc14e6ad2014-10-31 20:25:531459and performs necessary <code>git add</code> and <code>git rm</code> for you.</p></div>
Junio C Hamano60186642010-12-02 14:18:261460<div class="paragraph"><p>After staging changes to many files, you can alter the order the
Junio C Hamanoc14e6ad2014-10-31 20:25:531461changes are recorded in, by giving pathnames to <code>git commit</code>.
Junio C Hamanoe7935c42006-12-13 21:32:171462When pathnames are given, the command makes a commit that
Junio C Hamanoba4b9282008-07-06 05:20:311463only records the changes made to the named paths:</p></div>
Junio C Hamanoe7935c42006-12-13 21:32:171464<div class="listingblock">
1465<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:531466<pre><code>$ edit hello.c hello.h
Junio C Hamanoe7935c42006-12-13 21:32:171467$ git add hello.c hello.h
1468$ edit Makefile
Junio C Hamanoc14e6ad2014-10-31 20:25:531469$ git commit Makefile</code></pre>
Junio C Hamanoe7935c42006-12-13 21:32:171470</div></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:531471<div class="paragraph"><p>This makes a commit that records the modification to <code>Makefile</code>.
1472The changes staged for <code>hello.c</code> and <code>hello.h</code> are not included
Junio C Hamano60186642010-12-02 14:18:261473in the resulting commit. However, their changes are not lost&#8201;&#8212;&#8201;they are still staged and merely held back. After the above
Junio C Hamanoba4b9282008-07-06 05:20:311474sequence, if you do:</p></div>
Junio C Hamanoe7935c42006-12-13 21:32:171475<div class="listingblock">
1476<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:531477<pre><code>$ git commit</code></pre>
Junio C Hamanoe7935c42006-12-13 21:32:171478</div></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:531479<div class="paragraph"><p>this second commit would record the changes to <code>hello.c</code> and
1480<code>hello.h</code> as expected.</p></div>
Junio C Hamano60186642010-12-02 14:18:261481<div class="paragraph"><p>After a merge (initiated by <em>git merge</em> or <em>git pull</em>) stops
Junio C Hamanofce7c7e2008-07-02 03:06:381482because of conflicts, cleanly merged
Junio C Hamanoe7935c42006-12-13 21:32:171483paths are already staged to be committed for you, and paths that
1484conflicted are left in unmerged state. You would have to first
Junio C Hamano1aa40d22010-01-21 17:46:431485check which paths are conflicting with <em>git status</em>
Junio C Hamanoe7935c42006-12-13 21:32:171486and after fixing them manually in your working tree, you would
Junio C Hamano1aa40d22010-01-21 17:46:431487stage the result as usual with <em>git add</em>:</p></div>
Junio C Hamanoe7935c42006-12-13 21:32:171488<div class="listingblock">
1489<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:531490<pre><code>$ git status | grep unmerged
Junio C Hamanoe7935c42006-12-13 21:32:171491unmerged: hello.c
1492$ edit hello.c
Junio C Hamanoc14e6ad2014-10-31 20:25:531493$ git add hello.c</code></pre>
Junio C Hamanoe7935c42006-12-13 21:32:171494</div></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:531495<div class="paragraph"><p>After resolving conflicts and staging the result, <code>git ls-files -u</code>
Junio C Hamanoe7935c42006-12-13 21:32:171496would stop mentioning the conflicted path. When you are done,
Junio C Hamanoc14e6ad2014-10-31 20:25:531497run <code>git commit</code> to finally record the merge:</p></div>
Junio C Hamanoe7935c42006-12-13 21:32:171498<div class="listingblock">
1499<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:531500<pre><code>$ git commit</code></pre>
Junio C Hamanoe7935c42006-12-13 21:32:171501</div></div>
Junio C Hamanoc14e6ad2014-10-31 20:25:531502<div class="paragraph"><p>As with the case to record your own changes, you can use <code>-a</code>
Junio C Hamanoe7935c42006-12-13 21:32:171503option to save typing. One difference is that during a merge
Junio C Hamanoc14e6ad2014-10-31 20:25:531504resolution, you cannot use <code>git commit</code> with pathnames to
Junio C Hamanoe7935c42006-12-13 21:32:171505alter the order the changes are committed, because the merge
1506should be recorded as a single commit. In fact, the command
Junio C Hamanoc14e6ad2014-10-31 20:25:531507refuses to run when given pathnames (but see <code>-i</code> option).</p></div>
Junio C Hamanoe7935c42006-12-13 21:32:171508</div>
Junio C Hamano9d971152012-12-19 00:43:111509</div>
1510<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311511<h2 id="_discussion">DISCUSSION</h2>
Junio C Hamano775a0f42006-12-31 01:19:141512<div class="sectionbody">
Junio C Hamano60186642010-12-02 14:18:261513<div class="paragraph"><p>Though not required, it&#8217;s a good idea to begin the commit message
Junio C Hamano8f76dc62007-01-17 07:24:251514with a single short (less than 50 character) line summarizing the
1515change, followed by a blank line and then a more thorough description.
Junio C Hamano281fd392012-09-17 23:57:411516The text up to the first blank line in a commit message is treated
Junio C Hamano076ffcc2013-02-06 05:13:211517as the commit title, and that title is used throughout Git.
Junio C Hamano281fd392012-09-17 23:57:411518For example, <a href="git-format-patch.html">git-format-patch(1)</a> turns a commit into email, and it uses
1519the title on the Subject line and the rest of the commit in the body.</p></div>
Junio C Hamanod7ed4042015-08-03 19:43:001520<div class="paragraph"><p>Git is to some extent character encoding agnostic.</p></div>
Junio C Hamano60186642010-12-02 14:18:261521<div class="ulist"><ul>
Junio C Hamano775a0f42006-12-31 01:19:141522<li>
1523<p>
Junio C Hamano54bf1e22008-12-20 06:30:111524The contents of the blob objects are uninterpreted sequences
Junio C Hamano775a0f42006-12-31 01:19:141525 of bytes. There is no encoding translation at the core
1526 level.
1527</p>
1528</li>
1529<li>
1530<p>
Junio C Hamanod7ed4042015-08-03 19:43:001531Path names are encoded in UTF-8 normalization form C. This
1532 applies to tree objects, the index file, ref names, as well as
1533 path names in command line arguments, environment variables
1534 and config files (<code>.git/config</code> (see <a href="git-config.html">git-config(1)</a>),
1535 <a href="gitignore.html">gitignore(5)</a>, <a href="gitattributes.html">gitattributes(5)</a> and
1536 <a href="gitmodules.html">gitmodules(5)</a>).
1537</p>
1538<div class="paragraph"><p>Note that Git at the core level treats path names simply as
1539sequences of non-NUL bytes, there are no path name encoding
1540conversions (except on Mac and Windows). Therefore, using
1541non-ASCII path names will mostly work even on platforms and file
1542systems that use legacy extended ASCII encodings. However,
1543repositories created on such systems will not work properly on
1544UTF-8-based systems (e.g. Linux, Mac, Windows) and vice versa.
1545Additionally, many Git-based tools simply assume path names to
1546be UTF-8 and will fail to display other encodings correctly.</p></div>
1547</li>
1548<li>
1549<p>
1550Commit log messages are typically encoded in UTF-8, but other
1551 extended ASCII encodings are also supported. This includes
1552 ISO-8859-x, CP125x and many others, but <em>not</em> UTF-16/32,
1553 EBCDIC and CJK multi-byte encodings (GBK, Shift-JIS, Big5,
1554 EUC-x, CP9xx etc.).
Junio C Hamano775a0f42006-12-31 01:19:141555</p>
1556</li>
Junio C Hamanoba4b9282008-07-06 05:20:311557</ul></div>
Junio C Hamano60186642010-12-02 14:18:261558<div class="paragraph"><p>Although we encourage that the commit log messages are encoded
Junio C Hamano076ffcc2013-02-06 05:13:211559in UTF-8, both the core and Git Porcelain are designed not to
Junio C Hamano775a0f42006-12-31 01:19:141560force UTF-8 on projects. If all participants of a particular
Junio C Hamano076ffcc2013-02-06 05:13:211561project find it more convenient to use legacy encodings, Git
Junio C Hamano775a0f42006-12-31 01:19:141562does not forbid it. However, there are a few things to keep in
Junio C Hamanoba4b9282008-07-06 05:20:311563mind.</p></div>
Junio C Hamano60186642010-12-02 14:18:261564<div class="olist arabic"><ol class="arabic">
Junio C Hamano775a0f42006-12-31 01:19:141565<li>
1566<p>
Junio C Hamano1aa40d22010-01-21 17:46:431567<em>git commit</em> and <em>git commit-tree</em> issues
Junio C Hamano14b76482008-01-05 10:32:261568 a warning if the commit log message given to it does not look
Junio C Hamano775a0f42006-12-31 01:19:141569 like a valid UTF-8 string, unless you explicitly say your
1570 project uses a legacy encoding. The way to say this is to
Junio C Hamanoc14e6ad2014-10-31 20:25:531571 have i18n.commitencoding in <code>.git/config</code> file, like this:
Junio C Hamano775a0f42006-12-31 01:19:141572</p>
1573<div class="listingblock">
1574<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:531575<pre><code>[i18n]
Junio C Hamanobb34c102017-07-21 22:42:281576 commitEncoding = ISO-8859-1</code></pre>
Junio C Hamano775a0f42006-12-31 01:19:141577</div></div>
Junio C Hamano60186642010-12-02 14:18:261578<div class="paragraph"><p>Commit objects created with the above setting record the value
Junio C Hamanobb34c102017-07-21 22:42:281579of <code>i18n.commitEncoding</code> in its <code>encoding</code> header. This is to
Junio C Hamano775a0f42006-12-31 01:19:141580help other people who look at them later. Lack of this header
Junio C Hamanoba4b9282008-07-06 05:20:311581implies that the commit log message is encoded in UTF-8.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:141582</li>
1583<li>
1584<p>
Junio C Hamano1aa40d22010-01-21 17:46:431585<em>git log</em>, <em>git show</em>, <em>git blame</em> and friends look at the
Junio C Hamanoc14e6ad2014-10-31 20:25:531586 <code>encoding</code> header of a commit object, and try to re-code the
Junio C Hamanoaa17c7c2008-11-03 04:36:581587 log message into UTF-8 unless otherwise specified. You can
Junio C Hamano775a0f42006-12-31 01:19:141588 specify the desired output encoding with
Junio C Hamanobb34c102017-07-21 22:42:281589 <code>i18n.logOutputEncoding</code> in <code>.git/config</code> file, like this:
Junio C Hamano775a0f42006-12-31 01:19:141590</p>
1591<div class="listingblock">
1592<div class="content">
Junio C Hamanoc14e6ad2014-10-31 20:25:531593<pre><code>[i18n]
Junio C Hamanobb34c102017-07-21 22:42:281594 logOutputEncoding = ISO-8859-1</code></pre>
Junio C Hamano775a0f42006-12-31 01:19:141595</div></div>
Junio C Hamano60186642010-12-02 14:18:261596<div class="paragraph"><p>If you do not have this configuration variable, the value of
Junio C Hamanobb34c102017-07-21 22:42:281597<code>i18n.commitEncoding</code> is used instead.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:141598</li>
Junio C Hamanoba4b9282008-07-06 05:20:311599</ol></div>
Junio C Hamano60186642010-12-02 14:18:261600<div class="paragraph"><p>Note that we deliberately chose not to re-code the commit log
Junio C Hamano775a0f42006-12-31 01:19:141601message when a commit is made to force UTF-8 at the commit
1602object level, because re-coding to UTF-8 is not necessarily a
Junio C Hamanoba4b9282008-07-06 05:20:311603reversible operation.</p></div>
Junio C Hamano775a0f42006-12-31 01:19:141604</div>
Junio C Hamano9d971152012-12-19 00:43:111605</div>
1606<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311607<h2 id="_environment_and_configuration_variables">ENVIRONMENT AND CONFIGURATION VARIABLES</h2>
Junio C Hamanoe7935c42006-12-13 21:32:171608<div class="sectionbody">
Junio C Hamano60186642010-12-02 14:18:261609<div class="paragraph"><p>The editor used to edit the commit log message will be chosen from the
Junio C Hamano042f2142016-06-27 18:05:051610<code>GIT_EDITOR</code> environment variable, the core.editor configuration variable, the
1611<code>VISUAL</code> environment variable, or the <code>EDITOR</code> environment variable (in that
Junio C Hamanoa28a9202012-06-21 07:08:231612order). See <a href="git-var.html">git-var(1)</a> for details.</p></div>
Junio C Hamanoe7935c42006-12-13 21:32:171613</div>
Junio C Hamano9d971152012-12-19 00:43:111614</div>
1615<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311616<h2 id="_hooks">HOOKS</h2>
Junio C Hamanoe7935c42006-12-13 21:32:171617<div class="sectionbody">
Junio C Hamanoc14e6ad2014-10-31 20:25:531618<div class="paragraph"><p>This command can run <code>commit-msg</code>, <code>prepare-commit-msg</code>, <code>pre-commit</code>,
Junio C Hamanocb06ef92017-03-21 22:40:141619<code>post-commit</code> and <code>post-rewrite</code> hooks. See <a href="githooks.html">githooks(5)</a> for more
Junio C Hamanoba4b9282008-07-06 05:20:311620information.</p></div>
Junio C Hamanoe7935c42006-12-13 21:32:171621</div>
Junio C Hamano9d971152012-12-19 00:43:111622</div>
1623<div class="sect1">
Junio C Hamano28a85be2012-07-24 22:05:151624<h2 id="_files">FILES</h2>
1625<div class="sectionbody">
1626<div class="dlist"><dl>
1627<dt class="hdlist1">
Junio C Hamanoc14e6ad2014-10-31 20:25:531628<code>$GIT_DIR/COMMIT_EDITMSG</code>
Junio C Hamano28a85be2012-07-24 22:05:151629</dt>
1630<dd>
1631<p>
1632 This file contains the commit message of a commit in progress.
Junio C Hamanoc14e6ad2014-10-31 20:25:531633 If <code>git commit</code> exits due to an error before creating a commit,
Junio C Hamano28a85be2012-07-24 22:05:151634 any commit message that has been provided by the user (e.g., in
1635 an editor session) will be available in this file, but will be
Junio C Hamanoc14e6ad2014-10-31 20:25:531636 overwritten by the next invocation of <code>git commit</code>.
Junio C Hamano28a85be2012-07-24 22:05:151637</p>
1638</dd>
1639</dl></div>
1640</div>
Junio C Hamano9d971152012-12-19 00:43:111641</div>
1642<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311643<h2 id="_see_also">SEE ALSO</h2>
Junio C Hamanoe7935c42006-12-13 21:32:171644<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:231645<div class="paragraph"><p><a href="git-add.html">git-add(1)</a>,
1646<a href="git-rm.html">git-rm(1)</a>,
1647<a href="git-mv.html">git-mv(1)</a>,
1648<a href="git-merge.html">git-merge(1)</a>,
1649<a href="git-commit-tree.html">git-commit-tree(1)</a></p></div>
Junio C Hamano40f2f8d2006-02-07 08:04:391650</div>
Junio C Hamano9d971152012-12-19 00:43:111651</div>
1652<div class="sect1">
Junio C Hamanoba4b9282008-07-06 05:20:311653<h2 id="_git">GIT</h2>
Junio C Hamano1a4e8412005-12-27 08:17:231654<div class="sectionbody">
Junio C Hamanoa28a9202012-06-21 07:08:231655<div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
Junio C Hamano1a4e8412005-12-27 08:17:231656</div>
Junio C Hamano7bd050f2011-09-22 06:32:221657</div>
Junio C Hamano9d971152012-12-19 00:43:111658</div>
Junio C Hamano7bd050f2011-09-22 06:32:221659<div id="footnotes"><hr /></div>
Junio C Hamano1a4e8412005-12-27 08:17:231660<div id="footer">
1661<div id="footer-text">
Junio C Hamano2ef0ba32018-01-26 23:13:531662Last updated
1663 2018-01-26 15:11:04 PST
Junio C Hamano1a4e8412005-12-27 08:17:231664</div>
1665</div>
1666</body>
1667</html>