Google Git
Sign in
chromium / external / gitster / git-htmldocs / b96f40a0cb74a86e910bb0f415c4df5182ea5ccf / . / git-checkout.html
blob: 24eb0cca32753dcb8b2cd15462f2d1fb62f027a0 [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>git-checkout(1)</title>
9<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/>
10<style>
11/*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */
12/* Uncomment the following line when using as a custom stylesheet */
13/* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */
14html{font-family:sans-serif;-webkit-text-size-adjust:100%}
15a{background:none}
16a:focus{outline:thin dotted}
17a:active,a:hover{outline:0}
18h1{font-size:2em;margin:.67em 0}
19b,strong{font-weight:bold}
20abbr{font-size:.9em}
21abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
22dfn{font-style:italic}
23hr{height:0}
24mark{background:#ff0;color:#000}
25code,kbd,pre,samp{font-family:monospace;font-size:1em}
26pre{white-space:pre-wrap}
27q{quotes:"\201C" "\201D" "\2018" "\2019"}
28small{font-size:80%}
29sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
30sup{top:-.5em}
31sub{bottom:-.25em}
32img{border:0}
33svg:not(:root){overflow:hidden}
34figure{margin:0}
35audio,video{display:inline-block}
36audio:not([controls]){display:none;height:0}
37fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38legend{border:0;padding:0}
39button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40button,input{line-height:normal}
41button,select{text-transform:none}
42button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
43button[disabled],html input[disabled]{cursor:default}
44input[type=checkbox],input[type=radio]{padding:0}
45button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46textarea{overflow:auto;vertical-align:top}
47table{border-collapse:collapse;border-spacing:0}
48*,::before,::after{box-sizing:border-box}
49html,body{font-size:100%}
50body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased}
51a:hover{cursor:pointer}
52img,object,embed{max-width:100%;height:auto}
53object,embed{height:100%}
54img{-ms-interpolation-mode:bicubic}
55.left{float:left!important}
56.right{float:right!important}
57.text-left{text-align:left!important}
58.text-right{text-align:right!important}
59.text-center{text-align:center!important}
60.text-justify{text-align:justify!important}
61.hide{display:none}
62img,object,svg{display:inline-block;vertical-align:middle}
63textarea{height:auto;min-height:50px}
64select{width:100%}
65.subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em}
66div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0}
67a{color:#2156a5;text-decoration:underline;line-height:inherit}
68a:hover,a:focus{color:#1d4b8f}
69a img{border:0}
70p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
71p aside{font-size:.875em;line-height:1.35;font-style:italic}
72h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em}
73h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0}
74h1{font-size:2.125em}
75h2{font-size:1.6875em}
76h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
77h4,h5{font-size:1.125em}
78h6{font-size:1em}
79hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
80em,i{font-style:italic;line-height:inherit}
81strong,b{font-weight:bold;line-height:inherit}
82small{font-size:60%;line-height:inherit}
83code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
84ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
85ul,ol{margin-left:1.5em}
86ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
87ul.circle{list-style-type:circle}
88ul.disc{list-style-type:disc}
89ul.square{list-style-type:square}
90ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
91ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
92dl dt{margin-bottom:.3125em;font-weight:bold}
93dl dd{margin-bottom:1.25em}
94blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
95blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)}
96@media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2}
97h1{font-size:2.75em}
98h2{font-size:2.3125em}
99h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
100h4{font-size:1.4375em}}
101table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
102table thead,table tfoot{background:#f7f8f7}
103table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left}
104table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
105table tr.even,table tr.alt{background:#f8f8f7}
106table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
107h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
108h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400}
109.center{margin-left:auto;margin-right:auto}
110.stretch{width:100%}
111.clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table}
112.clearfix::after,.float-group::after{clear:both}
113:not(pre).nobreak{word-wrap:normal}
114:not(pre).nowrap{white-space:nowrap}
115:not(pre).pre-wrap{white-space:pre-wrap}
116:not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed}
117pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
118pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119pre>code{display:block}
120pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121em em{font-style:normal}
122strong strong{font-weight:400}
123.keyseq{color:rgba(51,51,51,.8)}
124kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap}
125.keyseq kbd:first-child{margin-left:0}
126.keyseq kbd:last-child{margin-right:0}
127.menuseq,.menuref{color:#000}
128.menuseq b:not(.caret),.menuref{font-weight:inherit}
129.menuseq{word-spacing:-.02em}
130.menuseq b.caret{font-size:1.25em;line-height:.8}
131.menuseq i.caret{font-weight:bold;text-align:center;width:.45em}
132b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
133b.button::before{content:"[";padding:0 3px 0 2px}
134b.button::after{content:"]";padding:0 2px 0 3px}
135p a>code:hover{color:rgba(0,0,0,.9)}
136#header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em}
137#header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table}
138#header::after,#content::after,#footnotes::after,#footer::after{clear:both}
139#content{margin-top:1.25em}
140#content::before{content:none}
141#header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0}
142#header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf}
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>git-checkout(1) Manual Page</h1>
444<h2 id="_name">NAME</h2>
445<div class="sectionbody">
446<p>git-checkout - Switch branches or restore working tree files</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="verseblock">
454<pre class="content"><em>git checkout</em> [-q] [-f] [-m] [&lt;branch&gt;]
455<em>git checkout</em> [-q] [-f] [-m] --detach [&lt;branch&gt;]
456<em>git checkout</em> [-q] [-f] [-m] [--detach] &lt;commit&gt;
457<em>git checkout</em> [-q] [-f] [-m] [[-b|-B|--orphan] &lt;new-branch&gt;] [&lt;start-point&gt;]
458<em>git checkout</em> [-f] &lt;tree-ish&gt; [--] &lt;pathspec&gt;&#8230;&#8203;
459<em>git checkout</em> [-f] &lt;tree-ish&gt; --pathspec-from-file=&lt;file&gt; [--pathspec-file-nul]
460<em>git checkout</em> [-f|--ours|--theirs|-m|--conflict=&lt;style&gt;] [--] &lt;pathspec&gt;&#8230;&#8203;
461<em>git checkout</em> [-f|--ours|--theirs|-m|--conflict=&lt;style&gt;] --pathspec-from-file=&lt;file&gt; [--pathspec-file-nul]
462<em>git checkout</em> (-p|--patch) [&lt;tree-ish&gt;] [--] [&lt;pathspec&gt;&#8230;&#8203;]</pre>
463</div>
464</div>
465</div>
466<div class="sect1">
467<h2 id="_description">DESCRIPTION</h2>
468<div class="sectionbody">
469<div class="paragraph">
470<p>Updates files in the working tree to match the version in the index
471or the specified tree. If no pathspec was given, <em>git checkout</em> will
472also update <code>HEAD</code> to set the specified branch as the current
473branch.</p>
474</div>
475<div class="dlist">
476<dl>
477<dt class="hdlist1"><em>git checkout</em> [&lt;branch&gt;]</dt>
478<dd>
479<p>To prepare for working on <code>&lt;branch&gt;</code>, switch to it by updating
480the index and the files in the working tree, and by pointing
481<code>HEAD</code> at the branch. Local modifications to the files in the
482working tree are kept, so that they can be committed to the
483<code>&lt;branch&gt;</code>.</p>
484<div class="paragraph">
485<p>If <code>&lt;branch&gt;</code> is not found but there does exist a tracking branch in
486exactly one remote (call it <code>&lt;remote&gt;</code>) with a matching name and
487<code>--no-guess</code> is not specified, treat as equivalent to</p>
488</div>
489<div class="listingblock">
490<div class="content">
491<pre>$ git checkout -b &lt;branch&gt; --track &lt;remote&gt;/&lt;branch&gt;</pre>
492</div>
493</div>
494<div class="paragraph">
495<p>You could omit <code>&lt;branch&gt;</code>, in which case the command degenerates to
496"check out the current branch", which is a glorified no-op with
497rather expensive side-effects to show only the tracking information,
498if it exists, for the current branch.</p>
499</div>
500</dd>
501<dt class="hdlist1"><em>git checkout</em> -b|-B &lt;new-branch&gt; [&lt;start-point&gt;]</dt>
502<dd>
503<p>Specifying <code>-b</code> causes a new branch to be created as if
504<a href="git-branch.html">git-branch(1)</a> were called and then checked out. In
505this case you can use the <code>--track</code> or <code>--no-track</code> options,
506which will be passed to <em>git branch</em>. As a convenience,
507<code>--track</code> without <code>-b</code> implies branch creation; see the
508description of <code>--track</code> below.</p>
509<div class="paragraph">
510<p>If <code>-B</code> is given, <code>&lt;new-branch&gt;</code> is created if it doesn&#8217;t exist; otherwise, it
511is reset. This is the transactional equivalent of</p>
512</div>
513<div class="listingblock">
514<div class="content">
515<pre>$ git branch -f &lt;branch&gt; [&lt;start-point&gt;]
516$ git checkout &lt;branch&gt;</pre>
517</div>
518</div>
519<div class="paragraph">
520<p>that is to say, the branch is not reset/created unless "git checkout" is
521successful (e.g., when the branch is in use in another worktree, not
522just the current branch stays the same, but the branch is not reset to
523the start-point, either).</p>
524</div>
525</dd>
526<dt class="hdlist1"><em>git checkout</em> --detach [&lt;branch&gt;]</dt>
527<dt class="hdlist1"><em>git checkout</em> [--detach] &lt;commit&gt;</dt>
528<dd>
529<p>Prepare to work on top of <code>&lt;commit&gt;</code>, by detaching <code>HEAD</code> at it
530(see "DETACHED HEAD" section), and updating the index and the
531files in the working tree. Local modifications to the files
532in the working tree are kept, so that the resulting working
533tree will be the state recorded in the commit plus the local
534modifications.</p>
535<div class="paragraph">
536<p>When the <code>&lt;commit&gt;</code> argument is a branch name, the <code>--detach</code> option can
537be used to detach <code>HEAD</code> at the tip of the branch (<code>git checkout
538&lt;branch&gt;</code> would check out that branch without detaching <code>HEAD</code>).</p>
539</div>
540<div class="paragraph">
541<p>Omitting <code>&lt;branch&gt;</code> detaches <code>HEAD</code> at the tip of the current branch.</p>
542</div>
543</dd>
544<dt class="hdlist1"><em>git checkout</em> [-f|--ours|--theirs|-m|--conflict=&lt;style&gt;] [&lt;tree-ish&gt;] [--] &lt;pathspec&gt;&#8230;&#8203;</dt>
545<dt class="hdlist1"><em>git checkout</em> [-f|--ours|--theirs|-m|--conflict=&lt;style&gt;] [&lt;tree-ish&gt;] --pathspec-from-file=&lt;file&gt; [--pathspec-file-nul]</dt>
546<dd>
547<p>Overwrite the contents of the files that match the pathspec.
548When the <code>&lt;tree-ish&gt;</code> (most often a commit) is not given,
549overwrite working tree with the contents in the index.
550When the <code>&lt;tree-ish&gt;</code> is given, overwrite both the index and
551the working tree with the contents at the <code>&lt;tree-ish&gt;</code>.</p>
552<div class="paragraph">
553<p>The index may contain unmerged entries because of a previous failed merge.
554By default, if you try to check out such an entry from the index, the
555checkout operation will fail and nothing will be checked out.
556Using <code>-f</code> will ignore these unmerged entries. The contents from a
557specific side of the merge can be checked out of the index by
558using <code>--ours</code> or <code>--theirs</code>. With <code>-m</code>, changes made to the working tree
559file can be discarded to re-create the original conflicted merge result.</p>
560</div>
561</dd>
562<dt class="hdlist1"><em>git checkout</em> (-p|--patch) [&lt;tree-ish&gt;] [--] [&lt;pathspec&gt;&#8230;&#8203;]</dt>
563<dd>
564<p>This is similar to the previous mode, but lets you use the
565interactive interface to show the "diff" output and choose which
566hunks to use in the result. See below for the description of
567<code>--patch</code> option.</p>
568</dd>
569</dl>
570</div>
571</div>
572</div>
573<div class="sect1">
574<h2 id="_options">OPTIONS</h2>
575<div class="sectionbody">
576<div class="dlist">
577<dl>
578<dt class="hdlist1">-q</dt>
579<dt class="hdlist1">--quiet</dt>
580<dd>
581<p>Quiet, suppress feedback messages.</p>
582</dd>
583<dt class="hdlist1">--progress</dt>
584<dt class="hdlist1">--no-progress</dt>
585<dd>
586<p>Progress status is reported on the standard error stream
587by default when it is attached to a terminal, unless <code>--quiet</code>
588is specified. This flag enables progress reporting even if not
589attached to a terminal, regardless of <code>--quiet</code>.</p>
590</dd>
591<dt class="hdlist1">-f</dt>
592<dt class="hdlist1">--force</dt>
593<dd>
594<p>When switching branches, proceed even if the index or the
595working tree differs from <code>HEAD</code>, and even if there are untracked
596files in the way. This is used to throw away local changes and
597any untracked files or directories that are in the way.</p>
598<div class="paragraph">
599<p>When checking out paths from the index, do not fail upon unmerged
600entries; instead, unmerged entries are ignored.</p>
601</div>
602</dd>
603<dt class="hdlist1">--ours</dt>
604<dt class="hdlist1">--theirs</dt>
605<dd>
606<p>When checking out paths from the index, check out stage #2
607(<em>ours</em>) or #3 (<em>theirs</em>) for unmerged paths.</p>
608<div class="paragraph">
609<p>Note that during <code>git rebase</code> and <code>git pull --rebase</code>, <em>ours</em> and
610<em>theirs</em> may appear swapped; <code>--ours</code> gives the version from the
611branch the changes are rebased onto, while <code>--theirs</code> gives the
612version from the branch that holds your work that is being rebased.</p>
613</div>
614<div class="paragraph">
615<p>This is because <code>rebase</code> is used in a workflow that treats the
616history at the remote as the shared canonical one, and treats the
617work done on the branch you are rebasing as the third-party work to
618be integrated, and you are temporarily assuming the role of the
619keeper of the canonical history during the rebase. As the keeper of
620the canonical history, you need to view the history from the remote
621as <code>ours</code> (i.e. "our shared canonical history"), while what you did
622on your side branch as <code>theirs</code> (i.e. "one contributor&#8217;s work on top
623of it").</p>
624</div>
625</dd>
626<dt class="hdlist1">-b &lt;new-branch&gt;</dt>
627<dd>
628<p>Create a new branch named <code>&lt;new-branch&gt;</code>, start it at
629<code>&lt;start-point&gt;</code>, and check the resulting branch out;
630see <a href="git-branch.html">git-branch(1)</a> for details.</p>
631</dd>
632<dt class="hdlist1">-B &lt;new-branch&gt;</dt>
633<dd>
634<p>Creates the branch <code>&lt;new-branch&gt;</code>, start it at <code>&lt;start-point&gt;</code>;
635if it already exists, then reset it to <code>&lt;start-point&gt;</code>. And then
636check the resulting branch out. This is equivalent to running
637"git branch" with "-f" followed by "git checkout" of that branch;
638see <a href="git-branch.html">git-branch(1)</a> for details.</p>
639</dd>
640<dt class="hdlist1">-t</dt>
641<dt class="hdlist1">--track[=(direct|inherit)]</dt>
642<dd>
643<p>When creating a new branch, set up "upstream" configuration. See
644"--track" in <a href="git-branch.html">git-branch(1)</a> for details.</p>
645<div class="paragraph">
646<p>If no <code>-b</code> option is given, the name of the new branch will be
647derived from the remote-tracking branch, by looking at the local part of
648the refspec configured for the corresponding remote, and then stripping
649the initial part up to the "*".
650This would tell us to use <code>hack</code> as the local branch when branching
651off of <code>origin/hack</code> (or <code>remotes/origin/hack</code>, or even
652<code>refs/remotes/origin/hack</code>). If the given name has no slash, or the above
653guessing results in an empty name, the guessing is aborted. You can
654explicitly give a name with <code>-b</code> in such a case.</p>
655</div>
656</dd>
657<dt class="hdlist1">--no-track</dt>
658<dd>
659<p>Do not set up "upstream" configuration, even if the
660<code>branch.autoSetupMerge</code> configuration variable is true.</p>
661</dd>
662<dt class="hdlist1">--guess</dt>
663<dt class="hdlist1">--no-guess</dt>
664<dd>
665<p>If <code>&lt;branch&gt;</code> is not found but there does exist a tracking
666branch in exactly one remote (call it <code>&lt;remote&gt;</code>) with a
667matching name, treat as equivalent to</p>
668<div class="listingblock">
669<div class="content">
670<pre>$ git checkout -b &lt;branch&gt; --track &lt;remote&gt;/&lt;branch&gt;</pre>
671</div>
672</div>
673<div class="paragraph">
674<p>If the branch exists in multiple remotes and one of them is named by
675the <code>checkout.defaultRemote</code> configuration variable, we&#8217;ll use that
676one for the purposes of disambiguation, even if the <code>&lt;branch&gt;</code> isn&#8217;t
677unique across all remotes. Set it to
678e.g. <code>checkout.defaultRemote=origin</code> to always checkout remote
679branches from there if <code>&lt;branch&gt;</code> is ambiguous but exists on the
680<em>origin</em> remote. See also <code>checkout.defaultRemote</code> in
681<a href="git-config.html">git-config(1)</a>.</p>
682</div>
683<div class="paragraph">
684<p><code>--guess</code> is the default behavior. Use <code>--no-guess</code> to disable it.</p>
685</div>
686<div class="paragraph">
687<p>The default behavior can be set via the <code>checkout.guess</code> configuration
688variable.</p>
689</div>
690</dd>
691<dt class="hdlist1">-l</dt>
692<dd>
693<p>Create the new branch&#8217;s reflog; see <a href="git-branch.html">git-branch(1)</a> for
694details.</p>
695</dd>
696<dt class="hdlist1">-d</dt>
697<dt class="hdlist1">--detach</dt>
698<dd>
699<p>Rather than checking out a branch to work on it, check out a
700commit for inspection and discardable experiments.
701This is the default behavior of <code>git checkout &lt;commit&gt;</code> when
702<code>&lt;commit&gt;</code> is not a branch name. See the "DETACHED HEAD" section
703below for details.</p>
704</dd>
705<dt class="hdlist1">--orphan &lt;new-branch&gt;</dt>
706<dd>
707<p>Create a new unborn branch, named <code>&lt;new-branch&gt;</code>, started from
708<code>&lt;start-point&gt;</code> and switch to it. The first commit made on this
709new branch will have no parents and it will be the root of a new
710history totally disconnected from all the other branches and
711commits.</p>
712<div class="paragraph">
713<p>The index and the working tree are adjusted as if you had previously run
714<code>git checkout &lt;start-point&gt;</code>. This allows you to start a new history
715that records a set of paths similar to <code>&lt;start-point&gt;</code> by easily running
716<code>git commit -a</code> to make the root commit.</p>
717</div>
718<div class="paragraph">
719<p>This can be useful when you want to publish the tree from a commit
720without exposing its full history. You might want to do this to publish
721an open source branch of a project whose current tree is "clean", but
722whose full history contains proprietary or otherwise encumbered bits of
723code.</p>
724</div>
725<div class="paragraph">
726<p>If you want to start a disconnected history that records a set of paths
727that is totally different from the one of <code>&lt;start-point&gt;</code>, then you should
728clear the index and the working tree right after creating the orphan
729branch by running <code>git rm -rf .</code> from the top level of the working tree.
730Afterwards you will be ready to prepare your new files, repopulating the
731working tree, by copying them from elsewhere, extracting a tarball, etc.</p>
732</div>
733</dd>
734<dt class="hdlist1">--ignore-skip-worktree-bits</dt>
735<dd>
736<p>In sparse checkout mode, <code>git checkout -- &lt;paths&gt;</code> would
737update only entries matched by <code>&lt;paths&gt;</code> and sparse patterns
738in <code>$GIT_DIR/info/sparse-checkout</code>. This option ignores
739the sparse patterns and adds back any files in <code>&lt;paths&gt;</code>.</p>
740</dd>
741<dt class="hdlist1">-m</dt>
742<dt class="hdlist1">--merge</dt>
743<dd>
744<p>When switching branches,
745if you have local modifications to one or more files that
746are different between the current branch and the branch to
747which you are switching, the command refuses to switch
748branches in order to preserve your modifications in context.
749However, with this option, a three-way merge between the current
750branch, your working tree contents, and the new branch
751is done, and you will be on the new branch.</p>
752<div class="paragraph">
753<p>When a merge conflict happens, the index entries for conflicting
754paths are left unmerged, and you need to resolve the conflicts
755and mark the resolved paths with <code>git add</code> (or <code>git rm</code> if the merge
756should result in deletion of the path).</p>
757</div>
758<div class="paragraph">
759<p>When checking out paths from the index, this option lets you recreate
760the conflicted merge in the specified paths. This option cannot be
761used when checking out paths from a tree-ish.</p>
762</div>
763<div class="paragraph">
764<p>When switching branches with <code>--merge</code>, staged changes may be lost.</p>
765</div>
766</dd>
767<dt class="hdlist1">--conflict=&lt;style&gt;</dt>
768<dd>
769<p>The same as <code>--merge</code> option above, but changes the way the
770conflicting hunks are presented, overriding the
771<code>merge.conflictStyle</code> configuration variable. Possible values are
772"merge" (default), "diff3", and "zdiff3".</p>
773</dd>
774<dt class="hdlist1">-p</dt>
775<dt class="hdlist1">--patch</dt>
776<dd>
777<p>Interactively select hunks in the difference between the
778<code>&lt;tree-ish&gt;</code> (or the index, if unspecified) and the working
779tree. The chosen hunks are then applied in reverse to the
780working tree (and if a <code>&lt;tree-ish&gt;</code> was specified, the index).</p>
781<div class="paragraph">
782<p>This means that you can use <code>git checkout -p</code> to selectively discard
783edits from your current working tree. See the &#8220;Interactive Mode&#8221;
784section of <a href="git-add.html">git-add(1)</a> to learn how to operate the <code>--patch</code> mode.</p>
785</div>
786<div class="paragraph">
787<p>Note that this option uses the no overlay mode by default (see also
788<code>--overlay</code>), and currently doesn&#8217;t support overlay mode.</p>
789</div>
790</dd>
791<dt class="hdlist1">--ignore-other-worktrees</dt>
792<dd>
793<p><code>git checkout</code> refuses when the wanted ref is already checked
794out by another worktree. This option makes it check the ref
795out anyway. In other words, the ref can be held by more than one
796worktree.</p>
797</dd>
798<dt class="hdlist1">--overwrite-ignore</dt>
799<dt class="hdlist1">--no-overwrite-ignore</dt>
800<dd>
801<p>Silently overwrite ignored files when switching branches. This
802is the default behavior. Use <code>--no-overwrite-ignore</code> to abort
803the operation when the new branch contains ignored files.</p>
804</dd>
805<dt class="hdlist1">--recurse-submodules</dt>
806<dt class="hdlist1">--no-recurse-submodules</dt>
807<dd>
808<p>Using <code>--recurse-submodules</code> will update the content of all active
809submodules according to the commit recorded in the superproject. If
810local modifications in a submodule would be overwritten the checkout
811will fail unless <code>-f</code> is used. If nothing (or <code>--no-recurse-submodules</code>)
812is used, submodules working trees will not be updated.
813Just like <a href="git-submodule.html">git-submodule(1)</a>, this will detach <code>HEAD</code> of the
814submodule.</p>
815</dd>
816<dt class="hdlist1">--overlay</dt>
817<dt class="hdlist1">--no-overlay</dt>
818<dd>
819<p>In the default overlay mode, <code>git checkout</code> never
820removes files from the index or the working tree. When
821specifying <code>--no-overlay</code>, files that appear in the index and
822working tree, but not in <code>&lt;tree-ish&gt;</code> are removed, to make them
823match <code>&lt;tree-ish&gt;</code> exactly.</p>
824</dd>
825<dt class="hdlist1">--pathspec-from-file=&lt;file&gt;</dt>
826<dd>
827<p>Pathspec is passed in <code>&lt;file&gt;</code> instead of commandline args. If
828<code>&lt;file&gt;</code> is exactly <code>-</code> then standard input is used. Pathspec
829elements are separated by LF or CR/LF. Pathspec elements can be
830quoted as explained for the configuration variable <code>core.quotePath</code>
831(see <a href="git-config.html">git-config(1)</a>). See also <code>--pathspec-file-nul</code> and
832global <code>--literal-pathspecs</code>.</p>
833</dd>
834<dt class="hdlist1">--pathspec-file-nul</dt>
835<dd>
836<p>Only meaningful with <code>--pathspec-from-file</code>. Pathspec elements are
837separated with NUL character and all other characters are taken
838literally (including newlines and quotes).</p>
839</dd>
840<dt class="hdlist1">&lt;branch&gt;</dt>
841<dd>
842<p>Branch to checkout; if it refers to a branch (i.e., a name that,
843when prepended with "refs/heads/", is a valid ref), then that
844branch is checked out. Otherwise, if it refers to a valid
845commit, your <code>HEAD</code> becomes "detached" and you are no longer on
846any branch (see below for details).</p>
847<div class="paragraph">
848<p>You can use the <code>@{-N}</code> syntax to refer to the N-th last
849branch/commit checked out using "git checkout" operation. You may
850also specify <code>-</code> which is synonymous to <code>@{-1}</code>.</p>
851</div>
852<div class="paragraph">
853<p>As a special case, you may use <code>A...B</code> as a shortcut for the
854merge base of <code>A</code> and <code>B</code> if there is exactly one merge base. You can
855leave out at most one of <code>A</code> and <code>B</code>, in which case it defaults to <code>HEAD</code>.</p>
856</div>
857</dd>
858<dt class="hdlist1">&lt;new-branch&gt;</dt>
859<dd>
860<p>Name for the new branch.</p>
861</dd>
862<dt class="hdlist1">&lt;start-point&gt;</dt>
863<dd>
864<p>The name of a commit at which to start the new branch; see
865<a href="git-branch.html">git-branch(1)</a> for details. Defaults to <code>HEAD</code>.</p>
866<div class="paragraph">
867<p>As a special case, you may use <code>"A...B"</code> as a shortcut for the
868merge base of <code>A</code> and <code>B</code> if there is exactly one merge base. You can
869leave out at most one of <code>A</code> and <code>B</code>, in which case it defaults to <code>HEAD</code>.</p>
870</div>
871</dd>
872<dt class="hdlist1">&lt;tree-ish&gt;</dt>
873<dd>
874<p>Tree to checkout from (when paths are given). If not specified,
875the index will be used.</p>
876<div class="paragraph">
877<p>As a special case, you may use <code>"A...B"</code> as a shortcut for the
878merge base of <code>A</code> and <code>B</code> if there is exactly one merge base. You can
879leave out at most one of <code>A</code> and <code>B</code>, in which case it defaults to <code>HEAD</code>.</p>
880</div>
881</dd>
882<dt class="hdlist1">--</dt>
883<dd>
884<p>Do not interpret any more arguments as options.</p>
885</dd>
886<dt class="hdlist1">&lt;pathspec&gt;&#8230;&#8203;</dt>
887<dd>
888<p>Limits the paths affected by the operation.</p>
889<div class="paragraph">
890<p>For more details, see the <em>pathspec</em> entry in <a href="gitglossary.html">gitglossary(7)</a>.</p>
891</div>
892</dd>
893</dl>
894</div>
895</div>
896</div>
897<div class="sect1">
898<h2 id="_detached_head">DETACHED HEAD</h2>
899<div class="sectionbody">
900<div class="paragraph">
901<p><code>HEAD</code> normally refers to a named branch (e.g. <code>master</code>). Meanwhile, each
902branch refers to a specific commit. Let&#8217;s look at a repo with three
903commits, one of them tagged, and with branch <code>master</code> checked out:</p>
904</div>
905<div class="listingblock">
906<div class="content">
907<pre> HEAD (refers to branch 'master')
908 |
909 v
910a---b---c branch 'master' (refers to commit 'c')
911 ^
912 |
913 tag 'v2.0' (refers to commit 'b')</pre>
914</div>
915</div>
916<div class="paragraph">
917<p>When a commit is created in this state, the branch is updated to refer to
918the new commit. Specifically, <em>git commit</em> creates a new commit <code>d</code>, whose
919parent is commit <code>c</code>, and then updates branch <code>master</code> to refer to new
920commit <code>d</code>. <code>HEAD</code> still refers to branch <code>master</code> and so indirectly now refers
921to commit <code>d</code>:</p>
922</div>
923<div class="listingblock">
924<div class="content">
925<pre>$ edit; git add; git commit
926
927 HEAD (refers to branch 'master')
928 |
929 v
930a---b---c---d branch 'master' (refers to commit 'd')
931 ^
932 |
933 tag 'v2.0' (refers to commit 'b')</pre>
934</div>
935</div>
936<div class="paragraph">
937<p>It is sometimes useful to be able to checkout a commit that is not at
938the tip of any named branch, or even to create a new commit that is not
939referenced by a named branch. Let&#8217;s look at what happens when we
940checkout commit <code>b</code> (here we show two ways this may be done):</p>
941</div>
942<div class="listingblock">
943<div class="content">
944<pre>$ git checkout v2.0 # or
945$ git checkout master^^
946
947 HEAD (refers to commit 'b')
948 |
949 v
950a---b---c---d branch 'master' (refers to commit 'd')
951 ^
952 |
953 tag 'v2.0' (refers to commit 'b')</pre>
954</div>
955</div>
956<div class="paragraph">
957<p>Notice that regardless of which checkout command we use, <code>HEAD</code> now refers
958directly to commit <code>b</code>. This is known as being in detached <code>HEAD</code> state.
959It means simply that <code>HEAD</code> refers to a specific commit, as opposed to
960referring to a named branch. Let&#8217;s see what happens when we create a commit:</p>
961</div>
962<div class="listingblock">
963<div class="content">
964<pre>$ edit; git add; git commit
965
966 HEAD (refers to commit 'e')
967 |
968 v
969 e
970 /
971a---b---c---d branch 'master' (refers to commit 'd')
972 ^
973 |
974 tag 'v2.0' (refers to commit 'b')</pre>
975</div>
976</div>
977<div class="paragraph">
978<p>There is now a new commit <code>e</code>, but it is referenced only by <code>HEAD</code>. We can
979of course add yet another commit in this state:</p>
980</div>
981<div class="listingblock">
982<div class="content">
983<pre>$ edit; git add; git commit
984
985 HEAD (refers to commit 'f')
986 |
987 v
988 e---f
989 /
990a---b---c---d branch 'master' (refers to commit 'd')
991 ^
992 |
993 tag 'v2.0' (refers to commit 'b')</pre>
994</div>
995</div>
996<div class="paragraph">
997<p>In fact, we can perform all the normal Git operations. But, let&#8217;s look
998at what happens when we then checkout <code>master</code>:</p>
999</div>
1000<div class="listingblock">
1001<div class="content">
1002<pre>$ git checkout master
1003
1004 HEAD (refers to branch 'master')
1005 e---f |
1006 / v
1007a---b---c---d branch 'master' (refers to commit 'd')
1008 ^
1009 |
1010 tag 'v2.0' (refers to commit 'b')</pre>
1011</div>
1012</div>
1013<div class="paragraph">
1014<p>It is important to realize that at this point nothing refers to commit
1015<code>f</code>. Eventually commit <code>f</code> (and by extension commit <code>e</code>) will be deleted
1016by the routine Git garbage collection process, unless we create a reference
1017before that happens. If we have not yet moved away from commit <code>f</code>,
1018any of these will create a reference to it:</p>
1019</div>
1020<div class="listingblock">
1021<div class="content">
1022<pre>$ git checkout -b foo # or "git switch -c foo" <b class="conum">(1)</b>
1023$ git branch foo <b class="conum">(2)</b>
1024$ git tag foo <b class="conum">(3)</b></pre>
1025</div>
1026</div>
1027<div class="colist arabic">
1028<ol>
1029<li>
1030<p>creates a new branch <code>foo</code>, which refers to commit <code>f</code>, and then
1031updates <code>HEAD</code> to refer to branch <code>foo</code>. In other words, we&#8217;ll no longer
1032be in detached <code>HEAD</code> state after this command.</p>
1033</li>
1034<li>
1035<p>similarly creates a new branch <code>foo</code>, which refers to commit <code>f</code>,
1036but leaves <code>HEAD</code> detached.</p>
1037</li>
1038<li>
1039<p>creates a new tag <code>foo</code>, which refers to commit <code>f</code>,
1040leaving <code>HEAD</code> detached.</p>
1041</li>
1042</ol>
1043</div>
1044<div class="paragraph">
1045<p>If we have moved away from commit <code>f</code>, then we must first recover its object
1046name (typically by using git reflog), and then we can create a reference to
1047it. For example, to see the last two commits to which <code>HEAD</code> referred, we
1048can use either of these commands:</p>
1049</div>
1050<div class="listingblock">
1051<div class="content">
1052<pre>$ git reflog -2 HEAD # or
1053$ git log -g -2 HEAD</pre>
1054</div>
1055</div>
1056</div>
1057</div>
1058<div class="sect1">
1059<h2 id="_argument_disambiguation">ARGUMENT DISAMBIGUATION</h2>
1060<div class="sectionbody">
1061<div class="paragraph">
1062<p>When there is only one argument given and it is not <code>--</code> (e.g. <code>git
1063checkout abc</code>), and when the argument is both a valid <code>&lt;tree-ish&gt;</code>
1064(e.g. a branch <code>abc</code> exists) and a valid <code>&lt;pathspec&gt;</code> (e.g. a file
1065or a directory whose name is "abc" exists), Git would usually ask
1066you to disambiguate. Because checking out a branch is so common an
1067operation, however, <code>git checkout abc</code> takes "abc" as a <code>&lt;tree-ish&gt;</code>
1068in such a situation. Use <code>git checkout -- &lt;pathspec&gt;</code> if you want
1069to checkout these paths out of the index.</p>
1070</div>
1071</div>
1072</div>
1073<div class="sect1">
1074<h2 id="_examples">EXAMPLES</h2>
1075<div class="sectionbody">
1076<div class="sect2">
1077<h3 id="_1_paths">1. Paths</h3>
1078<div class="paragraph">
1079<p>The following sequence checks out the <code>master</code> branch, reverts
1080the <code>Makefile</code> to two revisions back, deletes <code>hello.c</code> by
1081mistake, and gets it back from the index.</p>
1082</div>
1083<div class="listingblock">
1084<div class="content">
1085<pre>$ git checkout master <b class="conum">(1)</b>
1086$ git checkout master~2 Makefile <b class="conum">(2)</b>
1087$ rm -f hello.c
1088$ git checkout hello.c <b class="conum">(3)</b></pre>
1089</div>
1090</div>
1091<div class="colist arabic">
1092<ol>
1093<li>
1094<p>switch branch</p>
1095</li>
1096<li>
1097<p>take a file out of another commit</p>
1098</li>
1099<li>
1100<p>restore <code>hello.c</code> from the index</p>
1101</li>
1102</ol>
1103</div>
1104<div class="paragraph">
1105<p>If you want to check out <em>all</em> C source files out of the index,
1106you can say</p>
1107</div>
1108<div class="listingblock">
1109<div class="content">
1110<pre>$ git checkout -- '*.c'</pre>
1111</div>
1112</div>
1113<div class="paragraph">
1114<p>Note the quotes around <code>*.c</code>. The file <code>hello.c</code> will also be
1115checked out, even though it is no longer in the working tree,
1116because the file globbing is used to match entries in the index
1117(not in the working tree by the shell).</p>
1118</div>
1119<div class="paragraph">
1120<p>If you have an unfortunate branch that is named <code>hello.c</code>, this
1121step would be confused as an instruction to switch to that branch.
1122You should instead write:</p>
1123</div>
1124<div class="listingblock">
1125<div class="content">
1126<pre>$ git checkout -- hello.c</pre>
1127</div>
1128</div>
1129</div>
1130<div class="sect2">
1131<h3 id="_2_merge">2. Merge</h3>
1132<div class="paragraph">
1133<p>After working in the wrong branch, switching to the correct
1134branch would be done using:</p>
1135</div>
1136<div class="listingblock">
1137<div class="content">
1138<pre>$ git checkout mytopic</pre>
1139</div>
1140</div>
1141<div class="paragraph">
1142<p>However, your "wrong" branch and correct <code>mytopic</code> branch may
1143differ in files that you have modified locally, in which case
1144the above checkout would fail like this:</p>
1145</div>
1146<div class="listingblock">
1147<div class="content">
1148<pre>$ git checkout mytopic
1149error: You have local changes to 'frotz'; not switching branches.</pre>
1150</div>
1151</div>
1152<div class="paragraph">
1153<p>You can give the <code>-m</code> flag to the command, which would try a
1154three-way merge:</p>
1155</div>
1156<div class="listingblock">
1157<div class="content">
1158<pre>$ git checkout -m mytopic
1159Auto-merging frotz</pre>
1160</div>
1161</div>
1162<div class="paragraph">
1163<p>After this three-way merge, the local modifications are <em>not</em>
1164registered in your index file, so <code>git diff</code> would show you what
1165changes you made since the tip of the new branch.</p>
1166</div>
1167</div>
1168<div class="sect2">
1169<h3 id="_3_merge_conflict">3. Merge conflict</h3>
1170<div class="paragraph">
1171<p>When a merge conflict happens during switching branches with
1172the <code>-m</code> option, you would see something like this:</p>
1173</div>
1174<div class="listingblock">
1175<div class="content">
1176<pre>$ git checkout -m mytopic
1177Auto-merging frotz
1178ERROR: Merge conflict in frotz
1179fatal: merge program failed</pre>
1180</div>
1181</div>
1182<div class="paragraph">
1183<p>At this point, <code>git diff</code> shows the changes cleanly merged as in
1184the previous example, as well as the changes in the conflicted
1185files. Edit and resolve the conflict and mark it resolved with
1186<code>git add</code> as usual:</p>
1187</div>
1188<div class="listingblock">
1189<div class="content">
1190<pre>$ edit frotz
1191$ git add frotz</pre>
1192</div>
1193</div>
1194</div>
1195</div>
1196</div>
1197<div class="sect1">
1198<h2 id="_configuration">CONFIGURATION</h2>
1199<div class="sectionbody">
1200<div class="paragraph">
1201<p>Everything below this line in this section is selectively included
1202from the <a href="git-config.html">git-config(1)</a> documentation. The content is the same
1203as what&#8217;s found there:</p>
1204</div>
1205<div class="dlist">
1206<dl>
1207<dt class="hdlist1">checkout.defaultRemote</dt>
1208<dd>
1209<p>When you run <code>git checkout &lt;something&gt;</code>
1210or <code>git switch &lt;something&gt;</code> and only have one
1211remote, it may implicitly fall back on checking out and
1212tracking e.g. <code>origin/&lt;something&gt;</code>. This stops working as soon
1213as you have more than one remote with a <code>&lt;something&gt;</code>
1214reference. This setting allows for setting the name of a
1215preferred remote that should always win when it comes to
1216disambiguation. The typical use-case is to set this to
1217<code>origin</code>.</p>
1218<div class="paragraph">
1219<p>Currently this is used by <a href="git-switch.html">git-switch(1)</a> and
1220<a href="git-checkout.html">git-checkout(1)</a> when <code>git checkout &lt;something&gt;</code>
1221or <code>git switch &lt;something&gt;</code>
1222will checkout the <code>&lt;something&gt;</code> branch on another remote,
1223and by <a href="git-worktree.html">git-worktree(1)</a> when <code>git worktree add</code> refers to a
1224remote branch. This setting might be used for other checkout-like
1225commands or functionality in the future.</p>
1226</div>
1227</dd>
1228<dt class="hdlist1">checkout.guess</dt>
1229<dd>
1230<p>Provides the default value for the <code>--guess</code> or <code>--no-guess</code>
1231option in <code>git checkout</code> and <code>git switch</code>. See
1232<a href="git-switch.html">git-switch(1)</a> and <a href="git-checkout.html">git-checkout(1)</a>.</p>
1233</dd>
1234<dt class="hdlist1">checkout.workers</dt>
1235<dd>
1236<p>The number of parallel workers to use when updating the working tree.
1237The default is one, i.e. sequential execution. If set to a value less
1238than one, Git will use as many workers as the number of logical cores
1239available. This setting and <code>checkout.thresholdForParallelism</code> affect
1240all commands that perform checkout. E.g. checkout, clone, reset,
1241sparse-checkout, etc.</p>
1242<div class="paragraph">
1243<p>Note: Parallel checkout usually delivers better performance for repositories
1244located on SSDs or over NFS. For repositories on spinning disks and/or machines
1245with a small number of cores, the default sequential checkout often performs
1246better. The size and compression level of a repository might also influence how
1247well the parallel version performs.</p>
1248</div>
1249</dd>
1250<dt class="hdlist1">checkout.thresholdForParallelism</dt>
1251<dd>
1252<p>When running parallel checkout with a small number of files, the cost
1253of subprocess spawning and inter-process communication might outweigh
1254the parallelization gains. This setting allows you to define the minimum
1255number of files for which parallel checkout should be attempted. The
1256default is 100.</p>
1257</dd>
1258</dl>
1259</div>
1260</div>
1261</div>
1262<div class="sect1">
1263<h2 id="_see_also">SEE ALSO</h2>
1264<div class="sectionbody">
1265<div class="paragraph">
1266<p><a href="git-switch.html">git-switch(1)</a>,
1267<a href="git-restore.html">git-restore(1)</a></p>
1268</div>
1269</div>
1270</div>
1271<div class="sect1">
1272<h2 id="_git">GIT</h2>
1273<div class="sectionbody">
1274<div class="paragraph">
1275<p>Part of the <a href="git.html">git(1)</a> suite</p>
1276</div>
1277</div>
1278</div>
1279</div>
1280<div id="footer">
1281<div id="footer-text">
1282Last updated 2024-01-02 14:28:43 -0800
1283</div>
1284</div>
1285</body>
1286</html>