Google Git
Sign in
chromium / external / gitster / git-htmldocs / 7f7e6a47a4543fc8b8335e64746e0f7e3ce80f4a / . / gitfaq.html
blob: 055cff9e34224ba9ab00a1cfa47bcde9c2be0c9c [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"/>
7<meta name="generator" content="Asciidoctor 2.0.20"/>
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}
143#header>h1:only-child,body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px}
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}
165#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}
166#toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em}
167#toc.toc2>ul{font-size:.9em;margin-bottom:0}
168#toc.toc2 ul ul{margin-left:0;padding-left:1em}
169#toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em}
170body.toc2.toc-right{padding-left:0;padding-right:15em}
171body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}}
172@media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0}
173#toc.toc2{width:20em}
174#toc.toc2 #toctitle{font-size:1.375em}
175#toc.toc2>ul{font-size:.95em}
176#toc.toc2 ul ul{padding-left:1.25em}
177body.toc2.toc-right{padding-left:0;padding-right:20em}}
178#content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px}
179#content #toc>:first-child{margin-top:0}
180#content #toc>:last-child{margin-bottom:0}
181#footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em}
182#footer-text{color:hsla(0,0%,100%,.8);line-height:1.44}
183#content{margin-bottom:.625em}
184.sect1{padding-bottom:.625em}
185@media screen and (min-width:768px){#content{margin-bottom:1.25em}
186.sect1{padding-bottom:1.25em}}
187.sect1:last-child{padding-bottom:0}
188.sect1+.sect1{border-top:1px solid #e7e7e9}
189#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}
190#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}
191#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}
192#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}
193#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}
194details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
195details{margin-left:1.25rem}
196details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
197details>summary::-webkit-details-marker{display:none}
198details>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%)}
199details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
200details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem}
201.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}
202table.tableblock.fit-content>caption.title{white-space:nowrap;width:0}
203.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)}
204.admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%}
205.admonitionblock>table td.icon{text-align:center;width:80px}
206.admonitionblock>table td.icon img{max-width:none}
207.admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase}
208.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}
209.admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0}
210.exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px}
211.sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px}
212.sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center}
213.exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0}
214.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}
215.literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em}
216@media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}}
217@media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}}
218.literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8}
219.literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)}
220.listingblock>.content{position:relative}
221.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}
222.listingblock:hover code[data-lang]::before{display:block}
223.listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5}
224.listingblock.terminal pre .command:not([data-prompt])::before{content:"$"}
225.listingblock pre.highlightjs{padding:0}
226.listingblock pre.highlightjs>code{padding:1em;border-radius:4px}
227.listingblock pre.prettyprint{border-width:0}
228.prettyprint{background:#f7f7f8}
229pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
230pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
231pre.prettyprint li code[data-lang]::before{opacity:1}
232pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
233table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
234table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
235table.linenotable td.code{padding-left:.75em}
236table.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}
237pre.pygments span.linenos{display:inline-block;margin-right:.75em}
238.quoteblock{margin:0 1em 1.25em 1.5em;display:table}
239.quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em}
240.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}
241.quoteblock blockquote{margin:0;padding:0;border:0}
242.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)}
243.quoteblock blockquote>.paragraph:last-child p{margin-bottom:0}
244.quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right}
245.verseblock{margin:0 1em 1.25em}
246.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}
247.verseblock pre strong{font-weight:400}
248.verseblock .attribution{margin-top:1.25rem;margin-left:.5ex}
249.quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic}
250.quoteblock .attribution br,.verseblock .attribution br{display:none}
251.quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)}
252.quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none}
253.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}
254.quoteblock.abstract{margin:0 1em 1.25em;display:block}
255.quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center}
256.quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf}
257.quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0}
258.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem}
259.quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0}
260p.tableblock:last-child{margin-bottom:0}
261td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
262td.tableblock>.content>:last-child{margin-bottom:-1.25em}
263table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
264table.grid-all>*>tr>*{border-width:1px}
265table.grid-cols>*>tr>*{border-width:0 1px}
266table.grid-rows>*>tr>*{border-width:1px 0}
267table.frame-all{border-width:1px}
268table.frame-ends{border-width:1px 0}
269table.frame-sides{border-width:0 1px}
270table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
271table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
272table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
273table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
274table.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}
275th.halign-left,td.halign-left{text-align:left}
276th.halign-right,td.halign-right{text-align:right}
277th.halign-center,td.halign-center{text-align:center}
278th.valign-top,td.valign-top{vertical-align:top}
279th.valign-bottom,td.valign-bottom{vertical-align:bottom}
280th.valign-middle,td.valign-middle{vertical-align:middle}
281table thead th,table tfoot th{font-weight:bold}
282tbody tr th{background:#f7f8f7}
283tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
284p.tableblock>code:only-child{background:none;padding:0}
285p.tableblock{font-size:1em}
286ol{margin-left:1.75em}
287ul li ol{margin-left:1.5em}
288dl dd{margin-left:1.125em}
289dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
290li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
291ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
292ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
293ul.unstyled,ol.unstyled{margin-left:0}
294li>p:empty:only-child::before{content:"";display:inline-block}
295ul.checklist>li>p:first-child{margin-left:-1em}
296ul.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}
297ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
298ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
299ul.inline>li{margin-left:1.25em}
300.unstyled dl dt{font-weight:400;font-style:normal}
301ol.arabic{list-style-type:decimal}
302ol.decimal{list-style-type:decimal-leading-zero}
303ol.loweralpha{list-style-type:lower-alpha}
304ol.upperalpha{list-style-type:upper-alpha}
305ol.lowerroman{list-style-type:lower-roman}
306ol.upperroman{list-style-type:upper-roman}
307ol.lowergreek{list-style-type:lower-greek}
308.hdlist>table,.colist>table{border:0;background:none}
309.hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none}
310td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
311td.hdlist1{font-weight:bold;padding-bottom:1.25em}
312td.hdlist2{word-wrap:anywhere}
313.literalblock+.colist,.listingblock+.colist{margin-top:-.5em}
314.colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top}
315.colist td:not([class]):first-child img{max-width:none}
316.colist td:not([class]):last-child{padding:.25em 0}
317.thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd}
318.imageblock.left{margin:.25em .625em 1.25em 0}
319.imageblock.right{margin:.25em 0 1.25em .625em}
320.imageblock>.title{margin-bottom:0}
321.imageblock.thumb,.imageblock.th{border-width:6px}
322.imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em}
323.image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0}
324.image.left{margin-right:.625em}
325.image.right{margin-left:.625em}
326a.image{text-decoration:none;display:inline-block}
327a.image object{pointer-events:none}
328sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
329sup.footnote a,sup.footnoteref a{text-decoration:none}
330sup.footnote a:active,sup.footnoteref a:active{text-decoration:underline}
331#footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em}
332#footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0}
333#footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em}
334#footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em}
335#footnotes .footnote:last-of-type{margin-bottom:0}
336#content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0}
337div.unbreakable{page-break-inside:avoid}
338.big{font-size:larger}
339.small{font-size:smaller}
340.underline{text-decoration:underline}
341.overline{text-decoration:overline}
342.line-through{text-decoration:line-through}
343.aqua{color:#00bfbf}
344.aqua-background{background:#00fafa}
345.black{color:#000}
346.black-background{background:#000}
347.blue{color:#0000bf}
348.blue-background{background:#0000fa}
349.fuchsia{color:#bf00bf}
350.fuchsia-background{background:#fa00fa}
351.gray{color:#606060}
352.gray-background{background:#7d7d7d}
353.green{color:#006000}
354.green-background{background:#007d00}
355.lime{color:#00bf00}
356.lime-background{background:#00fa00}
357.maroon{color:#600000}
358.maroon-background{background:#7d0000}
359.navy{color:#000060}
360.navy-background{background:#00007d}
361.olive{color:#606000}
362.olive-background{background:#7d7d00}
363.purple{color:#600060}
364.purple-background{background:#7d007d}
365.red{color:#bf0000}
366.red-background{background:#fa0000}
367.silver{color:#909090}
368.silver-background{background:#bcbcbc}
369.teal{color:#006060}
370.teal-background{background:#007d7d}
371.white{color:#bfbfbf}
372.white-background{background:#fafafa}
373.yellow{color:#bfbf00}
374.yellow-background{background:#fafa00}
375span.icon>.fa{cursor:default}
376a span.icon>.fa{cursor:inherit}
377.admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default}
378.admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c}
379.admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111}
380.admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900}
381.admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400}
382.admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000}
383.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}
384.conum[data-value] *{color:#fff!important}
385.conum[data-value]+b{display:none}
386.conum[data-value]::after{content:attr(data-value)}
387pre .conum[data-value]{position:relative;top:-.125em}
388b.conum *{color:inherit!important}
389.conum:not([data-value]):empty{display:none}
390dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
391h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
392p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
393p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
394p{margin-bottom:1.25rem}
395.sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em}
396.exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc}
397.print-only{display:none!important}
398@page{margin:1.25cm .75cm}
399@media print{*{box-shadow:none!important;text-shadow:none!important}
400html{font-size:80%}
401a{color:inherit!important;text-decoration:underline!important}
402a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
403a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
404abbr[title]{border-bottom:1px dotted}
405abbr[title]::after{content:" (" attr(title) ")"}
406pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
407thead{display:table-header-group}
408svg{max-width:100%}
409p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
410h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid}
411#header,#content,#footnotes,#footer{max-width:none}
412#toc,.sidebarblock,.exampleblock>.content{background:none!important}
413#toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important}
414body.book #header{text-align:center}
415body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
416body.book #header .details{border:0!important;display:block;padding:0!important}
417body.book #header .details span:first-child{margin-left:0!important}
418body.book #header .details br{display:block}
419body.book #header .details br+span::before{content:none!important}
420body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
421body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always}
422.listingblock code[data-lang]::before{display:block}
423#footer{padding:0 .9375em}
424.hide-on-print{display:none!important}
425.print-only{display:block!important}
426.hide-for-print{display:none!important}
427.show-for-print{display:inherit!important}}
428@media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem}
429.sect1{padding:0!important}
430.sect1+.sect1{border:0}
431#footer{background:none}
432#footer-text{color:rgba(0,0,0,.6);font-size:.9em}}
433@media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}}
434</style>
435<style>
436pre>code {
437 display: inline;
438}
439</style>
440</head>
441<body class="manpage">
442<div id="header">
443<h1>gitfaq(7) Manual Page</h1>
444<h2 id="_name">NAME</h2>
445<div class="sectionbody">
446<p>gitfaq - Frequently asked questions about using Git</p>
447</div>
448</div>
449<div id="content">
450<div class="sect1">
451<h2 id="_synopsis">SYNOPSIS</h2>
452<div class="sectionbody">
453<div class="paragraph">
454<p>gitfaq</p>
455</div>
456</div>
457</div>
458<div class="sect1">
459<h2 id="_description">DESCRIPTION</h2>
460<div class="sectionbody">
461<div class="paragraph">
462<p>The examples in this FAQ assume a standard POSIX shell, like <code>bash</code> or <code>dash</code>,
463and a user, A U Thor, who has the account <code>author</code> on the hosting provider
464<code>git.example.org</code>.</p>
465</div>
466</div>
467</div>
468<div class="sect1">
469<h2 id="_configuration">Configuration</h2>
470<div class="sectionbody">
471<div id="user-name" class="dlist">
472<dl>
473<dt class="hdlist1">What should I put in <code>user.name</code>?</dt>
474<dd>
475<p>You should put your personal name, generally a form using a given name
476and family name. For example, the current maintainer of Git uses "Junio
477C Hamano". This will be the name portion that is stored in every commit
478you make.</p>
479<div class="paragraph">
480<p>This configuration doesn&#8217;t have any effect on authenticating to remote services;
481for that, see <code>credential.username</code> in <a href="git-config.html">git-config(1)</a>.</p>
482</div>
483</dd>
484</dl>
485</div>
486<div id="http-postbuffer" class="dlist">
487<dl>
488<dt class="hdlist1">What does <code>http.postBuffer</code> really do?</dt>
489<dd>
490<p>This option changes the size of the buffer that Git uses when pushing
491data to a remote over HTTP or HTTPS. If the data is larger than this
492size, libcurl, which handles the HTTP support for Git, will use chunked
493transfer encoding since it isn&#8217;t known ahead of time what the size of
494the pushed data will be.</p>
495<div class="paragraph">
496<p>Leaving this value at the default size is fine unless you know that either the
497remote server or a proxy in the middle doesn&#8217;t support HTTP/1.1 (which
498introduced the chunked transfer encoding) or is known to be broken with chunked
499data. This is often (erroneously) suggested as a solution for generic push
500problems, but since almost every server and proxy supports at least HTTP/1.1,
501raising this value usually doesn&#8217;t solve most push problems. A server or proxy
502that didn&#8217;t correctly support HTTP/1.1 and chunked transfer encoding wouldn&#8217;t be
503that useful on the Internet today, since it would break lots of traffic.</p>
504</div>
505<div class="paragraph">
506<p>Note that increasing this value will increase the memory used on every relevant
507push that Git does over HTTP or HTTPS, since the entire buffer is allocated
508regardless of whether or not it is all used. Thus, it&#8217;s best to leave it at the
509default unless you are sure you need a different value.</p>
510</div>
511</dd>
512</dl>
513</div>
514<div id="configure-editor" class="dlist">
515<dl>
516<dt class="hdlist1">How do I configure a different editor?</dt>
517<dd>
518<p>If you haven&#8217;t specified an editor specifically for Git, it will by default
519use the editor you&#8217;ve configured using the <code>VISUAL</code> or <code>EDITOR</code> environment
520variables, or if neither is specified, the system default (which is usually
521<code>vi</code>). Since some people find <code>vi</code> difficult to use or prefer a different
522editor, it may be desirable to change the editor used.</p>
523<div class="paragraph">
524<p>If you want to configure a general editor for most programs which need one, you
525can edit your shell configuration (e.g., <code>~/.bashrc</code> or <code>~/.zshenv</code>) to contain
526a line setting the <code>EDITOR</code> or <code>VISUAL</code> environment variable to an appropriate
527value. For example, if you prefer the editor <code>nano</code>, then you could write the
528following:</p>
529</div>
530<div class="listingblock">
531<div class="content">
532<pre>export VISUAL=nano</pre>
533</div>
534</div>
535<div class="paragraph">
536<p>If you want to configure an editor specifically for Git, you can either set the
537<code>core.editor</code> configuration value or the <code>GIT_EDITOR</code> environment variable. You
538can see <a href="git-var.html">git-var(1)</a> for details on the order in which these options are
539consulted.</p>
540</div>
541<div class="paragraph">
542<p>Note that in all cases, the editor value will be passed to the shell, so any
543arguments containing spaces should be appropriately quoted. Additionally, if
544your editor normally detaches from the terminal when invoked, you should specify
545it with an argument that makes it not do that, or else Git will not see any
546changes. An example of a configuration addressing both of these issues on
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]547Windows would be the configuration "C:\Program <code>Files</code>\Vim\gvim.<code>exe</code>" <code>--nofork</code>,
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]548which quotes the filename with spaces and specifies the <code>--nofork</code> option to
549avoid backgrounding the process.</p>
550</div>
551</dd>
552</dl>
553</div>
554</div>
555</div>
556<div class="sect1">
557<h2 id="_credentials">Credentials</h2>
558<div class="sectionbody">
559<div id="http-credentials" class="dlist">
560<dl>
561<dt class="hdlist1">How do I specify my credentials when pushing over HTTP?</dt>
562<dd>
563<p>The easiest way to do this is to use a credential helper via the
564<code>credential.helper</code> configuration. Most systems provide a standard
565choice to integrate with the system credential manager. For example,
566Git for Windows provides the <code>wincred</code> credential manager, macOS has the
567<code>osxkeychain</code> credential manager, and Unix systems with a standard
568desktop environment can use the <code>libsecret</code> credential manager. All of
569these store credentials in an encrypted store to keep your passwords or
570tokens secure.</p>
571<div class="paragraph">
572<p>In addition, you can use the <code>store</code> credential manager which stores in a file
573in your home directory, or the <code>cache</code> credential manager, which does not
574permanently store your credentials, but does prevent you from being prompted for
575them for a certain period of time.</p>
576</div>
577<div class="paragraph">
578<p>You can also just enter your password when prompted. While it is possible to
579place the password (which must be percent-encoded) in the URL, this is not
580particularly secure and can lead to accidental exposure of credentials, so it is
581not recommended.</p>
582</div>
583</dd>
584</dl>
585</div>
586<div id="http-credentials-environment" class="dlist">
587<dl>
588<dt class="hdlist1">How do I read a password or token from an environment variable?</dt>
589<dd>
590<p>The <code>credential.helper</code> configuration option can also take an arbitrary
591shell command that produces the credential protocol on standard output.
592This is useful when passing credentials into a container, for example.</p>
593<div class="paragraph">
594<p>Such a shell command can be specified by starting the option value with an
595exclamation point. If your password or token were stored in the <code>GIT_TOKEN</code>,
596you could run the following command to set your credential helper:</p>
597</div>
598<div class="listingblock">
599<div class="content">
600<pre>$ git config credential.helper \
601 '!f() { echo username=author; echo "password=$GIT_TOKEN"; };f'</pre>
602</div>
603</div>
604</dd>
605</dl>
606</div>
607<div id="http-reset-credentials" class="dlist">
608<dl>
609<dt class="hdlist1">How do I change the password or token I&#8217;ve saved in my credential manager?</dt>
610<dd>
611<p>Usually, if the password or token is invalid, Git will erase it and
612prompt for a new one. However, there are times when this doesn&#8217;t always
613happen. To change the password or token, you can erase the existing
614credentials and then Git will prompt for new ones. To erase
615credentials, use a syntax like the following (substituting your username
616and the hostname):</p>
617<div class="listingblock">
618<div class="content">
619<pre>$ echo url=https://author@git.example.org | git credential reject</pre>
620</div>
621</div>
622</dd>
623</dl>
624</div>
625<div id="multiple-accounts-http" class="dlist">
626<dl>
627<dt class="hdlist1">How do I use multiple accounts with the same hosting provider using HTTP?</dt>
628<dd>
629<p>Usually the easiest way to distinguish between these accounts is to use
630the username in the URL. For example, if you have the accounts <code>author</code>
631and <code>committer</code> on <code>git.example.org</code>, you can use the URLs
632<a href="https://author@git.example.org/org1/project1.git" class="bare">https://author@git.example.org/org1/project1.git</a> and
633<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
634use a credential helper, it will automatically try to look up the
635correct credentials for your account. If you already have a remote set
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]636up, you can change the URL with something like <code>git</code> <code>remote</code> <code>set-url</code>
637<code>origin</code> <code>https://author@git.example.org/org1/project1.git</code> (see
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]638<a href="git-remote.html">git-remote(1)</a> for details).</p>
639</dd>
640</dl>
641</div>
642<div id="multiple-accounts-ssh" class="dlist">
643<dl>
644<dt class="hdlist1">How do I use multiple accounts with the same hosting provider using SSH?</dt>
645<dd>
646<p>With most hosting providers that support SSH, a single key pair uniquely
647identifies a user. Therefore, to use multiple accounts, it&#8217;s necessary
648to create a key pair for each account. If you&#8217;re using a reasonably
649modern OpenSSH version, you can create a new key pair with something
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]650like <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]651register the public key (in this case, <code>~/.ssh/id_committer.pub</code>; note
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]652the .<code>pub</code>) with the hosting provider.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]653<div class="paragraph">
654<p>Most hosting providers use a single SSH account for pushing; that is, all users
655push to the <code>git</code> account (e.g., <code>git@git.example.org</code>). If that&#8217;s the case for
656your provider, you can set up multiple aliases in SSH to make it clear which key
657pair to use. For example, you could write something like the following in
658<code>~/.ssh/config</code>, substituting the proper private key file:</p>
659</div>
660<div class="listingblock">
661<div class="content">
662<pre># This is the account for author on git.example.org.
663Host example_author
664 HostName git.example.org
665 User git
666 # This is the key pair registered for author with git.example.org.
667 IdentityFile ~/.ssh/id_author
668 IdentitiesOnly yes
669# This is the account for committer on git.example.org.
670Host example_committer
671 HostName git.example.org
672 User git
673 # This is the key pair registered for committer with git.example.org.
674 IdentityFile ~/.ssh/id_committer
675 IdentitiesOnly yes</pre>
676</div>
677</div>
678<div class="paragraph">
679<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]680<code>git@example_committer</code> instead of <code>git@example.org</code> (e.g., <code>git</code> <code>remote</code> <code>set-url</code>
681<code>git@example_author:org1/project1.git</code>).</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]682</div>
683</dd>
684</dl>
685</div>
686</div>
687</div>
688<div class="sect1">
689<h2 id="_transfers">Transfers</h2>
690<div class="sectionbody">
691<div id="sync-working-tree" class="dlist">
692<dl>
693<dt class="hdlist1">How do I sync a working tree across systems?</dt>
694<dd>
695<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]696push 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]697and isn&#8217;t designed to share a working tree across systems. This is
698potentially risky and in some cases can cause repository corruption or data
699loss.</p>
700<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]701<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]702working tree. Additionally, Git&#8217;s security model does not permit sharing a
703working tree across untrusted users, so it is only safe to sync a working tree
704if it will only be used by a single user across all machines.</p>
705</div>
706<div class="paragraph">
707<p>It is important not to use a cloud syncing service to sync any portion of a Git
708repository, since this can cause corruption, such as missing objects, changed
709or added files, broken refs, and a wide variety of other problems. These
710services tend to sync file by file on a continuous basis and don&#8217;t understand
711the structure of a Git repository. This is especially bad if they sync the
712repository in the middle of it being updated, since that is very likely to
713cause incomplete or partial updates and therefore data loss.</p>
714</div>
715<div class="paragraph">
716<p>An example of the kind of corruption that can occur is conflicts over the state
717of refs, such that both sides end up with different commits on a branch that
718the other doesn&#8217;t have. This can result in important objects becoming
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]719unreferenced and possibly pruned by <code>git</code> <code>gc</code>, causing data loss.</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]720</div>
721<div class="paragraph">
722<p>Therefore, it&#8217;s better to push your work to either the other system or a central
723server using the normal push and pull mechanism. However, this doesn&#8217;t always
724preserve important data, like stashes, so some people prefer to share a working
725tree across systems.</p>
726</div>
727<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]728<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]729(ideally with an encrypted connection such as with <code>ssh</code>) on the root of
730repository. You should ensure several things when you do this:</p>
731</div>
732<div class="ulist">
733<ul>
734<li>
735<p>If you have additional worktrees or a separate Git directory, they must be
736synced at the same time as the main working tree and repository.</p>
737</li>
738<li>
739<p>You are comfortable with the destination directory being an exact copy of the
740source directory, <em>deleting any data that is already there</em>.</p>
741</li>
742<li>
743<p>The repository (including all worktrees and the Git directory) is in a
744quiescent state for the duration of the transfer (that is, no operations of
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]745any sort are taking place on it, including background operations like <code>git</code>
746<code>gc</code> and operations invoked by your editor).</p>
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]747<div class="paragraph">
748<p>Be aware that even with these recommendations, syncing in this way has some risk
749since it bypasses Git&#8217;s normal integrity checking for repositories, so having
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]750backups 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]751integrity of your data on the destination system after syncing.</p>
752</div>
753</li>
754</ul>
755</div>
756</dd>
757</dl>
758</div>
759</div>
760</div>
761<div class="sect1">
762<h2 id="_common_issues">Common Issues</h2>
763<div class="sectionbody">
764<div id="last-commit-amend" class="dlist">
765<dl>
766<dt class="hdlist1">I&#8217;ve made a mistake in the last commit. How do I change it?</dt>
767<dd>
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]768<p>You can make the appropriate change to your working tree, run <code>git</code> <code>add</code>
769<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>
770<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]771be prompted to edit the commit message again; if you wish to use the
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]772original message verbatim, you can use the <code>--no-edit</code> option to <code>git</code>
773<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]774</dd>
775</dl>
776</div>
777<div id="undo-previous-change" class="dlist">
778<dl>
779<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>
780<dd>
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]781<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]782the history that the original change was made and was a valuable
783contribution, but also introduces a new commit that undoes those changes
784because the original had a problem. The commit message of the revert
785indicates the commit which was reverted and is usually edited to include
786an explanation as to why the revert was made.</p>
787</dd>
788</dl>
789</div>
790<div id="ignore-tracked-files" class="dlist">
791<dl>
792<dt class="hdlist1">How do I ignore changes to a tracked file?</dt>
793<dd>
794<p>Git doesn&#8217;t provide a way to do this. The reason is that if Git needs
795to overwrite this file, such as during a checkout, it doesn&#8217;t know
796whether the changes to the file are precious and should be kept, or
797whether they are irrelevant and can safely be destroyed. Therefore, it
798has to take the safe route and always preserve them.</p>
799<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]800<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]801assume-unchanged and skip-worktree bits, but these don&#8217;t work properly for this
802purpose and shouldn&#8217;t be used this way.</p>
803</div>
804<div class="paragraph">
805<p>If your goal is to modify a configuration file, it can often be helpful to have
806a file checked into the repository which is a template or set of defaults which
807can then be copied alongside and modified as appropriate. This second, modified
808file is usually ignored to prevent accidentally committing it.</p>
809</div>
810</dd>
811</dl>
812</div>
813<div id="files-in-gitignore-are-tracked" class="dlist">
814<dl>
815<dt class="hdlist1">I asked Git to ignore various files, yet they are still tracked</dt>
816<dd>
817<p>A <code>gitignore</code> file ensures that certain file(s) which are not
818tracked by Git remain untracked. However, sometimes particular
819file(s) may have been tracked before adding them into the
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]820.<code>gitignore</code>, hence they still remain tracked. To untrack and
821ignore files/patterns, use <code>git</code> <code>rm</code> <code>--cached</code> &lt;file/pattern&gt;
822and add a pattern to .<code>gitignore</code> that matches the &lt;file&gt;.
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]823See <a href="gitignore.html">gitignore(5)</a> for details.</p>
824</dd>
825</dl>
826</div>
827<div id="fetching-and-pulling" class="dlist">
828<dl>
829<dt class="hdlist1">How do I know if I want to do a fetch or a pull?</dt>
830<dd>
831<p>A fetch stores a copy of the latest changes from the remote
832repository, without modifying the working tree or current branch.
833You can then at your leisure inspect, merge, rebase on top of, or
834ignore the upstream changes. A pull consists of a fetch followed
835immediately by either a merge or rebase. See <a href="git-pull.html">git-pull(1)</a>.</p>
836</dd>
837</dl>
838</div>
839<div id="proxy" class="dlist">
840<dl>
841<dt class="hdlist1">Can I use a proxy with Git?</dt>
842<dd>
843<p>Yes, Git supports the use of proxies. Git honors the standard <code>http_proxy</code>,
844<code>https_proxy</code>, and <code>no_proxy</code> environment variables commonly used on Unix, and
845it also can be configured with <code>http.proxy</code> and similar options for HTTPS (see
846<a href="git-config.html">git-config(1)</a>). The <code>http.proxy</code> and related options can be
847customized on a per-URL pattern basis. In addition, Git can in theory
848function normally with transparent proxies that exist on the network.</p>
849<div class="paragraph">
850<p>For SSH, Git can support a proxy using OpenSSH&#8217;s <code>ProxyCommand</code>. Commonly used
851tools include <code>netcat</code> and <code>socat</code>. However, they must be configured not to
852exit when seeing EOF on standard input, which usually means that <code>netcat</code> will
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]853require <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]854This is required because the way the Git SSH server knows that no more requests
855will be made is an EOF on standard input, but when that happens, the server may
856not have yet processed the final request, so dropping the connection at that
857point would interrupt that request.</p>
858</div>
859<div class="paragraph">
860<p>An example configuration entry in <code>~/.ssh/config</code> with an HTTP proxy might look
861like this:</p>
862</div>
863<div class="listingblock">
864<div class="content">
865<pre>Host git.example.org
866 User git
867 ProxyCommand socat -t 10 - PROXY:proxy.example.org:%h:%p,proxyport=8080</pre>
868</div>
869</div>
870<div class="paragraph">
871<p>Note that in all cases, for Git to work properly, the proxy must be completely
872transparent. The proxy cannot modify, tamper with, or buffer the connection in
873any way, or Git will almost certainly fail to work. Note that many proxies,
874including many TLS middleboxes, Windows antivirus and firewall programs other
875than Windows Defender and Windows Firewall, and filtering proxies fail to meet
876this standard, and as a result end up breaking Git. Because of the many
877reports of problems and their poor security history, we recommend against the
878use of these classes of software and devices.</p>
879</div>
880</dd>
881</dl>
882</div>
883</div>
884</div>
885<div class="sect1">
886<h2 id="_merging_and_rebasing">Merging and Rebasing</h2>
887<div class="sectionbody">
888<div id="long-running-squash-merge" class="dlist">
889<dl>
890<dt class="hdlist1">What kinds of problems can occur when merging long-lived branches with squash merges?</dt>
891<dd>
892<p>In general, there are a variety of problems that can occur when using squash
893merges to merge two branches multiple times. These can include seeing extra
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]894commits in <code>git</code> <code>log</code> output, with a GUI, or when using the ... notation to
Junio C Hamanob96f40a2024-08-01 00:57:25[diff] [blame]895express a range, as well as the possibility of needing to re-resolve conflicts
896again and again.</p>
897<div class="paragraph">
898<p>When Git does a normal merge between two branches, it considers exactly three
899points: the two branches and a third commit, called the <em>merge base</em>, which is
900usually the common ancestor of the commits. The result of the merge is the sum
901of the changes between the merge base and each head. When you merge two
902branches with a regular merge commit, this results in a new commit which will
903end up as a merge base when they&#8217;re merged again, because there is now a new
904common ancestor. Git doesn&#8217;t have to consider changes that occurred before the
905merge base, so you don&#8217;t have to re-resolve any conflicts you resolved before.</p>
906</div>
907<div class="paragraph">
908<p>When you perform a squash merge, a merge commit isn&#8217;t created; instead, the
909changes from one side are applied as a regular commit to the other side. This
910means that the merge base for these branches won&#8217;t have changed, and so when Git
911goes to perform its next merge, it considers all of the changes that it
912considered the last time plus the new changes. That means any conflicts may
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]913need to be re-resolved. Similarly, anything using the ... notation in <code>git</code>
914<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]915original merge base.</p>
916</div>
917<div class="paragraph">
918<p>As a consequence, if you want to merge two long-lived branches repeatedly, it&#8217;s
919best to always use a regular merge commit.</p>
920</div>
921</dd>
922</dl>
923</div>
924<div id="merge-two-revert-one" class="dlist">
925<dl>
926<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>
927<dd>
928<p>By default, when Git does a merge, it uses a strategy called the <code>ort</code>
929strategy, which does a fancy three-way merge. In such a case, when Git
930performs the merge, it considers exactly three points: the two heads and a
931third point, called the <em>merge base</em>, which is usually the common ancestor of
932those commits. Git does not consider the history or the individual commits
933that have happened on those branches at all.</p>
934<div class="paragraph">
935<p>As a result, if both sides have a change and one side has reverted that change,
936the result is to include the change. This is because the code has changed on
937one side and there is no net change on the other, and in this scenario, Git
938adopts the change.</p>
939</div>
940<div class="paragraph">
941<p>If this is a problem for you, you can do a rebase instead, rebasing the branch
942with the revert onto the other branch. A rebase in this scenario will revert
943the change, because a rebase applies each individual commit, including the
944revert. Note that rebases rewrite history, so you should avoid rebasing
945published branches unless you&#8217;re sure you&#8217;re comfortable with that. See the
946NOTES section in <a href="git-rebase.html">git-rebase(1)</a> for more details.</p>
947</div>
948</dd>
949</dl>
950</div>
951</div>
952</div>
953<div class="sect1">
954<h2 id="_hooks">Hooks</h2>
955<div class="sectionbody">
956<div id="restrict-with-hooks" class="dlist">
957<dl>
958<dt class="hdlist1">How do I use hooks to prevent users from making certain changes?</dt>
959<dd>
960<p>The only safe place to make these changes is on the remote repository
961(i.e., the Git server), usually in the <code>pre-receive</code> hook or in a
962continuous integration (CI) system. These are the locations in which
963policy can be enforced effectively.</p>
964<div class="paragraph">
965<p>It&#8217;s common to try to use <code>pre-commit</code> hooks (or, for commit messages,
966<code>commit-msg</code> hooks) to check these things, which is great if you&#8217;re working as a
967solo developer and want the tooling to help you. However, using hooks on a
968developer machine is not effective as a policy control because a user can bypass
969these hooks with <code>--no-verify</code> without being noticed (among various other ways).
970Git assumes that the user is in control of their local repositories and doesn&#8217;t
971try to prevent this or tattle on the user.</p>
972</div>
973<div class="paragraph">
974<p>In addition, some advanced users find <code>pre-commit</code> hooks to be an impediment to
975workflows that use temporary commits to stage work in progress or that create
976fixup commits, so it&#8217;s better to push these kinds of checks to the server
977anyway.</p>
978</div>
979</dd>
980</dl>
981</div>
982</div>
983</div>
984<div class="sect1">
985<h2 id="_cross_platform_issues">Cross-Platform Issues</h2>
986<div class="sectionbody">
987<div id="windows-text-binary" class="dlist">
988<dl>
989<dt class="hdlist1">I&#8217;m on Windows and my text files are detected as binary.</dt>
990<dd>
991<p>Git works best when you store text files as UTF-8. Many programs on
992Windows support UTF-8, but some do not and only use the little-endian
993UTF-16 format, which Git detects as binary. If you can&#8217;t use UTF-8 with
994your programs, you can specify a working tree encoding that indicates
995which encoding your files should be checked out with, while still
996storing these files as UTF-8 in the repository. This allows tools like
997<a href="git-diff.html">git-diff(1)</a> to work as expected, while still allowing your tools
998to work.</p>
999<div class="paragraph">
1000<p>To do so, you can specify a <a href="gitattributes.html">gitattributes(5)</a> pattern with the
1001<code>working-tree-encoding</code> attribute. For example, the following pattern sets all
1002C files to use UTF-16LE-BOM, which is a common encoding on Windows:</p>
1003</div>
1004<div class="listingblock">
1005<div class="content">
1006<pre>*.c working-tree-encoding=UTF-16LE-BOM</pre>
1007</div>
1008</div>
1009<div class="paragraph">
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]1010<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]1011that if you are making these changes on a project that is used across platforms,
1012you&#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]1013in <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]1014repository will apply to all users of the repository.</p>
1015</div>
1016<div class="paragraph">
1017<p>See the following entry for information about normalizing line endings as well,
1018and see <a href="gitattributes.html">gitattributes(5)</a> for more information about attribute files.</p>
1019</div>
1020</dd>
1021</dl>
1022</div>
1023<div id="windows-diff-control-m" class="dlist">
1024<dl>
1025<dt class="hdlist1">I&#8217;m on Windows and git diff shows my files as having a <code>^M</code> at the end.</dt>
1026<dd>
1027<p>By default, Git expects files to be stored with Unix line endings. As such,
1028the carriage return (<code>^M</code>) that is part of a Windows line ending is shown
1029because it is considered to be trailing whitespace. Git defaults to showing
1030trailing whitespace only on new lines, not existing ones.</p>
1031<div class="paragraph">
1032<p>You can store the files in the repository with Unix line endings and convert
1033them automatically to your platform&#8217;s line endings. To do that, set the
1034configuration option <code>core.eol</code> to <code>native</code> and see
1035<a href="#recommended-storage-settings">the question on recommended storage settings</a>
1036for information about how to configure files as text or binary.</p>
1037</div>
1038<div class="paragraph">
1039<p>You can also control this behavior with the <code>core.whitespace</code> setting if you
1040don&#8217;t wish to remove the carriage returns from your line endings.</p>
1041</div>
1042</dd>
1043</dl>
1044</div>
1045<div id="always-modified-files-case" class="dlist">
1046<dl>
1047<dt class="hdlist1">Why do I have a file that&#8217;s always modified?</dt>
1048<dd>
1049<p>Internally, Git always stores file names as sequences of bytes and doesn&#8217;t
1050perform any encoding or case folding. However, Windows and macOS by default
1051both perform case folding on file names. As a result, it&#8217;s possible to end up
1052with multiple files or directories whose names differ only in case. Git can
1053handle this just fine, but the file system can store only one of these files,
1054so when Git reads the other file to see its contents, it looks modified.</p>
1055<div class="paragraph">
1056<p>It&#8217;s best to remove one of the files such that you only have one file. You can
1057do this with commands like the following (assuming two files <code>AFile.txt</code> and
1058<code>afile.txt</code>) on an otherwise clean working tree:</p>
1059</div>
1060<div class="listingblock">
1061<div class="content">
1062<pre>$ git rm --cached AFile.txt
1063$ git commit -m 'Remove files conflicting in case'
1064$ git checkout .</pre>
1065</div>
1066</div>
1067<div class="paragraph">
1068<p>This avoids touching the disk, but removes the additional file. Your project
1069may prefer to adopt a naming convention, such as all-lowercase names, to avoid
1070this problem from occurring again; such a convention can be checked using a
1071<code>pre-receive</code> hook or as part of a continuous integration (CI) system.</p>
1072</div>
1073<div class="paragraph">
1074<p>It is also possible for perpetually modified files to occur on any platform if a
1075smudge or clean filter is in use on your system but a file was previously
1076committed without running the smudge or clean filter. To fix this, run the
1077following on an otherwise clean working tree:</p>
1078</div>
1079<div class="listingblock">
1080<div class="content">
1081<pre>$ git add --renormalize .</pre>
1082</div>
1083</div>
1084</dd>
1085</dl>
1086</div>
1087<div id="recommended-storage-settings" class="dlist">
1088<dl>
1089<dt class="hdlist1">What&#8217;s the recommended way to store files in Git?</dt>
1090<dd>
1091<p>While Git can store and handle any file of any type, there are some
1092settings that work better than others. In general, we recommend that
1093text files be stored in UTF-8 without a byte-order mark (BOM) with LF
1094(Unix-style) endings. We also recommend the use of UTF-8 (again,
1095without BOM) in commit messages. These are the settings that work best
Junio C Hamanodc392382024-10-11 18:57:29[diff] [blame]1096across 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]1097<div class="paragraph">
1098<p>Additionally, if you have a choice between storage formats that are text based
1099or non-text based, we recommend storing files in the text format and, if
1100necessary, transforming them into the other format. For example, a text-based
1101SQL dump with one record per line will work much better for diffing and merging
1102than an actual database file. Similarly, text-based formats such as Markdown
1103and AsciiDoc will work better than binary formats such as Microsoft Word and
1104PDF.</p>
1105</div>
1106<div class="paragraph">
1107<p>Similarly, storing binary dependencies (e.g., shared libraries or JAR files) or
1108build products in the repository is generally not recommended. Dependencies and
1109build products are best stored on an artifact or package server with only
1110references, URLs, and hashes stored in the repository.</p>
1111</div>
1112<div class="paragraph">
1113<p>We also recommend setting a <a href="gitattributes.html">gitattributes(5)</a> file to explicitly mark
1114which files are text and which are binary. If you want Git to guess, you can
1115set the attribute <code>text=auto</code>.</p>
1116</div>
1117<div class="paragraph">
1118<p>With text files, Git will generally ensure that LF endings are used in the
1119repository. The <code>core.autocrlf</code> and <code>core.eol</code> configuration variables specify
1120what line-ending convention is followed when any text file is checked out. You
1121can also use the <code>eol</code> attribute (e.g., <code>eol=crlf</code>) to override which files get
1122what line-ending treatment.</p>
1123</div>
1124<div class="paragraph">
1125<p>For example, generally shell files must have LF endings and batch files must
1126have CRLF endings, so the following might be appropriate in some projects:</p>
1127</div>
1128<div class="listingblock">
1129<div class="content">
1130<pre># By default, guess.
1131* text=auto
1132# Mark all C files as text.
1133*.c text
1134# Ensure all shell files have LF endings and all batch files have CRLF
1135# endings in the working tree and both have LF in the repo.
1136*.sh text eol=lf
1137*.bat text eol=crlf
1138# Mark all JPEG files as binary.
1139*.jpg binary</pre>
1140</div>
1141</div>
1142<div class="paragraph">
1143<p>These settings help tools pick the right format for output such as patches and
1144result in files being checked out in the appropriate line ending for the
1145platform.</p>
1146</div>
1147</dd>
1148</dl>
1149</div>
1150</div>
1151</div>
1152<div class="sect1">
1153<h2 id="_git">GIT</h2>
1154<div class="sectionbody">
1155<div class="paragraph">
1156<p>Part of the <a href="git.html">git(1)</a> suite</p>
1157</div>
1158</div>
1159</div>
1160</div>
1161<div id="footer">
1162<div id="footer-text">
1163Last updated 2024-07-16 15:50:24 -0700
1164</div>
1165</div>
1166</body>
1167</html>