| <!DOCTYPE html> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"/> |
| <meta name="generator" content="Asciidoctor 2.0.23"/> |
| <title>git-worktree(1)</title> |
| <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"/> |
| <style> |
| /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */ |
| /* Uncomment the following line when using as a custom stylesheet */ |
| /* @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"; */ |
| html{font-family:sans-serif;-webkit-text-size-adjust:100%} |
| a{background:none} |
| a:focus{outline:thin dotted} |
| a:active,a:hover{outline:0} |
| h1{font-size:2em;margin:.67em 0} |
| b,strong{font-weight:bold} |
| abbr{font-size:.9em} |
| abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none} |
| dfn{font-style:italic} |
| hr{height:0} |
| mark{background:#ff0;color:#000} |
| code,kbd,pre,samp{font-family:monospace;font-size:1em} |
| pre{white-space:pre-wrap} |
| q{quotes:"\201C" "\201D" "\2018" "\2019"} |
| small{font-size:80%} |
| sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} |
| sup{top:-.5em} |
| sub{bottom:-.25em} |
| img{border:0} |
| svg:not(:root){overflow:hidden} |
| figure{margin:0} |
| audio,video{display:inline-block} |
| audio:not([controls]){display:none;height:0} |
| fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} |
| legend{border:0;padding:0} |
| button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} |
| button,input{line-height:normal} |
| button,select{text-transform:none} |
| button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer} |
| button[disabled],html input[disabled]{cursor:default} |
| input[type=checkbox],input[type=radio]{padding:0} |
| button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} |
| textarea{overflow:auto;vertical-align:top} |
| table{border-collapse:collapse;border-spacing:0} |
| *,::before,::after{box-sizing:border-box} |
| html,body{font-size:100%} |
| 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} |
| a:hover{cursor:pointer} |
| img,object,embed{max-width:100%;height:auto} |
| object,embed{height:100%} |
| img{-ms-interpolation-mode:bicubic} |
| .left{float:left!important} |
| .right{float:right!important} |
| .text-left{text-align:left!important} |
| .text-right{text-align:right!important} |
| .text-center{text-align:center!important} |
| .text-justify{text-align:justify!important} |
| .hide{display:none} |
| img,object,svg{display:inline-block;vertical-align:middle} |
| textarea{height:auto;min-height:50px} |
| select{width:100%} |
| .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} |
| 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} |
| a{color:#2156a5;text-decoration:underline;line-height:inherit} |
| a:hover,a:focus{color:#1d4b8f} |
| a img{border:0} |
| p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} |
| p aside{font-size:.875em;line-height:1.35;font-style:italic} |
| 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} |
| 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} |
| h1{font-size:2.125em} |
| h2{font-size:1.6875em} |
| h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} |
| h4,h5{font-size:1.125em} |
| h6{font-size:1em} |
| hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em} |
| em,i{font-style:italic;line-height:inherit} |
| strong,b{font-weight:bold;line-height:inherit} |
| small{font-size:60%;line-height:inherit} |
| code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} |
| ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} |
| ul,ol{margin-left:1.5em} |
| ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0} |
| ul.circle{list-style-type:circle} |
| ul.disc{list-style-type:disc} |
| ul.square{list-style-type:square} |
| ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit} |
| ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} |
| dl dt{margin-bottom:.3125em;font-weight:bold} |
| dl dd{margin-bottom:1.25em} |
| blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} |
| blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} |
| @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} |
| h1{font-size:2.75em} |
| h2{font-size:2.3125em} |
| h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} |
| h4{font-size:1.4375em}} |
| table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal} |
| table thead,table tfoot{background:#f7f8f7} |
| 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} |
| table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} |
| table tr.even,table tr.alt{background:#f8f8f7} |
| table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6} |
| h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} |
| h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} |
| .center{margin-left:auto;margin-right:auto} |
| .stretch{width:100%} |
| .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table} |
| .clearfix::after,.float-group::after{clear:both} |
| :not(pre).nobreak{word-wrap:normal} |
| :not(pre).nowrap{white-space:nowrap} |
| :not(pre).pre-wrap{white-space:pre-wrap} |
| :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} |
| pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed} |
| pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit} |
| pre>code{display:block} |
| pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal} |
| em em{font-style:normal} |
| strong strong{font-weight:400} |
| .keyseq{color:rgba(51,51,51,.8)} |
| 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} |
| .keyseq kbd:first-child{margin-left:0} |
| .keyseq kbd:last-child{margin-right:0} |
| .menuseq,.menuref{color:#000} |
| .menuseq b:not(.caret),.menuref{font-weight:inherit} |
| .menuseq{word-spacing:-.02em} |
| .menuseq b.caret{font-size:1.25em;line-height:.8} |
| .menuseq i.caret{font-weight:bold;text-align:center;width:.45em} |
| b.button::before,b.button::after{position:relative;top:-1px;font-weight:400} |
| b.button::before{content:"[";padding:0 3px 0 2px} |
| b.button::after{content:"]";padding:0 2px 0 3px} |
| p a>code:hover{color:rgba(0,0,0,.9)} |
| #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} |
| #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table} |
| #header::after,#content::after,#footnotes::after,#footer::after{clear:both} |
| #content{margin-top:1.25em} |
| #content::before{content:none} |
| #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} |
| #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf} |
| #header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px} |
| #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} |
| #header .details span:first-child{margin-left:-.125em} |
| #header .details span.email a{color:rgba(0,0,0,.85)} |
| #header .details br{display:none} |
| #header .details br+span::before{content:"\00a0\2013\00a0"} |
| #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} |
| #header .details br+span#revremark::before{content:"\00a0|\00a0"} |
| #header #revnumber{text-transform:capitalize} |
| #header #revnumber::after{content:"\00a0"} |
| #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} |
| #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em} |
| #toc>ul{margin-left:.125em} |
| #toc ul.sectlevel0>li>a{font-style:italic} |
| #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} |
| #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} |
| #toc li{line-height:1.3334;margin-top:.3334em} |
| #toc a{text-decoration:none} |
| #toc a:active{text-decoration:underline} |
| #toctitle{color:#7a2518;font-size:1.2em} |
| @media screen and (min-width:768px){#toctitle{font-size:1.375em} |
| body.toc2{padding-left:15em;padding-right:0} |
| body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px} |
| #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} |
| #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em} |
| #toc.toc2>ul{font-size:.9em;margin-bottom:0} |
| #toc.toc2 ul ul{margin-left:0;padding-left:1em} |
| #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} |
| body.toc2.toc-right{padding-left:0;padding-right:15em} |
| body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}} |
| @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} |
| #toc.toc2{width:20em} |
| #toc.toc2 #toctitle{font-size:1.375em} |
| #toc.toc2>ul{font-size:.95em} |
| #toc.toc2 ul ul{padding-left:1.25em} |
| body.toc2.toc-right{padding-left:0;padding-right:20em}} |
| #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px} |
| #content #toc>:first-child{margin-top:0} |
| #content #toc>:last-child{margin-bottom:0} |
| #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em} |
| #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44} |
| #content{margin-bottom:.625em} |
| .sect1{padding-bottom:.625em} |
| @media screen and (min-width:768px){#content{margin-bottom:1.25em} |
| .sect1{padding-bottom:1.25em}} |
| .sect1:last-child{padding-bottom:0} |
| .sect1+.sect1{border-top:1px solid #e7e7e9} |
| #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} |
| #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} |
| #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} |
| #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} |
| #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} |
| details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} |
| details{margin-left:1.25rem} |
| details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent} |
| details>summary::-webkit-details-marker{display:none} |
| 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%)} |
| details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)} |
| details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem} |
| .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} |
| table.tableblock.fit-content>caption.title{white-space:nowrap;width:0} |
| .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)} |
| .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} |
| .admonitionblock>table td.icon{text-align:center;width:80px} |
| .admonitionblock>table td.icon img{max-width:none} |
| .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} |
| .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} |
| .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} |
| .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px} |
| .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px} |
| .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} |
| .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0} |
| .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} |
| .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em} |
| @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}} |
| @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}} |
| .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8} |
| .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)} |
| .listingblock>.content{position:relative} |
| .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} |
| .listingblock:hover code[data-lang]::before{display:block} |
| .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5} |
| .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"} |
| .listingblock pre.highlightjs{padding:0} |
| .listingblock pre.highlightjs>code{padding:1em;border-radius:4px} |
| .listingblock pre.prettyprint{border-width:0} |
| .prettyprint{background:#f7f7f8} |
| pre.prettyprint .linenums{line-height:1.45;margin-left:2em} |
| pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0} |
| pre.prettyprint li code[data-lang]::before{opacity:1} |
| pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none} |
| table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none} |
| table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal} |
| table.linenotable td.code{padding-left:.75em} |
| 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} |
| pre.pygments span.linenos{display:inline-block;margin-right:.75em} |
| .quoteblock{margin:0 1em 1.25em 1.5em;display:table} |
| .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em} |
| .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} |
| .quoteblock blockquote{margin:0;padding:0;border:0} |
| .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)} |
| .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} |
| .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right} |
| .verseblock{margin:0 1em 1.25em} |
| .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} |
| .verseblock pre strong{font-weight:400} |
| .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} |
| .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} |
| .quoteblock .attribution br,.verseblock .attribution br{display:none} |
| .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)} |
| .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none} |
| .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} |
| .quoteblock.abstract{margin:0 1em 1.25em;display:block} |
| .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center} |
| .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf} |
| .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0} |
| .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem} |
| .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0} |
| p.tableblock:last-child{margin-bottom:0} |
| td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere} |
| td.tableblock>.content>:last-child{margin-bottom:-1.25em} |
| table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} |
| table.grid-all>*>tr>*{border-width:1px} |
| table.grid-cols>*>tr>*{border-width:0 1px} |
| table.grid-rows>*>tr>*{border-width:1px 0} |
| table.frame-all{border-width:1px} |
| table.frame-ends{border-width:1px 0} |
| table.frame-sides{border-width:0 1px} |
| table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0} |
| table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0} |
| table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0} |
| table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0} |
| 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} |
| th.halign-left,td.halign-left{text-align:left} |
| th.halign-right,td.halign-right{text-align:right} |
| th.halign-center,td.halign-center{text-align:center} |
| th.valign-top,td.valign-top{vertical-align:top} |
| th.valign-bottom,td.valign-bottom{vertical-align:bottom} |
| th.valign-middle,td.valign-middle{vertical-align:middle} |
| table thead th,table tfoot th{font-weight:bold} |
| tbody tr th{background:#f7f8f7} |
| tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} |
| p.tableblock>code:only-child{background:none;padding:0} |
| p.tableblock{font-size:1em} |
| ol{margin-left:1.75em} |
| ul li ol{margin-left:1.5em} |
| dl dd{margin-left:1.125em} |
| dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} |
| li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} |
| ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none} |
| ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em} |
| ul.unstyled,ol.unstyled{margin-left:0} |
| li>p:empty:only-child::before{content:"";display:inline-block} |
| ul.checklist>li>p:first-child{margin-left:-1em} |
| 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} |
| ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em} |
| ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em} |
| ul.inline>li{margin-left:1.25em} |
| .unstyled dl dt{font-weight:400;font-style:normal} |
| ol.arabic{list-style-type:decimal} |
| ol.decimal{list-style-type:decimal-leading-zero} |
| ol.loweralpha{list-style-type:lower-alpha} |
| ol.upperalpha{list-style-type:upper-alpha} |
| ol.lowerroman{list-style-type:lower-roman} |
| ol.upperroman{list-style-type:upper-roman} |
| ol.lowergreek{list-style-type:lower-greek} |
| .hdlist>table,.colist>table{border:0;background:none} |
| .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} |
| td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em} |
| td.hdlist1{font-weight:bold;padding-bottom:1.25em} |
| td.hdlist2{word-wrap:anywhere} |
| .literalblock+.colist,.listingblock+.colist{margin-top:-.5em} |
| .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top} |
| .colist td:not([class]):first-child img{max-width:none} |
| .colist td:not([class]):last-child{padding:.25em 0} |
| .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd} |
| .imageblock.left{margin:.25em .625em 1.25em 0} |
| .imageblock.right{margin:.25em 0 1.25em .625em} |
| .imageblock>.title{margin-bottom:0} |
| .imageblock.thumb,.imageblock.th{border-width:6px} |
| .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} |
| .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} |
| .image.left{margin-right:.625em} |
| .image.right{margin-left:.625em} |
| a.image{text-decoration:none;display:inline-block} |
| a.image object{pointer-events:none} |
| sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super} |
| sup.footnote a,sup.footnoteref a{text-decoration:none} |
| sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline} |
| #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} |
| #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0} |
| #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em} |
| #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em} |
| #footnotes .footnote:last-of-type{margin-bottom:0} |
| #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} |
| div.unbreakable{page-break-inside:avoid} |
| .big{font-size:larger} |
| .small{font-size:smaller} |
| .underline{text-decoration:underline} |
| .overline{text-decoration:overline} |
| .line-through{text-decoration:line-through} |
| .aqua{color:#00bfbf} |
| .aqua-background{background:#00fafa} |
| .black{color:#000} |
| .black-background{background:#000} |
| .blue{color:#0000bf} |
| .blue-background{background:#0000fa} |
| .fuchsia{color:#bf00bf} |
| .fuchsia-background{background:#fa00fa} |
| .gray{color:#606060} |
| .gray-background{background:#7d7d7d} |
| .green{color:#006000} |
| .green-background{background:#007d00} |
| .lime{color:#00bf00} |
| .lime-background{background:#00fa00} |
| .maroon{color:#600000} |
| .maroon-background{background:#7d0000} |
| .navy{color:#000060} |
| .navy-background{background:#00007d} |
| .olive{color:#606000} |
| .olive-background{background:#7d7d00} |
| .purple{color:#600060} |
| .purple-background{background:#7d007d} |
| .red{color:#bf0000} |
| .red-background{background:#fa0000} |
| .silver{color:#909090} |
| .silver-background{background:#bcbcbc} |
| .teal{color:#006060} |
| .teal-background{background:#007d7d} |
| .white{color:#bfbfbf} |
| .white-background{background:#fafafa} |
| .yellow{color:#bfbf00} |
| .yellow-background{background:#fafa00} |
| span.icon>.fa{cursor:default} |
| a span.icon>.fa{cursor:inherit} |
| .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} |
| .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c} |
| .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} |
| .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900} |
| .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400} |
| .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000} |
| .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} |
| .conum[data-value] *{color:#fff!important} |
| .conum[data-value]+b{display:none} |
| .conum[data-value]::after{content:attr(data-value)} |
| pre .conum[data-value]{position:relative;top:-.125em} |
| b.conum *{color:inherit!important} |
| .conum:not([data-value]):empty{display:none} |
| dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility} |
| h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em} |
| p strong,td.content strong,div.footnote strong{letter-spacing:-.005em} |
| p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem} |
| p{margin-bottom:1.25rem} |
| .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} |
| .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc} |
| .print-only{display:none!important} |
| @page{margin:1.25cm .75cm} |
| @media print{*{box-shadow:none!important;text-shadow:none!important} |
| html{font-size:80%} |
| a{color:inherit!important;text-decoration:underline!important} |
| a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} |
| a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} |
| abbr[title]{border-bottom:1px dotted} |
| abbr[title]::after{content:" (" attr(title) ")"} |
| pre,blockquote,tr,img,object,svg{page-break-inside:avoid} |
| thead{display:table-header-group} |
| svg{max-width:100%} |
| p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} |
| h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} |
| #header,#content,#footnotes,#footer{max-width:none} |
| #toc,.sidebarblock,.exampleblock>.content{background:none!important} |
| #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important} |
| body.book #header{text-align:center} |
| body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em} |
| body.book #header .details{border:0!important;display:block;padding:0!important} |
| body.book #header .details span:first-child{margin-left:0!important} |
| body.book #header .details br{display:block} |
| body.book #header .details br+span::before{content:none!important} |
| body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} |
| body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} |
| .listingblock code[data-lang]::before{display:block} |
| #footer{padding:0 .9375em} |
| .hide-on-print{display:none!important} |
| .print-only{display:block!important} |
| .hide-for-print{display:none!important} |
| .show-for-print{display:inherit!important}} |
| @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem} |
| .sect1{padding:0!important} |
| .sect1+.sect1{border:0} |
| #footer{background:none} |
| #footer-text{color:rgba(0,0,0,.6);font-size:.9em}} |
| @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}} |
| </style> |
| <style> |
| pre>code { |
| display: inline; |
| } |
| </style> |
| </head> |
| <body class="manpage"> |
| <div id="header"> |
| <h1>git-worktree(1) Manual Page</h1> |
| <h2 id="_name">NAME</h2> |
| <div class="sectionbody"> |
| <p>git-worktree - Manage multiple working trees</p> |
| </div> |
| </div> |
| <div id="content"> |
| <div class="sect1"> |
| <h2 id="_synopsis">SYNOPSIS</h2> |
| <div class="sectionbody"> |
| <div class="verseblock"> |
| <pre class="content"><em>git worktree add</em> [-f] [--detach] [--checkout] [--lock [--reason <string>]] |
| [--orphan] [(-b | -B) <new-branch>] <path> [<commit-ish>] |
| <em>git worktree list</em> [-v | --porcelain [-z]] |
| <em>git worktree lock</em> [--reason <string>] <worktree> |
| <em>git worktree move</em> <worktree> <new-path> |
| <em>git worktree prune</em> [-n] [-v] [--expire <expire>] |
| <em>git worktree remove</em> [-f] <worktree> |
| <em>git worktree repair</em> [<path>…​] |
| <em>git worktree unlock</em> <worktree></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_description">DESCRIPTION</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Manage multiple working trees attached to the same repository.</p> |
| </div> |
| <div class="paragraph"> |
| <p>A git repository can support multiple working trees, allowing you to check |
| out more than one branch at a time. With <code>git</code> <code>worktree</code> <code>add</code> a new working |
| tree is associated with the repository, along with additional metadata |
| that differentiates that working tree from others in the same repository. |
| The working tree, along with this metadata, is called a "worktree".</p> |
| </div> |
| <div class="paragraph"> |
| <p>This new worktree is called a "linked worktree" as opposed to the "main |
| worktree" prepared by <a href="git-init.html">git-init(1)</a> or <a href="git-clone.html">git-clone(1)</a>. |
| A repository has one main worktree (if it’s not a bare repository) and |
| zero or more linked worktrees. When you are done with a linked worktree, |
| remove it with <code>git</code> <code>worktree</code> <code>remove</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>In its simplest form, <code>git</code> <code>worktree</code> <code>add</code> <em><path></em> automatically creates a |
| new branch whose name is the final component of <em><path></em>, which is |
| convenient if you plan to work on a new topic. For instance, <code>git</code> |
| <code>worktree</code> <code>add</code> <code>..</code><code>/hotfix</code> creates new branch <code>hotfix</code> and checks it out at |
| path <code>..</code><code>/hotfix</code>. To instead work on an existing branch in a new worktree, |
| use <code>git</code> <code>worktree</code> <code>add</code> <em><path></em> <em><branch></em>. On the other hand, if you just |
| plan to make some experimental changes or do testing without disturbing |
| existing development, it is often convenient to create a <em>throwaway</em> |
| worktree not associated with any branch. For instance, |
| <code>git</code> <code>worktree</code> <code>add</code> <code>-d</code> <em><path></em> creates a new worktree with a detached <code>HEAD</code> |
| at the same commit as the current branch.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If a working tree is deleted without using <code>git</code> <code>worktree</code> <code>remove</code>, then |
| its associated administrative files, which reside in the repository |
| (see "DETAILS" below), will eventually be removed automatically (see |
| <code>gc.worktreePruneExpire</code> in <a href="git-config.html">git-config(1)</a>), or you can run |
| <code>git</code> <code>worktree</code> <code>prune</code> in the main or any linked worktree to clean up any |
| stale administrative files.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If the working tree for a linked worktree is stored on a portable device |
| or network share which is not always mounted, you can prevent its |
| administrative files from being pruned by issuing the <code>git</code> <code>worktree</code> <code>lock</code> |
| command, optionally specifying <code>--reason</code> to explain why the worktree is |
| locked.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_commands">COMMANDS</h2> |
| <div class="sectionbody"> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">add <path> [<commit-ish>]</dt> |
| <dd> |
| <p>Create a worktree at <em><path></em> and checkout <em><commit-ish></em> into it. The new worktree |
| is linked to the current repository, sharing everything except per-worktree |
| files such as <code>HEAD</code>, <code>index</code>, etc. As a convenience, <em><commit-ish></em> may |
| be a bare "<code>-</code>", which is synonymous with <code>@</code>{-1}.</p> |
| <div class="paragraph"> |
| <p>If <em><commit-ish></em> is a branch name (call it <em><branch></em>) and is not found, |
| and neither <code>-b</code> nor <code>-B</code> nor <code>--detach</code> are used, but there does |
| exist a tracking branch in exactly one remote (call it <em><remote></em>) |
| with a matching name, treat as equivalent to:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git worktree add --track -b <branch> <path> <remote>/<branch></pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>If the branch exists in multiple remotes and one of them is named by |
| the <code>checkout.defaultRemote</code> configuration variable, we’ll use that |
| one for the purposes of disambiguation, even if the <em><branch></em> isn’t |
| unique across all remotes. Set it to |
| e.g. <code>checkout.defaultRemote=origin</code> to always checkout remote |
| branches from there if <em><branch></em> is ambiguous but exists on the |
| <code>origin</code> remote. See also <code>checkout.defaultRemote</code> in |
| <a href="git-config.html">git-config(1)</a>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <em><commit-ish></em> is omitted and neither <code>-b</code> nor <code>-B</code> nor <code>--detach</code> used, |
| then, as a convenience, the new worktree is associated with a branch (call |
| it <em><branch></em>) named after <code>$</code>(<code>basename</code> <em><path></em>). If <em><branch></em> doesn’t |
| exist, a new branch based on <code>HEAD</code> is automatically created as if |
| <code>-b</code> <em><branch></em> was given. If <em><branch></em> does exist, it will be checked out |
| in the new worktree, if it’s not checked out anywhere else, otherwise the |
| command will refuse to create the worktree (unless <code>--force</code> is used).</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <em><commit-ish></em> is omitted, neither <code>--detach</code>, or <code>--orphan</code> is |
| used, and there are no valid local branches (or remote branches if |
| <code>--guess-remote</code> is specified) then, as a convenience, the new worktree is |
| associated with a new unborn branch named <em><branch></em> (after |
| <code>$</code>(<code>basename</code> <em><path></em>) if neither <code>-b</code> or <code>-B</code> is used) as if <code>--orphan</code> was |
| passed to the command. In the event the repository has a remote and |
| <code>--guess-remote</code> is used, but no remote or local branches exist, then the |
| command fails with a warning reminding the user to fetch from their remote |
| first (or override by using <code>-f/--force</code>).</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">list</dt> |
| <dd> |
| <p>List details of each worktree. The main worktree is listed first, |
| followed by each of the linked worktrees. The output details include |
| whether the worktree is bare, the revision currently checked out, the |
| branch currently checked out (or "detached HEAD" if none), "locked" if |
| the worktree is locked, "prunable" if the worktree can be pruned by the |
| <code>prune</code> command.</p> |
| </dd> |
| <dt class="hdlist1">lock</dt> |
| <dd> |
| <p>If a worktree is on a portable device or network share which is not always |
| mounted, lock it to prevent its administrative files from being pruned |
| automatically. This also prevents it from being moved or deleted. |
| Optionally, specify a reason for the lock with <code>--reason</code>.</p> |
| </dd> |
| <dt class="hdlist1">move</dt> |
| <dd> |
| <p>Move a worktree to a new location. Note that the main worktree or linked |
| worktrees containing submodules cannot be moved with this command. (The |
| <code>git</code> <code>worktree</code> <code>repair</code> command, however, can reestablish the connection |
| with linked worktrees if you move the main worktree manually.)</p> |
| </dd> |
| <dt class="hdlist1">prune</dt> |
| <dd> |
| <p>Prune worktree information in <code>$GIT_DIR/worktrees</code>.</p> |
| </dd> |
| <dt class="hdlist1">remove</dt> |
| <dd> |
| <p>Remove a worktree. Only clean worktrees (no untracked files and no |
| modification in tracked files) can be removed. Unclean worktrees or ones |
| with submodules can be removed with <code>--force</code>. The main worktree cannot be |
| removed.</p> |
| </dd> |
| <dt class="hdlist1">repair [<path>…​]</dt> |
| <dd> |
| <p>Repair worktree administrative files, if possible, if they have become |
| corrupted or outdated due to external factors.</p> |
| <div class="paragraph"> |
| <p>For instance, if the main worktree (or bare repository) is moved, linked |
| worktrees will be unable to locate it. Running <code>repair</code> in the main |
| worktree will reestablish the connection from linked worktrees back to the |
| main worktree.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Similarly, if the working tree for a linked worktree is moved without |
| using <code>git</code> <code>worktree</code> <code>move</code>, the main worktree (or bare repository) will be |
| unable to locate it. Running <code>repair</code> within the recently-moved worktree |
| will reestablish the connection. If multiple linked worktrees are moved, |
| running <code>repair</code> from any worktree with each tree’s new <em><path></em> as an |
| argument, will reestablish the connection to all the specified paths.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If both the main worktree and linked worktrees have been moved or copied manually, |
| then running <code>repair</code> in the main worktree and specifying the new <em><path></em> |
| of each linked worktree will reestablish all connections in both |
| directions.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">unlock</dt> |
| <dd> |
| <p>Unlock a worktree, allowing it to be pruned, moved or deleted.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_options">OPTIONS</h2> |
| <div class="sectionbody"> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">-f</dt> |
| <dt class="hdlist1">--force</dt> |
| <dd> |
| <p>By default, <code>add</code> refuses to create a new worktree when |
| <em><commit-ish></em> is a branch name and is already checked out by |
| another worktree, or if <em><path></em> is already assigned to some |
| worktree but is missing (for instance, if <em><path></em> was deleted |
| manually). This option overrides these safeguards. To add a missing but |
| locked worktree path, specify <code>--force</code> twice.</p> |
| <div class="paragraph"> |
| <p><code>move</code> refuses to move a locked worktree unless <code>--force</code> is specified |
| twice. If the destination is already assigned to some other worktree but is |
| missing (for instance, if <em><new-path></em> was deleted manually), then <code>--force</code> |
| allows the move to proceed; use <code>--force</code> twice if the destination is locked.</p> |
| </div> |
| <div class="paragraph"> |
| <p><code>remove</code> refuses to remove an unclean worktree unless <code>--force</code> is used. |
| To remove a locked worktree, specify <code>--force</code> twice.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">-b <new-branch></dt> |
| <dt class="hdlist1">-B <new-branch></dt> |
| <dd> |
| <p>With <code>add</code>, create a new branch named <em><new-branch></em> starting at |
| <em><commit-ish></em>, and check out <em><new-branch></em> into the new worktree. |
| If <em><commit-ish></em> is omitted, it defaults to <code>HEAD</code>. |
| By default, <code>-b</code> refuses to create a new branch if it already |
| exists. <code>-B</code> overrides this safeguard, resetting <em><new-branch></em> to |
| <em><commit-ish></em>.</p> |
| </dd> |
| <dt class="hdlist1">-d</dt> |
| <dt class="hdlist1">--detach</dt> |
| <dd> |
| <p>With <code>add</code>, detach <code>HEAD</code> in the new worktree. See "DETACHED HEAD" |
| in <a href="git-checkout.html">git-checkout(1)</a>.</p> |
| </dd> |
| <dt class="hdlist1">--[no-]checkout</dt> |
| <dd> |
| <p>By default, <code>add</code> checks out <em><commit-ish></em>, however, <code>--no-checkout</code> can |
| be used to suppress checkout in order to make customizations, |
| such as configuring sparse-checkout. See "Sparse checkout" |
| in <a href="git-read-tree.html">git-read-tree(1)</a>.</p> |
| </dd> |
| <dt class="hdlist1">--[no-]guess-remote</dt> |
| <dd> |
| <p>With <code>worktree</code> <code>add</code> <em><path></em>, without <em><commit-ish></em>, instead |
| of creating a new branch from <code>HEAD</code>, if there exists a tracking |
| branch in exactly one remote matching the basename of <em><path></em>, |
| base the new branch on the remote-tracking branch, and mark |
| the remote-tracking branch as "upstream" from the new branch.</p> |
| <div class="paragraph"> |
| <p>This can also be set up as the default behaviour by using the |
| <code>worktree.guessRemote</code> config option.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">--[no-]relative-paths</dt> |
| <dd> |
| <p>Link worktrees using relative paths or absolute paths (default). |
| Overrides the <code>worktree.useRelativePaths</code> config option, see |
| <a href="git-config.html">git-config(1)</a>.</p> |
| <div class="paragraph"> |
| <p>With <code>repair</code>, the linking files will be updated if there’s an absolute/relative |
| mismatch, even if the links are correct.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">--[no-]track</dt> |
| <dd> |
| <p>When creating a new branch, if <em><commit-ish></em> is a branch, |
| mark it as "upstream" from the new branch. This is the |
| default if <em><commit-ish></em> is a remote-tracking branch. See |
| <code>--track</code> in <a href="git-branch.html">git-branch(1)</a> for details.</p> |
| </dd> |
| <dt class="hdlist1">--lock</dt> |
| <dd> |
| <p>Keep the worktree locked after creation. This is the |
| equivalent of <code>git</code> <code>worktree</code> <code>lock</code> after <code>git</code> <code>worktree</code> <code>add</code>, |
| but without a race condition.</p> |
| </dd> |
| <dt class="hdlist1">-n</dt> |
| <dt class="hdlist1">--dry-run</dt> |
| <dd> |
| <p>With <code>prune</code>, do not remove anything; just report what it would |
| remove.</p> |
| </dd> |
| <dt class="hdlist1">--orphan</dt> |
| <dd> |
| <p>With <code>add</code>, make the new worktree and index empty, associating |
| the worktree with a new unborn branch named <em><new-branch></em>.</p> |
| </dd> |
| <dt class="hdlist1">--porcelain</dt> |
| <dd> |
| <p>With <code>list</code>, output in an easy-to-parse format for scripts. |
| This format will remain stable across Git versions and regardless of user |
| configuration. It is recommended to combine this with <code>-z</code>. |
| See below for details.</p> |
| </dd> |
| <dt class="hdlist1">-z</dt> |
| <dd> |
| <p>Terminate each line with a NUL rather than a newline when |
| <code>--porcelain</code> is specified with <code>list</code>. This makes it possible |
| to parse the output when a worktree path contains a newline |
| character.</p> |
| </dd> |
| <dt class="hdlist1">-q</dt> |
| <dt class="hdlist1">--quiet</dt> |
| <dd> |
| <p>With <code>add</code>, suppress feedback messages.</p> |
| </dd> |
| <dt class="hdlist1">-v</dt> |
| <dt class="hdlist1">--verbose</dt> |
| <dd> |
| <p>With <code>prune</code>, report all removals.</p> |
| <div class="paragraph"> |
| <p>With <code>list</code>, output additional information about worktrees (see below).</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">--expire <time></dt> |
| <dd> |
| <p>With <code>prune</code>, only expire unused worktrees older than <em><time></em>.</p> |
| <div class="paragraph"> |
| <p>With <code>list</code>, annotate missing worktrees as prunable if they are older than |
| <em><time></em>.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">--reason <string></dt> |
| <dd> |
| <p>With <code>lock</code> or with <code>add</code> <code>--lock</code>, an explanation why the worktree |
| is locked.</p> |
| </dd> |
| <dt class="hdlist1"><worktree></dt> |
| <dd> |
| <p>Worktrees can be identified by path, either relative or absolute.</p> |
| <div class="paragraph"> |
| <p>If the last path components in the worktree’s path is unique among |
| worktrees, it can be used to identify a worktree. For example if you only |
| have two worktrees, at <code>/abc/def/ghi</code> and <code>/abc/def/ggg</code>, then <code>ghi</code> or |
| <code>def/ghi</code> is enough to point to the former worktree.</p> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_refs">REFS</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>When using multiple worktrees, some refs are shared between all worktrees, |
| but others are specific to an individual worktree. One example is <code>HEAD</code>, |
| which is different for each worktree. This section is about the sharing |
| rules and how to access refs of one worktree from another.</p> |
| </div> |
| <div class="paragraph"> |
| <p>In general, all pseudo refs are per-worktree and all refs starting with |
| <code>refs/</code> are shared. Pseudo refs are ones like <code>HEAD</code> which are directly |
| under <code>$GIT_DIR</code> instead of inside <code>$GIT_DIR/refs</code>. There are exceptions, |
| however: refs inside <code>refs/bisect</code>, <code>refs/worktree</code> and <code>refs/rewritten</code> are |
| not shared.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Refs that are per-worktree can still be accessed from another worktree via |
| two special paths, <code>main-worktree</code> and <code>worktrees</code>. The former gives |
| access to per-worktree refs of the main worktree, while the latter to all |
| linked worktrees.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For example, <code>main-worktree/HEAD</code> or <code>main-worktree/refs/bisect/good</code> |
| resolve to the same value as the main worktree’s <code>HEAD</code> and |
| <code>refs/bisect/good</code> respectively. Similarly, <code>worktrees/foo/HEAD</code> or |
| <code>worktrees/bar/refs/bisect/bad</code> are the same as |
| <code>$GIT_COMMON_DIR/worktrees/foo/HEAD</code> and |
| <code>$GIT_COMMON_DIR/worktrees/bar/refs/bisect/bad</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To access refs, it’s best not to look inside <code>$GIT_DIR</code> directly. Instead |
| use commands such as <a href="git-rev-parse.html">git-rev-parse(1)</a> or <a href="git-update-ref.html">git-update-ref(1)</a> |
| which will handle refs correctly.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_configuration_file">CONFIGURATION FILE</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>By default, the repository <code>config</code> file is shared across all worktrees. |
| If the config variables <code>core.bare</code> or <code>core.worktree</code> are present in the |
| common config file and <code>extensions.worktreeConfig</code> is disabled, then they |
| will be applied to the main worktree only.</p> |
| </div> |
| <div class="paragraph"> |
| <p>In order to have worktree-specific configuration, you can turn on the |
| <code>worktreeConfig</code> extension, e.g.:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git config extensions.worktreeConfig true</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>In this mode, specific configuration stays in the path pointed by <code>git</code> |
| <code>rev-parse</code> <code>--git-path</code> <code>config.worktree</code>. You can add or update |
| configuration in this file with <code>git</code> <code>config</code> <code>--worktree</code>. Older Git |
| versions will refuse to access repositories with this extension.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Note that in this file, the exception for <code>core.bare</code> and <code>core.worktree</code> |
| is gone. If they exist in <code>$GIT_DIR/config</code>, you must move |
| them to the <code>config.worktree</code> of the main worktree. You may also take this |
| opportunity to review and move other configuration that you do not want to |
| share to all worktrees:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>core.worktree</code> should never be shared.</p> |
| </li> |
| <li> |
| <p><code>core.bare</code> should not be shared if the value is <code>core.bare=true</code>.</p> |
| </li> |
| <li> |
| <p><code>core.sparseCheckout</code> should not be shared, unless you are sure you |
| always use sparse checkout for all worktrees.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="paragraph"> |
| <p>See the documentation of <code>extensions.worktreeConfig</code> in |
| <a href="git-config.html">git-config(1)</a> for more details.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_details">DETAILS</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Each linked worktree has a private sub-directory in the repository’s |
| <code>$GIT_DIR/worktrees</code> directory. The private sub-directory’s name is usually |
| the base name of the linked worktree’s path, possibly appended with a |
| number to make it unique. For example, when <code>$GIT_DIR=/path/main/.git</code> the |
| command <code>git</code> <code>worktree</code> <code>add</code> <code>/path/other/test-next</code> <code>next</code> creates the linked |
| worktree in <code>/path/other/test-next</code> and also creates a |
| <code>$GIT_DIR/worktrees/test-next</code> directory (or <code>$GIT_DIR/worktrees/test-next1</code> |
| if <code>test-next</code> is already taken).</p> |
| </div> |
| <div class="paragraph"> |
| <p>Within a linked worktree, <code>$GIT_DIR</code> is set to point to this private |
| directory (e.g. <code>/path/main/.git/worktrees/test-next</code> in the example) and |
| <code>$GIT_COMMON_DIR</code> is set to point back to the main worktree’s <code>$GIT_DIR</code> |
| (e.g. <code>/path/main/.git</code>). These settings are made in a .<code>git</code> file located at |
| the top directory of the linked worktree.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Path resolution via <code>git</code> <code>rev-parse</code> <code>--git-path</code> uses either |
| <code>$GIT_DIR</code> or <code>$GIT_COMMON_DIR</code> depending on the path. For example, in the |
| linked worktree <code>git</code> <code>rev-parse</code> <code>--git-path</code> <code>HEAD</code> returns |
| <code>/path/main/.git/worktrees/test-next/HEAD</code> (not |
| <code>/path/other/test-next/.git/HEAD</code> or <code>/path/main/.git/HEAD</code>) while <code>git</code> |
| <code>rev-parse</code> <code>--git-path</code> <code>refs/heads/master</code> uses |
| <code>$GIT_COMMON_DIR</code> and returns <code>/path/main/.git/refs/heads/master</code>, |
| since refs are shared across all worktrees, except <code>refs/bisect</code>, |
| <code>refs/worktree</code> and <code>refs/rewritten</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See <a href="gitrepository-layout.html">gitrepository-layout(5)</a> for more information. The rule of |
| thumb is do not make any assumption about whether a path belongs to |
| <code>$GIT_DIR</code> or <code>$GIT_COMMON_DIR</code> when you need to directly access something |
| inside <code>$GIT_DIR</code>. Use <code>git</code> <code>rev-parse</code> <code>--git-path</code> to get the final path.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If you manually move a linked worktree, you need to update the <code>gitdir</code> file |
| in the entry’s directory. For example, if a linked worktree is moved |
| to <code>/newpath/test-next</code> and its .<code>git</code> file points to |
| <code>/path/main/.git/worktrees/test-next</code>, then update |
| <code>/path/main/.git/worktrees/test-next/gitdir</code> to reference <code>/newpath/test-next</code> |
| instead. Better yet, run <code>git</code> <code>worktree</code> <code>repair</code> to reestablish the connection |
| automatically.</p> |
| </div> |
| <div class="paragraph"> |
| <p>To prevent a <code>$GIT_DIR/worktrees</code> entry from being pruned (which |
| can be useful in some situations, such as when the |
| entry’s worktree is stored on a portable device), use the |
| <code>git</code> <code>worktree</code> <code>lock</code> command, which adds a file named |
| <code>locked</code> to the entry’s directory. The file contains the reason in |
| plain text. For example, if a linked worktree’s .<code>git</code> file points |
| to <code>/path/main/.git/worktrees/test-next</code> then a file named |
| <code>/path/main/.git/worktrees/test-next/locked</code> will prevent the |
| <code>test-next</code> entry from being pruned. See |
| <a href="gitrepository-layout.html">gitrepository-layout(5)</a> for details.</p> |
| </div> |
| <div class="paragraph"> |
| <p>When <code>extensions.worktreeConfig</code> is enabled, the config file |
| .<code>git/worktrees/</code><em><id></em><code>/config.worktree</code> is read after .<code>git/config</code> is.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_list_output_format">LIST OUTPUT FORMAT</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>The <code>worktree</code> <code>list</code> command has two output formats. The default format shows the |
| details on a single line with columns. For example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git worktree list |
| /path/to/bare-source (bare) |
| /path/to/linked-worktree abcd1234 [master] |
| /path/to/other-linked-worktree 1234abc (detached HEAD)</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>The command also shows annotations for each worktree, according to its state. |
| These annotations are:</p> |
| </div> |
| <div class="ulist"> |
| <ul> |
| <li> |
| <p><code>locked</code>, if the worktree is locked.</p> |
| </li> |
| <li> |
| <p><code>prunable</code>, if the worktree can be pruned via <code>git</code> <code>worktree</code> <code>prune</code>.</p> |
| </li> |
| </ul> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git worktree list |
| /path/to/linked-worktree abcd1234 [master] |
| /path/to/locked-worktree acbd5678 (brancha) locked |
| /path/to/prunable-worktree 5678abc (detached HEAD) prunable</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>For these annotations, a reason might also be available and this can be |
| seen using the verbose mode. The annotation is then moved to the next line |
| indented followed by the additional information.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git worktree list --verbose |
| /path/to/linked-worktree abcd1234 [master] |
| /path/to/locked-worktree-no-reason abcd5678 (detached HEAD) locked |
| /path/to/locked-worktree-with-reason 1234abcd (brancha) |
| locked: worktree path is mounted on a portable device |
| /path/to/prunable-worktree 5678abc1 (detached HEAD) |
| prunable: gitdir file points to non-existent location</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Note that the annotation is moved to the next line if the additional |
| information is available, otherwise it stays on the same line as the |
| worktree itself.</p> |
| </div> |
| <div class="sect2"> |
| <h3 id="_porcelain_format">Porcelain Format</h3> |
| <div class="paragraph"> |
| <p>The porcelain format has a line per attribute. If <code>-z</code> is given then the lines |
| are terminated with NUL rather than a newline. Attributes are listed with a |
| label and value separated by a single space. Boolean attributes (like <code>bare</code> |
| and <code>detached</code>) are listed as a label only, and are present only |
| if the value is true. Some attributes (like <code>locked</code>) can be listed as a label |
| only or with a value depending upon whether a reason is available. The first |
| attribute of a worktree is always <code>worktree</code>, an empty line indicates the |
| end of the record. For example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git worktree list --porcelain |
| worktree /path/to/bare-source |
| bare |
| |
| worktree /path/to/linked-worktree |
| HEAD abcd1234abcd1234abcd1234abcd1234abcd1234 |
| branch refs/heads/master |
| |
| worktree /path/to/other-linked-worktree |
| HEAD 1234abc1234abc1234abc1234abc1234abc1234a |
| detached |
| |
| worktree /path/to/linked-worktree-locked-no-reason |
| HEAD 5678abc5678abc5678abc5678abc5678abc5678c |
| branch refs/heads/locked-no-reason |
| locked |
| |
| worktree /path/to/linked-worktree-locked-with-reason |
| HEAD 3456def3456def3456def3456def3456def3456b |
| branch refs/heads/locked-with-reason |
| locked reason why is locked |
| |
| worktree /path/to/linked-worktree-prunable |
| HEAD 1233def1234def1234def1234def1234def1234b |
| detached |
| prunable gitdir file points to non-existent location</pre> |
| </div> |
| </div> |
| <div class="paragraph"> |
| <p>Unless <code>-z</code> is used any "unusual" characters in the lock reason such as newlines |
| are escaped and the entire reason is quoted as explained for the |
| configuration variable <code>core.quotePath</code> (see <a href="git-config.html">git-config(1)</a>). |
| For Example:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git worktree list --porcelain |
| ... |
| locked "reason\nwhy is locked" |
| ...</pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_examples">EXAMPLES</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>You are in the middle of a refactoring session and your boss comes in and |
| demands that you fix something immediately. You might typically use |
| <a href="git-stash.html">git-stash(1)</a> to store your changes away temporarily, however, your |
| working tree is in such a state of disarray (with new, moved, and removed |
| files, and other bits and pieces strewn around) that you don’t want to risk |
| disturbing any of it. Instead, you create a temporary linked worktree to |
| make the emergency fix, remove it when done, and then resume your earlier |
| refactoring session.</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>$ git worktree add -b emergency-fix ../temp master |
| $ pushd ../temp |
| # ... hack hack hack ... |
| $ git commit -a -m 'emergency fix for boss' |
| $ popd |
| $ git worktree remove ../temp</pre> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_bugs">BUGS</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Multiple checkout in general is still experimental, and the support |
| for submodules is incomplete. It is NOT recommended to make multiple |
| checkouts of a superproject.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_git">GIT</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Part of the <a href="git.html">git(1)</a> suite</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="footer-text"> |
| Last updated 2025-02-14 21:38:14 -0800 |
| </div> |
| </div> |
| </body> |
| </html> |
