blob: 11ab92f2c2a4ca92962571261e0858c4819155dc [file] [log] [blame]
Junio C Hamanob96f40a2024-08-01 00:57:251<!DOCTYPE html>
2<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
3<head>
4<meta charset="UTF-8"/>
5<meta http-equiv="X-UA-Compatible" content="IE=edge"/>
6<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
Junio C Hamanod6a33e42025-02-18 23:45:117<meta name="generator" content="Asciidoctor 2.0.23"/>
Junio C Hamanob96f40a2024-08-01 00:57:258<title>git-commit(1)</title>
9<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
10<style>
11/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
12/* Uncomment the following line when using as a custom stylesheet */
13/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
14html{font-family:sans-serif;-webkit-text-size-adjust:100%}
15a{background:none}
16a:focus{outline:thin dotted}
17a:active,a:hover{outline:0}
18h1{font-size:2em;margin:.67em 0}
19b,strong{font-weight:bold}
20abbr{font-size:.9em}
21abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
22dfn{font-style:italic}
23hr{height:0}
24mark{background:#ff0;color:#000}
25code,kbd,pre,samp{font-family:monospace;font-size:1em}
26pre{white-space:pre-wrap}
27q{quotes:"\201C" "\201D" "\2018" "\2019"}
28small{font-size:80%}
29sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
30sup{top:-.5em}
31sub{bottom:-.25em}
32img{border:0}
33svg:not(:root){overflow:hidden}
34figure{margin:0}
35audio,video{display:inline-block}
36audio:not([controls]){display:none;height:0}
37fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38legend{border:0;padding:0}
39button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40button,input{line-height:normal}
41button,select{text-transform:none}
42button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
43button[disabled],html input[disabled]{cursor:default}
44input[type=checkbox],input[type=radio]{padding:0}
45button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46textarea{overflow:auto;vertical-align:top}
47table{border-collapse:collapse;border-spacing:0}
48*,::before,::after{box-sizing:border-box}
49html,body{font-size:100%}
50body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
51a:hover{cursor:pointer}
52img,object,embed{max-width:100%;height:auto}
53object,embed{height:100%}
54img{-ms-interpolation-mode:bicubic}
55.left{float:left!important}
56.right{float:right!important}
57.text-left{text-align:left!important}
58.text-right{text-align:right!important}
59.text-center{text-align:center!important}
60.text-justify{text-align:justify!important}
61.hide{display:none}
62img,object,svg{display:inline-block;vertical-align:middle}
63textarea{height:auto;min-height:50px}
64select{width:100%}
65.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
66div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
67a{color:#2156a5;text-decoration:underline;line-height:inherit}
68a:hover,a:focus{color:#1d4b8f}
69a img{border:0}
70p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
71p aside{font-size:.875em;line-height:1.35;font-style:italic}
72h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
73h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
74h1{font-size:2.125em}
75h2{font-size:1.6875em}
76h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
77h4,h5{font-size:1.125em}
78h6{font-size:1em}
79hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
80em,i{font-style:italic;line-height:inherit}
81strong,b{font-weight:bold;line-height:inherit}
82small{font-size:60%;line-height:inherit}
83code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
84ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
85ul,ol{margin-left:1.5em}
86ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
87ul.circle{list-style-type:circle}
88ul.disc{list-style-type:disc}
89ul.square{list-style-type:square}
90ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
91ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
92dl dt{margin-bottom:.3125em;font-weight:bold}
93dl dd{margin-bottom:1.25em}
94blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
95blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
96@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
97h1{font-size:2.75em}
98h2{font-size:2.3125em}
99h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
100h4{font-size:1.4375em}}
101table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
102table thead,table tfoot{background:#f7f8f7}
103table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
104table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
105table tr.even,table tr.alt{background:#f8f8f7}
106table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
107h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
108h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
109.center{margin-left:auto;margin-right:auto}
110.stretch{width:100%}
111.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
112.clearfix::after,.float-group::after{clear:both}
113:not(pre).nobreak{word-wrap:normal}
114:not(pre).nowrap{white-space:nowrap}
115:not(pre).pre-wrap{white-space:pre-wrap}
116:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
117pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
118pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119pre>code{display:block}
120pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121em em{font-style:normal}
122strong strong{font-weight:400}
123.keyseq{color:rgba(51,51,51,.8)}
124kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
125.keyseq kbd:first-child{margin-left:0}
126.keyseq kbd:last-child{margin-right:0}
127.menuseq,.menuref{color:#000}
128.menuseq b:not(.caret),.menuref{font-weight:inherit}
129.menuseq{word-spacing:-.02em}
130.menuseq b.caret{font-size:1.25em;line-height:.8}
131.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
132b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
133b.button::before{content:"[";padding:0 3px 0 2px}
134b.button::after{content:"]";padding:0 2px 0 3px}
135p a>code:hover{color:rgba(0,0,0,.9)}
136#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
137#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
138#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
139#content{margin-top:1.25em}
140#content::before{content:none}
141#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
142#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
Junio C Hamanod6a33e42025-02-18 23:45:11143#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
Junio C Hamanob96f40a2024-08-01 00:57:25144#header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap}
145#header .details span:first-child{margin-left:-.125em}
146#header .details span.email a{color:rgba(0,0,0,.85)}
147#header .details br{display:none}
148#header .details br+span::before{content:"\00a0\2013\00a0"}
149#header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)}
150#header .details br+span#revremark::before{content:"\00a0|\00a0"}
151#header #revnumber{text-transform:capitalize}
152#header #revnumber::after{content:"\00a0"}
153#content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem}
154#toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em}
155#toc>ul{margin-left:.125em}
156#toc ul.sectlevel0>li>a{font-style:italic}
157#toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0}
158#toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none}
159#toc li{line-height:1.3334;margin-top:.3334em}
160#toc a{text-decoration:none}
161#toc a:active{text-decoration:underline}
162#toctitle{color:#7a2518;font-size:1.2em}
163@media screen and (min-width:768px){#toctitle{font-size:1.375em}
164body.toc2{padding-left:15em;padding-right:0}
Junio C Hamanod6a33e42025-02-18 23:45:11165body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
Junio C Hamanob96f40a2024-08-01 00:57:25166#toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto}
167#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
168#toc.toc2>ul{font-size:.9em;margin-bottom:0}
169#toc.toc2 ul ul{margin-left:0;padding-left:1em}
170#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
171body.toc2.toc-right{padding-left:0;padding-right:15em}
172body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
173@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
174#toc.toc2{width:20em}
175#toc.toc2 #toctitle{font-size:1.375em}
176#toc.toc2>ul{font-size:.95em}
177#toc.toc2 ul ul{padding-left:1.25em}
178body.toc2.toc-right{padding-left:0;padding-right:20em}}
179#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
180#content #toc>:first-child{margin-top:0}
181#content #toc>:last-child{margin-bottom:0}
182#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
183#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
184#content{margin-bottom:.625em}
185.sect1{padding-bottom:.625em}
186@media screen and (min-width:768px){#content{margin-bottom:1.25em}
187.sect1{padding-bottom:1.25em}}
188.sect1:last-child{padding-bottom:0}
189.sect1+.sect1{border-top:1px solid #e7e7e9}
190#content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400}
191#content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em}
192#content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible}
193#content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none}
194#content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221}
195details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
196details{margin-left:1.25rem}
197details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
198details>summary::-webkit-details-marker{display:none}
199details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)}
200details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
201details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
202.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
203table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
204.paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)}
205.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
206.admonitionblock>table td.icon{text-align:center;width:80px}
207.admonitionblock>table td.icon img{max-width:none}
208.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
209.admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere}
210.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
211.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
212.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
213.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
214.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
215.exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0}
216.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
217@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
218@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
219.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
220.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
221.listingblock>.content{position:relative}
222.listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5}
223.listingblock:hover code[data-lang]::before{display:block}
224.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
225.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
226.listingblock pre.highlightjs{padding:0}
227.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
228.listingblock pre.prettyprint{border-width:0}
229.prettyprint{background:#f7f7f8}
230pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
231pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
232pre.prettyprint li code[data-lang]::before{opacity:1}
233pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
234table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
235table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
236table.linenotable td.code{padding-left:.75em}
237table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none}
238pre.pygments span.linenos{display:inline-block;margin-right:.75em}
239.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
240.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
241.quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify}
242.quoteblock blockquote{margin:0;padding:0;border:0}
243.quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)}
244.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
245.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
246.verseblock{margin:0 1em 1.25em}
247.verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility}
248.verseblock pre strong{font-weight:400}
249.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
250.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
251.quoteblock .attribution br,.verseblock .attribution br{display:none}
252.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
253.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
254.quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0}
255.quoteblock.abstract{margin:0 1em 1.25em;display:block}
256.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
257.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
258.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
259.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
260.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
261p.tableblock:last-child{margin-bottom:0}
262td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
263td.tableblock>.content>:last-child{margin-bottom:-1.25em}
264table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
265table.grid-all>*>tr>*{border-width:1px}
266table.grid-cols>*>tr>*{border-width:0 1px}
267table.grid-rows>*>tr>*{border-width:1px 0}
268table.frame-all{border-width:1px}
269table.frame-ends{border-width:1px 0}
270table.frame-sides{border-width:0 1px}
271table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
272table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
273table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
274table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
275table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7}
276th.halign-left,td.halign-left{text-align:left}
277th.halign-right,td.halign-right{text-align:right}
278th.halign-center,td.halign-center{text-align:center}
279th.valign-top,td.valign-top{vertical-align:top}
280th.valign-bottom,td.valign-bottom{vertical-align:bottom}
281th.valign-middle,td.valign-middle{vertical-align:middle}
282table thead th,table tfoot th{font-weight:bold}
283tbody tr th{background:#f7f8f7}
284tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
285p.tableblock>code:only-child{background:none;padding:0}
286p.tableblock{font-size:1em}
287ol{margin-left:1.75em}
288ul li ol{margin-left:1.5em}
289dl dd{margin-left:1.125em}
290dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
291li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
292ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
293ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
294ul.unstyled,ol.unstyled{margin-left:0}
295li>p:empty:only-child::before{content:"";display:inline-block}
296ul.checklist>li>p:first-child{margin-left:-1em}
297ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em}
298ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
299ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
300ul.inline>li{margin-left:1.25em}
301.unstyled dl dt{font-weight:400;font-style:normal}
302ol.arabic{list-style-type:decimal}
303ol.decimal{list-style-type:decimal-leading-zero}
304ol.loweralpha{list-style-type:lower-alpha}
305ol.upperalpha{list-style-type:upper-alpha}
306ol.lowerroman{list-style-type:lower-roman}
307ol.upperroman{list-style-type:upper-roman}
308ol.lowergreek{list-style-type:lower-greek}
309.hdlist>table,.colist>table{border:0;background:none}
310.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
311td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
312td.hdlist1{font-weight:bold;padding-bottom:1.25em}
313td.hdlist2{word-wrap:anywhere}
314.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
315.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
316.colist td:not([class]):first-child img{max-width:none}
317.colist td:not([class]):last-child{padding:.25em 0}
318.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
319.imageblock.left{margin:.25em .625em 1.25em 0}
320.imageblock.right{margin:.25em 0 1.25em .625em}
321.imageblock>.title{margin-bottom:0}
322.imageblock.thumb,.imageblock.th{border-width:6px}
323.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
324.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
325.image.left{margin-right:.625em}
326.image.right{margin-left:.625em}
327a.image{text-decoration:none;display:inline-block}
328a.image object{pointer-events:none}
329sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
330sup.footnote a,sup.footnoteref a{text-decoration:none}
Junio C Hamanod6a33e42025-02-18 23:45:11331sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
Junio C Hamanob96f40a2024-08-01 00:57:25332#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
333#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
334#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
335#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
336#footnotes .footnote:last-of-type{margin-bottom:0}
337#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
338div.unbreakable{page-break-inside:avoid}
339.big{font-size:larger}
340.small{font-size:smaller}
341.underline{text-decoration:underline}
342.overline{text-decoration:overline}
343.line-through{text-decoration:line-through}
344.aqua{color:#00bfbf}
345.aqua-background{background:#00fafa}
346.black{color:#000}
347.black-background{background:#000}
348.blue{color:#0000bf}
349.blue-background{background:#0000fa}
350.fuchsia{color:#bf00bf}
351.fuchsia-background{background:#fa00fa}
352.gray{color:#606060}
353.gray-background{background:#7d7d7d}
354.green{color:#006000}
355.green-background{background:#007d00}
356.lime{color:#00bf00}
357.lime-background{background:#00fa00}
358.maroon{color:#600000}
359.maroon-background{background:#7d0000}
360.navy{color:#000060}
361.navy-background{background:#00007d}
362.olive{color:#606000}
363.olive-background{background:#7d7d00}
364.purple{color:#600060}
365.purple-background{background:#7d007d}
366.red{color:#bf0000}
367.red-background{background:#fa0000}
368.silver{color:#909090}
369.silver-background{background:#bcbcbc}
370.teal{color:#006060}
371.teal-background{background:#007d7d}
372.white{color:#bfbfbf}
373.white-background{background:#fafafa}
374.yellow{color:#bfbf00}
375.yellow-background{background:#fafa00}
376span.icon>.fa{cursor:default}
377a span.icon>.fa{cursor:inherit}
378.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
379.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
380.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
381.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
382.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
383.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
384.conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold}
385.conum[data-value] *{color:#fff!important}
386.conum[data-value]+b{display:none}
387.conum[data-value]::after{content:attr(data-value)}
388pre .conum[data-value]{position:relative;top:-.125em}
389b.conum *{color:inherit!important}
390.conum:not([data-value]):empty{display:none}
391dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
392h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
393p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
394p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
395p{margin-bottom:1.25rem}
396.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
397.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
398.print-only{display:none!important}
399@page{margin:1.25cm .75cm}
400@media print{*{box-shadow:none!important;text-shadow:none!important}
401html{font-size:80%}
402a{color:inherit!important;text-decoration:underline!important}
403a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
404a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
405abbr[title]{border-bottom:1px dotted}
406abbr[title]::after{content:" (" attr(title) ")"}
407pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
408thead{display:table-header-group}
409svg{max-width:100%}
410p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
411h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
412#header,#content,#footnotes,#footer{max-width:none}
413#toc,.sidebarblock,.exampleblock>.content{background:none!important}
414#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
415body.book #header{text-align:center}
416body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
417body.book #header .details{border:0!important;display:block;padding:0!important}
418body.book #header .details span:first-child{margin-left:0!important}
419body.book #header .details br{display:block}
420body.book #header .details br+span::before{content:none!important}
421body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
422body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
423.listingblock code[data-lang]::before{display:block}
424#footer{padding:0 .9375em}
425.hide-on-print{display:none!important}
426.print-only{display:block!important}
427.hide-for-print{display:none!important}
428.show-for-print{display:inherit!important}}
429@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
430.sect1{padding:0!important}
431.sect1+.sect1{border:0}
432#footer{background:none}
433#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
434@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
435</style>
436<style>
437pre>code {
438 display: inline;
439}
440</style>
441</head>
442<body class="manpage">
443<div id="header">
444<h1>git-commit(1) Manual Page</h1>
445<h2 id="_name">NAME</h2>
446<div class="sectionbody">
447<p>git-commit - Record changes to the repository</p>
448</div>
449</div>
450<div id="content">
451<div class="sect1">
452<h2 id="_synopsis">SYNOPSIS</h2>
453<div class="sectionbody">
454<div class="verseblock">
Junio C Hamano796624e2025-01-29 23:44:54455<pre class="content"><code>git</code> <code>commit</code> [<code>-a</code> | <code>--interactive</code> | <code>--patch</code>] [<code>-s</code>] [<code>-v</code>] [<code>-u</code>[<em>&lt;mode&gt;</em>]] [<code>--amend</code>]
456 [<code>--dry-run</code>] [(<code>-c</code> | <code>-C</code> | <code>--squash</code>) <em>&lt;commit&gt;</em> | <code>--fixup</code> [(<code>amend</code>|<code>reword</code>)<code>:</code>]<em>&lt;commit&gt;</em>]
457 [<code>-F</code> <em>&lt;file&gt;</em> | <code>-m</code> <em>&lt;msg&gt;</em>] [<code>--reset-author</code>] [<code>--allow-empty</code>]
458 [<code>--allow-empty-message</code>] [<code>--no-verify</code>] [<code>-e</code>] [<code>--author=</code><em>&lt;author&gt;</em>]
459 [<code>--date=</code><em>&lt;date&gt;</em>] [<code>--cleanup=</code><em>&lt;mode&gt;</em>] [<code>--</code>[<code>no-</code>]<code>status</code>]
460 [<code>-i</code> | <code>-o</code>] [<code>--pathspec-from-file=</code><em>&lt;file&gt;</em> [<code>--pathspec-file-nul</code>]]
461 [(<code>--trailer</code> <em>&lt;token&gt;</em>[(<code>=</code>|<code>:</code>)<em>&lt;value&gt;</em>])&#8230;&#8203;] [<code>-S</code>[<em>&lt;keyid&gt;</em>]]
462 [<code>--</code>] [<em>&lt;pathspec&gt;</em>&#8230;&#8203;]</pre>
Junio C Hamanob96f40a2024-08-01 00:57:25463</div>
464</div>
465</div>
466<div class="sect1">
467<h2 id="_description">DESCRIPTION</h2>
468<div class="sectionbody">
469<div class="paragraph">
470<p>Create a new commit containing the current contents of the index and
471the given log message describing the changes. The new commit is a
472direct child of HEAD, usually the tip of the current branch, and the
473branch is updated to point to it (unless no branch is associated with
Junio C Hamano796624e2025-01-29 23:44:54474the working tree, in which case <code>HEAD</code> is "detached" as described in
Junio C Hamanob96f40a2024-08-01 00:57:25475<a href="git-checkout.html">git-checkout(1)</a>).</p>
476</div>
477<div class="paragraph">
478<p>The content to be committed can be specified in several ways:</p>
479</div>
480<div class="olist arabic">
481<ol class="arabic">
482<li>
483<p>by using <a href="git-add.html">git-add(1)</a> to incrementally "add" changes to the
Junio C Hamano796624e2025-01-29 23:44:54484index before using the <code>commit</code> command (Note: even modified files
Junio C Hamanob96f40a2024-08-01 00:57:25485must be "added");</p>
486</li>
487<li>
488<p>by using <a href="git-rm.html">git-rm(1)</a> to remove files from the working tree
Junio C Hamano796624e2025-01-29 23:44:54489and the index, again before using the <code>commit</code> command;</p>
Junio C Hamanob96f40a2024-08-01 00:57:25490</li>
491<li>
Junio C Hamano796624e2025-01-29 23:44:54492<p>by listing files as arguments to the <code>commit</code> command
493(without <code>--interactive</code> or <code>--patch</code> switch), in which
Junio C Hamanob96f40a2024-08-01 00:57:25494case the commit will ignore changes staged in the index, and instead
495record the current content of the listed files (which must already
496be known to Git);</p>
497</li>
498<li>
Junio C Hamano796624e2025-01-29 23:44:54499<p>by using the <code>-a</code> switch with the <code>commit</code> command to automatically
Junio C Hamanob96f40a2024-08-01 00:57:25500"add" changes from all known files (i.e. all files that are already
501listed in the index) and to automatically "rm" files in the index
502that have been removed from the working tree, and then perform the
503actual commit;</p>
504</li>
505<li>
Junio C Hamano796624e2025-01-29 23:44:54506<p>by using the <code>--interactive</code> or <code>--patch</code> switches with the <code>commit</code> command
Junio C Hamanob96f40a2024-08-01 00:57:25507to decide one by one which files or hunks should be part of the commit
508in addition to contents in the index,
509before finalizing the operation. See the &#8220;Interactive Mode&#8221; section of
510<a href="git-add.html">git-add(1)</a> to learn how to operate these modes.</p>
511</li>
512</ol>
513</div>
514<div class="paragraph">
515<p>The <code>--dry-run</code> option can be used to obtain a
516summary of what is included by any of the above for the next
517commit by giving the same set of parameters (options and paths).</p>
518</div>
519<div class="paragraph">
520<p>If you make a commit and then find a mistake immediately after
Junio C Hamano796624e2025-01-29 23:44:54521that, you can recover from it with <code>git</code> <code>reset</code>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25522</div>
523</div>
524</div>
525<div class="sect1">
526<h2 id="_options">OPTIONS</h2>
527<div class="sectionbody">
528<div class="dlist">
529<dl>
Junio C Hamano796624e2025-01-29 23:44:54530<dt class="hdlist1"><code>-a</code></dt>
531<dt class="hdlist1"><code>--all</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25532<dd>
Junio C Hamano796624e2025-01-29 23:44:54533<p>Automatically stage files that have
Junio C Hamanob96f40a2024-08-01 00:57:25534been modified and deleted, but new files you have not
535told Git about are not affected.</p>
536</dd>
Junio C Hamano796624e2025-01-29 23:44:54537<dt class="hdlist1"><code>-p</code></dt>
538<dt class="hdlist1"><code>--patch</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25539<dd>
540<p>Use the interactive patch selection interface to choose
541which changes to commit. See <a href="git-add.html">git-add(1)</a> for
542details.</p>
543</dd>
Junio C Hamano1cc68cc2025-08-04 16:37:24544<dt class="hdlist1"><code>-U</code><em>&lt;n&gt;</em></dt>
545<dt class="hdlist1"><code>--unified=</code><em>&lt;n&gt;</em></dt>
546<dd>
547<p>Generate diffs with <em>&lt;n&gt;</em> lines of context. Defaults to <code>diff.context</code>
548or 3 if the config option is unset.</p>
549</dd>
550<dt class="hdlist1"><code>--inter-hunk-context=</code><em>&lt;n&gt;</em></dt>
551<dd>
552<p>Show the context between diff hunks, up to the specified <em>&lt;number&gt;</em>
553of lines, thereby fusing hunks that are close to each other.
554Defaults to <code>diff.interHunkContext</code> or 0 if the config option
555is unset.</p>
556</dd>
Junio C Hamano796624e2025-01-29 23:44:54557<dt class="hdlist1"><code>-C</code> <em>&lt;commit&gt;</em></dt>
558<dt class="hdlist1"><code>--reuse-message=</code><em>&lt;commit&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25559<dd>
Junio C Hamano796624e2025-01-29 23:44:54560<p>Take an existing <em>&lt;commit&gt;</em> object, and reuse the log message
Junio C Hamanob96f40a2024-08-01 00:57:25561and the authorship information (including the timestamp)
562when creating the commit.</p>
563</dd>
Junio C Hamano796624e2025-01-29 23:44:54564<dt class="hdlist1"><code>-c</code> <em>&lt;commit&gt;</em></dt>
565<dt class="hdlist1"><code>--reedit-message=</code><em>&lt;commit&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25566<dd>
Junio C Hamano796624e2025-01-29 23:44:54567<p>Like <code>-C</code>, but with <code>-c</code> the editor is invoked, so that
Junio C Hamanob96f40a2024-08-01 00:57:25568the user can further edit the commit message.</p>
569</dd>
Junio C Hamano796624e2025-01-29 23:44:54570<dt class="hdlist1"><code>--fixup=</code>[(<code>amend</code>|<code>reword</code>)<code>:</code>]<em>&lt;commit&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25571<dd>
Junio C Hamanodc392382024-10-11 18:57:29572<p>Create a new commit which "fixes up" <em>&lt;commit&gt;</em> when applied with
573<code>git</code> <code>rebase</code> <code>--autosquash</code>. Plain <code>--fixup=</code><em>&lt;commit&gt;</em> creates a
574"fixup!" commit which changes the content of <em>&lt;commit&gt;</em> but leaves
575its log message untouched. <code>--fixup=amend:</code><em>&lt;commit&gt;</em> is similar but
Junio C Hamanob96f40a2024-08-01 00:57:25576creates an "amend!" commit which also replaces the log message of
Junio C Hamanodc392382024-10-11 18:57:29577<em>&lt;commit&gt;</em> with the log message of the "amend!" commit.
578<code>--fixup=reword:</code><em>&lt;commit&gt;</em> creates an "amend!" commit which
579replaces the log message of <em>&lt;commit&gt;</em> with its own log message
580but makes no changes to the content of <em>&lt;commit&gt;</em>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25581<div class="paragraph">
Junio C Hamano6c767ae2025-02-25 23:24:09582<p>The commit created by plain <code>--fixup=</code><em>&lt;commit&gt;</em> has a title
583composed of "fixup!" followed by the title of <em>&lt;commit&gt;</em>,
Junio C Hamanodc392382024-10-11 18:57:29584and is recognized specially by <code>git</code> <code>rebase</code> <code>--autosquash</code>. The <code>-m</code>
Junio C Hamanob96f40a2024-08-01 00:57:25585option may be used to supplement the log message of the created
586commit, but the additional commentary will be thrown away once the
Junio C Hamanodc392382024-10-11 18:57:29587"fixup!" commit is squashed into <em>&lt;commit&gt;</em> by
588<code>git</code> <code>rebase</code> <code>--autosquash</code>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25589</div>
590<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29591<p>The commit created by <code>--fixup=amend:</code><em>&lt;commit&gt;</em> is similar but its
Junio C Hamano6c767ae2025-02-25 23:24:09592title is instead prefixed with "amend!". The log message of
Junio C Hamano796624e2025-01-29 23:44:54593<em>&lt;commit&gt;</em> is copied into the log message of the "amend!" commit and
Junio C Hamanodc392382024-10-11 18:57:29594opened in an editor so it can be refined. When <code>git</code> <code>rebase</code>
595<code>--autosquash</code> squashes the "amend!" commit into <em>&lt;commit&gt;</em>, the
596log message of <em>&lt;commit&gt;</em> is replaced by the refined log message
Junio C Hamanob96f40a2024-08-01 00:57:25597from the "amend!" commit. It is an error for the "amend!" commit&#8217;s
598log message to be empty unless <code>--allow-empty-message</code> is
599specified.</p>
600</div>
601<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29602<p><code>--fixup=reword:</code><em>&lt;commit&gt;</em> is shorthand for <code>--fixup=amend:</code><em>&lt;commit&gt;</em>
Junio C Hamano796624e2025-01-29 23:44:54603 <code>--only</code>. It creates an "amend!" commit with only a log message
Junio C Hamanodc392382024-10-11 18:57:29604(ignoring any changes staged in the index). When squashed by <code>git</code>
605<code>rebase</code> <code>--autosquash</code>, it replaces the log message of <em>&lt;commit&gt;</em>
Junio C Hamanob96f40a2024-08-01 00:57:25606without making any other changes.</p>
607</div>
608<div class="paragraph">
609<p>Neither "fixup!" nor "amend!" commits change authorship of
Junio C Hamanodc392382024-10-11 18:57:29610<em>&lt;commit&gt;</em> when applied by <code>git</code> <code>rebase</code> <code>--autosquash</code>.
Junio C Hamanob96f40a2024-08-01 00:57:25611See <a href="git-rebase.html">git-rebase(1)</a> for details.</p>
612</div>
613</dd>
Junio C Hamano796624e2025-01-29 23:44:54614<dt class="hdlist1"><code>--squash=</code><em>&lt;commit&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25615<dd>
Junio C Hamano796624e2025-01-29 23:44:54616<p>Construct a commit message for use with <code>git</code> <code>rebase</code> <code>--autosquash</code>.
Junio C Hamano6c767ae2025-02-25 23:24:09617The commit message title is taken from the specified
Junio C Hamanob96f40a2024-08-01 00:57:25618commit with a prefix of "squash! ". Can be used with additional
619commit message options (<code>-m</code>/<code>-c</code>/<code>-C</code>/<code>-F</code>). See
620<a href="git-rebase.html">git-rebase(1)</a> for details.</p>
621</dd>
Junio C Hamano796624e2025-01-29 23:44:54622<dt class="hdlist1"><code>--reset-author</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25623<dd>
Junio C Hamano796624e2025-01-29 23:44:54624<p>When used with <code>-C</code>/<code>-c</code>/<code>--amend</code> options, or when committing after a
Junio C Hamanob96f40a2024-08-01 00:57:25625conflicting cherry-pick, declare that the authorship of the
626resulting commit now belongs to the committer. This also renews
627the author timestamp.</p>
628</dd>
Junio C Hamano796624e2025-01-29 23:44:54629<dt class="hdlist1"><code>--short</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25630<dd>
631<p>When doing a dry-run, give the output in the short-format. See
632<a href="git-status.html">git-status(1)</a> for details. Implies <code>--dry-run</code>.</p>
633</dd>
Junio C Hamano796624e2025-01-29 23:44:54634<dt class="hdlist1"><code>--branch</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25635<dd>
636<p>Show the branch and tracking info even in short-format.</p>
637</dd>
Junio C Hamano796624e2025-01-29 23:44:54638<dt class="hdlist1"><code>--porcelain</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25639<dd>
640<p>When doing a dry-run, give the output in a porcelain-ready
641format. See <a href="git-status.html">git-status(1)</a> for details. Implies
642<code>--dry-run</code>.</p>
643</dd>
Junio C Hamano796624e2025-01-29 23:44:54644<dt class="hdlist1"><code>--long</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25645<dd>
646<p>When doing a dry-run, give the output in the long-format.
647Implies <code>--dry-run</code>.</p>
648</dd>
Junio C Hamano796624e2025-01-29 23:44:54649<dt class="hdlist1"><code>-z</code></dt>
650<dt class="hdlist1"><code>--null</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25651<dd>
652<p>When showing <code>short</code> or <code>porcelain</code> status output, print the
Junio C Hamano796624e2025-01-29 23:44:54653filename verbatim and terminate the entries with <em>NUL</em>, instead of <em>LF</em>.
Junio C Hamanob96f40a2024-08-01 00:57:25654If no format is given, implies the <code>--porcelain</code> output format.
655Without the <code>-z</code> option, filenames with "unusual" characters are
656quoted as explained for the configuration variable <code>core.quotePath</code>
657(see <a href="git-config.html">git-config(1)</a>).</p>
658</dd>
Junio C Hamano796624e2025-01-29 23:44:54659<dt class="hdlist1"><code>-F</code> <em>&lt;file&gt;</em></dt>
660<dt class="hdlist1"><code>--file=</code><em>&lt;file&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25661<dd>
Junio C Hamano796624e2025-01-29 23:44:54662<p>Take the commit message from <em>&lt;file&gt;</em>. Use <em>-</em> to
Junio C Hamanob96f40a2024-08-01 00:57:25663read the message from the standard input.</p>
664</dd>
Junio C Hamano796624e2025-01-29 23:44:54665<dt class="hdlist1"><code>--author=</code><em>&lt;author&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25666<dd>
667<p>Override the commit author. Specify an explicit author using the
Junio C Hamano796624e2025-01-29 23:44:54668standard <code>A</code> <code>U</code> <code>Thor</code> &lt;author@example.<code>com</code>&gt; format. Otherwise <em>&lt;author&gt;</em>
Junio C Hamanob96f40a2024-08-01 00:57:25669is assumed to be a pattern and is used to search for an existing
Junio C Hamano796624e2025-01-29 23:44:54670commit by that author (i.e. <code>git</code> <code>rev-list</code> <code>--all</code> <code>-i</code> <code>--author=</code><em>&lt;author&gt;</em>);
Junio C Hamanob96f40a2024-08-01 00:57:25671the commit author is then copied from the first such commit found.</p>
672</dd>
Junio C Hamano796624e2025-01-29 23:44:54673<dt class="hdlist1"><code>--date=</code><em>&lt;date&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25674<dd>
675<p>Override the author date used in the commit.</p>
676</dd>
Junio C Hamano796624e2025-01-29 23:44:54677<dt class="hdlist1"><code>-m</code> <em>&lt;msg&gt;</em></dt>
678<dt class="hdlist1"><code>--message=</code><em>&lt;msg&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25679<dd>
Junio C Hamano796624e2025-01-29 23:44:54680<p>Use <em>&lt;msg&gt;</em> as the commit message.
Junio C Hamanob96f40a2024-08-01 00:57:25681If multiple <code>-m</code> options are given, their values are
682concatenated as separate paragraphs.</p>
683<div class="paragraph">
684<p>The <code>-m</code> option is mutually exclusive with <code>-c</code>, <code>-C</code>, and <code>-F</code>.</p>
685</div>
686</dd>
Junio C Hamano796624e2025-01-29 23:44:54687<dt class="hdlist1"><code>-t</code> <em>&lt;file&gt;</em></dt>
688<dt class="hdlist1"><code>--template=</code><em>&lt;file&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25689<dd>
690<p>When editing the commit message, start the editor with the
Junio C Hamano796624e2025-01-29 23:44:54691contents in <em>&lt;file&gt;</em>. The <code>commit.template</code> configuration
Junio C Hamanob96f40a2024-08-01 00:57:25692variable is often used to give this option implicitly to the
693command. This mechanism can be used by projects that want to
694guide participants with some hints on what to write in the message
695in what order. If the user exits the editor without editing the
696message, the commit is aborted. This has no effect when a message
697is given by other means, e.g. with the <code>-m</code> or <code>-F</code> options.</p>
698</dd>
Junio C Hamano796624e2025-01-29 23:44:54699<dt class="hdlist1"><code>-s</code></dt>
700<dt class="hdlist1"><code>--signoff</code></dt>
701<dt class="hdlist1"><code>--no-signoff</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25702<dd>
703<p>Add a <code>Signed-off-by</code> trailer by the committer at the end of the commit
704log message. The meaning of a signoff depends on the project
705to which you&#8217;re committing. For example, it may certify that
706the committer has the rights to submit the work under the
707project&#8217;s license or agrees to some contributor representation,
708such as a Developer Certificate of Origin.
709(See <a href="https://developercertificate.org" class="bare">https://developercertificate.org</a> for the one used by the
710Linux kernel and Git projects.) Consult the documentation or
711leadership of the project to which you&#8217;re contributing to
712understand how the signoffs are used in that project.</p>
713<div class="paragraph">
Junio C Hamano796624e2025-01-29 23:44:54714<p>The <code>--no-signoff</code> option can be used to countermand an earlier <code>--signoff</code>
Junio C Hamanob96f40a2024-08-01 00:57:25715option on the command line.</p>
716</div>
717</dd>
Junio C Hamano796624e2025-01-29 23:44:54718<dt class="hdlist1"><code>--trailer</code> <em>&lt;token&gt;</em>[(<code>=</code>|<code>:</code>)<em>&lt;value&gt;</em>]</dt>
Junio C Hamanob96f40a2024-08-01 00:57:25719<dd>
Junio C Hamano796624e2025-01-29 23:44:54720<p>Specify a (<em>&lt;token&gt;</em>, <em>&lt;value&gt;</em>) pair that should be applied as a
Junio C Hamanoe03f5992025-04-23 22:24:29721trailer. (e.g. <code>git</code> <code>commit</code> <code>--trailer</code> "Signed-off-by:C <code>O</code> <code>Mitter</code> <code>\</code>
722&lt;committer@example.<code>com</code>&gt;" <code>--trailer</code> "Helped-by:C <code>O</code> <code>Mitter</code> <code>\</code>
Junio C Hamano796624e2025-01-29 23:44:54723&lt;committer@example.<code>com</code>&gt;" will add the <code>Signed-off-by</code> trailer
724and the <code>Helped-by</code> trailer to the commit message.)
Junio C Hamanoe03f5992025-04-23 22:24:29725The <code>trailer.*</code> configuration variables
Junio C Hamanob96f40a2024-08-01 00:57:25726(<a href="git-interpret-trailers.html">git-interpret-trailers(1)</a>) can be used to define if
727a duplicated trailer is omitted, where in the run of trailers
728each trailer would appear, and other details.</p>
729</dd>
Junio C Hamano796624e2025-01-29 23:44:54730<dt class="hdlist1"><code>-n</code></dt>
731<dt class="hdlist1"><code>--</code>[<code>no-</code>]<code>verify</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25732<dd>
Junio C Hamano796624e2025-01-29 23:44:54733<p>Bypass the <code>pre-commit</code> and <code>commit-msg</code> hooks.
Junio C Hamanob96f40a2024-08-01 00:57:25734See also <a href="githooks.html">githooks(5)</a>.</p>
735</dd>
Junio C Hamano796624e2025-01-29 23:44:54736<dt class="hdlist1"><code>--allow-empty</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25737<dd>
738<p>Usually recording a commit that has the exact same tree as its
739sole parent commit is a mistake, and the command prevents you
740from making such a commit. This option bypasses the safety, and
741is primarily for use by foreign SCM interface scripts.</p>
742</dd>
Junio C Hamano796624e2025-01-29 23:44:54743<dt class="hdlist1"><code>--allow-empty-message</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25744<dd>
Junio C Hamano796624e2025-01-29 23:44:54745<p>Create a commit with an empty commit message without using plumbing
746commands like <a href="git-commit-tree.html">git-commit-tree(1)</a>. Like <code>--allow-empty</code>, this
747command is primarily for use by foreign SCM interface scripts.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25748</dd>
Junio C Hamano796624e2025-01-29 23:44:54749<dt class="hdlist1"><code>--cleanup=</code><em>&lt;mode&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25750<dd>
Junio C Hamano796624e2025-01-29 23:44:54751<p>Determine how the supplied commit message should be
Junio C Hamanob96f40a2024-08-01 00:57:25752cleaned up before committing. The <em>&lt;mode&gt;</em> can be <code>strip</code>,
753<code>whitespace</code>, <code>verbatim</code>, <code>scissors</code> or <code>default</code>.</p>
754<div class="openblock">
755<div class="content">
756<div class="dlist">
757<dl>
Junio C Hamano796624e2025-01-29 23:44:54758<dt class="hdlist1"><code>strip</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25759<dd>
760<p>Strip leading and trailing empty lines, trailing whitespace,
761commentary and collapse consecutive empty lines.</p>
762</dd>
Junio C Hamano796624e2025-01-29 23:44:54763<dt class="hdlist1"><code>whitespace</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25764<dd>
765<p>Same as <code>strip</code> except #commentary is not removed.</p>
766</dd>
Junio C Hamano796624e2025-01-29 23:44:54767<dt class="hdlist1"><code>verbatim</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25768<dd>
769<p>Do not change the message at all.</p>
770</dd>
Junio C Hamano796624e2025-01-29 23:44:54771<dt class="hdlist1"><code>scissors</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25772<dd>
773<p>Same as <code>whitespace</code> except that everything from (and including)
774the line found below is truncated, if the message is to be edited.
Junio C Hamano796624e2025-01-29 23:44:54775"#" can be customized with <code>core.commentChar</code>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25776<div class="literalblock">
777<div class="content">
778<pre># ------------------------ &gt;8 ------------------------</pre>
779</div>
780</div>
781</dd>
Junio C Hamano796624e2025-01-29 23:44:54782<dt class="hdlist1"><code>default</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25783<dd>
784<p>Same as <code>strip</code> if the message is to be edited.
785Otherwise <code>whitespace</code>.</p>
786</dd>
787</dl>
788</div>
789</div>
790</div>
791<div class="paragraph">
792<p>The default can be changed by the <code>commit.cleanup</code> configuration
793variable (see <a href="git-config.html">git-config(1)</a>).</p>
794</div>
795</dd>
Junio C Hamano796624e2025-01-29 23:44:54796<dt class="hdlist1"><code>-e</code></dt>
797<dt class="hdlist1"><code>--edit</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25798<dd>
Junio C Hamano796624e2025-01-29 23:44:54799<p>Let the user further edit the message taken from <em>&lt;file&gt;</em>
800with <code>-F</code> <em>&lt;file&gt;</em>, command line with <code>-m</code> <em>&lt;message&gt;</em>, and
801from <em>&lt;commit&gt;</em> with <code>-C</code> <em>&lt;commit&gt;</em>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25802</dd>
Junio C Hamano796624e2025-01-29 23:44:54803<dt class="hdlist1"><code>--no-edit</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25804<dd>
805<p>Use the selected commit message without launching an editor.
Junio C Hamanodc392382024-10-11 18:57:29806For example, <code>git</code> <code>commit</code> <code>--amend</code> <code>--no-edit</code> amends a commit
Junio C Hamanob96f40a2024-08-01 00:57:25807without changing its commit message.</p>
808</dd>
Junio C Hamano796624e2025-01-29 23:44:54809<dt class="hdlist1"><code>--amend</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25810<dd>
811<p>Replace the tip of the current branch by creating a new
812commit. The recorded tree is prepared as usual (including
813the effect of the <code>-i</code> and <code>-o</code> options and explicit
814pathspec), and the message from the original commit is used
815as the starting point, instead of an empty message, when no
816other message is specified from the command line via options
817such as <code>-m</code>, <code>-F</code>, <code>-c</code>, etc. The new commit has the same
818parents and author as the current one (the <code>--reset-author</code>
819option can countermand this).</p>
820<div class="openblock">
821<div class="content">
822<div class="paragraph">
823<p>It is a rough equivalent for:</p>
824</div>
825<div class="listingblock">
826<div class="content">
827<pre> $ git reset --soft HEAD^
828 $ ... do something else to come up with the right tree ...
829 $ git commit -c ORIG_HEAD</pre>
830</div>
831</div>
832<div class="paragraph">
833<p>but can be used to amend a merge commit.</p>
834</div>
835</div>
836</div>
837<div class="paragraph">
838<p>You should understand the implications of rewriting history if you
839amend a commit that has already been published. (See the "RECOVERING
840FROM UPSTREAM REBASE" section in <a href="git-rebase.html">git-rebase(1)</a>.)</p>
841</div>
842</dd>
Junio C Hamano796624e2025-01-29 23:44:54843<dt class="hdlist1"><code>--no-post-rewrite</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25844<dd>
Junio C Hamano796624e2025-01-29 23:44:54845<p>Bypass the <code>post-rewrite</code> hook.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25846</dd>
Junio C Hamano796624e2025-01-29 23:44:54847<dt class="hdlist1"><code>-i</code></dt>
848<dt class="hdlist1"><code>--include</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25849<dd>
850<p>Before making a commit out of staged contents so far,
851stage the contents of paths given on the command line
852as well. This is usually not what you want unless you
853are concluding a conflicted merge.</p>
854</dd>
Junio C Hamano796624e2025-01-29 23:44:54855<dt class="hdlist1"><code>-o</code></dt>
856<dt class="hdlist1"><code>--only</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25857<dd>
858<p>Make a commit by taking the updated working tree contents
859of the paths specified on the
860command line, disregarding any contents that have been
861staged for other paths. This is the default mode of operation of
Junio C Hamano796624e2025-01-29 23:44:54862<code>git</code> <code>commit</code> if any paths are given on the command line,
Junio C Hamanob96f40a2024-08-01 00:57:25863in which case this option can be omitted.
864If this option is specified together with <code>--amend</code>, then
865no paths need to be specified, which can be used to amend
866the last commit without committing changes that have
867already been staged. If used together with <code>--allow-empty</code>
868paths are also not required, and an empty commit will be created.</p>
869</dd>
Junio C Hamano796624e2025-01-29 23:44:54870<dt class="hdlist1"><code>--pathspec-from-file=</code><em>&lt;file&gt;</em></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25871<dd>
Junio C Hamano796624e2025-01-29 23:44:54872<p>Pass pathspec in <em>&lt;file&gt;</em> instead of commandline args. If
Junio C Hamanodc392382024-10-11 18:57:29873<em>&lt;file&gt;</em> is exactly <code>-</code> then standard input is used. Pathspec
Junio C Hamano796624e2025-01-29 23:44:54874elements are separated by <em>LF</em> or <em>CR</em>/<em>LF</em>. Pathspec elements can be
Junio C Hamanob96f40a2024-08-01 00:57:25875quoted as explained for the configuration variable <code>core.quotePath</code>
876(see <a href="git-config.html">git-config(1)</a>). See also <code>--pathspec-file-nul</code> and
877global <code>--literal-pathspecs</code>.</p>
878</dd>
Junio C Hamano796624e2025-01-29 23:44:54879<dt class="hdlist1"><code>--pathspec-file-nul</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25880<dd>
881<p>Only meaningful with <code>--pathspec-from-file</code>. Pathspec elements are
Junio C Hamano796624e2025-01-29 23:44:54882separated with <em>NUL</em> character and all other characters are taken
Junio C Hamanob96f40a2024-08-01 00:57:25883literally (including newlines and quotes).</p>
884</dd>
Junio C Hamano796624e2025-01-29 23:44:54885<dt class="hdlist1"><code>-u</code>[<em>&lt;mode&gt;</em>]</dt>
886<dt class="hdlist1"><code>--untracked-files</code>[<code>=</code><em>&lt;mode&gt;</em>]</dt>
Junio C Hamanob96f40a2024-08-01 00:57:25887<dd>
888<p>Show untracked files.</p>
889<div class="openblock">
890<div class="content">
891<div class="paragraph">
Junio C Hamano796624e2025-01-29 23:44:54892<p>The <em>&lt;mode&gt;</em> parameter is optional (defaults to <code>all</code>), and is used to
893specify the handling of untracked files; when <code>-u</code> is not used, the
894default is <code>normal</code>, i.e. show untracked files and directories.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25895</div>
896<div class="paragraph">
897<p>The possible options are:</p>
898</div>
Junio C Hamano796624e2025-01-29 23:44:54899<div class="dlist">
900<dl>
901<dt class="hdlist1"><code>no</code></dt>
902<dd>
903<p>Show no untracked files</p>
904</dd>
905<dt class="hdlist1"><code>normal</code></dt>
906<dd>
907<p>Shows untracked files and directories</p>
908</dd>
909<dt class="hdlist1"><code>all</code></dt>
910<dd>
911<p>Also shows individual files in untracked directories.</p>
912</dd>
913</dl>
Junio C Hamanob96f40a2024-08-01 00:57:25914</div>
915<div class="paragraph">
916<p>All usual spellings for Boolean value <code>true</code> are taken as <code>normal</code>
917and <code>false</code> as <code>no</code>.
Junio C Hamano796624e2025-01-29 23:44:54918The default can be changed using the <code>status.showUntrackedFiles</code>
Junio C Hamanob96f40a2024-08-01 00:57:25919configuration variable documented in <a href="git-config.html">git-config(1)</a>.</p>
920</div>
921</div>
922</div>
923</dd>
Junio C Hamano796624e2025-01-29 23:44:54924<dt class="hdlist1"><code>-v</code></dt>
925<dt class="hdlist1"><code>--verbose</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25926<dd>
Junio C Hamano796624e2025-01-29 23:44:54927<p>Show unified diff between the <code>HEAD</code> commit and what
Junio C Hamanob96f40a2024-08-01 00:57:25928would be committed at the bottom of the commit message
929template to help the user describe the commit by reminding
930what changes the commit has.
931Note that this diff output doesn&#8217;t have its
Junio C Hamano796624e2025-01-29 23:44:54932lines prefixed with #. This diff will not be a part
Junio C Hamanob96f40a2024-08-01 00:57:25933of the commit message. See the <code>commit.verbose</code> configuration
934variable in <a href="git-config.html">git-config(1)</a>.</p>
935<div class="paragraph">
936<p>If specified twice, show in addition the unified diff between
937what would be committed and the worktree files, i.e. the unstaged
938changes to tracked files.</p>
939</div>
940</dd>
Junio C Hamano796624e2025-01-29 23:44:54941<dt class="hdlist1"><code>-q</code></dt>
942<dt class="hdlist1"><code>--quiet</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25943<dd>
944<p>Suppress commit summary message.</p>
945</dd>
Junio C Hamano796624e2025-01-29 23:44:54946<dt class="hdlist1"><code>--dry-run</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25947<dd>
948<p>Do not create a commit, but show a list of paths that are
949to be committed, paths with local changes that will be left
950uncommitted and paths that are untracked.</p>
951</dd>
Junio C Hamano796624e2025-01-29 23:44:54952<dt class="hdlist1"><code>--status</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25953<dd>
954<p>Include the output of <a href="git-status.html">git-status(1)</a> in the commit
955message template when using an editor to prepare the commit
956message. Defaults to on, but can be used to override
Junio C Hamano796624e2025-01-29 23:44:54957configuration variable <code>commit.status</code>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25958</dd>
Junio C Hamano796624e2025-01-29 23:44:54959<dt class="hdlist1"><code>--no-status</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25960<dd>
961<p>Do not include the output of <a href="git-status.html">git-status(1)</a> in the
962commit message template when using an editor to prepare the
963default commit message.</p>
964</dd>
Junio C Hamano796624e2025-01-29 23:44:54965<dt class="hdlist1"><code>-S</code>[<em>&lt;key-id&gt;</em>]</dt>
966<dt class="hdlist1"><code>--gpg-sign</code>[<code>=</code><em>&lt;key-id&gt;</em>]</dt>
967<dt class="hdlist1"><code>--no-gpg-sign</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25968<dd>
Junio C Hamano796624e2025-01-29 23:44:54969<p>GPG-sign commits. The <em>&lt;key-id&gt;</em> is optional and
Junio C Hamanob96f40a2024-08-01 00:57:25970defaults to the committer identity; if specified, it must be
971stuck to the option without a space. <code>--no-gpg-sign</code> is useful to
972countermand both <code>commit.gpgSign</code> configuration variable, and
973earlier <code>--gpg-sign</code>.</p>
974</dd>
Junio C Hamano796624e2025-01-29 23:44:54975<dt class="hdlist1"><code>--</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:25976<dd>
977<p>Do not interpret any more arguments as options.</p>
978</dd>
Junio C Hamano796624e2025-01-29 23:44:54979<dt class="hdlist1"><em>&lt;pathspec&gt;</em>...</dt>
Junio C Hamanob96f40a2024-08-01 00:57:25980<dd>
Junio C Hamano796624e2025-01-29 23:44:54981<p>When <em>&lt;pathspec&gt;</em> is given on the command line, commit the contents of
Junio C Hamanob96f40a2024-08-01 00:57:25982the files that match the pathspec without recording the changes
983already added to the index. The contents of these files are also
984staged for the next commit on top of what have been staged before.</p>
985<div class="paragraph">
986<p>For more details, see the <em>pathspec</em> entry in <a href="gitglossary.html">gitglossary(7)</a>.</p>
987</div>
988</dd>
989</dl>
990</div>
991</div>
992</div>
993<div class="sect1">
994<h2 id="_examples">EXAMPLES</h2>
995<div class="sectionbody">
996<div class="paragraph">
997<p>When recording your own work, the contents of modified files in
998your working tree are temporarily stored to a staging area
Junio C Hamano796624e2025-01-29 23:44:54999called the "index" with <code>git</code> <code>add</code>. A file can be
Junio C Hamanob96f40a2024-08-01 00:57:251000reverted back, only in the index but not in the working tree,
Junio C Hamanodc392382024-10-11 18:57:291001to that of the last commit with <code>git</code> <code>restore</code> <code>--staged</code> <em>&lt;file&gt;</em>,
Junio C Hamano796624e2025-01-29 23:44:541002which effectively reverts <code>git</code> <code>add</code> and prevents the changes to
Junio C Hamanob96f40a2024-08-01 00:57:251003this file from participating in the next commit. After building
1004the state to be committed incrementally with these commands,
Junio C Hamanodc392382024-10-11 18:57:291005<code>git</code> <code>commit</code> (without any pathname parameter) is used to record what
Junio C Hamanob96f40a2024-08-01 00:57:251006has been staged so far. This is the most basic form of the
1007command. An example:</p>
1008</div>
1009<div class="listingblock">
1010<div class="content">
1011<pre>$ edit hello.c
1012$ git rm goodbye.c
1013$ git add hello.c
1014$ git commit</pre>
1015</div>
1016</div>
1017<div class="paragraph">
1018<p>Instead of staging files after each individual change, you can
Junio C Hamanodc392382024-10-11 18:57:291019tell <code>git</code> <code>commit</code> to notice the changes to the files whose
Junio C Hamanob96f40a2024-08-01 00:57:251020contents are tracked in
Junio C Hamanodc392382024-10-11 18:57:291021your working tree and do corresponding <code>git</code> <code>add</code> and <code>git</code> <code>rm</code>
Junio C Hamanob96f40a2024-08-01 00:57:251022for you. That is, this example does the same as the earlier
1023example if there is no other change in your working tree:</p>
1024</div>
1025<div class="listingblock">
1026<div class="content">
1027<pre>$ edit hello.c
1028$ rm goodbye.c
1029$ git commit -a</pre>
1030</div>
1031</div>
1032<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:291033<p>The command <code>git</code> <code>commit</code> <code>-a</code> first looks at your working tree,
Junio C Hamano796624e2025-01-29 23:44:541034notices that you have modified <code>hello.c</code> and removed <code>goodbye.c</code>,
Junio C Hamanodc392382024-10-11 18:57:291035and performs necessary <code>git</code> <code>add</code> and <code>git</code> <code>rm</code> for you.</p>
Junio C Hamanob96f40a2024-08-01 00:57:251036</div>
1037<div class="paragraph">
1038<p>After staging changes to many files, you can alter the order the
Junio C Hamanodc392382024-10-11 18:57:291039changes are recorded in, by giving pathnames to <code>git</code> <code>commit</code>.
Junio C Hamanob96f40a2024-08-01 00:57:251040When pathnames are given, the command makes a commit that
1041only records the changes made to the named paths:</p>
1042</div>
1043<div class="listingblock">
1044<div class="content">
1045<pre>$ edit hello.c hello.h
1046$ git add hello.c hello.h
1047$ edit Makefile
1048$ git commit Makefile</pre>
1049</div>
1050</div>
1051<div class="paragraph">
1052<p>This makes a commit that records the modification to <code>Makefile</code>.
1053The changes staged for <code>hello.c</code> and <code>hello.h</code> are not included
1054in the resulting commit. However, their changes are not lost&#8201;&#8212;&#8201;they are still staged and merely held back. After the above
1055sequence, if you do:</p>
1056</div>
1057<div class="listingblock">
1058<div class="content">
1059<pre>$ git commit</pre>
1060</div>
1061</div>
1062<div class="paragraph">
1063<p>this second commit would record the changes to <code>hello.c</code> and
1064<code>hello.h</code> as expected.</p>
1065</div>
1066<div class="paragraph">
Junio C Hamano796624e2025-01-29 23:44:541067<p>After a merge (initiated by <code>git</code> <code>merge</code> or <code>git</code> <code>pull</code>) stops
Junio C Hamanob96f40a2024-08-01 00:57:251068because of conflicts, cleanly merged
1069paths are already staged to be committed for you, and paths that
1070conflicted are left in unmerged state. You would have to first
Junio C Hamano796624e2025-01-29 23:44:541071check which paths are conflicting with <code>git</code> <code>status</code>
Junio C Hamanob96f40a2024-08-01 00:57:251072and after fixing them manually in your working tree, you would
Junio C Hamano796624e2025-01-29 23:44:541073stage the result as usual with <code>git</code> <code>add</code>:</p>
Junio C Hamanob96f40a2024-08-01 00:57:251074</div>
1075<div class="listingblock">
1076<div class="content">
1077<pre>$ git status | grep unmerged
1078unmerged: hello.c
1079$ edit hello.c
1080$ git add hello.c</pre>
1081</div>
1082</div>
1083<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:291084<p>After resolving conflicts and staging the result, <code>git</code> <code>ls-files</code> <code>-u</code>
Junio C Hamanob96f40a2024-08-01 00:57:251085would stop mentioning the conflicted path. When you are done,
Junio C Hamanodc392382024-10-11 18:57:291086run <code>git</code> <code>commit</code> to finally record the merge:</p>
Junio C Hamanob96f40a2024-08-01 00:57:251087</div>
1088<div class="listingblock">
1089<div class="content">
1090<pre>$ git commit</pre>
1091</div>
1092</div>
1093<div class="paragraph">
1094<p>As with the case to record your own changes, you can use <code>-a</code>
1095option to save typing. One difference is that during a merge
Junio C Hamanodc392382024-10-11 18:57:291096resolution, you cannot use <code>git</code> <code>commit</code> with pathnames to
Junio C Hamanob96f40a2024-08-01 00:57:251097alter the order the changes are committed, because the merge
1098should be recorded as a single commit. In fact, the command
1099refuses to run when given pathnames (but see <code>-i</code> option).</p>
1100</div>
1101</div>
1102</div>
1103<div class="sect1">
1104<h2 id="_commit_information">COMMIT INFORMATION</h2>
1105<div class="sectionbody">
1106<div class="paragraph">
1107<p>Author and committer information is taken from the following environment
1108variables, if set:</p>
1109</div>
Junio C Hamano796624e2025-01-29 23:44:541110<div class="ulist">
1111<ul>
1112<li>
1113<p><code>GIT_AUTHOR_NAME</code></p>
1114</li>
1115<li>
1116<p><code>GIT_AUTHOR_EMAIL</code></p>
1117</li>
1118<li>
1119<p><code>GIT_AUTHOR_DATE</code></p>
1120</li>
1121<li>
1122<p><code>GIT_COMMITTER_NAME</code></p>
1123</li>
1124<li>
1125<p><code>GIT_COMMITTER_EMAIL</code></p>
1126</li>
1127<li>
1128<p><code>GIT_COMMITTER_DATE</code></p>
1129</li>
1130</ul>
Junio C Hamanob96f40a2024-08-01 00:57:251131</div>
1132<div class="paragraph">
1133<p>(nb "&lt;", "&gt;" and "\n"s are stripped)</p>
1134</div>
1135<div class="paragraph">
1136<p>The author and committer names are by convention some form of a personal name
1137(that is, the name by which other humans refer to you), although Git does not
1138enforce or require any particular form. Arbitrary Unicode may be used, subject
1139to the constraints listed above. This name has no effect on authentication; for
1140that, see the <code>credential.username</code> variable in <a href="git-config.html">git-config(1)</a>.</p>
1141</div>
1142<div class="paragraph">
1143<p>In case (some of) these environment variables are not set, the information
1144is taken from the configuration items <code>user.name</code> and <code>user.email</code>, or, if not
Junio C Hamano796624e2025-01-29 23:44:541145present, the environment variable <code>EMAIL</code>, or, if that is not set,
Junio C Hamanob96f40a2024-08-01 00:57:251146system user name and the hostname used for outgoing mail (taken
1147from <code>/etc/mailname</code> and falling back to the fully qualified hostname when
1148that file does not exist).</p>
1149</div>
1150<div class="paragraph">
1151<p>The <code>author.name</code> and <code>committer.name</code> and their corresponding email options
1152override <code>user.name</code> and <code>user.email</code> if set and are overridden themselves by
1153the environment variables.</p>
1154</div>
1155<div class="paragraph">
1156<p>The typical usage is to set just the <code>user.name</code> and <code>user.email</code> variables;
1157the other options are provided for more complex use cases.</p>
1158</div>
1159</div>
1160</div>
1161<div class="sect1">
1162<h2 id="_date_formats">DATE FORMATS</h2>
1163<div class="sectionbody">
1164<div class="paragraph">
1165<p>The <code>GIT_AUTHOR_DATE</code> and <code>GIT_COMMITTER_DATE</code> environment variables
1166support the following date formats:</p>
1167</div>
1168<div class="dlist">
1169<dl>
1170<dt class="hdlist1">Git internal format</dt>
1171<dd>
Junio C Hamanodc392382024-10-11 18:57:291172<p>It is <em>&lt;unix-timestamp&gt;</em> <em>&lt;time-zone-offset&gt;</em>, where
1173<em>&lt;unix-timestamp&gt;</em> is the number of seconds since the UNIX epoch.
1174<em>&lt;time-zone-offset&gt;</em> is a positive or negative offset from UTC.
Junio C Hamanob96f40a2024-08-01 00:57:251175For example CET (which is 1 hour ahead of UTC) is <code>+0100</code>.</p>
1176</dd>
1177<dt class="hdlist1">RFC 2822</dt>
1178<dd>
1179<p>The standard date format as described by RFC 2822, for example
Junio C Hamanodc392382024-10-11 18:57:291180<code>Thu,</code> <code>07</code> <code>Apr</code> <code>2005</code> <code>22:13:13</code> <code>+0200</code>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:251181</dd>
1182<dt class="hdlist1">ISO 8601</dt>
1183<dd>
1184<p>Time and date specified by the ISO 8601 standard, for example
1185<code>2005-04-07T22:13:13</code>. The parser accepts a space instead of the
1186<code>T</code> character as well. Fractional parts of a second will be ignored,
1187for example <code>2005-04-07T22:13:13.019</code> will be treated as
1188<code>2005-04-07T22:13:13</code>.</p>
1189<div class="admonitionblock note">
1190<table>
1191<tr>
1192<td class="icon">
1193<div class="title">Note</div>
1194</td>
1195<td class="content">
1196In addition, the date part is accepted in the following formats:
1197<code>YYYY.MM.DD</code>, <code>MM/DD/YYYY</code> and <code>DD.MM.YYYY</code>.
1198</td>
1199</tr>
1200</table>
1201</div>
1202</dd>
1203</dl>
1204</div>
1205<div class="paragraph">
1206<p>In addition to recognizing all date formats above, the <code>--date</code> option
1207will also try to make sense of other, more human-centric date formats,
1208such as relative dates like "yesterday" or "last Friday at noon".</p>
1209</div>
1210</div>
1211</div>
1212<div class="sect1">
1213<h2 id="_discussion">DISCUSSION</h2>
1214<div class="sectionbody">
1215<div class="paragraph">
1216<p>Though not required, it&#8217;s a good idea to begin the commit message
1217with a single short (no more than 50 characters) line summarizing the
1218change, followed by a blank line and then a more thorough description.
1219The text up to the first blank line in a commit message is treated
1220as the commit title, and that title is used throughout Git.
1221For example, <a href="git-format-patch.html">git-format-patch(1)</a> turns a commit into email, and it uses
1222the title on the Subject line and the rest of the commit in the body.</p>
1223</div>
1224<div class="paragraph">
1225<p>Git is to some extent character encoding agnostic.</p>
1226</div>
1227<div class="ulist">
1228<ul>
1229<li>
1230<p>The contents of the blob objects are uninterpreted sequences
1231of bytes. There is no encoding translation at the core
1232level.</p>
1233</li>
1234<li>
1235<p>Path names are encoded in UTF-8 normalization form C. This
1236applies to tree objects, the index file, ref names, as well as
1237path names in command line arguments, environment variables
Junio C Hamanodc392382024-10-11 18:57:291238and config files (.<code>git/config</code> (see <a href="git-config.html">git-config(1)</a>),
Junio C Hamanob96f40a2024-08-01 00:57:251239<a href="gitignore.html">gitignore(5)</a>, <a href="gitattributes.html">gitattributes(5)</a> and
1240<a href="gitmodules.html">gitmodules(5)</a>).</p>
1241<div class="paragraph">
1242<p>Note that Git at the core level treats path names simply as
1243sequences of non-NUL bytes, there are no path name encoding
1244conversions (except on Mac and Windows). Therefore, using
1245non-ASCII path names will mostly work even on platforms and file
1246systems that use legacy extended ASCII encodings. However,
1247repositories created on such systems will not work properly on
1248UTF-8-based systems (e.g. Linux, Mac, Windows) and vice versa.
1249Additionally, many Git-based tools simply assume path names to
1250be UTF-8 and will fail to display other encodings correctly.</p>
1251</div>
1252</li>
1253<li>
1254<p>Commit log messages are typically encoded in UTF-8, but other
1255extended ASCII encodings are also supported. This includes
1256ISO-8859-x, CP125x and many others, but <em>not</em> UTF-16/32,
1257EBCDIC and CJK multi-byte encodings (GBK, Shift-JIS, Big5,
1258EUC-x, CP9xx etc.).</p>
1259</li>
1260</ul>
1261</div>
1262<div class="paragraph">
1263<p>Although we encourage that the commit log messages are encoded
1264in UTF-8, both the core and Git Porcelain are designed not to
1265force UTF-8 on projects. If all participants of a particular
1266project find it more convenient to use legacy encodings, Git
1267does not forbid it. However, there are a few things to keep in
1268mind.</p>
1269</div>
1270<div class="olist arabic">
1271<ol class="arabic">
1272<li>
Junio C Hamano796624e2025-01-29 23:44:541273<p><code>git</code> <code>commit</code> and <code>git</code> <code>commit-tree</code> issue
Junio C Hamanob96f40a2024-08-01 00:57:251274a warning if the commit log message given to it does not look
1275like a valid UTF-8 string, unless you explicitly say your
1276project uses a legacy encoding. The way to say this is to
Junio C Hamanodc392382024-10-11 18:57:291277have <code>i18n.commitEncoding</code> in .<code>git/config</code> file, like this:</p>
Junio C Hamanob96f40a2024-08-01 00:57:251278<div class="listingblock">
1279<div class="content">
1280<pre>[i18n]
1281 commitEncoding = ISO-8859-1</pre>
1282</div>
1283</div>
1284<div class="paragraph">
1285<p>Commit objects created with the above setting record the value
1286of <code>i18n.commitEncoding</code> in their <code>encoding</code> header. This is to
1287help other people who look at them later. Lack of this header
1288implies that the commit log message is encoded in UTF-8.</p>
1289</div>
1290</li>
1291<li>
Junio C Hamano796624e2025-01-29 23:44:541292<p><code>git</code> <code>log</code>, <code>git</code> <code>show</code>, <code>git</code> <code>blame</code> and friends look at the
Junio C Hamanob96f40a2024-08-01 00:57:251293<code>encoding</code> header of a commit object, and try to re-code the
1294log message into UTF-8 unless otherwise specified. You can
1295specify the desired output encoding with
Junio C Hamanodc392382024-10-11 18:57:291296<code>i18n.logOutputEncoding</code> in .<code>git/config</code> file, like this:</p>
Junio C Hamanob96f40a2024-08-01 00:57:251297<div class="listingblock">
1298<div class="content">
1299<pre>[i18n]
1300 logOutputEncoding = ISO-8859-1</pre>
1301</div>
1302</div>
1303<div class="paragraph">
1304<p>If you do not have this configuration variable, the value of
1305<code>i18n.commitEncoding</code> is used instead.</p>
1306</div>
1307</li>
1308</ol>
1309</div>
1310<div class="paragraph">
1311<p>Note that we deliberately chose not to re-code the commit log
1312message when a commit is made to force UTF-8 at the commit
1313object level, because re-coding to UTF-8 is not necessarily a
1314reversible operation.</p>
1315</div>
1316</div>
1317</div>
1318<div class="sect1">
1319<h2 id="_environment_and_configuration_variables">ENVIRONMENT AND CONFIGURATION VARIABLES</h2>
1320<div class="sectionbody">
1321<div class="paragraph">
1322<p>The editor used to edit the commit log message will be chosen from the
Junio C Hamano796624e2025-01-29 23:44:541323<code>GIT_EDITOR</code> environment variable, the <code>core.editor</code> configuration variable, the
Junio C Hamanob96f40a2024-08-01 00:57:251324<code>VISUAL</code> environment variable, or the <code>EDITOR</code> environment variable (in that
1325order). See <a href="git-var.html">git-var(1)</a> for details.</p>
1326</div>
1327<div class="paragraph">
1328<p>Everything above this line in this section isn&#8217;t included from the
1329<a href="git-config.html">git-config(1)</a> documentation. The content that follows is the
1330same as what&#8217;s found there:</p>
1331</div>
1332<div class="dlist">
1333<dl>
Junio C Hamano796624e2025-01-29 23:44:541334<dt class="hdlist1"><code>commit.cleanup</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:251335<dd>
1336<p>This setting overrides the default of the <code>--cleanup</code> option in
Junio C Hamano796624e2025-01-29 23:44:541337<code>git</code> <code>commit</code>. Changing the default can be useful
1338when you always want to keep lines that begin
Junio C Hamano152bac02025-06-02 19:43:361339with the comment character (<code>core.commentChar</code>, default #)
1340in your log message, in which case you
Junio C Hamanodc392382024-10-11 18:57:291341would do <code>git</code> <code>config</code> <code>commit.cleanup</code> <code>whitespace</code> (note that you will
Junio C Hamano152bac02025-06-02 19:43:361342have to remove the help lines that begin with the comment character
1343in the commit log template yourself, if you do this).</p>
Junio C Hamanob96f40a2024-08-01 00:57:251344</dd>
Junio C Hamano796624e2025-01-29 23:44:541345<dt class="hdlist1"><code>commit.gpgSign</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:251346<dd>
1347<p>A boolean to specify whether all commits should be GPG signed.
1348Use of this option when doing operations such as rebase can
1349result in a large number of commits being signed. It may be
1350convenient to use an agent to avoid typing your GPG passphrase
1351several times.</p>
1352</dd>
Junio C Hamano796624e2025-01-29 23:44:541353<dt class="hdlist1"><code>commit.status</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:251354<dd>
1355<p>A boolean to enable/disable inclusion of status information in the
1356commit message template when using an editor to prepare the commit
Junio C Hamano796624e2025-01-29 23:44:541357message. Defaults to <code>true</code>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:251358</dd>
Junio C Hamano796624e2025-01-29 23:44:541359<dt class="hdlist1"><code>commit.template</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:251360<dd>
1361<p>Specify the pathname of a file to use as the template for
1362new commit messages.</p>
1363</dd>
Junio C Hamano796624e2025-01-29 23:44:541364<dt class="hdlist1"><code>commit.verbose</code></dt>
Junio C Hamanob96f40a2024-08-01 00:57:251365<dd>
Junio C Hamanodc392382024-10-11 18:57:291366<p>A boolean or int to specify the level of verbosity with <code>git</code> <code>commit</code>.
Junio C Hamano796624e2025-01-29 23:44:541367</p>
Junio C Hamanob96f40a2024-08-01 00:57:251368</dd>
1369</dl>
1370</div>
1371</div>
1372</div>
1373<div class="sect1">
1374<h2 id="_hooks">HOOKS</h2>
1375<div class="sectionbody">
1376<div class="paragraph">
1377<p>This command can run <code>commit-msg</code>, <code>prepare-commit-msg</code>, <code>pre-commit</code>,
1378<code>post-commit</code> and <code>post-rewrite</code> hooks. See <a href="githooks.html">githooks(5)</a> for more
1379information.</p>
1380</div>
1381</div>
1382</div>
1383<div class="sect1">
1384<h2 id="_files">FILES</h2>
1385<div class="sectionbody">
1386<div class="dlist">
1387<dl>
1388<dt class="hdlist1"><code>$GIT_DIR/COMMIT_EDITMSG</code></dt>
1389<dd>
1390<p>This file contains the commit message of a commit in progress.
Junio C Hamanodc392382024-10-11 18:57:291391If <code>git</code> <code>commit</code> exits due to an error before creating a commit,
Junio C Hamanob96f40a2024-08-01 00:57:251392any commit message that has been provided by the user (e.g., in
1393an editor session) will be available in this file, but will be
Junio C Hamanodc392382024-10-11 18:57:291394overwritten by the next invocation of <code>git</code> <code>commit</code>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:251395</dd>
1396</dl>
1397</div>
1398</div>
1399</div>
1400<div class="sect1">
1401<h2 id="_see_also">SEE ALSO</h2>
1402<div class="sectionbody">
1403<div class="paragraph">
1404<p><a href="git-add.html">git-add(1)</a>,
1405<a href="git-rm.html">git-rm(1)</a>,
1406<a href="git-mv.html">git-mv(1)</a>,
1407<a href="git-merge.html">git-merge(1)</a>,
1408<a href="git-commit-tree.html">git-commit-tree(1)</a></p>
1409</div>
1410</div>
1411</div>
1412<div class="sect1">
1413<h2 id="_git">GIT</h2>
1414<div class="sectionbody">
1415<div class="paragraph">
1416<p>Part of the <a href="git.html">git(1)</a> suite</p>
1417</div>
1418</div>
1419</div>
1420</div>
1421<div id="footer">
1422<div id="footer-text">
Junio C Hamano1cc68cc2025-08-04 16:37:241423Last updated 2025-08-04 09:35:46 -0700
Junio C Hamanob96f40a2024-08-01 00:57:251424</div>
1425</div>
1426</body>
1427</html>