| <!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-submodule(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-submodule(1) Manual Page</h1> |
| <h2 id="_name">NAME</h2> |
| <div class="sectionbody"> |
| <p>git-submodule - Initialize, update or inspect submodules</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 submodule</em> [--quiet] [--cached] |
| <em>git submodule</em> [--quiet] add [<options>] [--] <repository> [<path>] |
| <em>git submodule</em> [--quiet] status [--cached] [--recursive] [--] [<path>…​] |
| <em>git submodule</em> [--quiet] init [--] [<path>…​] |
| <em>git submodule</em> [--quiet] deinit [-f|--force] (--all|[--] <path>…​) |
| <em>git submodule</em> [--quiet] update [<options>] [--] [<path>…​] |
| <em>git submodule</em> [--quiet] set-branch [<options>] [--] <path> |
| <em>git submodule</em> [--quiet] set-url [--] <path> <newurl> |
| <em>git submodule</em> [--quiet] summary [<options>] [--] [<path>…​] |
| <em>git submodule</em> [--quiet] foreach [--recursive] <command> |
| <em>git submodule</em> [--quiet] sync [--recursive] [--] [<path>…​] |
| <em>git submodule</em> [--quiet] absorbgitdirs [--] [<path>…​]</pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_description">DESCRIPTION</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Inspects, updates and manages submodules.</p> |
| </div> |
| <div class="paragraph"> |
| <p>For more information about submodules, see <a href="gitsubmodules.html">gitsubmodules(7)</a>.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_commands">COMMANDS</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>With no arguments, shows the status of existing submodules. Several |
| subcommands are available to perform operations on the submodules.</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--ref-format <format>] [--depth <depth>] [--] <repository> [<path>]</dt> |
| <dd> |
| <p>Add the given repository as a submodule at the given path |
| to the changeset to be committed next to the current |
| project: the current project is termed the "superproject".</p> |
| <div class="paragraph"> |
| <p><repository> is the URL of the new submodule’s origin repository. |
| This may be either an absolute URL, or (if it begins with ./ |
| or ../), the location relative to the superproject’s default remote |
| repository (Please note that to specify a repository <em>foo.git</em> |
| which is located right next to a superproject <em>bar.git</em>, you’ll |
| have to use <code>..</code><code>/foo.git</code> instead of .<code>/foo.git</code> - as one might expect |
| when following the rules for relative URLs - because the evaluation |
| of relative URLs in Git is identical to that of relative directories).</p> |
| </div> |
| <div class="paragraph"> |
| <p>The default remote is the remote of the remote-tracking branch |
| of the current branch. If no such remote-tracking branch exists or |
| the HEAD is detached, "origin" is assumed to be the default remote. |
| If the superproject doesn’t have a default remote configured |
| the superproject is its own authoritative upstream and the current |
| working directory is used instead.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The optional argument <path> is the relative location for the cloned |
| submodule to exist in the superproject. If <path> is not given, the |
| canonical part of the source repository is used ("repo" for |
| "/path/to/repo.git" and "foo" for "host.xz:foo/.git"). If <path> |
| exists and is already a valid Git repository, then it is staged |
| for commit without cloning. The <path> is also used as the submodule’s |
| logical name in its configuration entries unless <code>--name</code> is used |
| to specify a logical name.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The given URL is recorded into .<code>gitmodules</code> for use by subsequent users |
| cloning the superproject. If the URL is given relative to the |
| superproject’s repository, the presumption is the superproject and |
| submodule repositories will be kept together in the same relative |
| location, and only the superproject’s URL needs to be provided. |
| git-submodule will correctly locate the submodule using the relative |
| URL in .<code>gitmodules</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <code>--ref-format</code> <em><format></em> is specified, the ref storage format of newly |
| cloned submodules will be set accordingly.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">status [--cached] [--recursive] [--] [<path>…​]</dt> |
| <dd> |
| <p>Show the status of the submodules. This will print the SHA-1 of the |
| currently checked out commit for each submodule, along with the |
| submodule path and the output of <em>git describe</em> for the |
| SHA-1. Each SHA-1 will possibly be prefixed with <code>-</code> if the submodule is |
| not initialized, <code>+</code> if the currently checked out submodule commit |
| does not match the SHA-1 found in the index of the containing |
| repository and <code>U</code> if the submodule has merge conflicts.</p> |
| <div class="paragraph"> |
| <p>If <code>--cached</code> is specified, this command will instead print the SHA-1 |
| recorded in the superproject for each submodule.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <code>--recursive</code> is specified, this command will recurse into nested |
| submodules, and show their status as well.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If you are only interested in changes of the currently initialized |
| submodules with respect to the commit recorded in the index or the HEAD, |
| <a href="git-status.html">git-status(1)</a> and <a href="git-diff.html">git-diff(1)</a> will provide that information |
| too (and can also report changes to a submodule’s work tree).</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">init [--] [<path>…​]</dt> |
| <dd> |
| <p>Initialize the submodules recorded in the index (which were |
| added and committed elsewhere) by setting <code>submodule.$name.url</code> |
| in .<code>git/config</code>, using the same setting from .<code>gitmodules</code> as |
| a template. If the URL is relative, it will be resolved using |
| the default remote. If there is no default remote, the current |
| repository will be assumed to be upstream.</p> |
| <div class="paragraph"> |
| <p>Optional <path> arguments limit which submodules will be initialized. |
| If no path is specified and submodule.active has been configured, submodules |
| configured to be active will be initialized, otherwise all submodules are |
| initialized.</p> |
| </div> |
| <div class="paragraph"> |
| <p>It will also copy the value of <code>submodule.$name.update</code>, if present in |
| the .<code>gitmodules</code> file, to .<code>git/config</code>, but (1) this command does not |
| alter existing information in .<code>git/config</code>, and (2) <code>submodule.$name.update</code> |
| that is set to a custom command is <strong>not</strong> copied for security reasons.</p> |
| </div> |
| <div class="paragraph"> |
| <p>You can then customize the submodule clone URLs in .<code>git/config</code> |
| for your local setup and proceed to <code>git</code> <code>submodule</code> <code>update</code>; |
| you can also just use <code>git</code> <code>submodule</code> <code>update</code> <code>--init</code> without |
| the explicit <em>init</em> step if you do not intend to customize |
| any submodule locations.</p> |
| </div> |
| <div class="paragraph"> |
| <p>See the add subcommand for the definition of default remote.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">deinit [-f|--force] (--all|[--] <path>…​)</dt> |
| <dd> |
| <p>Unregister the given submodules, i.e. remove the whole |
| <code>submodule.$name</code> section from .git/config together with their work |
| tree. Further calls to <code>git</code> <code>submodule</code> <code>update</code>, <code>git</code> <code>submodule</code> <code>foreach</code> |
| and <code>git</code> <code>submodule</code> <code>sync</code> will skip any unregistered submodules until |
| they are initialized again, so use this command if you don’t want to |
| have a local checkout of the submodule in your working tree anymore.</p> |
| <div class="paragraph"> |
| <p>When the command is run without pathspec, it errors out, |
| instead of deinit-ing everything, to prevent mistakes.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <code>--force</code> is specified, the submodule’s working tree will |
| be removed even if it contains local modifications.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If you really want to remove a submodule from the repository and commit |
| that use <a href="git-rm.html">git-rm(1)</a> instead. See <a href="gitsubmodules.html">gitsubmodules(7)</a> for removal |
| options.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference <repository>] [--ref-format <format>] [--depth <depth>] [--recursive] [--jobs <n>] [--[no-]single-branch] [--filter <filter-spec>] [--] [<path>…​]</dt> |
| <dd> |
| <div class="openblock"> |
| <div class="content"> |
| <div class="paragraph"> |
| <p>Update the registered submodules to match what the superproject |
| expects by cloning missing submodules, fetching missing commits |
| in submodules and updating the working tree of |
| the submodules. The "updating" can be done in several ways depending |
| on command line options and the value of <code>submodule.</code><em><name></em><code>.update</code> |
| configuration variable. The command line option takes precedence over |
| the configuration variable. If neither is given, a <em>checkout</em> is performed. |
| (note: what is in .<code>gitmodules</code> file is irrelevant at this point; |
| see <code>git</code> <code>submodule</code> <code>init</code> above for how .<code>gitmodules</code> is used). |
| The <em>update</em> procedures supported both from the command line as well as |
| through the <code>submodule.</code><em><name></em><code>.update</code> configuration are:</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">checkout</dt> |
| <dd> |
| <p>the commit recorded in the superproject will be |
| checked out in the submodule on a detached HEAD.</p> |
| <div class="paragraph"> |
| <p>If <code>--force</code> is specified, the submodule will be checked out (using |
| <code>git</code> <code>checkout</code> <code>--force</code>), even if the commit specified |
| in the index of the containing repository already matches the commit |
| checked out in the submodule.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">rebase</dt> |
| <dd> |
| <p>the current branch of the submodule will be rebased |
| onto the commit recorded in the superproject.</p> |
| </dd> |
| <dt class="hdlist1">merge</dt> |
| <dd> |
| <p>the commit recorded in the superproject will be merged |
| into the current branch in the submodule.</p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The following update procedures have additional limitations:</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">custom command</dt> |
| <dd> |
| <p>mechanism for running arbitrary commands with the |
| commit ID as an argument. Specifically, if the |
| <code>submodule.</code><em><name></em><code>.update</code> configuration variable is set to |
| !custom <code>command</code>, the object name of the commit recorded in the |
| superproject for the submodule is appended to the <code>custom</code> <code>command</code> |
| string and executed. Note that this mechanism is not supported in |
| the .<code>gitmodules</code> file or on the command line.</p> |
| </dd> |
| <dt class="hdlist1">none</dt> |
| <dd> |
| <p>the submodule is not updated. This update procedure is not |
| allowed on the command line.</p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>If the submodule is not yet initialized, and you just want to use the |
| setting as stored in .<code>gitmodules</code>, you can automatically initialize the |
| submodule with the <code>--init</code> option.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <code>--recursive</code> is specified, this command will recurse into the |
| registered submodules, and update any nested submodules within.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <code>--ref-format</code> <em><format></em> is specified, the ref storage format of newly |
| cloned submodules will be set accordingly.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <code>--filter</code> <em><filter-spec></em> is specified, the given partial clone filter will be |
| applied to the submodule. See <a href="git-rev-list.html">git-rev-list(1)</a> for details on filter |
| specifications.</p> |
| </div> |
| </div> |
| </div> |
| </dd> |
| <dt class="hdlist1">set-branch (-b|--branch) <branch> [--] <path></dt> |
| <dt class="hdlist1">set-branch (-d|--default) [--] <path></dt> |
| <dd> |
| <p>Sets the default remote tracking branch for the submodule. The |
| <code>--branch</code> option allows the remote branch to be specified. The |
| <code>--default</code> option removes the submodule.<name>.branch configuration |
| key, which causes the tracking branch to default to the remote <em>HEAD</em>.</p> |
| </dd> |
| <dt class="hdlist1">set-url [--] <path> <newurl></dt> |
| <dd> |
| <p>Sets the URL of the specified submodule to <newurl>. Then, it will |
| automatically synchronize the submodule’s new remote URL |
| configuration.</p> |
| </dd> |
| <dt class="hdlist1">summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] [<path>…​]</dt> |
| <dd> |
| <p>Show commit summary between the given commit (defaults to HEAD) and |
| working tree/index. For a submodule in question, a series of commits |
| in the submodule between the given super project commit and the |
| index or working tree (switched by <code>--cached</code>) are shown. If the option |
| <code>--files</code> is given, show the series of commits in the submodule between |
| the index of the super project and the working tree of the submodule |
| (this option doesn’t allow to use the <code>--cached</code> option or to provide an |
| explicit commit).</p> |
| <div class="paragraph"> |
| <p>Using the <code>--submodule=log</code> option with <a href="git-diff.html">git-diff(1)</a> will provide that |
| information too.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">foreach [--recursive] <command></dt> |
| <dd> |
| <p>Evaluates an arbitrary shell command in each checked out submodule. |
| The command has access to the variables $name, $sm_path, $displaypath, |
| $sha1 and $toplevel: |
| $name is the name of the relevant submodule section in .<code>gitmodules</code>, |
| $sm_path is the path of the submodule as recorded in the immediate |
| superproject, $displaypath contains the relative path from the |
| current working directory to the submodules root directory, |
| $sha1 is the commit as recorded in the immediate |
| superproject, and $toplevel is the absolute path to the top-level |
| of the immediate superproject. |
| Note that to avoid conflicts with <em>$PATH</em> on Windows, the <em>$path</em> |
| variable is now a deprecated synonym of <em>$sm_path</em> variable. |
| Any submodules defined in the superproject but not checked out are |
| ignored by this command. Unless given <code>--quiet</code>, foreach prints the name |
| of each submodule before evaluating the command. |
| If <code>--recursive</code> is given, submodules are traversed recursively (i.e. |
| the given shell command is evaluated in nested submodules as well). |
| A non-zero return from the command in any submodule causes |
| the processing to terminate. This can be overridden by adding <em>|| :</em> |
| to the end of the command.</p> |
| <div class="paragraph"> |
| <p>As an example, the command below will show the path and currently |
| checked out commit for each submodule:</p> |
| </div> |
| <div class="listingblock"> |
| <div class="content"> |
| <pre>git submodule foreach 'echo $sm_path `git rev-parse HEAD`'</pre> |
| </div> |
| </div> |
| </dd> |
| <dt class="hdlist1">sync [--recursive] [--] [<path>…​]</dt> |
| <dd> |
| <p>Synchronizes submodules' remote URL configuration setting |
| to the value specified in .<code>gitmodules</code>. It will only affect those |
| submodules which already have a URL entry in .git/config (that is the |
| case when they are initialized or freshly added). This is useful when |
| submodule URLs change upstream and you need to update your local |
| repositories accordingly.</p> |
| <div class="paragraph"> |
| <p><code>git</code> <code>submodule</code> <code>sync</code> synchronizes all submodules while |
| <code>git</code> <code>submodule</code> <code>sync</code> <code>--</code> <code>A</code> synchronizes submodule "A" only.</p> |
| </div> |
| <div class="paragraph"> |
| <p>If <code>--recursive</code> is specified, this command will recurse into the |
| registered submodules, and sync any nested submodules within.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">absorbgitdirs</dt> |
| <dd> |
| <p>If a git directory of a submodule is inside the submodule, |
| move the git directory of the submodule into its superproject’s |
| <code>$GIT_DIR/modules</code> path and then connect the git directory and |
| its working directory by setting the <code>core.worktree</code> and adding |
| a .git file pointing to the git directory embedded in the |
| superprojects git directory.</p> |
| <div class="paragraph"> |
| <p>A repository that was cloned independently and later added as a submodule or |
| old setups have the submodules git directory inside the submodule instead of |
| embedded into the superprojects git directory.</p> |
| </div> |
| <div class="paragraph"> |
| <p>This command is recursive by default.</p> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_options">OPTIONS</h2> |
| <div class="sectionbody"> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">-q</dt> |
| <dt class="hdlist1">--quiet</dt> |
| <dd> |
| <p>Only print error messages.</p> |
| </dd> |
| <dt class="hdlist1">--progress</dt> |
| <dd> |
| <p>This option is only valid for add and update commands. |
| Progress status is reported on the standard error stream |
| by default when it is attached to a terminal, unless -q |
| is specified. This flag forces progress status even if the |
| standard error stream is not directed to a terminal.</p> |
| </dd> |
| <dt class="hdlist1">--all</dt> |
| <dd> |
| <p>This option is only valid for the deinit command. Unregister all |
| submodules in the working tree.</p> |
| </dd> |
| <dt class="hdlist1">-b <branch></dt> |
| <dt class="hdlist1">--branch <branch></dt> |
| <dd> |
| <p>Branch of repository to add as submodule. |
| The name of the branch is recorded as <code>submodule.</code><em><name></em><code>.branch</code> in |
| .<code>gitmodules</code> for <code>update</code> <code>--remote</code>. A special value of . is used to |
| indicate that the name of the branch in the submodule should be the |
| same name as the current branch in the current repository. If the |
| option is not specified, it defaults to the remote <em>HEAD</em>.</p> |
| </dd> |
| <dt class="hdlist1">-f</dt> |
| <dt class="hdlist1">--force</dt> |
| <dd> |
| <p>This option is only valid for add, deinit and update commands. |
| When running add, allow adding an otherwise ignored submodule path. |
| This option is also used to bypass a check that the submodule’s name |
| is not already in use. By default, <em>git submodule add</em> will fail if |
| the proposed name (which is derived from the path) is already registered |
| for another submodule in the repository. Using <em>--force</em> allows the command |
| to proceed by automatically generating a unique name by appending a number |
| to the conflicting name (e.g., if a submodule named <em>child</em> exists, it will |
| try <em>child1</em>, and so on). |
| When running deinit the submodule working trees will be removed even |
| if they contain local changes. |
| When running update (only effective with the checkout procedure), |
| throw away local changes in submodules when switching to a |
| different commit; and always run a checkout operation in the |
| submodule, even if the commit listed in the index of the |
| containing repository matches the commit checked out in the |
| submodule.</p> |
| </dd> |
| <dt class="hdlist1">--cached</dt> |
| <dd> |
| <p>This option is only valid for status and summary commands. These |
| commands typically use the commit found in the submodule HEAD, but |
| with this option, the commit stored in the index is used instead.</p> |
| </dd> |
| <dt class="hdlist1">--files</dt> |
| <dd> |
| <p>This option is only valid for the summary command. This command |
| compares the commit in the index with that in the submodule HEAD |
| when this option is used.</p> |
| </dd> |
| <dt class="hdlist1">-n</dt> |
| <dt class="hdlist1">--summary-limit</dt> |
| <dd> |
| <p>This option is only valid for the summary command. |
| Limit the summary size (number of commits shown in total). |
| Giving 0 will disable the summary; a negative number means unlimited |
| (the default). This limit only applies to modified submodules. The |
| size is always limited to 1 for added/deleted/typechanged submodules.</p> |
| </dd> |
| <dt class="hdlist1">--remote</dt> |
| <dd> |
| <p>This option is only valid for the update command. Instead of using |
| the superproject’s recorded SHA-1 to update the submodule, use the |
| status of the submodule’s remote-tracking branch. The remote used |
| is branch’s remote (<code>branch.</code><em><name></em><code>.remote</code>), defaulting to <code>origin</code>. |
| The remote branch used defaults to the remote <code>HEAD</code>, but the branch |
| name may be overridden by setting the <code>submodule.</code><em><name></em><code>.branch</code> |
| option in either .<code>gitmodules</code> or .<code>git/config</code> (with .<code>git/config</code> |
| taking precedence).</p> |
| <div class="paragraph"> |
| <p>This works for any of the supported update procedures (<code>--checkout</code>, |
| <code>--rebase</code>, etc.). The only change is the source of the target SHA-1. |
| For example, <code>submodule</code> <code>update</code> <code>--remote</code> <code>--merge</code> will merge upstream |
| submodule changes into the submodules, while <code>submodule</code> <code>update</code> |
| <code>--merge</code> will merge superproject gitlink changes into the submodules.</p> |
| </div> |
| <div class="paragraph"> |
| <p>In order to ensure a current tracking branch state, <code>update</code> <code>--remote</code> |
| fetches the submodule’s remote repository before calculating the |
| SHA-1. If you don’t want to fetch, you should use <code>submodule</code> <code>update</code> |
| <code>--remote</code> <code>--no-fetch</code>.</p> |
| </div> |
| <div class="paragraph"> |
| <p>Use this option to integrate changes from the upstream subproject with |
| your submodule’s current HEAD. Alternatively, you can run <code>git</code> <code>pull</code> |
| from the submodule, which is equivalent except for the remote branch |
| name: <code>update</code> <code>--remote</code> uses the default upstream repository and |
| <code>submodule.</code><em><name></em><code>.branch</code>, while <code>git</code> <code>pull</code> uses the submodule’s |
| <code>branch.</code><em><name></em><code>.merge</code>. Prefer <code>submodule.</code><em><name></em><code>.branch</code> if you want |
| to distribute the default upstream branch with the superproject and |
| <code>branch.</code><em><name></em><code>.merge</code> if you want a more native feel while working in |
| the submodule itself.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">-N</dt> |
| <dt class="hdlist1">--no-fetch</dt> |
| <dd> |
| <p>This option is only valid for the update command. |
| Don’t fetch new objects from the remote site.</p> |
| </dd> |
| <dt class="hdlist1">--checkout</dt> |
| <dd> |
| <p>This option is only valid for the update command. |
| Checkout the commit recorded in the superproject on a detached HEAD |
| in the submodule. This is the default behavior, the main use of |
| this option is to override <code>submodule.$name.update</code> when set to |
| a value other than <code>checkout</code>. |
| If the key <code>submodule.$name.update</code> is either not explicitly set or |
| set to <code>checkout</code>, this option is implicit.</p> |
| </dd> |
| <dt class="hdlist1">--merge</dt> |
| <dd> |
| <p>This option is only valid for the update command. |
| Merge the commit recorded in the superproject into the current branch |
| of the submodule. If this option is given, the submodule’s HEAD will |
| not be detached. If a merge failure prevents this process, you will |
| have to resolve the resulting conflicts within the submodule with the |
| usual conflict resolution tools. |
| If the key <code>submodule.$name.update</code> is set to <code>merge</code>, this option is |
| implicit.</p> |
| </dd> |
| <dt class="hdlist1">--rebase</dt> |
| <dd> |
| <p>This option is only valid for the update command. |
| Rebase the current branch onto the commit recorded in the |
| superproject. If this option is given, the submodule’s HEAD will not |
| be detached. If a merge failure prevents this process, you will have |
| to resolve these failures with <a href="git-rebase.html">git-rebase(1)</a>. |
| If the key <code>submodule.$name.update</code> is set to <code>rebase</code>, this option is |
| implicit.</p> |
| </dd> |
| <dt class="hdlist1">--init</dt> |
| <dd> |
| <p>This option is only valid for the update command. |
| Initialize all submodules for which "git submodule init" has not been |
| called so far before updating.</p> |
| </dd> |
| <dt class="hdlist1">--name</dt> |
| <dd> |
| <p>This option is only valid for the add command. It sets the submodule’s |
| name to the given string instead of defaulting to its path. The name |
| must be valid as a directory name and may not end with a <em>/</em>.</p> |
| </dd> |
| <dt class="hdlist1">--reference <repository></dt> |
| <dd> |
| <p>This option is only valid for add and update commands. These |
| commands sometimes need to clone a remote repository. In this case, |
| this option will be passed to the <a href="git-clone.html">git-clone(1)</a> command.</p> |
| <div class="paragraph"> |
| <p><strong>NOTE</strong>: Do <strong>not</strong> use this option unless you have read the note |
| for <a href="git-clone.html">git-clone(1)</a>'s <code>--reference</code>, <code>--shared</code>, and <code>--dissociate</code> |
| options carefully.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">--dissociate</dt> |
| <dd> |
| <p>This option is only valid for add and update commands. These |
| commands sometimes need to clone a remote repository. In this case, |
| this option will be passed to the <a href="git-clone.html">git-clone(1)</a> command.</p> |
| <div class="paragraph"> |
| <p><strong>NOTE</strong>: see the NOTE for the <code>--reference</code> option.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">--recursive</dt> |
| <dd> |
| <p>This option is only valid for foreach, update, status and sync commands. |
| Traverse submodules recursively. The operation is performed not |
| only in the submodules of the current repo, but also |
| in any nested submodules inside those submodules (and so on).</p> |
| </dd> |
| <dt class="hdlist1">--depth</dt> |
| <dd> |
| <p>This option is valid for add and update commands. Create a <em>shallow</em> |
| clone with a history truncated to the specified number of revisions. |
| See <a href="git-clone.html">git-clone(1)</a></p> |
| </dd> |
| <dt class="hdlist1">--[no-]recommend-shallow</dt> |
| <dd> |
| <p>This option is only valid for the update command. |
| The initial clone of a submodule will use the recommended |
| <code>submodule.</code><em><name></em><code>.shallow</code> as provided by the .<code>gitmodules</code> file |
| by default. To ignore the suggestions use <code>--no-recommend-shallow</code>.</p> |
| </dd> |
| <dt class="hdlist1">-j <n></dt> |
| <dt class="hdlist1">--jobs <n></dt> |
| <dd> |
| <p>This option is only valid for the update command. |
| Clone new submodules in parallel with as many jobs. |
| Defaults to the <code>submodule.fetchJobs</code> option.</p> |
| </dd> |
| <dt class="hdlist1">--[no-]single-branch</dt> |
| <dd> |
| <p>This option is only valid for the update command. |
| Clone only one branch during update: HEAD or one specified by --branch.</p> |
| </dd> |
| <dt class="hdlist1"><path>…​</dt> |
| <dd> |
| <p>Paths to submodule(s). When specified this will restrict the command |
| to only operate on the submodules found at the specified paths. |
| (This argument is required with add).</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_files">FILES</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>When initializing submodules, a .<code>gitmodules</code> file in the top-level directory |
| of the containing repository is used to find the url of each submodule. |
| This file should be formatted in the same way as <code>$GIT_DIR/config</code>. The key |
| to each submodule url is "submodule.$name.url". See <a href="gitmodules.html">gitmodules(5)</a> |
| for details.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_see_also">SEE ALSO</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p><a href="gitsubmodules.html">gitsubmodules(7)</a>, <a href="gitmodules.html">gitmodules(5)</a>.</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-08-05 16:00:31 -0700 |
| </div> |
| </div> |
| </body> |
| </html> |
