2007-06-12 09:05:21 +02:00
|
|
|
gitmodules(5)
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
2018-05-20 20:40:02 +02:00
|
|
|
gitmodules - Defining submodule properties
|
2007-06-12 09:05:21 +02:00
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2021-01-03 18:42:15 +01:00
|
|
|
$GIT_WORK_TREE/.gitmodules
|
2007-06-12 09:05:21 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
2013-01-21 20:17:53 +01:00
|
|
|
The `.gitmodules` file, located in the top-level directory of a Git
|
2007-06-12 09:05:21 +02:00
|
|
|
working tree, is a text file with a syntax matching the requirements
|
2007-12-29 07:20:38 +01:00
|
|
|
of linkgit:git-config[1].
|
2007-06-12 09:05:21 +02:00
|
|
|
|
|
|
|
|
The file contains one subsection per submodule, and the subsection value
|
2012-09-30 01:05:58 +02:00
|
|
|
is the name of the submodule. The name is set to the path where the
|
2016-06-28 13:40:11 +02:00
|
|
|
submodule has been added unless it was customized with the `--name`
|
2012-09-30 01:05:58 +02:00
|
|
|
option of 'git submodule add'. Each submodule section also contains the
|
2007-06-12 09:05:21 +02:00
|
|
|
following required keys:
|
|
|
|
|
|
|
|
|
|
submodule.<name>.path::
|
2013-01-21 20:17:53 +01:00
|
|
|
Defines the path, relative to the top-level directory of the Git
|
2007-06-12 09:05:21 +02:00
|
|
|
working tree, where the submodule is expected to be checked out.
|
|
|
|
|
The path name must not end with a `/`. All submodule paths must
|
2021-01-03 18:42:15 +01:00
|
|
|
be unique within the `.gitmodules` file.
|
2007-06-12 09:05:21 +02:00
|
|
|
|
|
|
|
|
submodule.<name>.url::
|
2012-03-28 10:41:54 +02:00
|
|
|
Defines a URL from which the submodule repository can be cloned.
|
2010-07-15 09:41:55 +02:00
|
|
|
This may be either an absolute URL ready to be passed to
|
2021-01-03 18:42:15 +01:00
|
|
|
linkgit:git-clone[1] or (if it begins with `./` or `../`) a location
|
2010-07-15 09:41:55 +02:00
|
|
|
relative to the superproject's origin repository.
|
2007-06-12 09:05:21 +02:00
|
|
|
|
2014-01-03 19:31:22 +01:00
|
|
|
In addition, there are a number of optional keys:
|
|
|
|
|
|
Rename submodule.<name>.rebase to submodule.<name>.update
The addition of "submodule.<name>.rebase" demonstrates the usefulness of
alternatives to the default behaviour of "git submodule update". However,
by naming the config variable "submodule.<name>.rebase", and making it a
boolean choice, we are artificially constraining future git versions that
may want to add _more_ alternatives than just "rebase".
Therefore, while "submodule.<name>.rebase" is not yet in a stable git
release, future-proof it, by changing it from
submodule.<name>.rebase = true/false
to
submodule.<name>.update = rebase/checkout
where "checkout" specifies the default behaviour of "git submodule update"
(checking out the new commit to a detached HEAD), and "rebase" specifies
the --rebase behaviour (where the current local branch in the submodule is
rebase onto the new commit). Thus .update == checkout is equivalent to
.rebase == false, and .update == rebase is equivalent to .rebase == true.
Finally, leaving .update unset is equivalent to leaving .rebase unset.
In future git versions, other alternatives to "git submodule update"
behaviour can be included by adding them to the list of allowable values
for the submodule.<name>.update variable.
Signed-off-by: Johan Herland <johan@herland.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2009-06-03 08:27:06 +02:00
|
|
|
submodule.<name>.update::
|
2015-03-02 23:57:58 +01:00
|
|
|
Defines the default update procedure for the named submodule,
|
2021-01-03 18:42:15 +01:00
|
|
|
i.e. how the submodule is updated by the `git submodule update`
|
2015-03-02 23:57:58 +01:00
|
|
|
command in the superproject. This is only used by `git
|
|
|
|
|
submodule init` to initialize the configuration variable of
|
|
|
|
|
the same name. Allowed values here are 'checkout', 'rebase',
|
|
|
|
|
'merge' or 'none'. See description of 'update' command in
|
submodule: reject submodule.update = !command in .gitmodules
Since ac1fbbda2013 (submodule: do not copy unknown update mode from
.gitmodules, 2013-12-02), Git has been careful to avoid copying
[submodule "foo"]
update = !run an arbitrary scary command
from .gitmodules to a repository's local config, copying in the
setting 'update = none' instead. The gitmodules(5) manpage documents
the intention:
The !command form is intentionally ignored here for security
reasons
Unfortunately, starting with v2.20.0-rc0 (which integrated ee69b2a9
(submodule--helper: introduce new update-module-mode helper,
2018-08-13, first released in v2.20.0-rc0)), there are scenarios where
we *don't* ignore it: if the config store contains no
submodule.foo.update setting, the submodule-config API falls back to
reading .gitmodules and the repository-supplied !command gets run
after all.
This was part of a general change over time in submodule support to
read more directly from .gitmodules, since unlike .git/config it
allows a project to change values between branches and over time
(while still allowing .git/config to override things). But it was
never intended to apply to this kind of dangerous configuration.
The behavior change was not advertised in ee69b2a9's commit message
and was missed in review.
Let's take the opportunity to make the protection more robust, even in
Git versions that are technically not affected: instead of quietly
converting 'update = !command' to 'update = none', noisily treat it as
an error. Allowing the setting but treating it as meaning something
else was just confusing; users are better served by seeing the error
sooner. Forbidding the construct makes the semantics simpler and
means we can check for it in fsck (in a separate patch).
As a result, the submodule-config API cannot read this value from
.gitmodules under any circumstance, and we can declare with confidence
For security reasons, the '!command' form is not accepted
here.
Reported-by: Joern Schneeweisz <jschneeweisz@gitlab.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Johannes Schindelin <Johannes.Schindelin@gmx.de>
2019-12-05 10:28:28 +01:00
|
|
|
linkgit:git-submodule[1] for their meaning. For security
|
|
|
|
|
reasons, the '!command' form is not accepted here.
|
2009-04-24 01:06:38 +02:00
|
|
|
|
submodule update: add --remote for submodule's upstream changes
The current `update` command incorporates the superproject's gitlinked
SHA-1 ($sha1) into the submodule HEAD ($subsha1). Depending on the
options you use, it may checkout $sha1, rebase the $subsha1 onto
$sha1, or merge $sha1 into $subsha1. This helps you keep up with
changes in the upstream superproject.
However, it's also useful to stay up to date with changes in the
upstream subproject. Previous workflows for incorporating such
changes include the ungainly:
$ git submodule foreach 'git checkout $(git config --file $toplevel/.gitmodules submodule.$name.branch) && git pull'
With this patch, all of the useful functionality for incorporating
superproject changes can be reused to incorporate upstream subproject
updates. When you specify --remote, the target $sha1 is replaced with
a $sha1 of the submodule's origin/master tracking branch. If you want
to merge a different tracking branch, you can configure the
`submodule.<name>.branch` option in `.gitmodules`. You can override
the `.gitmodules` configuration setting for a particular superproject
by configuring the option in that superproject's default configuration
(using the usual configuration hierarchy, e.g. `.git/config`,
`~/.gitconfig`, etc.).
Previous use of submodule.<name>.branch
=======================================
Because we're adding a new configuration option, it's a good idea to
check if anyone else is already using the option. The foreach-pull
example above was described by Ævar in
commit f030c96d8643fa0a1a9b2bd9c2f36a77721fb61f
Author: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Fri May 21 16:10:10 2010 +0000
git-submodule foreach: Add $toplevel variable
Gerrit uses the same interpretation for the setting, but because
Gerrit has direct access to the subproject repositories, it updates
the superproject repositories automatically when a subproject changes.
Gerrit also accepts the special value '.', which it expands into the
superproject's branch name.
Although the --remote functionality is using `submodule.<name>.branch`
slightly differently, the effect is the same. The foreach-pull
example uses the option to record the name of the local branch to
checkout before pulls. The tracking branch to be pulled is recorded
in `.git/modules/<name>/config`, which was initialized by the module
clone during `submodule add` or `submodule init`. Because the branch
name stored in `submodule.<name>.branch` was likely the same as the
branch name used during the initial `submodule add`, the same branch
will be pulled in each workflow.
Implementation details
======================
In order to ensure a current tracking branch state, `update --remote`
fetches the submodule's remote repository before calculating the
SHA-1. However, I didn't change the logic guarding the existing fetch:
if test -z "$nofetch"
then
# Run fetch only if $sha1 isn't present or it
# is not reachable from a ref.
(clear_local_git_env; cd "$path" &&
( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
test -z "$rev") || git-fetch)) ||
die "$(eval_gettext "Unable to fetch in submodule path '\$path'")"
fi
There will not be a double-fetch, because the new $sha1 determined
after the `--remote` triggered fetch should always exist in the
repository. If it doesn't, it's because some racy process removed it
from the submodule's repository and we *should* be re-fetching.
Signed-off-by: W. Trevor King <wking@tremily.us>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-19 17:03:32 +01:00
|
|
|
submodule.<name>.branch::
|
|
|
|
|
A remote branch name for tracking updates in the upstream submodule.
|
2021-01-03 18:42:15 +01:00
|
|
|
If the option is not specified, it defaults to the remote `HEAD`.
|
2020-06-24 16:46:30 +02:00
|
|
|
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
|
2016-10-19 22:42:54 +02:00
|
|
|
current repository. See the `--remote` documentation in
|
|
|
|
|
linkgit:git-submodule[1] for details.
|
submodule update: add --remote for submodule's upstream changes
The current `update` command incorporates the superproject's gitlinked
SHA-1 ($sha1) into the submodule HEAD ($subsha1). Depending on the
options you use, it may checkout $sha1, rebase the $subsha1 onto
$sha1, or merge $sha1 into $subsha1. This helps you keep up with
changes in the upstream superproject.
However, it's also useful to stay up to date with changes in the
upstream subproject. Previous workflows for incorporating such
changes include the ungainly:
$ git submodule foreach 'git checkout $(git config --file $toplevel/.gitmodules submodule.$name.branch) && git pull'
With this patch, all of the useful functionality for incorporating
superproject changes can be reused to incorporate upstream subproject
updates. When you specify --remote, the target $sha1 is replaced with
a $sha1 of the submodule's origin/master tracking branch. If you want
to merge a different tracking branch, you can configure the
`submodule.<name>.branch` option in `.gitmodules`. You can override
the `.gitmodules` configuration setting for a particular superproject
by configuring the option in that superproject's default configuration
(using the usual configuration hierarchy, e.g. `.git/config`,
`~/.gitconfig`, etc.).
Previous use of submodule.<name>.branch
=======================================
Because we're adding a new configuration option, it's a good idea to
check if anyone else is already using the option. The foreach-pull
example above was described by Ævar in
commit f030c96d8643fa0a1a9b2bd9c2f36a77721fb61f
Author: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Date: Fri May 21 16:10:10 2010 +0000
git-submodule foreach: Add $toplevel variable
Gerrit uses the same interpretation for the setting, but because
Gerrit has direct access to the subproject repositories, it updates
the superproject repositories automatically when a subproject changes.
Gerrit also accepts the special value '.', which it expands into the
superproject's branch name.
Although the --remote functionality is using `submodule.<name>.branch`
slightly differently, the effect is the same. The foreach-pull
example uses the option to record the name of the local branch to
checkout before pulls. The tracking branch to be pulled is recorded
in `.git/modules/<name>/config`, which was initialized by the module
clone during `submodule add` or `submodule init`. Because the branch
name stored in `submodule.<name>.branch` was likely the same as the
branch name used during the initial `submodule add`, the same branch
will be pulled in each workflow.
Implementation details
======================
In order to ensure a current tracking branch state, `update --remote`
fetches the submodule's remote repository before calculating the
SHA-1. However, I didn't change the logic guarding the existing fetch:
if test -z "$nofetch"
then
# Run fetch only if $sha1 isn't present or it
# is not reachable from a ref.
(clear_local_git_env; cd "$path" &&
( (rev=$(git rev-list -n 1 $sha1 --not --all 2>/dev/null) &&
test -z "$rev") || git-fetch)) ||
die "$(eval_gettext "Unable to fetch in submodule path '\$path'")"
fi
There will not be a double-fetch, because the new $sha1 determined
after the `--remote` triggered fetch should always exist in the
repository. If it doesn't, it's because some racy process removed it
from the submodule's repository and we *should* be re-fetching.
Signed-off-by: W. Trevor King <wking@tremily.us>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2012-12-19 17:03:32 +01:00
|
|
|
|
2010-11-11 00:55:41 +01:00
|
|
|
submodule.<name>.fetchRecurseSubmodules::
|
2011-03-06 23:12:19 +01:00
|
|
|
This option can be used to control recursive fetching of this
|
2021-01-03 18:42:15 +01:00
|
|
|
submodule. If this option is also present in the submodule's entry in
|
|
|
|
|
`.git/config` of the superproject, the setting there will override the
|
|
|
|
|
one found in `.gitmodules`.
|
2011-01-03 20:03:34 +01:00
|
|
|
Both settings can be overridden on the command line by using the
|
2021-01-03 18:42:15 +01:00
|
|
|
`--[no-]recurse-submodules` option to `git fetch` and `git pull`.
|
2010-11-11 00:55:41 +01:00
|
|
|
|
2010-08-06 00:40:48 +02:00
|
|
|
submodule.<name>.ignore::
|
2021-01-03 18:42:15 +01:00
|
|
|
Defines under what circumstances `git status` and the diff family show
|
2017-04-19 11:15:15 +02:00
|
|
|
a submodule as modified. The following values are supported:
|
2018-10-22 22:45:43 +02:00
|
|
|
+
|
|
|
|
|
--
|
2017-04-19 11:15:15 +02:00
|
|
|
all;; The submodule will never be considered modified (but will
|
|
|
|
|
nonetheless show up in the output of status and commit when it has
|
|
|
|
|
been staged).
|
|
|
|
|
|
|
|
|
|
dirty;; All changes to the submodule's work tree will be ignored, only
|
2021-01-03 18:42:15 +01:00
|
|
|
committed differences between the `HEAD` of the submodule and its
|
2017-04-19 11:15:15 +02:00
|
|
|
recorded state in the superproject are taken into account.
|
|
|
|
|
|
|
|
|
|
untracked;; Only untracked files in submodules will be ignored.
|
|
|
|
|
Committed differences and modifications to tracked files will show
|
|
|
|
|
up.
|
|
|
|
|
|
2019-11-05 18:07:20 +01:00
|
|
|
none;; No modifications to submodules are ignored, all of committed
|
2017-04-19 11:15:15 +02:00
|
|
|
differences, and modifications to tracked and untracked files are
|
|
|
|
|
shown. This is the default option.
|
|
|
|
|
|
2021-01-03 18:42:15 +01:00
|
|
|
If this option is also present in the submodule's entry in `.git/config`
|
2018-10-22 22:45:43 +02:00
|
|
|
of the superproject, the setting there will override the one found in
|
2021-01-03 18:42:15 +01:00
|
|
|
`.gitmodules`.
|
2018-10-22 22:45:43 +02:00
|
|
|
|
|
|
|
|
Both settings can be overridden on the command line by using the
|
2021-01-03 18:42:15 +01:00
|
|
|
`--ignore-submodules` option. The `git submodule` commands are not
|
2018-10-22 22:45:43 +02:00
|
|
|
affected by this setting.
|
|
|
|
|
--
|
2010-08-06 00:40:48 +02:00
|
|
|
|
2016-08-03 01:51:36 +02:00
|
|
|
submodule.<name>.shallow::
|
|
|
|
|
When set to true, a clone of this submodule will be performed as a
|
2017-04-19 09:56:33 +02:00
|
|
|
shallow clone (with a history depth of 1) unless the user explicitly
|
|
|
|
|
asks for a non-shallow clone.
|
2016-08-03 01:51:36 +02:00
|
|
|
|
2021-05-03 22:43:28 +02:00
|
|
|
NOTES
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
Git does not allow the `.gitmodules` file within a working tree to be a
|
|
|
|
|
symbolic link, and will refuse to check out such a tree entry. This
|
|
|
|
|
keeps behavior consistent when the file is accessed from the index or a
|
|
|
|
|
tree versus from the filesystem, and helps Git reliably enforce security
|
|
|
|
|
checks of the file contents.
|
2007-06-12 09:05:21 +02:00
|
|
|
|
|
|
|
|
EXAMPLES
|
|
|
|
|
--------
|
|
|
|
|
|
2021-01-03 18:42:15 +01:00
|
|
|
Consider the following `.gitmodules` file:
|
2007-06-12 09:05:21 +02:00
|
|
|
|
2019-09-07 16:12:49 +02:00
|
|
|
----
|
|
|
|
|
[submodule "libfoo"]
|
|
|
|
|
path = include/foo
|
|
|
|
|
url = git://foo.com/git/lib.git
|
2007-06-12 09:05:21 +02:00
|
|
|
|
2019-09-07 16:12:49 +02:00
|
|
|
[submodule "libbar"]
|
|
|
|
|
path = include/bar
|
|
|
|
|
url = git://bar.com/git/lib.git
|
|
|
|
|
----
|
2007-06-12 09:05:21 +02:00
|
|
|
|
|
|
|
|
This defines two submodules, `libfoo` and `libbar`. These are expected to
|
2019-03-06 14:04:46 +01:00
|
|
|
be checked out in the paths `include/foo` and `include/bar`, and for both
|
2012-03-28 10:41:54 +02:00
|
|
|
submodules a URL is specified which can be used for cloning the submodules.
|
2007-06-12 09:05:21 +02:00
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
2019-12-11 05:15:56 +01:00
|
|
|
linkgit:git-submodule[1], linkgit:gitsubmodules[7], linkgit:git-config[1]
|
2007-06-12 09:05:21 +02:00
|
|
|
|
|
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 09:07:32 +02:00
|
|
|
Part of the linkgit:git[1] suite
|