summaryrefslogtreecommitdiffstats
path: root/gitmodules.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2021-01-15 16:14:51 -0800
committerJunio C Hamano <gitster@pobox.com>2021-01-15 16:14:51 -0800
commitd5cfc8f5a014ca40c71c8355aa37074cc885297e (patch)
tree349e29bf38d1ab89b921d43c9632223d8eb21e52 /gitmodules.html
parent674f3e1acc5b11dca193bca8d2c5d8b7008c3274 (diff)
downloadgit-htmldocs-d5cfc8f5a014ca40c71c8355aa37074cc885297e.tar.gz
Autogenerated HTML docs for v2.30.0-122-g4151f
Diffstat (limited to 'gitmodules.html')
-rw-r--r--gitmodules.html32
1 files changed, 16 insertions, 16 deletions
diff --git a/gitmodules.html b/gitmodules.html
index c82a89297..625bc0de7 100644
--- a/gitmodules.html
+++ b/gitmodules.html
@@ -748,7 +748,7 @@ gitmodules(5) Manual Page
<div class="sect1">
<h2 id="_synopsis">SYNOPSIS</h2>
<div class="sectionbody">
-<div class="paragraph"><p>$GIT_WORK_DIR/.gitmodules</p></div>
+<div class="paragraph"><p>$GIT_WORK_TREE/.gitmodules</p></div>
</div>
</div>
<div class="sect1">
@@ -771,7 +771,7 @@ submodule.&lt;name&gt;.path
Defines the path, relative to the top-level directory of the Git
working tree, where the submodule is expected to be checked out.
The path name must not end with a <code>/</code>. All submodule paths must
- be unique within the .gitmodules file.
+ be unique within the <code>.gitmodules</code> file.
</p>
</dd>
<dt class="hdlist1">
@@ -781,7 +781,7 @@ submodule.&lt;name&gt;.url
<p>
Defines a URL from which the submodule repository can be cloned.
This may be either an absolute URL ready to be passed to
- <a href="git-clone.html">git-clone(1)</a> or (if it begins with ./ or ../) a location
+ <a href="git-clone.html">git-clone(1)</a> or (if it begins with <code>./</code> or <code>../</code>) a location
relative to the superproject&#8217;s origin repository.
</p>
</dd>
@@ -794,7 +794,7 @@ submodule.&lt;name&gt;.update
<dd>
<p>
Defines the default update procedure for the named submodule,
- i.e. how the submodule is updated by "git submodule update"
+ i.e. how the submodule is updated by the <code>git submodule update</code>
command in the superproject. This is only used by <code>git
submodule init</code> to initialize the configuration variable of
the same name. Allowed values here are <em>checkout</em>, <em>rebase</em>,
@@ -809,7 +809,7 @@ submodule.&lt;name&gt;.branch
<dd>
<p>
A remote branch name for tracking updates in the upstream submodule.
- If the option is not specified, it defaults to the remote <em>HEAD</em>.
+ If the option is not specified, it defaults to the remote <code>HEAD</code>.
A special value of <code>.</code> 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. See the <code>--remote</code> documentation in
@@ -822,11 +822,11 @@ submodule.&lt;name&gt;.fetchRecurseSubmodules
<dd>
<p>
This option can be used to control recursive fetching of this
- submodule. If this option is also present in the submodules entry in
- .git/config of the superproject, the setting there will override the
- one found in .gitmodules.
+ submodule. If this option is also present in the submodule&#8217;s entry in
+ <code>.git/config</code> of the superproject, the setting there will override the
+ one found in <code>.gitmodules</code>.
Both settings can be overridden on the command line by using the
- "--[no-]recurse-submodules" option to "git fetch" and "git pull".
+ <code>--[no-]recurse-submodules</code> option to <code>git fetch</code> and <code>git pull</code>.
</p>
</dd>
<dt class="hdlist1">
@@ -834,7 +834,7 @@ submodule.&lt;name&gt;.ignore
</dt>
<dd>
<p>
- Defines under what circumstances "git status" and the diff family show
+ Defines under what circumstances <code>git status</code> and the diff family show
a submodule as modified. The following values are supported:
</p>
<div class="openblock">
@@ -856,7 +856,7 @@ dirty
<dd>
<p>
All changes to the submodule&#8217;s work tree will be ignored, only
- committed differences between the HEAD of the submodule and its
+ committed differences between the <code>HEAD</code> of the submodule and its
recorded state in the superproject are taken into account.
</p>
</dd>
@@ -881,11 +881,11 @@ No modifications to submodules are ignored, all of committed
</p>
</dd>
</dl></div>
-<div class="paragraph"><p>If this option is also present in the submodules entry in .git/config
+<div class="paragraph"><p>If this option is also present in the submodule&#8217;s entry in <code>.git/config</code>
of the superproject, the setting there will override the one found in
-.gitmodules.</p></div>
+<code>.gitmodules</code>.</p></div>
<div class="paragraph"><p>Both settings can be overridden on the command line by using the
-"--ignore-submodules" option. The <em>git submodule</em> commands are not
+<code>--ignore-submodules</code> option. The <code>git submodule</code> commands are not
affected by this setting.</p></div>
</div></div>
</dd>
@@ -905,7 +905,7 @@ submodule.&lt;name&gt;.shallow
<div class="sect1">
<h2 id="_examples">EXAMPLES</h2>
<div class="sectionbody">
-<div class="paragraph"><p>Consider the following .gitmodules file:</p></div>
+<div class="paragraph"><p>Consider the following <code>.gitmodules</code> file:</p></div>
<div class="listingblock">
<div class="content">
<pre><code>[submodule "libfoo"]
@@ -938,7 +938,7 @@ submodules a URL is specified which can be used for cloning the submodules.</p><
<div id="footer">
<div id="footer-text">
Last updated
- 2020-07-06 22:33:22 PDT
+ 2021-01-15 16:12:09 PST
</div>
</div>
</body>