2007-06-12 09:05:21 +02:00
|
|
|
gitmodules(5)
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
gitmodules - defining submodule properties
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2008-08-31 18:00:27 +02:00
|
|
|
$GIT_WORK_DIR/.gitmodules
|
2007-06-12 09:05:21 +02:00
|
|
|
|
|
|
|
|
|
|
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
The `.gitmodules` file, located in the top-level directory of a git
|
|
|
|
|
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
|
|
|
|
|
is the name of the submodule. Each submodule section also contains the
|
|
|
|
|
following required keys:
|
|
|
|
|
|
|
|
|
|
submodule.<name>.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 `/`. All submodule paths must
|
|
|
|
|
be unique within the .gitmodules file.
|
|
|
|
|
|
|
|
|
|
submodule.<name>.url::
|
|
|
|
|
Defines an url from where 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
|
|
|
|
|
linkgit:git-clone[1] or (if it begins with ./ or ../) a location
|
|
|
|
|
relative to the superproject's origin repository.
|
2007-06-12 09:05:21 +02:00
|
|
|
|
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::
|
|
|
|
|
Defines what to do when the submodule is updated by the superproject.
|
|
|
|
|
If 'checkout' (the default), the new commit specified in the
|
|
|
|
|
superproject will be checked out in the submodule on a detached HEAD.
|
|
|
|
|
If 'rebase', the current branch of the submodule will be rebased onto
|
2009-06-03 00:59:12 +02:00
|
|
|
the commit specified in the superproject. If 'merge', the commit
|
|
|
|
|
specified in the superproject will be merged into the current branch
|
|
|
|
|
in the submodule.
|
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
|
|
|
This config option is overridden if 'git submodule update' is given
|
2009-06-03 00:59:12 +02:00
|
|
|
the '--merge' or '--rebase' options.
|
2009-04-24 01:06:38 +02: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
|
2010-11-11 00:55:41 +01:00
|
|
|
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.
|
2011-01-03 20:03:34 +01:00
|
|
|
Both settings can be overridden on the command line by using the
|
2011-03-06 23:12:19 +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::
|
|
|
|
|
Defines under what circumstances "git status" and the diff family show
|
|
|
|
|
a submodule as modified. When set to "all", it will never be considered
|
|
|
|
|
modified, "dirty" will ignore all changes to the submodules work tree and
|
|
|
|
|
takes only differences between the HEAD of the submodule and the commit
|
|
|
|
|
recorded in the superproject into account. "untracked" will additionally
|
|
|
|
|
let submodules with modified tracked files in their work tree show up.
|
|
|
|
|
Using "none" (the default when this option is not set) also shows
|
|
|
|
|
submodules that have untracked files in their work tree as changed.
|
|
|
|
|
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.
|
2010-08-22 13:12:12 +02:00
|
|
|
Both settings can be overridden on the command line by using the
|
2010-08-06 00:40:48 +02:00
|
|
|
"--ignore-submodule" option.
|
|
|
|
|
|
2007-06-12 09:05:21 +02:00
|
|
|
|
|
|
|
|
EXAMPLES
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Consider the following .gitmodules file:
|
|
|
|
|
|
|
|
|
|
[submodule "libfoo"]
|
|
|
|
|
path = include/foo
|
|
|
|
|
url = git://foo.com/git/lib.git
|
|
|
|
|
|
|
|
|
|
[submodule "libbar"]
|
|
|
|
|
path = include/bar
|
|
|
|
|
url = git://bar.com/git/lib.git
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This defines two submodules, `libfoo` and `libbar`. These are expected to
|
|
|
|
|
be checked out in the paths 'include/foo' and 'include/bar', and for both
|
|
|
|
|
submodules an url is specified which can be used for cloning the submodules.
|
|
|
|
|
|
|
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
2007-12-29 07:20:38 +01:00
|
|
|
linkgit:git-submodule[1] 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
|