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.
|
|
|
|
|
|
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
|
|
|
|
|
the commit specified in the superproject.
|
|
|
|
|
This config option is overridden if 'git submodule update' is given
|
|
|
|
|
the '--rebase' option.
|
2009-04-24 01:06:38 +02:00
|
|
|
|
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
|
|
|
|
|
|
|
|
DOCUMENTATION
|
|
|
|
|
-------------
|
|
|
|
|
Documentation by Lars Hjemli <hjemli@gmail.com>
|
|
|
|
|
|
|
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 09:07:32 +02:00
|
|
|
Part of the linkgit:git[1] suite
|