1434 lines
46 KiB
HTML
1434 lines
46 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
|
|
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
|
|
<meta name="generator" content="AsciiDoc 10.2.0" />
|
|
<title>git-submodule(1)</title>
|
|
<style type="text/css">
|
|
/* Shared CSS for AsciiDoc xhtml11 and html5 backends */
|
|
|
|
/* Default font. */
|
|
body {
|
|
font-family: Georgia,serif;
|
|
}
|
|
|
|
/* Title font. */
|
|
h1, h2, h3, h4, h5, h6,
|
|
div.title, caption.title,
|
|
thead, p.table.header,
|
|
#toctitle,
|
|
#author, #revnumber, #revdate, #revremark,
|
|
#footer {
|
|
font-family: Arial,Helvetica,sans-serif;
|
|
}
|
|
|
|
body {
|
|
margin: 1em 5% 1em 5%;
|
|
}
|
|
|
|
a {
|
|
color: blue;
|
|
text-decoration: underline;
|
|
}
|
|
a:visited {
|
|
color: fuchsia;
|
|
}
|
|
|
|
em {
|
|
font-style: italic;
|
|
color: navy;
|
|
}
|
|
|
|
strong {
|
|
font-weight: bold;
|
|
color: #083194;
|
|
}
|
|
|
|
h1, h2, h3, h4, h5, h6 {
|
|
color: #527bbd;
|
|
margin-top: 1.2em;
|
|
margin-bottom: 0.5em;
|
|
line-height: 1.3;
|
|
}
|
|
|
|
h1, h2, h3 {
|
|
border-bottom: 2px solid silver;
|
|
}
|
|
h2 {
|
|
padding-top: 0.5em;
|
|
}
|
|
h3 {
|
|
float: left;
|
|
}
|
|
h3 + * {
|
|
clear: left;
|
|
}
|
|
h5 {
|
|
font-size: 1.0em;
|
|
}
|
|
|
|
div.sectionbody {
|
|
margin-left: 0;
|
|
}
|
|
|
|
hr {
|
|
border: 1px solid silver;
|
|
}
|
|
|
|
p {
|
|
margin-top: 0.5em;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
|
|
ul, ol, li > p {
|
|
margin-top: 0;
|
|
}
|
|
ul > li { color: #aaa; }
|
|
ul > li > * { color: black; }
|
|
|
|
.monospaced, code, pre {
|
|
font-family: "Courier New", Courier, monospace;
|
|
font-size: inherit;
|
|
color: navy;
|
|
padding: 0;
|
|
margin: 0;
|
|
}
|
|
pre {
|
|
white-space: pre-wrap;
|
|
}
|
|
|
|
#author {
|
|
color: #527bbd;
|
|
font-weight: bold;
|
|
font-size: 1.1em;
|
|
}
|
|
#email {
|
|
}
|
|
#revnumber, #revdate, #revremark {
|
|
}
|
|
|
|
#footer {
|
|
font-size: small;
|
|
border-top: 2px solid silver;
|
|
padding-top: 0.5em;
|
|
margin-top: 4.0em;
|
|
}
|
|
#footer-text {
|
|
float: left;
|
|
padding-bottom: 0.5em;
|
|
}
|
|
#footer-badges {
|
|
float: right;
|
|
padding-bottom: 0.5em;
|
|
}
|
|
|
|
#preamble {
|
|
margin-top: 1.5em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.imageblock, div.exampleblock, div.verseblock,
|
|
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
|
|
div.admonitionblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.admonitionblock {
|
|
margin-top: 2.0em;
|
|
margin-bottom: 2.0em;
|
|
margin-right: 10%;
|
|
color: #606060;
|
|
}
|
|
|
|
div.content { /* Block element content. */
|
|
padding: 0;
|
|
}
|
|
|
|
/* Block element titles. */
|
|
div.title, caption.title {
|
|
color: #527bbd;
|
|
font-weight: bold;
|
|
text-align: left;
|
|
margin-top: 1.0em;
|
|
margin-bottom: 0.5em;
|
|
}
|
|
div.title + * {
|
|
margin-top: 0;
|
|
}
|
|
|
|
td div.title:first-child {
|
|
margin-top: 0.0em;
|
|
}
|
|
div.content div.title:first-child {
|
|
margin-top: 0.0em;
|
|
}
|
|
div.content + div.title {
|
|
margin-top: 0.0em;
|
|
}
|
|
|
|
div.sidebarblock > div.content {
|
|
background: #ffffee;
|
|
border: 1px solid #dddddd;
|
|
border-left: 4px solid #f0f0f0;
|
|
padding: 0.5em;
|
|
}
|
|
|
|
div.listingblock > div.content {
|
|
border: 1px solid #dddddd;
|
|
border-left: 5px solid #f0f0f0;
|
|
background: #f8f8f8;
|
|
padding: 0.5em;
|
|
}
|
|
|
|
div.quoteblock, div.verseblock {
|
|
padding-left: 1.0em;
|
|
margin-left: 1.0em;
|
|
margin-right: 10%;
|
|
border-left: 5px solid #f0f0f0;
|
|
color: #888;
|
|
}
|
|
|
|
div.quoteblock > div.attribution {
|
|
padding-top: 0.5em;
|
|
text-align: right;
|
|
}
|
|
|
|
div.verseblock > pre.content {
|
|
font-family: inherit;
|
|
font-size: inherit;
|
|
}
|
|
div.verseblock > div.attribution {
|
|
padding-top: 0.75em;
|
|
text-align: left;
|
|
}
|
|
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
|
|
div.verseblock + div.attribution {
|
|
text-align: left;
|
|
}
|
|
|
|
div.admonitionblock .icon {
|
|
vertical-align: top;
|
|
font-size: 1.1em;
|
|
font-weight: bold;
|
|
text-decoration: underline;
|
|
color: #527bbd;
|
|
padding-right: 0.5em;
|
|
}
|
|
div.admonitionblock td.content {
|
|
padding-left: 0.5em;
|
|
border-left: 3px solid #dddddd;
|
|
}
|
|
|
|
div.exampleblock > div.content {
|
|
border-left: 3px solid #dddddd;
|
|
padding-left: 0.5em;
|
|
}
|
|
|
|
div.imageblock div.content { padding-left: 0; }
|
|
span.image img { border-style: none; vertical-align: text-bottom; }
|
|
a.image:visited { color: white; }
|
|
|
|
dl {
|
|
margin-top: 0.8em;
|
|
margin-bottom: 0.8em;
|
|
}
|
|
dt {
|
|
margin-top: 0.5em;
|
|
margin-bottom: 0;
|
|
font-style: normal;
|
|
color: navy;
|
|
}
|
|
dd > *:first-child {
|
|
margin-top: 0.1em;
|
|
}
|
|
|
|
ul, ol {
|
|
list-style-position: outside;
|
|
}
|
|
ol.arabic {
|
|
list-style-type: decimal;
|
|
}
|
|
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;
|
|
}
|
|
|
|
div.compact ul, div.compact ol,
|
|
div.compact p, div.compact p,
|
|
div.compact div, div.compact div {
|
|
margin-top: 0.1em;
|
|
margin-bottom: 0.1em;
|
|
}
|
|
|
|
tfoot {
|
|
font-weight: bold;
|
|
}
|
|
td > div.verse {
|
|
white-space: pre;
|
|
}
|
|
|
|
div.hdlist {
|
|
margin-top: 0.8em;
|
|
margin-bottom: 0.8em;
|
|
}
|
|
div.hdlist tr {
|
|
padding-bottom: 15px;
|
|
}
|
|
dt.hdlist1.strong, td.hdlist1.strong {
|
|
font-weight: bold;
|
|
}
|
|
td.hdlist1 {
|
|
vertical-align: top;
|
|
font-style: normal;
|
|
padding-right: 0.8em;
|
|
color: navy;
|
|
}
|
|
td.hdlist2 {
|
|
vertical-align: top;
|
|
}
|
|
div.hdlist.compact tr {
|
|
margin: 0;
|
|
padding-bottom: 0;
|
|
}
|
|
|
|
.comment {
|
|
background: yellow;
|
|
}
|
|
|
|
.footnote, .footnoteref {
|
|
font-size: 0.8em;
|
|
}
|
|
|
|
span.footnote, span.footnoteref {
|
|
vertical-align: super;
|
|
}
|
|
|
|
#footnotes {
|
|
margin: 20px 0 20px 0;
|
|
padding: 7px 0 0 0;
|
|
}
|
|
|
|
#footnotes div.footnote {
|
|
margin: 0 0 5px 0;
|
|
}
|
|
|
|
#footnotes hr {
|
|
border: none;
|
|
border-top: 1px solid silver;
|
|
height: 1px;
|
|
text-align: left;
|
|
margin-left: 0;
|
|
width: 20%;
|
|
min-width: 100px;
|
|
}
|
|
|
|
div.colist td {
|
|
padding-right: 0.5em;
|
|
padding-bottom: 0.3em;
|
|
vertical-align: top;
|
|
}
|
|
div.colist td img {
|
|
margin-top: 0.3em;
|
|
}
|
|
|
|
@media print {
|
|
#footer-badges { display: none; }
|
|
}
|
|
|
|
#toc {
|
|
margin-bottom: 2.5em;
|
|
}
|
|
|
|
#toctitle {
|
|
color: #527bbd;
|
|
font-size: 1.1em;
|
|
font-weight: bold;
|
|
margin-top: 1.0em;
|
|
margin-bottom: 0.1em;
|
|
}
|
|
|
|
div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
|
|
margin-top: 0;
|
|
margin-bottom: 0;
|
|
}
|
|
div.toclevel2 {
|
|
margin-left: 2em;
|
|
font-size: 0.9em;
|
|
}
|
|
div.toclevel3 {
|
|
margin-left: 4em;
|
|
font-size: 0.9em;
|
|
}
|
|
div.toclevel4 {
|
|
margin-left: 6em;
|
|
font-size: 0.9em;
|
|
}
|
|
|
|
span.aqua { color: aqua; }
|
|
span.black { color: black; }
|
|
span.blue { color: blue; }
|
|
span.fuchsia { color: fuchsia; }
|
|
span.gray { color: gray; }
|
|
span.green { color: green; }
|
|
span.lime { color: lime; }
|
|
span.maroon { color: maroon; }
|
|
span.navy { color: navy; }
|
|
span.olive { color: olive; }
|
|
span.purple { color: purple; }
|
|
span.red { color: red; }
|
|
span.silver { color: silver; }
|
|
span.teal { color: teal; }
|
|
span.white { color: white; }
|
|
span.yellow { color: yellow; }
|
|
|
|
span.aqua-background { background: aqua; }
|
|
span.black-background { background: black; }
|
|
span.blue-background { background: blue; }
|
|
span.fuchsia-background { background: fuchsia; }
|
|
span.gray-background { background: gray; }
|
|
span.green-background { background: green; }
|
|
span.lime-background { background: lime; }
|
|
span.maroon-background { background: maroon; }
|
|
span.navy-background { background: navy; }
|
|
span.olive-background { background: olive; }
|
|
span.purple-background { background: purple; }
|
|
span.red-background { background: red; }
|
|
span.silver-background { background: silver; }
|
|
span.teal-background { background: teal; }
|
|
span.white-background { background: white; }
|
|
span.yellow-background { background: yellow; }
|
|
|
|
span.big { font-size: 2em; }
|
|
span.small { font-size: 0.6em; }
|
|
|
|
span.underline { text-decoration: underline; }
|
|
span.overline { text-decoration: overline; }
|
|
span.line-through { text-decoration: line-through; }
|
|
|
|
div.unbreakable { page-break-inside: avoid; }
|
|
|
|
|
|
/*
|
|
* xhtml11 specific
|
|
*
|
|
* */
|
|
|
|
div.tableblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
div.tableblock > table {
|
|
border: 3px solid #527bbd;
|
|
}
|
|
thead, p.table.header {
|
|
font-weight: bold;
|
|
color: #527bbd;
|
|
}
|
|
p.table {
|
|
margin-top: 0;
|
|
}
|
|
/* Because the table frame attribute is overridden by CSS in most browsers. */
|
|
div.tableblock > table[frame="void"] {
|
|
border-style: none;
|
|
}
|
|
div.tableblock > table[frame="hsides"] {
|
|
border-left-style: none;
|
|
border-right-style: none;
|
|
}
|
|
div.tableblock > table[frame="vsides"] {
|
|
border-top-style: none;
|
|
border-bottom-style: none;
|
|
}
|
|
|
|
|
|
/*
|
|
* html5 specific
|
|
*
|
|
* */
|
|
|
|
table.tableblock {
|
|
margin-top: 1.0em;
|
|
margin-bottom: 1.5em;
|
|
}
|
|
thead, p.tableblock.header {
|
|
font-weight: bold;
|
|
color: #527bbd;
|
|
}
|
|
p.tableblock {
|
|
margin-top: 0;
|
|
}
|
|
table.tableblock {
|
|
border-width: 3px;
|
|
border-spacing: 0px;
|
|
border-style: solid;
|
|
border-color: #527bbd;
|
|
border-collapse: collapse;
|
|
}
|
|
th.tableblock, td.tableblock {
|
|
border-width: 1px;
|
|
padding: 4px;
|
|
border-style: solid;
|
|
border-color: #527bbd;
|
|
}
|
|
|
|
table.tableblock.frame-topbot {
|
|
border-left-style: hidden;
|
|
border-right-style: hidden;
|
|
}
|
|
table.tableblock.frame-sides {
|
|
border-top-style: hidden;
|
|
border-bottom-style: hidden;
|
|
}
|
|
table.tableblock.frame-none {
|
|
border-style: hidden;
|
|
}
|
|
|
|
th.tableblock.halign-left, td.tableblock.halign-left {
|
|
text-align: left;
|
|
}
|
|
th.tableblock.halign-center, td.tableblock.halign-center {
|
|
text-align: center;
|
|
}
|
|
th.tableblock.halign-right, td.tableblock.halign-right {
|
|
text-align: right;
|
|
}
|
|
|
|
th.tableblock.valign-top, td.tableblock.valign-top {
|
|
vertical-align: top;
|
|
}
|
|
th.tableblock.valign-middle, td.tableblock.valign-middle {
|
|
vertical-align: middle;
|
|
}
|
|
th.tableblock.valign-bottom, td.tableblock.valign-bottom {
|
|
vertical-align: bottom;
|
|
}
|
|
|
|
|
|
/*
|
|
* manpage specific
|
|
*
|
|
* */
|
|
|
|
body.manpage h1 {
|
|
padding-top: 0.5em;
|
|
padding-bottom: 0.5em;
|
|
border-top: 2px solid silver;
|
|
border-bottom: 2px solid silver;
|
|
}
|
|
body.manpage h2 {
|
|
border-style: none;
|
|
}
|
|
body.manpage div.sectionbody {
|
|
margin-left: 3em;
|
|
}
|
|
|
|
@media print {
|
|
body.manpage div#toc { display: none; }
|
|
}
|
|
|
|
|
|
</style>
|
|
<script type="text/javascript">
|
|
/*<+'])');
|
|
// Function that scans the DOM tree for header elements (the DOM2
|
|
// nodeIterator API would be a better technique but not supported by all
|
|
// browsers).
|
|
var iterate = function (el) {
|
|
for (var i = el.firstChild; i != null; i = i.nextSibling) {
|
|
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
|
|
var mo = re.exec(i.tagName);
|
|
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
|
|
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
|
|
}
|
|
iterate(i);
|
|
}
|
|
}
|
|
}
|
|
iterate(el);
|
|
return result;
|
|
}
|
|
|
|
var toc = document.getElementById("toc");
|
|
if (!toc) {
|
|
return;
|
|
}
|
|
|
|
// Delete existing TOC entries in case we're reloading the TOC.
|
|
var tocEntriesToRemove = [];
|
|
var i;
|
|
for (i = 0; i < toc.childNodes.length; i++) {
|
|
var entry = toc.childNodes[i];
|
|
if (entry.nodeName.toLowerCase() == 'div'
|
|
&& entry.getAttribute("class")
|
|
&& entry.getAttribute("class").match(/^toclevel/))
|
|
tocEntriesToRemove.push(entry);
|
|
}
|
|
for (i = 0; i < tocEntriesToRemove.length; i++) {
|
|
toc.removeChild(tocEntriesToRemove[i]);
|
|
}
|
|
|
|
// Rebuild TOC entries.
|
|
var entries = tocEntries(document.getElementById("content"), toclevels);
|
|
for (var i = 0; i < entries.length; ++i) {
|
|
var entry = entries[i];
|
|
if (entry.element.id == "")
|
|
entry.element.id = "_toc_" + i;
|
|
var a = document.createElement("a");
|
|
a.href = "#" + entry.element.id;
|
|
a.appendChild(document.createTextNode(entry.text));
|
|
var div = document.createElement("div");
|
|
div.appendChild(a);
|
|
div.className = "toclevel" + entry.toclevel;
|
|
toc.appendChild(div);
|
|
}
|
|
if (entries.length == 0)
|
|
toc.parentNode.removeChild(toc);
|
|
},
|
|
|
|
|
|
/////////////////////////////////////////////////////////////////////
|
|
// Footnotes generator
|
|
/////////////////////////////////////////////////////////////////////
|
|
|
|
/* Based on footnote generation code from:
|
|
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
|
|
*/
|
|
|
|
footnotes: function () {
|
|
// Delete existing footnote entries in case we're reloading the footnodes.
|
|
var i;
|
|
var noteholder = document.getElementById("footnotes");
|
|
if (!noteholder) {
|
|
return;
|
|
}
|
|
var entriesToRemove = [];
|
|
for (i = 0; i < noteholder.childNodes.length; i++) {
|
|
var entry = noteholder.childNodes[i];
|
|
if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
|
|
entriesToRemove.push(entry);
|
|
}
|
|
for (i = 0; i < entriesToRemove.length; i++) {
|
|
noteholder.removeChild(entriesToRemove[i]);
|
|
}
|
|
|
|
// Rebuild footnote entries.
|
|
var cont = document.getElementById("content");
|
|
var spans = cont.getElementsByTagName("span");
|
|
var refs = {};
|
|
var n = 0;
|
|
for (i=0; i<spans.length; i++) {
|
|
if (spans[i].className == "footnote") {
|
|
n++;
|
|
var note = spans[i].getAttribute("data-note");
|
|
if (!note) {
|
|
// Use [\s\S] in place of . so multi-line matches work.
|
|
// Because JavaScript has no s (dotall) regex flag.
|
|
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
|
|
spans[i].innerHTML =
|
|
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
|
|
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
|
spans[i].setAttribute("data-note", note);
|
|
}
|
|
noteholder.innerHTML +=
|
|
"<div class='footnote' id='_footnote_" + n + "'>" +
|
|
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
|
|
n + "</a>. " + note + "</div>";
|
|
var id =spans[i].getAttribute("id");
|
|
if (id != null) refs["#"+id] = n;
|
|
}
|
|
}
|
|
if (n == 0)
|
|
noteholder.parentNode.removeChild(noteholder);
|
|
else {
|
|
// Process footnoterefs.
|
|
for (i=0; i<spans.length; i++) {
|
|
if (spans[i].className == "footnoteref") {
|
|
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
|
|
href = href.match(/#.*/)[0]; // Because IE return full URL.
|
|
n = refs[href];
|
|
spans[i].innerHTML =
|
|
"[<a href='#_footnote_" + n +
|
|
"' title='View footnote' class='footnote'>" + n + "</a>]";
|
|
}
|
|
}
|
|
}
|
|
},
|
|
|
|
install: function(toclevels) {
|
|
var timerId;
|
|
|
|
function reinstall() {
|
|
asciidoc.footnotes();
|
|
if (toclevels) {
|
|
asciidoc.toc(toclevels);
|
|
}
|
|
}
|
|
|
|
function reinstallAndRemoveTimer() {
|
|
clearInterval(timerId);
|
|
reinstall();
|
|
}
|
|
|
|
timerId = setInterval(reinstall, 500);
|
|
if (document.addEventListener)
|
|
document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
|
|
else
|
|
window.onload = reinstallAndRemoveTimer;
|
|
}
|
|
|
|
}
|
|
asciidoc.install();
|
|
/*]]>*/
|
|
</script>
|
|
</head>
|
|
<body class="manpage">
|
|
<div id="header">
|
|
<h1>
|
|
git-submodule(1) Manual Page
|
|
</h1>
|
|
<h2>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 class="attribution">
|
|
</div></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><code>git submodule foreach 'echo $sm_path `git rev-parse HEAD`'</code></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="footnotes"><hr /></div>
|
|
<div id="footer">
|
|
<div id="footer-text">
|
|
Last updated
|
|
2025-08-18 02:18:23 CEST
|
|
</div>
|
|
</div>
|
|
</body>
|
|
</html>
|