Autogenerated HTML docs for v2.47.0-305-g4083a
[git-htmldocs.git] / git-branch.html
blob948e202900b52e2a5b0988e5c8ed2a8de9e984d6
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-branch(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"; */
14 html{font-family:sans-serif;-webkit-text-size-adjust:100%}
15 a{background:none}
16 a:focus{outline:thin dotted}
17 a:active,a:hover{outline:0}
18 h1{font-size:2em;margin:.67em 0}
19 b,strong{font-weight:bold}
20 abbr{font-size:.9em}
21 abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none}
22 dfn{font-style:italic}
23 hr{height:0}
24 mark{background:#ff0;color:#000}
25 code,kbd,pre,samp{font-family:monospace;font-size:1em}
26 pre{white-space:pre-wrap}
27 q{quotes:"\201C" "\201D" "\2018" "\2019"}
28 small{font-size:80%}
29 sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}
30 sup{top:-.5em}
31 sub{bottom:-.25em}
32 img{border:0}
33 svg:not(:root){overflow:hidden}
34 figure{margin:0}
35 audio,video{display:inline-block}
36 audio:not([controls]){display:none;height:0}
37 fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}
38 legend{border:0;padding:0}
39 button,input,select,textarea{font-family:inherit;font-size:100%;margin:0}
40 button,input{line-height:normal}
41 button,select{text-transform:none}
42 button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer}
43 button[disabled],html input[disabled]{cursor:default}
44 input[type=checkbox],input[type=radio]{padding:0}
45 button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}
46 textarea{overflow:auto;vertical-align:top}
47 table{border-collapse:collapse;border-spacing:0}
48 *,::before,::after{box-sizing:border-box}
49 html,body{font-size:100%}
50 body{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}
51 a:hover{cursor:pointer}
52 img,object,embed{max-width:100%;height:auto}
53 object,embed{height:100%}
54 img{-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}
62 img,object,svg{display:inline-block;vertical-align:middle}
63 textarea{height:auto;min-height:50px}
64 select{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}
66 div,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}
67 a{color:#2156a5;text-decoration:underline;line-height:inherit}
68 a:hover,a:focus{color:#1d4b8f}
69 a img{border:0}
70 p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility}
71 p aside{font-size:.875em;line-height:1.35;font-style:italic}
72 h1,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}
73 h1 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}
74 h1{font-size:2.125em}
75 h2{font-size:1.6875em}
76 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em}
77 h4,h5{font-size:1.125em}
78 h6{font-size:1em}
79 hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em}
80 em,i{font-style:italic;line-height:inherit}
81 strong,b{font-weight:bold;line-height:inherit}
82 small{font-size:60%;line-height:inherit}
83 code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)}
84 ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit}
85 ul,ol{margin-left:1.5em}
86 ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0}
87 ul.circle{list-style-type:circle}
88 ul.disc{list-style-type:disc}
89 ul.square{list-style-type:square}
90 ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit}
91 ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0}
92 dl dt{margin-bottom:.3125em;font-weight:bold}
93 dl dd{margin-bottom:1.25em}
94 blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd}
95 blockquote,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}
97 h1{font-size:2.75em}
98 h2{font-size:2.3125em}
99 h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em}
100 h4{font-size:1.4375em}}
101 table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal}
102 table thead,table tfoot{background:#f7f8f7}
103 table 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}
104 table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)}
105 table tr.even,table tr.alt{background:#f8f8f7}
106 table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6}
107 h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em}
108 h1 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}
117 pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed}
118 pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit}
119 pre>code{display:block}
120 pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal}
121 em em{font-style:normal}
122 strong strong{font-weight:400}
123 .keyseq{color:rgba(51,51,51,.8)}
124 kbd{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}
132 b.button::before,b.button::after{position:relative;top:-1px;font-weight:400}
133 b.button::before{content:"[";padding:0 3px 0 2px}
134 b.button::after{content:"]";padding:0 2px 0 3px}
135 p 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}
164 body.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}
170 body.toc2.toc-right{padding-left:0;padding-right:15em}
171 body.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}
177 body.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}
194 details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em}
195 details{margin-left:1.25rem}
196 details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent}
197 details>summary::-webkit-details-marker{display:none}
198 details>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%)}
199 details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)}
200 details>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}
202 table.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}
229 pre.prettyprint .linenums{line-height:1.45;margin-left:2em}
230 pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0}
231 pre.prettyprint li code[data-lang]::before{opacity:1}
232 pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none}
233 table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none}
234 table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal}
235 table.linenotable td.code{padding-left:.75em}
236 table.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}
237 pre.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}
260 p.tableblock:last-child{margin-bottom:0}
261 td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere}
262 td.tableblock>.content>:last-child{margin-bottom:-1.25em}
263 table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede}
264 table.grid-all>*>tr>*{border-width:1px}
265 table.grid-cols>*>tr>*{border-width:0 1px}
266 table.grid-rows>*>tr>*{border-width:1px 0}
267 table.frame-all{border-width:1px}
268 table.frame-ends{border-width:1px 0}
269 table.frame-sides{border-width:0 1px}
270 table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0}
271 table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0}
272 table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0}
273 table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0}
274 table.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}
275 th.halign-left,td.halign-left{text-align:left}
276 th.halign-right,td.halign-right{text-align:right}
277 th.halign-center,td.halign-center{text-align:center}
278 th.valign-top,td.valign-top{vertical-align:top}
279 th.valign-bottom,td.valign-bottom{vertical-align:bottom}
280 th.valign-middle,td.valign-middle{vertical-align:middle}
281 table thead th,table tfoot th{font-weight:bold}
282 tbody tr th{background:#f7f8f7}
283 tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold}
284 p.tableblock>code:only-child{background:none;padding:0}
285 p.tableblock{font-size:1em}
286 ol{margin-left:1.75em}
287 ul li ol{margin-left:1.5em}
288 dl dd{margin-left:1.125em}
289 dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0}
290 li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em}
291 ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none}
292 ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em}
293 ul.unstyled,ol.unstyled{margin-left:0}
294 li>p:empty:only-child::before{content:"";display:inline-block}
295 ul.checklist>li>p:first-child{margin-left:-1em}
296 ul.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}
297 ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em}
298 ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em}
299 ul.inline>li{margin-left:1.25em}
300 .unstyled dl dt{font-weight:400;font-style:normal}
301 ol.arabic{list-style-type:decimal}
302 ol.decimal{list-style-type:decimal-leading-zero}
303 ol.loweralpha{list-style-type:lower-alpha}
304 ol.upperalpha{list-style-type:upper-alpha}
305 ol.lowerroman{list-style-type:lower-roman}
306 ol.upperroman{list-style-type:upper-roman}
307 ol.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}
310 td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em}
311 td.hdlist1{font-weight:bold;padding-bottom:1.25em}
312 td.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}
326 a.image{text-decoration:none;display:inline-block}
327 a.image object{pointer-events:none}
328 sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super}
329 sup.footnote a,sup.footnoteref a{text-decoration:none}
330 sup.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}
337 div.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}
375 span.icon>.fa{cursor:default}
376 a 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)}
387 pre .conum[data-value]{position:relative;top:-.125em}
388 b.conum *{color:inherit!important}
389 .conum:not([data-value]):empty{display:none}
390 dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility}
391 h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em}
392 p strong,td.content strong,div.footnote strong{letter-spacing:-.005em}
393 p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem}
394 p{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}
400 html{font-size:80%}
401 a{color:inherit!important;text-decoration:underline!important}
402 a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important}
403 a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em}
404 abbr[title]{border-bottom:1px dotted}
405 abbr[title]::after{content:" (" attr(title) ")"}
406 pre,blockquote,tr,img,object,svg{page-break-inside:avoid}
407 thead{display:table-header-group}
408 svg{max-width:100%}
409 p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3}
410 h2,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}
414 body.book #header{text-align:center}
415 body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em}
416 body.book #header .details{border:0!important;display:block;padding:0!important}
417 body.book #header .details span:first-child{margin-left:0!important}
418 body.book #header .details br{display:block}
419 body.book #header .details br+span::before{content:none!important}
420 body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important}
421 body.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>
436 pre>code {
437 display: inline;
439 </style>
440 </head>
441 <body class="manpage">
442 <div id="header">
443 <h1>git-branch(1) Manual Page</h1>
444 <h2 id="_name">NAME</h2>
445 <div class="sectionbody">
446 <p>git-branch - List, create, or delete branches</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 branch</em> [--color[=&lt;when&gt;] | --no-color] [--show-current]
455 [-v [--abbrev=&lt;n&gt; | --no-abbrev]]
456 [--column[=&lt;options&gt;] | --no-column] [--sort=&lt;key&gt;]
457 [--merged [&lt;commit&gt;]] [--no-merged [&lt;commit&gt;]]
458 [--contains [&lt;commit&gt;]] [--no-contains [&lt;commit&gt;]]
459 [--points-at &lt;object&gt;] [--format=&lt;format&gt;]
460 [(-r | --remotes) | (-a | --all)]
461 [--list] [&lt;pattern&gt;&#8230;&#8203;]
462 <em>git branch</em> [--track[=(direct|inherit)] | --no-track] [-f]
463 [--recurse-submodules] &lt;branchname&gt; [&lt;start-point&gt;]
464 <em>git branch</em> (--set-upstream-to=&lt;upstream&gt; | -u &lt;upstream&gt;) [&lt;branchname&gt;]
465 <em>git branch</em> --unset-upstream [&lt;branchname&gt;]
466 <em>git branch</em> (-m | -M) [&lt;oldbranch&gt;] &lt;newbranch&gt;
467 <em>git branch</em> (-c | -C) [&lt;oldbranch&gt;] &lt;newbranch&gt;
468 <em>git branch</em> (-d | -D) [-r] &lt;branchname&gt;&#8230;&#8203;
469 <em>git branch</em> --edit-description [&lt;branchname&gt;]</pre>
470 </div>
471 </div>
472 </div>
473 <div class="sect1">
474 <h2 id="_description">DESCRIPTION</h2>
475 <div class="sectionbody">
476 <div class="paragraph">
477 <p>If <code>--list</code> is given, or if there are no non-option arguments, existing
478 branches are listed; the current branch will be highlighted in green and
479 marked with an asterisk. Any branches checked out in linked worktrees will
480 be highlighted in cyan and marked with a plus sign. Option <code>-r</code> causes the
481 remote-tracking branches to be listed,
482 and option <code>-a</code> shows both local and remote branches.</p>
483 </div>
484 <div class="paragraph">
485 <p>If a <em>&lt;pattern&gt;</em>
486 is given, it is used as a shell wildcard to restrict the output to
487 matching branches. If multiple patterns are given, a branch is shown if
488 it matches any of the patterns.</p>
489 </div>
490 <div class="paragraph">
491 <p>Note that when providing a
492 <em>&lt;pattern&gt;</em>, you must use <code>--list</code>; otherwise the command may be interpreted
493 as branch creation.</p>
494 </div>
495 <div class="paragraph">
496 <p>With <code>--contains</code>, shows only the branches that contain the named commit
497 (in other words, the branches whose tip commits are descendants of the
498 named commit), <code>--no-contains</code> inverts it. With <code>--merged</code>, only branches
499 merged into the named commit (i.e. the branches whose tip commits are
500 reachable from the named commit) will be listed. With <code>--no-merged</code> only
501 branches not merged into the named commit will be listed. If the &lt;commit&gt;
502 argument is missing it defaults to <code>HEAD</code> (i.e. the tip of the current
503 branch).</p>
504 </div>
505 <div class="paragraph">
506 <p>The command&#8217;s second form creates a new branch head named &lt;branchname&gt;
507 which points to the current <code>HEAD</code>, or &lt;start-point&gt; if given. As a
508 special case, for &lt;start-point&gt;, you may use "A<code>...</code><code>B</code>" as a shortcut for
509 the merge base of <code>A</code> and <code>B</code> if there is exactly one merge base. You
510 can leave out at most one of <code>A</code> and <code>B</code>, in which case it defaults to
511 <code>HEAD</code>.</p>
512 </div>
513 <div class="paragraph">
514 <p>Note that this will create the new branch, but it will not switch the
515 working tree to it; use "git switch &lt;newbranch&gt;" to switch to the
516 new branch.</p>
517 </div>
518 <div class="paragraph">
519 <p>When a local branch is started off a remote-tracking branch, Git sets up the
520 branch (specifically the <code>branch.</code><em>&lt;name&gt;</em><code>.remote</code> and <code>branch.</code><em>&lt;name&gt;</em><code>.merge</code>
521 configuration entries) so that <em>git pull</em> will appropriately merge from
522 the remote-tracking branch. This behavior may be changed via the global
523 <code>branch.autoSetupMerge</code> configuration flag. That setting can be
524 overridden by using the <code>--track</code> and <code>--no-track</code> options, and
525 changed later using <code>git</code> <code>branch</code> <code>--set-upstream-to</code>.</p>
526 </div>
527 <div class="paragraph">
528 <p>With a <code>-m</code> or <code>-M</code> option, &lt;oldbranch&gt; will be renamed to &lt;newbranch&gt;.
529 If &lt;oldbranch&gt; had a corresponding reflog, it is renamed to match
530 &lt;newbranch&gt;, and a reflog entry is created to remember the branch
531 renaming. If &lt;newbranch&gt; exists, -M must be used to force the rename
532 to happen.</p>
533 </div>
534 <div class="paragraph">
535 <p>The <code>-c</code> and <code>-C</code> options have the exact same semantics as <code>-m</code> and
536 <code>-M</code>, except instead of the branch being renamed, it will be copied to a
537 new name, along with its config and reflog.</p>
538 </div>
539 <div class="paragraph">
540 <p>With a <code>-d</code> or <code>-D</code> option, <em>&lt;branchname&gt;</em> will be deleted. You may
541 specify more than one branch for deletion. If the branch currently
542 has a reflog then the reflog will also be deleted.</p>
543 </div>
544 <div class="paragraph">
545 <p>Use <code>-r</code> together with <code>-d</code> to delete remote-tracking branches. Note, that it
546 only makes sense to delete remote-tracking branches if they no longer exist
547 in the remote repository or if <em>git fetch</em> was configured not to fetch
548 them again. See also the <em>prune</em> subcommand of <a href="git-remote.html">git-remote(1)</a> for a
549 way to clean up all obsolete remote-tracking branches.</p>
550 </div>
551 </div>
552 </div>
553 <div class="sect1">
554 <h2 id="_options">OPTIONS</h2>
555 <div class="sectionbody">
556 <div class="dlist">
557 <dl>
558 <dt class="hdlist1">-d</dt>
559 <dt class="hdlist1">--delete</dt>
560 <dd>
561 <p>Delete a branch. The branch must be fully merged in its
562 upstream branch, or in <code>HEAD</code> if no upstream was set with
563 <code>--track</code> or <code>--set-upstream-to</code>.</p>
564 </dd>
565 <dt class="hdlist1">-D</dt>
566 <dd>
567 <p>Shortcut for <code>--delete</code> <code>--force</code>.</p>
568 </dd>
569 <dt class="hdlist1">--create-reflog</dt>
570 <dd>
571 <p>Create the branch&#8217;s reflog. This activates recording of
572 all changes made to the branch ref, enabling use of date
573 based sha1 expressions such as "&lt;branchname&gt;@{yesterday}".
574 Note that in non-bare repositories, reflogs are usually
575 enabled by default by the <code>core.logAllRefUpdates</code> config option.
576 The negated form <code>--no-create-reflog</code> only overrides an earlier
577 <code>--create-reflog</code>, but currently does not negate the setting of
578 <code>core.logAllRefUpdates</code>.</p>
579 </dd>
580 <dt class="hdlist1">-f</dt>
581 <dt class="hdlist1">--force</dt>
582 <dd>
583 <p>Reset &lt;branchname&gt; to &lt;start-point&gt;, even if &lt;branchname&gt; exists
584 already. Without <code>-f</code>, <em>git branch</em> refuses to change an existing branch.
585 In combination with <code>-d</code> (or <code>--delete</code>), allow deleting the
586 branch irrespective of its merged status, or whether it even
587 points to a valid commit. In combination with
588 <code>-m</code> (or <code>--move</code>), allow renaming the branch even if the new
589 branch name already exists, the same applies for <code>-c</code> (or <code>--copy</code>).</p>
590 <div class="paragraph">
591 <p>Note that <em>git branch -f &lt;branchname&gt; [&lt;start-point&gt;]</em>, even with <em>-f</em>,
592 refuses to change an existing branch <em>&lt;branchname&gt;</em> that is checked out
593 in another worktree linked to the same repository.</p>
594 </div>
595 </dd>
596 <dt class="hdlist1">-m</dt>
597 <dt class="hdlist1">--move</dt>
598 <dd>
599 <p>Move/rename a branch, together with its config and reflog.</p>
600 </dd>
601 <dt class="hdlist1">-M</dt>
602 <dd>
603 <p>Shortcut for <code>--move</code> <code>--force</code>.</p>
604 </dd>
605 <dt class="hdlist1">-c</dt>
606 <dt class="hdlist1">--copy</dt>
607 <dd>
608 <p>Copy a branch, together with its config and reflog.</p>
609 </dd>
610 <dt class="hdlist1">-C</dt>
611 <dd>
612 <p>Shortcut for <code>--copy</code> <code>--force</code>.</p>
613 </dd>
614 <dt class="hdlist1">--color[=&lt;when&gt;]</dt>
615 <dd>
616 <p>Color branches to highlight current, local, and
617 remote-tracking branches.
618 The value must be always (the default), never, or auto.</p>
619 </dd>
620 <dt class="hdlist1">--no-color</dt>
621 <dd>
622 <p>Turn off branch colors, even when the configuration file gives the
623 default to color output.
624 Same as <code>--color=never</code>.</p>
625 </dd>
626 <dt class="hdlist1">-i</dt>
627 <dt class="hdlist1">--ignore-case</dt>
628 <dd>
629 <p>Sorting and filtering branches are case insensitive.</p>
630 </dd>
631 <dt class="hdlist1">--omit-empty</dt>
632 <dd>
633 <p>Do not print a newline after formatted refs where the format expands
634 to the empty string.</p>
635 </dd>
636 <dt class="hdlist1">--column[=&lt;options&gt;]</dt>
637 <dt class="hdlist1">--no-column</dt>
638 <dd>
639 <p>Display branch listing in columns. See configuration variable
640 <code>column.branch</code> for option syntax. <code>--column</code> and <code>--no-column</code>
641 without options are equivalent to <em>always</em> and <em>never</em> respectively.</p>
642 <div class="paragraph">
643 <p>This option is only applicable in non-verbose mode.</p>
644 </div>
645 </dd>
646 <dt class="hdlist1">-r</dt>
647 <dt class="hdlist1">--remotes</dt>
648 <dd>
649 <p>List or delete (if used with -d) the remote-tracking branches.
650 Combine with <code>--list</code> to match the optional pattern(s).</p>
651 </dd>
652 <dt class="hdlist1">-a</dt>
653 <dt class="hdlist1">--all</dt>
654 <dd>
655 <p>List both remote-tracking branches and local branches.
656 Combine with <code>--list</code> to match optional pattern(s).</p>
657 </dd>
658 <dt class="hdlist1">-l</dt>
659 <dt class="hdlist1">--list</dt>
660 <dd>
661 <p>List branches. With optional <em>&lt;pattern&gt;</em>..., e.g. <code>git</code>
662 <code>branch</code> <code>--list</code> 'maint-*', list only the branches that match
663 the pattern(s).</p>
664 </dd>
665 <dt class="hdlist1">--show-current</dt>
666 <dd>
667 <p>Print the name of the current branch. In detached HEAD state,
668 nothing is printed.</p>
669 </dd>
670 <dt class="hdlist1">-v</dt>
671 <dt class="hdlist1">-vv</dt>
672 <dt class="hdlist1">--verbose</dt>
673 <dd>
674 <p>When in list mode,
675 show sha1 and commit subject line for each head, along with
676 relationship to upstream branch (if any). If given twice, print
677 the path of the linked worktree (if any) and the name of the upstream
678 branch, as well (see also <code>git</code> <code>remote</code> <code>show</code> <em>&lt;remote&gt;</em>). Note that the
679 current worktree&#8217;s HEAD will not have its path printed (it will always
680 be your current directory).</p>
681 </dd>
682 <dt class="hdlist1">-q</dt>
683 <dt class="hdlist1">--quiet</dt>
684 <dd>
685 <p>Be more quiet when creating or deleting a branch, suppressing
686 non-error messages.</p>
687 </dd>
688 <dt class="hdlist1">--abbrev=&lt;n&gt;</dt>
689 <dd>
690 <p>In the verbose listing that show the commit object name,
691 show the shortest prefix that is at least <em>&lt;n&gt;</em> hexdigits
692 long that uniquely refers the object.
693 The default value is 7 and can be overridden by the <code>core.abbrev</code>
694 config option.</p>
695 </dd>
696 <dt class="hdlist1">--no-abbrev</dt>
697 <dd>
698 <p>Display the full sha1s in the output listing rather than abbreviating them.</p>
699 </dd>
700 <dt class="hdlist1">-t</dt>
701 <dt class="hdlist1">--track[=(direct|inherit)]</dt>
702 <dd>
703 <p>When creating a new branch, set up <code>branch.</code><em>&lt;name&gt;</em><code>.remote</code> and
704 <code>branch.</code><em>&lt;name&gt;</em><code>.merge</code> configuration entries to set "upstream" tracking
705 configuration for the new branch. This
706 configuration will tell git to show the relationship between the
707 two branches in <code>git</code> <code>status</code> and <code>git</code> <code>branch</code> <code>-v</code>. Furthermore,
708 it directs <code>git</code> <code>pull</code> without arguments to pull from the
709 upstream when the new branch is checked out.</p>
710 <div class="paragraph">
711 <p>The exact upstream branch is chosen depending on the optional argument:
712 <code>-t</code>, <code>--track</code>, or <code>--track=direct</code> means to use the start-point branch
713 itself as the upstream; <code>--track=inherit</code> means to copy the upstream
714 configuration of the start-point branch.</p>
715 </div>
716 <div class="paragraph">
717 <p>The branch.autoSetupMerge configuration variable specifies how <code>git</code> <code>switch</code>,
718 <code>git</code> <code>checkout</code> and <code>git</code> <code>branch</code> should behave when neither <code>--track</code> nor
719 <code>--no-track</code> are specified:</p>
720 </div>
721 <div class="paragraph">
722 <p>The default option, <code>true</code>, behaves as though <code>--track=direct</code>
723 were given whenever the start-point is a remote-tracking branch.
724 <code>false</code> behaves as if <code>--no-track</code> were given. <code>always</code> behaves as though
725 <code>--track=direct</code> were given. <code>inherit</code> behaves as though <code>--track=inherit</code>
726 were given. <code>simple</code> behaves as though <code>--track=direct</code> were given only when
727 the start-point is a remote-tracking branch and the new branch has the same
728 name as the remote branch.</p>
729 </div>
730 <div class="paragraph">
731 <p>See <a href="git-pull.html">git-pull(1)</a> and <a href="git-config.html">git-config(1)</a> for additional discussion on
732 how the <code>branch.</code><em>&lt;name&gt;</em><code>.remote</code> and <code>branch.</code><em>&lt;name&gt;</em><code>.merge</code> options are used.</p>
733 </div>
734 </dd>
735 <dt class="hdlist1">--no-track</dt>
736 <dd>
737 <p>Do not set up "upstream" configuration, even if the
738 branch.autoSetupMerge configuration variable is set.</p>
739 </dd>
740 <dt class="hdlist1">--recurse-submodules</dt>
741 <dd>
742 <p>THIS OPTION IS EXPERIMENTAL! Causes the current command to
743 recurse into submodules if <code>submodule.propagateBranches</code> is
744 enabled. See <code>submodule.propagateBranches</code> in
745 <a href="git-config.html">git-config(1)</a>. Currently, only branch creation is
746 supported.</p>
747 <div class="paragraph">
748 <p>When used in branch creation, a new branch &lt;branchname&gt; will be created
749 in the superproject and all of the submodules in the superproject&#8217;s
750 &lt;start-point&gt;. In submodules, the branch will point to the submodule
751 commit in the superproject&#8217;s &lt;start-point&gt; but the branch&#8217;s tracking
752 information will be set up based on the submodule&#8217;s branches and remotes
753 e.g. <code>git</code> <code>branch</code> <code>--recurse-submodules</code> <code>topic</code> <code>origin/main</code> will create the
754 submodule branch "topic" that points to the submodule commit in the
755 superproject&#8217;s "origin/main", but tracks the submodule&#8217;s "origin/main".</p>
756 </div>
757 </dd>
758 <dt class="hdlist1">--set-upstream</dt>
759 <dd>
760 <p>As this option had confusing syntax, it is no longer supported.
761 Please use <code>--track</code> or <code>--set-upstream-to</code> instead.</p>
762 </dd>
763 <dt class="hdlist1">-u &lt;upstream&gt;</dt>
764 <dt class="hdlist1">--set-upstream-to=&lt;upstream&gt;</dt>
765 <dd>
766 <p>Set up &lt;branchname&gt;'s tracking information so &lt;upstream&gt; is
767 considered &lt;branchname&gt;'s upstream branch. If no &lt;branchname&gt;
768 is specified, then it defaults to the current branch.</p>
769 </dd>
770 <dt class="hdlist1">--unset-upstream</dt>
771 <dd>
772 <p>Remove the upstream information for &lt;branchname&gt;. If no branch
773 is specified it defaults to the current branch.</p>
774 </dd>
775 <dt class="hdlist1">--edit-description</dt>
776 <dd>
777 <p>Open an editor and edit the text to explain what the branch is
778 for, to be used by various other commands (e.g. <code>format-patch</code>,
779 <code>request-pull</code>, and <code>merge</code> (if enabled)). Multi-line explanations
780 may be used.</p>
781 </dd>
782 <dt class="hdlist1">--contains [&lt;commit&gt;]</dt>
783 <dd>
784 <p>Only list branches which contain the specified commit (HEAD
785 if not specified). Implies <code>--list</code>.</p>
786 </dd>
787 <dt class="hdlist1">--no-contains [&lt;commit&gt;]</dt>
788 <dd>
789 <p>Only list branches which don&#8217;t contain the specified commit
790 (HEAD if not specified). Implies <code>--list</code>.</p>
791 </dd>
792 <dt class="hdlist1">--merged [&lt;commit&gt;]</dt>
793 <dd>
794 <p>Only list branches whose tips are reachable from the
795 specified commit (HEAD if not specified). Implies <code>--list</code>.</p>
796 </dd>
797 <dt class="hdlist1">--no-merged [&lt;commit&gt;]</dt>
798 <dd>
799 <p>Only list branches whose tips are not reachable from the
800 specified commit (HEAD if not specified). Implies <code>--list</code>.</p>
801 </dd>
802 <dt class="hdlist1">&lt;branchname&gt;</dt>
803 <dd>
804 <p>The name of the branch to create or delete.
805 The new branch name must pass all checks defined by
806 <a href="git-check-ref-format.html">git-check-ref-format(1)</a>. Some of these checks
807 may restrict the characters allowed in a branch name.</p>
808 </dd>
809 <dt class="hdlist1">&lt;start-point&gt;</dt>
810 <dd>
811 <p>The new branch head will point to this commit. It may be
812 given as a branch name, a commit-id, or a tag. If this
813 option is omitted, the current HEAD will be used instead.</p>
814 </dd>
815 <dt class="hdlist1">&lt;oldbranch&gt;</dt>
816 <dd>
817 <p>The name of an existing branch. If this option is omitted,
818 the name of the current branch will be used instead.</p>
819 </dd>
820 <dt class="hdlist1">&lt;newbranch&gt;</dt>
821 <dd>
822 <p>The new name for an existing branch. The same restrictions as for
823 &lt;branchname&gt; apply.</p>
824 </dd>
825 <dt class="hdlist1">--sort=&lt;key&gt;</dt>
826 <dd>
827 <p>Sort based on the key given. Prefix <code>-</code> to sort in descending
828 order of the value. You may use the --sort=&lt;key&gt; option
829 multiple times, in which case the last key becomes the primary
830 key. The keys supported are the same as those in <code>git</code>
831 <code>for-each-ref</code>. Sort order defaults to the value configured for the
832 <code>branch.sort</code> variable if it exists, or to sorting based on the
833 full refname (including <code>refs/..</code>. prefix). This lists
834 detached HEAD (if present) first, then local branches and
835 finally remote-tracking branches. See <a href="git-config.html">git-config(1)</a>.</p>
836 </dd>
837 <dt class="hdlist1">--points-at &lt;object&gt;</dt>
838 <dd>
839 <p>Only list branches of the given object.</p>
840 </dd>
841 <dt class="hdlist1">--format &lt;format&gt;</dt>
842 <dd>
843 <p>A string that interpolates %(<code>fieldname</code>) from a branch ref being shown
844 and the object it points at. The format is the same as
845 that of <a href="git-for-each-ref.html">git-for-each-ref(1)</a>.</p>
846 </dd>
847 </dl>
848 </div>
849 </div>
850 </div>
851 <div class="sect1">
852 <h2 id="_configuration">CONFIGURATION</h2>
853 <div class="sectionbody">
854 <div class="paragraph">
855 <p><code>pager.branch</code> is only respected when listing branches, i.e., when
856 <code>--list</code> is used or implied. The default is to use a pager.
857 See <a href="git-config.html">git-config(1)</a>.</p>
858 </div>
859 <div class="paragraph">
860 <p>Everything above this line in this section isn&#8217;t included from the
861 <a href="git-config.html">git-config(1)</a> documentation. The content that follows is the
862 same as what&#8217;s found there:</p>
863 </div>
864 <div class="dlist">
865 <dl>
866 <dt class="hdlist1">branch.autoSetupMerge</dt>
867 <dd>
868 <p>Tells <em>git branch</em>, <em>git switch</em> and <em>git checkout</em> to set up new branches
869 so that <a href="git-pull.html">git-pull(1)</a> will appropriately merge from the
870 starting point branch. Note that even if this option is not set,
871 this behavior can be chosen per-branch using the <code>--track</code>
872 and <code>--no-track</code> options. The valid settings are: <code>false</code>&#8201;&#8212;&#8201;no
873 automatic setup is done; <code>true</code>&#8201;&#8212;&#8201;automatic setup is done when the
874 starting point is a remote-tracking branch; <code>always</code>&#8201;&#8212;&#8201;automatic setup is done when the starting point is either a
875 local branch or remote-tracking branch; <code>inherit</code>&#8201;&#8212;&#8201;if the starting point
876 has a tracking configuration, it is copied to the new
877 branch; <code>simple</code>&#8201;&#8212;&#8201;automatic setup is done only when the starting point
878 is a remote-tracking branch and the new branch has the same name as the
879 remote branch. This option defaults to true.</p>
880 </dd>
881 <dt class="hdlist1">branch.autoSetupRebase</dt>
882 <dd>
883 <p>When a new branch is created with <em>git branch</em>, <em>git switch</em> or <em>git checkout</em>
884 that tracks another branch, this variable tells Git to set
885 up pull to rebase instead of merge (see "branch.&lt;name&gt;.rebase").
886 When <code>never</code>, rebase is never automatically set to true.
887 When <code>local</code>, rebase is set to true for tracked branches of
888 other local branches.
889 When <code>remote</code>, rebase is set to true for tracked branches of
890 remote-tracking branches.
891 When <code>always</code>, rebase will be set to true for all tracking
892 branches.
893 See "branch.autoSetupMerge" for details on how to set up a
894 branch to track another branch.
895 This option defaults to never.</p>
896 </dd>
897 <dt class="hdlist1">branch.sort</dt>
898 <dd>
899 <p>This variable controls the sort ordering of branches when displayed by
900 <a href="git-branch.html">git-branch(1)</a>. Without the "--sort=&lt;value&gt;" option provided, the
901 value of this variable will be used as the default.
902 See <a href="git-for-each-ref.html">git-for-each-ref(1)</a> field names for valid values.</p>
903 </dd>
904 <dt class="hdlist1">branch.&lt;name&gt;.remote</dt>
905 <dd>
906 <p>When on branch &lt;name&gt;, it tells <em>git fetch</em> and <em>git push</em>
907 which remote to fetch from or push to. The remote to push to
908 may be overridden with <code>remote.pushDefault</code> (for all branches).
909 The remote to push to, for the current branch, may be further
910 overridden by <code>branch.</code><em>&lt;name&gt;</em><code>.pushRemote</code>. If no remote is
911 configured, or if you are not on any branch and there is more than
912 one remote defined in the repository, it defaults to <code>origin</code> for
913 fetching and <code>remote.pushDefault</code> for pushing.
914 Additionally, . (a period) is the current local repository
915 (a dot-repository), see <code>branch.</code><em>&lt;name&gt;</em><code>.merge</code>'s final note below.</p>
916 </dd>
917 <dt class="hdlist1">branch.&lt;name&gt;.pushRemote</dt>
918 <dd>
919 <p>When on branch &lt;name&gt;, it overrides <code>branch.</code><em>&lt;name&gt;</em><code>.remote</code> for
920 pushing. It also overrides <code>remote.pushDefault</code> for pushing
921 from branch &lt;name&gt;. When you pull from one place (e.g. your
922 upstream) and push to another place (e.g. your own publishing
923 repository), you would want to set <code>remote.pushDefault</code> to
924 specify the remote to push to for all branches, and use this
925 option to override it for a specific branch.</p>
926 </dd>
927 <dt class="hdlist1">branch.&lt;name&gt;.merge</dt>
928 <dd>
929 <p>Defines, together with branch.&lt;name&gt;.remote, the upstream branch
930 for the given branch. It tells <em>git fetch</em>/<em>git pull</em>/<em>git rebase</em> which
931 branch to merge and can also affect <em>git push</em> (see push.default).
932 When in branch &lt;name&gt;, it tells <em>git fetch</em> the default
933 refspec to be marked for merging in FETCH_HEAD. The value is
934 handled like the remote part of a refspec, and must match a
935 ref which is fetched from the remote given by
936 "branch.&lt;name&gt;.remote".
937 The merge information is used by <em>git pull</em> (which first calls
938 <em>git fetch</em>) to lookup the default branch for merging. Without
939 this option, <em>git pull</em> defaults to merge the first refspec fetched.
940 Specify multiple values to get an octopus merge.
941 If you wish to setup <em>git pull</em> so that it merges into &lt;name&gt; from
942 another branch in the local repository, you can point
943 branch.&lt;name&gt;.merge to the desired branch, and use the relative path
944 setting . (a period) for branch.&lt;name&gt;.remote.</p>
945 </dd>
946 <dt class="hdlist1">branch.&lt;name&gt;.mergeOptions</dt>
947 <dd>
948 <p>Sets default options for merging into branch &lt;name&gt;. The syntax and
949 supported options are the same as those of <a href="git-merge.html">git-merge(1)</a>, but
950 option values containing whitespace characters are currently not
951 supported.</p>
952 </dd>
953 <dt class="hdlist1">branch.&lt;name&gt;.rebase</dt>
954 <dd>
955 <p>When true, rebase the branch &lt;name&gt; on top of the fetched branch,
956 instead of merging the default branch from the default remote when
957 "git pull" is run. See "pull.rebase" for doing this in a non
958 branch-specific manner.</p>
959 <div class="paragraph">
960 <p>When <code>merges</code> (or just <em>m</em>), pass the <code>--rebase-merges</code> option to <em>git rebase</em>
961 so that the local merge commits are included in the rebase (see
962 <a href="git-rebase.html">git-rebase(1)</a> for details).</p>
963 </div>
964 <div class="paragraph">
965 <p>When the value is <code>interactive</code> (or just <em>i</em>), the rebase is run in interactive
966 mode.</p>
967 </div>
968 <div class="paragraph">
969 <p><strong>NOTE</strong>: this is a possibly dangerous operation; do <strong>not</strong> use
970 it unless you understand the implications (see <a href="git-rebase.html">git-rebase(1)</a>
971 for details).</p>
972 </div>
973 </dd>
974 <dt class="hdlist1">branch.&lt;name&gt;.description</dt>
975 <dd>
976 <p>Branch description, can be edited with
977 <code>git</code> <code>branch</code> <code>--edit-description</code>. Branch description is
978 automatically added to the format-patch cover letter or
979 request-pull summary.</p>
980 </dd>
981 </dl>
982 </div>
983 </div>
984 </div>
985 <div class="sect1">
986 <h2 id="_examples">EXAMPLES</h2>
987 <div class="sectionbody">
988 <div class="dlist">
989 <dl>
990 <dt class="hdlist1">Start development from a known tag</dt>
991 <dd>
992 <div class="listingblock">
993 <div class="content">
994 <pre>$ git clone git://git.kernel.org/pub/scm/.../linux-2.6 my2.6
995 $ cd my2.6
996 $ git branch my2.6.14 v2.6.14 <b class="conum">(1)</b>
997 $ git switch my2.6.14</pre>
998 </div>
999 </div>
1000 <div class="colist arabic">
1001 <ol>
1002 <li>
1003 <p>This step and the next one could be combined into a single step with
1004 "checkout -b my2.6.14 v2.6.14".</p>
1005 </li>
1006 </ol>
1007 </div>
1008 </dd>
1009 <dt class="hdlist1">Delete an unneeded branch</dt>
1010 <dd>
1011 <div class="listingblock">
1012 <div class="content">
1013 <pre>$ git clone git://git.kernel.org/.../git.git my.git
1014 $ cd my.git
1015 $ git branch -d -r origin/todo origin/html origin/man <b class="conum">(1)</b>
1016 $ git branch -D test <b class="conum">(2)</b></pre>
1017 </div>
1018 </div>
1019 <div class="colist arabic">
1020 <ol>
1021 <li>
1022 <p>Delete the remote-tracking branches "todo", "html" and "man". The next
1023 <em>fetch</em> or <em>pull</em> will create them again unless you configure them not to.
1024 See <a href="git-fetch.html">git-fetch(1)</a>.</p>
1025 </li>
1026 <li>
1027 <p>Delete the "test" branch even if the "master" branch (or whichever branch
1028 is currently checked out) does not have all commits from the test branch.</p>
1029 </li>
1030 </ol>
1031 </div>
1032 </dd>
1033 <dt class="hdlist1">Listing branches from a specific remote</dt>
1034 <dd>
1035 <div class="listingblock">
1036 <div class="content">
1037 <pre>$ git branch -r -l '&lt;remote&gt;/&lt;pattern&gt;' <b class="conum">(1)</b>
1038 $ git for-each-ref 'refs/remotes/&lt;remote&gt;/&lt;pattern&gt;' <b class="conum">(2)</b></pre>
1039 </div>
1040 </div>
1041 <div class="colist arabic">
1042 <ol>
1043 <li>
1044 <p>Using <code>-a</code> would conflate &lt;remote&gt; with any local branches you happen to
1045 have been prefixed with the same &lt;remote&gt; pattern.</p>
1046 </li>
1047 <li>
1048 <p><code>for-each-ref</code> can take a wide range of options. See <a href="git-for-each-ref.html">git-for-each-ref(1)</a></p>
1049 </li>
1050 </ol>
1051 </div>
1052 </dd>
1053 </dl>
1054 </div>
1055 <div class="paragraph">
1056 <p>Patterns will normally need quoting.</p>
1057 </div>
1058 </div>
1059 </div>
1060 <div class="sect1">
1061 <h2 id="_notes">NOTES</h2>
1062 <div class="sectionbody">
1063 <div class="paragraph">
1064 <p>If you are creating a branch that you want to switch to immediately,
1065 it is easier to use the "git switch" command with its <code>-c</code> option to
1066 do the same thing with a single command.</p>
1067 </div>
1068 <div class="paragraph">
1069 <p>The options <code>--contains</code>, <code>--no-contains</code>, <code>--merged</code> and <code>--no-merged</code>
1070 serve four related but different purposes:</p>
1071 </div>
1072 <div class="ulist">
1073 <ul>
1074 <li>
1075 <p><code>--contains</code> <em>&lt;commit&gt;</em> is used to find all branches which will need
1076 special attention if &lt;commit&gt; were to be rebased or amended, since those
1077 branches contain the specified &lt;commit&gt;.</p>
1078 </li>
1079 <li>
1080 <p><code>--no-contains</code> <em>&lt;commit&gt;</em> is the inverse of that, i.e. branches that don&#8217;t
1081 contain the specified &lt;commit&gt;.</p>
1082 </li>
1083 <li>
1084 <p><code>--merged</code> is used to find all branches which can be safely deleted,
1085 since those branches are fully contained by HEAD.</p>
1086 </li>
1087 <li>
1088 <p><code>--no-merged</code> is used to find branches which are candidates for merging
1089 into HEAD, since those branches are not fully contained by HEAD.</p>
1090 </li>
1091 </ul>
1092 </div>
1093 <div class="paragraph">
1094 <p>When combining multiple <code>--contains</code> and <code>--no-contains</code> filters, only
1095 references that contain at least one of the <code>--contains</code> commits and
1096 contain none of the <code>--no-contains</code> commits are shown.</p>
1097 </div>
1098 <div class="paragraph">
1099 <p>When combining multiple <code>--merged</code> and <code>--no-merged</code> filters, only
1100 references that are reachable from at least one of the <code>--merged</code>
1101 commits and from none of the <code>--no-merged</code> commits are shown.</p>
1102 </div>
1103 </div>
1104 </div>
1105 <div class="sect1">
1106 <h2 id="_see_also">SEE ALSO</h2>
1107 <div class="sectionbody">
1108 <div class="paragraph">
1109 <p><a href="git-check-ref-format.html">git-check-ref-format(1)</a>,
1110 <a href="git-fetch.html">git-fetch(1)</a>,
1111 <a href="git-remote.html">git-remote(1)</a>,
1112 <a href="user-manual.html#what-is-a-branch">&#8220;Understanding history: What is
1113 a branch?&#8221;</a> in the Git User&#8217;s Manual.</p>
1114 </div>
1115 </div>
1116 </div>
1117 <div class="sect1">
1118 <h2 id="_git">GIT</h2>
1119 <div class="sectionbody">
1120 <div class="paragraph">
1121 <p>Part of the <a href="git.html">git(1)</a> suite</p>
1122 </div>
1123 </div>
1124 </div>
1125 </div>
1126 <div id="footer">
1127 <div id="footer-text">
1128 Last updated 2024-01-19 16:47:36 -0800
1129 </div>
1130 </div>
1131 </body>
1132 </html>