Google Git
Sign in
chromium / external / gitster / git-htmldocs / ca8e07cd1946b3cef21a33dedcd5794a1e119cc0 / . / gitfaq.html
blob: a8ca2365dc7094a3551172c8232caf2d0e9bd81e [file] [log] [blame]
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]1<!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:11[diff] [blame]7<meta name="generator" content="Asciidoctor 2.0.23"/>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]8<title>gitfaq(7)</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:11[diff] [blame]143#header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]144#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:11[diff] [blame]165body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]166#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:11[diff] [blame]331sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline}
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]332#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>gitfaq(7) Manual Page</h1>
445<h2 id="_name">NAME</h2>
446<div class="sectionbody">
447<p>gitfaq - Frequently asked questions about using Git</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="paragraph">
455<p>gitfaq</p>
456</div>
457</div>
458</div>
459<div class="sect1">
460<h2 id="_description">DESCRIPTION</h2>
461<div class="sectionbody">
462<div class="paragraph">
463<p>The examples in this FAQ assume a standard POSIX shell, like <code>bash</code> or <code>dash</code>,
464and a user, A U Thor, who has the account <code>author</code> on the hosting provider
465<code>git.example.org</code>.</p>
466</div>
467</div>
468</div>
469<div class="sect1">
470<h2 id="_configuration">Configuration</h2>
471<div class="sectionbody">
472<div id="user-name" class="dlist">
473<dl>
474<dt class="hdlist1">What should I put in <code>user.name</code>?</dt>
475<dd>
476<p>You should put your personal name, generally a form using a given name
477and family name. For example, the current maintainer of Git uses "Junio
478C Hamano". This will be the name portion that is stored in every commit
479you make.</p>
480<div class="paragraph">
481<p>This configuration doesn&#8217;t have any effect on authenticating to remote services;
482for that, see <code>credential.username</code> in <a href="git-config.html">git-config(1)</a>.</p>
483</div>
484</dd>
485</dl>
486</div>
487<div id="http-postbuffer" class="dlist">
488<dl>
489<dt class="hdlist1">What does <code>http.postBuffer</code> really do?</dt>
490<dd>
491<p>This option changes the size of the buffer that Git uses when pushing
492data to a remote over HTTP or HTTPS. If the data is larger than this
493size, libcurl, which handles the HTTP support for Git, will use chunked
494transfer encoding since it isn&#8217;t known ahead of time what the size of
495the pushed data will be.</p>
496<div class="paragraph">
497<p>Leaving this value at the default size is fine unless you know that either the
498remote server or a proxy in the middle doesn&#8217;t support HTTP/1.1 (which
499introduced the chunked transfer encoding) or is known to be broken with chunked
500data. This is often (erroneously) suggested as a solution for generic push
501problems, but since almost every server and proxy supports at least HTTP/1.1,
502raising this value usually doesn&#8217;t solve most push problems. A server or proxy
503that didn&#8217;t correctly support HTTP/1.1 and chunked transfer encoding wouldn&#8217;t be
504that useful on the Internet today, since it would break lots of traffic.</p>
505</div>
506<div class="paragraph">
507<p>Note that increasing this value will increase the memory used on every relevant
508push that Git does over HTTP or HTTPS, since the entire buffer is allocated
509regardless of whether or not it is all used. Thus, it&#8217;s best to leave it at the
510default unless you are sure you need a different value.</p>
511</div>
512</dd>
513</dl>
514</div>
515<div id="configure-editor" class="dlist">
516<dl>
517<dt class="hdlist1">How do I configure a different editor?</dt>
518<dd>
519<p>If you haven&#8217;t specified an editor specifically for Git, it will by default
520use the editor you&#8217;ve configured using the <code>VISUAL</code> or <code>EDITOR</code> environment
521variables, or if neither is specified, the system default (which is usually
522<code>vi</code>). Since some people find <code>vi</code> difficult to use or prefer a different
523editor, it may be desirable to change the editor used.</p>
524<div class="paragraph">
525<p>If you want to configure a general editor for most programs which need one, you
526can edit your shell configuration (e.g., <code>~/.bashrc</code> or <code>~/.zshenv</code>) to contain
527a line setting the <code>EDITOR</code> or <code>VISUAL</code> environment variable to an appropriate
528value. For example, if you prefer the editor <code>nano</code>, then you could write the
529following:</p>
530</div>
531<div class="listingblock">
532<div class="content">
533<pre>export VISUAL=nano</pre>
534</div>
535</div>
536<div class="paragraph">
537<p>If you want to configure an editor specifically for Git, you can either set the
538<code>core.editor</code> configuration value or the <code>GIT_EDITOR</code> environment variable. You
539can see <a href="git-var.html">git-var(1)</a> for details on the order in which these options are
540consulted.</p>
541</div>
542<div class="paragraph">
543<p>Note that in all cases, the editor value will be passed to the shell, so any
544arguments containing spaces should be appropriately quoted. Additionally, if
545your editor normally detaches from the terminal when invoked, you should specify
546it with an argument that makes it not do that, or else Git will not see any
547changes. An example of a configuration addressing both of these issues on
Junio C Hamanoe03f5992025-04-23 22:24:29[diff] [blame]548Windows would be the configuration "C:\Program <code>Files\Vim\gvim.exe</code>" <code>--nofork</code>,
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]549which quotes the filename with spaces and specifies the <code>--nofork</code> option to
550avoid backgrounding the process.</p>
551</div>
552</dd>
553</dl>
554</div>
555</div>
556</div>
557<div class="sect1">
558<h2 id="_credentials">Credentials</h2>
559<div class="sectionbody">
560<div id="http-credentials" class="dlist">
561<dl>
562<dt class="hdlist1">How do I specify my credentials when pushing over HTTP?</dt>
563<dd>
564<p>The easiest way to do this is to use a credential helper via the
565<code>credential.helper</code> configuration. Most systems provide a standard
566choice to integrate with the system credential manager. For example,
567Git for Windows provides the <code>wincred</code> credential manager, macOS has the
568<code>osxkeychain</code> credential manager, and Unix systems with a standard
569desktop environment can use the <code>libsecret</code> credential manager. All of
570these store credentials in an encrypted store to keep your passwords or
571tokens secure.</p>
572<div class="paragraph">
573<p>In addition, you can use the <code>store</code> credential manager which stores in a file
574in your home directory, or the <code>cache</code> credential manager, which does not
575permanently store your credentials, but does prevent you from being prompted for
576them for a certain period of time.</p>
577</div>
578<div class="paragraph">
579<p>You can also just enter your password when prompted. While it is possible to
580place the password (which must be percent-encoded) in the URL, this is not
581particularly secure and can lead to accidental exposure of credentials, so it is
582not recommended.</p>
583</div>
584</dd>
585</dl>
586</div>
587<div id="http-credentials-environment" class="dlist">
588<dl>
589<dt class="hdlist1">How do I read a password or token from an environment variable?</dt>
590<dd>
591<p>The <code>credential.helper</code> configuration option can also take an arbitrary
592shell command that produces the credential protocol on standard output.
593This is useful when passing credentials into a container, for example.</p>
594<div class="paragraph">
595<p>Such a shell command can be specified by starting the option value with an
596exclamation point. If your password or token were stored in the <code>GIT_TOKEN</code>,
597you could run the following command to set your credential helper:</p>
598</div>
599<div class="listingblock">
600<div class="content">
601<pre>$ git config credential.helper \
602 '!f() { echo username=author; echo "password=$GIT_TOKEN"; };f'</pre>
603</div>
604</div>
605</dd>
606</dl>
607</div>
608<div id="http-reset-credentials" class="dlist">
609<dl>
610<dt class="hdlist1">How do I change the password or token I&#8217;ve saved in my credential manager?</dt>
611<dd>
612<p>Usually, if the password or token is invalid, Git will erase it and
613prompt for a new one. However, there are times when this doesn&#8217;t always
614happen. To change the password or token, you can erase the existing
615credentials and then Git will prompt for new ones. To erase
616credentials, use a syntax like the following (substituting your username
617and the hostname):</p>
618<div class="listingblock">
619<div class="content">
620<pre>$ echo url=https://author@git.example.org | git credential reject</pre>
621</div>
622</div>
623</dd>
624</dl>
625</div>
626<div id="multiple-accounts-http" class="dlist">
627<dl>
628<dt class="hdlist1">How do I use multiple accounts with the same hosting provider using HTTP?</dt>
629<dd>
630<p>Usually the easiest way to distinguish between these accounts is to use
631the username in the URL. For example, if you have the accounts <code>author</code>
632and <code>committer</code> on <code>git.example.org</code>, you can use the URLs
633<a href="https://author@git.example.org/org1/project1.git" class="bare">https://author@git.example.org/org1/project1.git</a> and
634<a href="https://committer@git.example.org/org2/project2.git" class="bare">https://committer@git.example.org/org2/project2.git</a>. This way, when you
635use a credential helper, it will automatically try to look up the
636correct credentials for your account. If you already have a remote set
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]637up, you can change the URL with something like <code>git</code> <code>remote</code> <code>set-url</code>
638<code>origin</code> <code>https://author@git.example.org/org1/project1.git</code> (see
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]639<a href="git-remote.html">git-remote(1)</a> for details).</p>
640</dd>
641</dl>
642</div>
643<div id="multiple-accounts-ssh" class="dlist">
644<dl>
645<dt class="hdlist1">How do I use multiple accounts with the same hosting provider using SSH?</dt>
646<dd>
647<p>With most hosting providers that support SSH, a single key pair uniquely
648identifies a user. Therefore, to use multiple accounts, it&#8217;s necessary
649to create a key pair for each account. If you&#8217;re using a reasonably
650modern OpenSSH version, you can create a new key pair with something
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]651like <code>ssh-keygen</code> <code>-t</code> <code>ed25519</code> <code>-f</code> <code>~/.ssh/id_committer</code>. You can then
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]652register the public key (in this case, <code>~/.ssh/id_committer.pub</code>; note
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]653the .<code>pub</code>) with the hosting provider.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]654<div class="paragraph">
655<p>Most hosting providers use a single SSH account for pushing; that is, all users
656push to the <code>git</code> account (e.g., <code>git@git.example.org</code>). If that&#8217;s the case for
657your provider, you can set up multiple aliases in SSH to make it clear which key
658pair to use. For example, you could write something like the following in
659<code>~/.ssh/config</code>, substituting the proper private key file:</p>
660</div>
661<div class="listingblock">
662<div class="content">
663<pre># This is the account for author on git.example.org.
664Host example_author
665 HostName git.example.org
666 User git
667 # This is the key pair registered for author with git.example.org.
668 IdentityFile ~/.ssh/id_author
669 IdentitiesOnly yes
670# This is the account for committer on git.example.org.
671Host example_committer
672 HostName git.example.org
673 User git
674 # This is the key pair registered for committer with git.example.org.
675 IdentityFile ~/.ssh/id_committer
676 IdentitiesOnly yes</pre>
677</div>
678</div>
679<div class="paragraph">
680<p>Then, you can adjust your push URL to use <code>git@example_author</code> or
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]681<code>git@example_committer</code> instead of <code>git@example.org</code> (e.g., <code>git</code> <code>remote</code> <code>set-url</code>
682<code>git@example_author:org1/project1.git</code>).</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]683</div>
684</dd>
685</dl>
686</div>
687</div>
688</div>
689<div class="sect1">
690<h2 id="_transfers">Transfers</h2>
691<div class="sectionbody">
692<div id="sync-working-tree" class="dlist">
693<dl>
694<dt class="hdlist1">How do I sync a working tree across systems?</dt>
695<dd>
696<p>First, decide whether you want to do this at all. Git works best when you
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]697push or pull your work using the typical <code>git</code> <code>push</code> and <code>git</code> <code>fetch</code> commands
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]698and isn&#8217;t designed to share a working tree across systems. This is
699potentially risky and in some cases can cause repository corruption or data
700loss.</p>
701<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]702<p>Usually, doing so will cause <code>git</code> <code>status</code> to need to re-read every file in the
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]703working tree. Additionally, Git&#8217;s security model does not permit sharing a
704working tree across untrusted users, so it is only safe to sync a working tree
705if it will only be used by a single user across all machines.</p>
706</div>
707<div class="paragraph">
708<p>It is important not to use a cloud syncing service to sync any portion of a Git
709repository, since this can cause corruption, such as missing objects, changed
710or added files, broken refs, and a wide variety of other problems. These
711services tend to sync file by file on a continuous basis and don&#8217;t understand
712the structure of a Git repository. This is especially bad if they sync the
713repository in the middle of it being updated, since that is very likely to
714cause incomplete or partial updates and therefore data loss.</p>
715</div>
716<div class="paragraph">
717<p>An example of the kind of corruption that can occur is conflicts over the state
718of refs, such that both sides end up with different commits on a branch that
719the other doesn&#8217;t have. This can result in important objects becoming
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]720unreferenced and possibly pruned by <code>git</code> <code>gc</code>, causing data loss.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]721</div>
722<div class="paragraph">
723<p>Therefore, it&#8217;s better to push your work to either the other system or a central
724server using the normal push and pull mechanism. However, this doesn&#8217;t always
725preserve important data, like stashes, so some people prefer to share a working
726tree across systems.</p>
727</div>
728<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]729<p>If you do this, the recommended approach is to use <code>rsync</code> <code>-a</code> <code>--delete-after</code>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]730(ideally with an encrypted connection such as with <code>ssh</code>) on the root of
731repository. You should ensure several things when you do this:</p>
732</div>
733<div class="ulist">
734<ul>
735<li>
736<p>If you have additional worktrees or a separate Git directory, they must be
737synced at the same time as the main working tree and repository.</p>
738</li>
739<li>
740<p>You are comfortable with the destination directory being an exact copy of the
741source directory, <em>deleting any data that is already there</em>.</p>
742</li>
743<li>
744<p>The repository (including all worktrees and the Git directory) is in a
745quiescent state for the duration of the transfer (that is, no operations of
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]746any sort are taking place on it, including background operations like <code>git</code>
747<code>gc</code> and operations invoked by your editor).</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]748<div class="paragraph">
749<p>Be aware that even with these recommendations, syncing in this way has some risk
750since it bypasses Git&#8217;s normal integrity checking for repositories, so having
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]751backups is advised. You may also wish to do a <code>git</code> <code>fsck</code> to verify the
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]752integrity of your data on the destination system after syncing.</p>
753</div>
754</li>
755</ul>
756</div>
757</dd>
758</dl>
759</div>
760</div>
761</div>
762<div class="sect1">
763<h2 id="_common_issues">Common Issues</h2>
764<div class="sectionbody">
765<div id="last-commit-amend" class="dlist">
766<dl>
767<dt class="hdlist1">I&#8217;ve made a mistake in the last commit. How do I change it?</dt>
768<dd>
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]769<p>You can make the appropriate change to your working tree, run <code>git</code> <code>add</code>
770<em>&lt;file&gt;</em> or <code>git</code> <code>rm</code> <em>&lt;file&gt;</em>, as appropriate, to stage it, and then <code>git</code>
771<code>commit</code> <code>--amend</code>. Your change will be included in the commit, and you&#8217;ll
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]772be prompted to edit the commit message again; if you wish to use the
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]773original message verbatim, you can use the <code>--no-edit</code> option to <code>git</code>
774<code>commit</code> in addition, or just save and quit when your editor opens.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]775</dd>
776</dl>
777</div>
778<div id="undo-previous-change" class="dlist">
779<dl>
780<dt class="hdlist1">I&#8217;ve made a change with a bug and it&#8217;s been included in the main branch. How should I undo it?</dt>
781<dd>
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]782<p>The usual way to deal with this is to use <code>git</code> <code>revert</code>. This preserves
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]783the history that the original change was made and was a valuable
784contribution, but also introduces a new commit that undoes those changes
785because the original had a problem. The commit message of the revert
786indicates the commit which was reverted and is usually edited to include
787an explanation as to why the revert was made.</p>
788</dd>
789</dl>
790</div>
791<div id="ignore-tracked-files" class="dlist">
792<dl>
793<dt class="hdlist1">How do I ignore changes to a tracked file?</dt>
794<dd>
795<p>Git doesn&#8217;t provide a way to do this. The reason is that if Git needs
796to overwrite this file, such as during a checkout, it doesn&#8217;t know
797whether the changes to the file are precious and should be kept, or
798whether they are irrelevant and can safely be destroyed. Therefore, it
799has to take the safe route and always preserve them.</p>
800<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]801<p>It&#8217;s tempting to try to use certain features of <code>git</code> <code>update-index</code>, namely the
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]802assume-unchanged and skip-worktree bits, but these don&#8217;t work properly for this
803purpose and shouldn&#8217;t be used this way.</p>
804</div>
805<div class="paragraph">
806<p>If your goal is to modify a configuration file, it can often be helpful to have
807a file checked into the repository which is a template or set of defaults which
808can then be copied alongside and modified as appropriate. This second, modified
809file is usually ignored to prevent accidentally committing it.</p>
810</div>
811</dd>
812</dl>
813</div>
814<div id="files-in-gitignore-are-tracked" class="dlist">
815<dl>
816<dt class="hdlist1">I asked Git to ignore various files, yet they are still tracked</dt>
817<dd>
818<p>A <code>gitignore</code> file ensures that certain file(s) which are not
819tracked by Git remain untracked. However, sometimes particular
820file(s) may have been tracked before adding them into the
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]821.<code>gitignore</code>, hence they still remain tracked. To untrack and
822ignore files/patterns, use <code>git</code> <code>rm</code> <code>--cached</code> &lt;file/pattern&gt;
823and add a pattern to .<code>gitignore</code> that matches the &lt;file&gt;.
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]824See <a href="gitignore.html">gitignore(5)</a> for details.</p>
825</dd>
826</dl>
827</div>
828<div id="fetching-and-pulling" class="dlist">
829<dl>
830<dt class="hdlist1">How do I know if I want to do a fetch or a pull?</dt>
831<dd>
832<p>A fetch stores a copy of the latest changes from the remote
833repository, without modifying the working tree or current branch.
834You can then at your leisure inspect, merge, rebase on top of, or
835ignore the upstream changes. A pull consists of a fetch followed
836immediately by either a merge or rebase. See <a href="git-pull.html">git-pull(1)</a>.</p>
837</dd>
838</dl>
839</div>
840<div id="proxy" class="dlist">
841<dl>
842<dt class="hdlist1">Can I use a proxy with Git?</dt>
843<dd>
844<p>Yes, Git supports the use of proxies. Git honors the standard <code>http_proxy</code>,
845<code>https_proxy</code>, and <code>no_proxy</code> environment variables commonly used on Unix, and
846it also can be configured with <code>http.proxy</code> and similar options for HTTPS (see
847<a href="git-config.html">git-config(1)</a>). The <code>http.proxy</code> and related options can be
848customized on a per-URL pattern basis. In addition, Git can in theory
849function normally with transparent proxies that exist on the network.</p>
850<div class="paragraph">
851<p>For SSH, Git can support a proxy using OpenSSH&#8217;s <code>ProxyCommand</code>. Commonly used
852tools include <code>netcat</code> and <code>socat</code>. However, they must be configured not to
853exit when seeing EOF on standard input, which usually means that <code>netcat</code> will
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]854require <code>-q</code> and <code>socat</code> will require a timeout with something like <code>-t</code> <code>10</code>.
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]855This is required because the way the Git SSH server knows that no more requests
856will be made is an EOF on standard input, but when that happens, the server may
857not have yet processed the final request, so dropping the connection at that
858point would interrupt that request.</p>
859</div>
860<div class="paragraph">
861<p>An example configuration entry in <code>~/.ssh/config</code> with an HTTP proxy might look
862like this:</p>
863</div>
864<div class="listingblock">
865<div class="content">
866<pre>Host git.example.org
867 User git
868 ProxyCommand socat -t 10 - PROXY:proxy.example.org:%h:%p,proxyport=8080</pre>
869</div>
870</div>
871<div class="paragraph">
872<p>Note that in all cases, for Git to work properly, the proxy must be completely
873transparent. The proxy cannot modify, tamper with, or buffer the connection in
874any way, or Git will almost certainly fail to work. Note that many proxies,
875including many TLS middleboxes, Windows antivirus and firewall programs other
876than Windows Defender and Windows Firewall, and filtering proxies fail to meet
877this standard, and as a result end up breaking Git. Because of the many
878reports of problems and their poor security history, we recommend against the
879use of these classes of software and devices.</p>
880</div>
881</dd>
882</dl>
883</div>
884</div>
885</div>
886<div class="sect1">
887<h2 id="_merging_and_rebasing">Merging and Rebasing</h2>
888<div class="sectionbody">
889<div id="long-running-squash-merge" class="dlist">
890<dl>
891<dt class="hdlist1">What kinds of problems can occur when merging long-lived branches with squash merges?</dt>
892<dd>
893<p>In general, there are a variety of problems that can occur when using squash
894merges to merge two branches multiple times. These can include seeing extra
Junio C Hamanoe03f5992025-04-23 22:24:29[diff] [blame]895commits in <code>git</code> <code>log</code> output, with a GUI, or when using the <code>...</code> notation to
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]896express a range, as well as the possibility of needing to re-resolve conflicts
897again and again.</p>
898<div class="paragraph">
899<p>When Git does a normal merge between two branches, it considers exactly three
900points: the two branches and a third commit, called the <em>merge base</em>, which is
901usually the common ancestor of the commits. The result of the merge is the sum
902of the changes between the merge base and each head. When you merge two
903branches with a regular merge commit, this results in a new commit which will
904end up as a merge base when they&#8217;re merged again, because there is now a new
905common ancestor. Git doesn&#8217;t have to consider changes that occurred before the
906merge base, so you don&#8217;t have to re-resolve any conflicts you resolved before.</p>
907</div>
908<div class="paragraph">
909<p>When you perform a squash merge, a merge commit isn&#8217;t created; instead, the
910changes from one side are applied as a regular commit to the other side. This
911means that the merge base for these branches won&#8217;t have changed, and so when Git
912goes to perform its next merge, it considers all of the changes that it
913considered the last time plus the new changes. That means any conflicts may
Junio C Hamanoe03f5992025-04-23 22:24:29[diff] [blame]914need to be re-resolved. Similarly, anything using the <code>...</code> notation in <code>git</code>
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]915<code>diff</code>, <code>git</code> <code>log</code>, or a GUI will result in showing all of the changes since the
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]916original merge base.</p>
917</div>
918<div class="paragraph">
919<p>As a consequence, if you want to merge two long-lived branches repeatedly, it&#8217;s
920best to always use a regular merge commit.</p>
921</div>
922</dd>
923</dl>
924</div>
925<div id="merge-two-revert-one" class="dlist">
926<dl>
927<dt class="hdlist1">If I make a change on two branches but revert it on one, why does the merge of those branches include the change?</dt>
928<dd>
929<p>By default, when Git does a merge, it uses a strategy called the <code>ort</code>
930strategy, which does a fancy three-way merge. In such a case, when Git
931performs the merge, it considers exactly three points: the two heads and a
932third point, called the <em>merge base</em>, which is usually the common ancestor of
933those commits. Git does not consider the history or the individual commits
934that have happened on those branches at all.</p>
935<div class="paragraph">
936<p>As a result, if both sides have a change and one side has reverted that change,
937the result is to include the change. This is because the code has changed on
938one side and there is no net change on the other, and in this scenario, Git
939adopts the change.</p>
940</div>
941<div class="paragraph">
942<p>If this is a problem for you, you can do a rebase instead, rebasing the branch
943with the revert onto the other branch. A rebase in this scenario will revert
944the change, because a rebase applies each individual commit, including the
945revert. Note that rebases rewrite history, so you should avoid rebasing
946published branches unless you&#8217;re sure you&#8217;re comfortable with that. See the
947NOTES section in <a href="git-rebase.html">git-rebase(1)</a> for more details.</p>
948</div>
949</dd>
950</dl>
951</div>
952</div>
953</div>
954<div class="sect1">
955<h2 id="_hooks">Hooks</h2>
956<div class="sectionbody">
957<div id="restrict-with-hooks" class="dlist">
958<dl>
959<dt class="hdlist1">How do I use hooks to prevent users from making certain changes?</dt>
960<dd>
961<p>The only safe place to make these changes is on the remote repository
962(i.e., the Git server), usually in the <code>pre-receive</code> hook or in a
963continuous integration (CI) system. These are the locations in which
964policy can be enforced effectively.</p>
965<div class="paragraph">
966<p>It&#8217;s common to try to use <code>pre-commit</code> hooks (or, for commit messages,
967<code>commit-msg</code> hooks) to check these things, which is great if you&#8217;re working as a
968solo developer and want the tooling to help you. However, using hooks on a
969developer machine is not effective as a policy control because a user can bypass
970these hooks with <code>--no-verify</code> without being noticed (among various other ways).
971Git assumes that the user is in control of their local repositories and doesn&#8217;t
972try to prevent this or tattle on the user.</p>
973</div>
974<div class="paragraph">
975<p>In addition, some advanced users find <code>pre-commit</code> hooks to be an impediment to
976workflows that use temporary commits to stage work in progress or that create
977fixup commits, so it&#8217;s better to push these kinds of checks to the server
978anyway.</p>
979</div>
980</dd>
981</dl>
982</div>
983</div>
984</div>
985<div class="sect1">
986<h2 id="_cross_platform_issues">Cross-Platform Issues</h2>
987<div class="sectionbody">
988<div id="windows-text-binary" class="dlist">
989<dl>
990<dt class="hdlist1">I&#8217;m on Windows and my text files are detected as binary.</dt>
991<dd>
992<p>Git works best when you store text files as UTF-8. Many programs on
993Windows support UTF-8, but some do not and only use the little-endian
994UTF-16 format, which Git detects as binary. If you can&#8217;t use UTF-8 with
995your programs, you can specify a working tree encoding that indicates
996which encoding your files should be checked out with, while still
997storing these files as UTF-8 in the repository. This allows tools like
998<a href="git-diff.html">git-diff(1)</a> to work as expected, while still allowing your tools
999to work.</p>
1000<div class="paragraph">
1001<p>To do so, you can specify a <a href="gitattributes.html">gitattributes(5)</a> pattern with the
1002<code>working-tree-encoding</code> attribute. For example, the following pattern sets all
1003C files to use UTF-16LE-BOM, which is a common encoding on Windows:</p>
1004</div>
1005<div class="listingblock">
1006<div class="content">
1007<pre>*.c working-tree-encoding=UTF-16LE-BOM</pre>
1008</div>
1009</div>
1010<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]1011<p>You will need to run <code>git</code> <code>add</code> <code>--renormalize</code> to have this take effect. Note
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]1012that if you are making these changes on a project that is used across platforms,
1013you&#8217;ll probably want to make it in a per-user configuration file or in the one
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]1014in <code>$GIT_DIR/info/attributes</code>, since making it in a .<code>gitattributes</code> file in the
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]1015repository will apply to all users of the repository.</p>
1016</div>
1017<div class="paragraph">
1018<p>See the following entry for information about normalizing line endings as well,
1019and see <a href="gitattributes.html">gitattributes(5)</a> for more information about attribute files.</p>
1020</div>
1021</dd>
1022</dl>
1023</div>
1024<div id="windows-diff-control-m" class="dlist">
1025<dl>
1026<dt class="hdlist1">I&#8217;m on Windows and git diff shows my files as having a <code>^M</code> at the end.</dt>
1027<dd>
1028<p>By default, Git expects files to be stored with Unix line endings. As such,
1029the carriage return (<code>^M</code>) that is part of a Windows line ending is shown
1030because it is considered to be trailing whitespace. Git defaults to showing
1031trailing whitespace only on new lines, not existing ones.</p>
1032<div class="paragraph">
1033<p>You can store the files in the repository with Unix line endings and convert
1034them automatically to your platform&#8217;s line endings. To do that, set the
1035configuration option <code>core.eol</code> to <code>native</code> and see
1036<a href="#recommended-storage-settings">the question on recommended storage settings</a>
1037for information about how to configure files as text or binary.</p>
1038</div>
1039<div class="paragraph">
1040<p>You can also control this behavior with the <code>core.whitespace</code> setting if you
1041don&#8217;t wish to remove the carriage returns from your line endings.</p>
1042</div>
1043</dd>
1044</dl>
1045</div>
1046<div id="always-modified-files-case" class="dlist">
1047<dl>
1048<dt class="hdlist1">Why do I have a file that&#8217;s always modified?</dt>
1049<dd>
1050<p>Internally, Git always stores file names as sequences of bytes and doesn&#8217;t
1051perform any encoding or case folding. However, Windows and macOS by default
1052both perform case folding on file names. As a result, it&#8217;s possible to end up
1053with multiple files or directories whose names differ only in case. Git can
1054handle this just fine, but the file system can store only one of these files,
1055so when Git reads the other file to see its contents, it looks modified.</p>
1056<div class="paragraph">
1057<p>It&#8217;s best to remove one of the files such that you only have one file. You can
1058do this with commands like the following (assuming two files <code>AFile.txt</code> and
1059<code>afile.txt</code>) on an otherwise clean working tree:</p>
1060</div>
1061<div class="listingblock">
1062<div class="content">
1063<pre>$ git rm --cached AFile.txt
1064$ git commit -m 'Remove files conflicting in case'
1065$ git checkout .</pre>
1066</div>
1067</div>
1068<div class="paragraph">
1069<p>This avoids touching the disk, but removes the additional file. Your project
1070may prefer to adopt a naming convention, such as all-lowercase names, to avoid
1071this problem from occurring again; such a convention can be checked using a
1072<code>pre-receive</code> hook or as part of a continuous integration (CI) system.</p>
1073</div>
1074<div class="paragraph">
1075<p>It is also possible for perpetually modified files to occur on any platform if a
1076smudge or clean filter is in use on your system but a file was previously
1077committed without running the smudge or clean filter. To fix this, run the
1078following on an otherwise clean working tree:</p>
1079</div>
1080<div class="listingblock">
1081<div class="content">
1082<pre>$ git add --renormalize .</pre>
1083</div>
1084</div>
1085</dd>
1086</dl>
1087</div>
1088<div id="recommended-storage-settings" class="dlist">
1089<dl>
1090<dt class="hdlist1">What&#8217;s the recommended way to store files in Git?</dt>
1091<dd>
1092<p>While Git can store and handle any file of any type, there are some
1093settings that work better than others. In general, we recommend that
1094text files be stored in UTF-8 without a byte-order mark (BOM) with LF
1095(Unix-style) endings. We also recommend the use of UTF-8 (again,
1096without BOM) in commit messages. These are the settings that work best
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]1097across platforms and with tools such as <code>git</code> <code>diff</code> and <code>git</code> <code>merge</code>.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]1098<div class="paragraph">
1099<p>Additionally, if you have a choice between storage formats that are text based
1100or non-text based, we recommend storing files in the text format and, if
1101necessary, transforming them into the other format. For example, a text-based
1102SQL dump with one record per line will work much better for diffing and merging
1103than an actual database file. Similarly, text-based formats such as Markdown
1104and AsciiDoc will work better than binary formats such as Microsoft Word and
1105PDF.</p>
1106</div>
1107<div class="paragraph">
1108<p>Similarly, storing binary dependencies (e.g., shared libraries or JAR files) or
1109build products in the repository is generally not recommended. Dependencies and
1110build products are best stored on an artifact or package server with only
1111references, URLs, and hashes stored in the repository.</p>
1112</div>
1113<div class="paragraph">
1114<p>We also recommend setting a <a href="gitattributes.html">gitattributes(5)</a> file to explicitly mark
1115which files are text and which are binary. If you want Git to guess, you can
1116set the attribute <code>text=auto</code>.</p>
1117</div>
1118<div class="paragraph">
1119<p>With text files, Git will generally ensure that LF endings are used in the
1120repository. The <code>core.autocrlf</code> and <code>core.eol</code> configuration variables specify
1121what line-ending convention is followed when any text file is checked out. You
1122can also use the <code>eol</code> attribute (e.g., <code>eol=crlf</code>) to override which files get
1123what line-ending treatment.</p>
1124</div>
1125<div class="paragraph">
1126<p>For example, generally shell files must have LF endings and batch files must
1127have CRLF endings, so the following might be appropriate in some projects:</p>
1128</div>
1129<div class="listingblock">
1130<div class="content">
1131<pre># By default, guess.
1132* text=auto
1133# Mark all C files as text.
1134*.c text
1135# Ensure all shell files have LF endings and all batch files have CRLF
1136# endings in the working tree and both have LF in the repo.
1137*.sh text eol=lf
1138*.bat text eol=crlf
1139# Mark all JPEG files as binary.
1140*.jpg binary</pre>
1141</div>
1142</div>
1143<div class="paragraph">
1144<p>These settings help tools pick the right format for output such as patches and
1145result in files being checked out in the appropriate line ending for the
1146platform.</p>
1147</div>
1148</dd>
1149</dl>
1150</div>
1151</div>
1152</div>
1153<div class="sect1">
1154<h2 id="_git">GIT</h2>
1155<div class="sectionbody">
1156<div class="paragraph">
1157<p>Part of the <a href="git.html">git(1)</a> suite</p>
1158</div>
1159</div>
1160</div>
1161</div>
1162<div id="footer">
1163<div id="footer-text">
Junio C Hamano1cc68cc2025-08-04 16:37:24[diff] [blame]1164Last updated 2025-06-20 18:10:42 -0700
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]1165</div>
1166</div>
1167</body>
1168</html>