2007-05-26 13:56:40 +00:00
|
|
|
git-submodule(1)
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
git-submodule - Initialize, update or inspect submodules
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2007-07-07 00:56:31 +00:00
|
|
|
[verse]
|
2019-02-15 09:26:41 +00:00
|
|
|
'git submodule' [--quiet] [--cached]
|
2016-12-27 23:43:08 +00:00
|
|
|
'git submodule' [--quiet] add [<options>] [--] <repository> [<path>]
|
2009-08-19 01:45:24 +00:00
|
|
|
'git submodule' [--quiet] status [--cached] [--recursive] [--] [<path>...]
|
2008-06-30 06:09:04 +00:00
|
|
|
'git submodule' [--quiet] init [--] [<path>...]
|
2016-05-05 19:52:32 +00:00
|
|
|
'git submodule' [--quiet] deinit [-f|--force] (--all|[--] <path>...)
|
2016-12-27 23:43:08 +00:00
|
|
|
'git submodule' [--quiet] update [<options>] [--] [<path>...]
|
2019-02-08 11:21:34 +00:00
|
|
|
'git submodule' [--quiet] set-branch [<options>] [--] <path>
|
2019-10-29 17:01:52 +00:00
|
|
|
'git submodule' [--quiet] set-url [--] <path> <newurl>
|
2016-12-27 23:43:08 +00:00
|
|
|
'git submodule' [--quiet] summary [<options>] [--] [<path>...]
|
2009-08-19 01:45:22 +00:00
|
|
|
'git submodule' [--quiet] foreach [--recursive] <command>
|
2014-06-13 17:40:50 +00:00
|
|
|
'git submodule' [--quiet] sync [--recursive] [--] [<path>...]
|
2016-12-12 19:04:35 +00:00
|
|
|
'git submodule' [--quiet] absorbgitdirs [--] [<path>...]
|
2007-05-26 13:56:40 +00:00
|
|
|
|
|
|
|
|
|
2008-07-16 18:44:12 +00:00
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
submodule doc: reorder introductory paragraphs
It's better to start the man page with a description of what
submodules actually are, instead of saying what they are not.
Reorder the paragraphs such that
- the first short paragraph introduces the submodule concept,
- the second paragraph highlights the usage of the submodule command,
- the third paragraph giving background information, and finally
- the fourth paragraph discusing alternatives such as subtrees and
remotes, which we don't want to be confused with.
This ordering deepens the knowledge on submodules with each paragraph.
First the basic questions like "How/what" will be answered, while the
underlying concepts will be taught at a later time.
Making sure it is not confused with subtrees and remotes is not really
enhancing knowledge of submodules itself, but rather painting the big
picture of git concepts, so you could also argue to have it as the second
paragraph. Personally I think this may confuse readers, specially
newcomers though.
Additionally to reordering the paragraphs, they have been slightly
reworded.
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2015-05-27 19:48:01 +00:00
|
|
|
Inspects, updates and manages submodules.
|
2008-07-18 13:40:41 +00:00
|
|
|
|
2017-06-22 21:01:49 +00:00
|
|
|
For more information about submodules, see linkgit:gitsubmodules[7].
|
2008-07-16 18:44:12 +00:00
|
|
|
|
2007-05-26 13:56:40 +00:00
|
|
|
COMMANDS
|
|
|
|
|
--------
|
2019-02-15 09:26:41 +00:00
|
|
|
With no arguments, shows the status of existing submodules. Several
|
|
|
|
|
subcommands are available to perform operations on the submodules.
|
|
|
|
|
|
2016-12-27 23:43:08 +00:00
|
|
|
add [-b <branch>] [-f|--force] [--name <name>] [--reference <repository>] [--depth <depth>] [--] <repository> [<path>]::
|
2007-06-24 21:06:07 +00:00
|
|
|
Add the given repository as a submodule at the given path
|
git-submodule - make "submodule add" more strict, and document it
This change makes "submodule add" much more strict in the arguments it
takes, and is intended to address confusion as recently noted on the
git-list. With this change, the required syntax is:
$ git submodule add URL path
Specifically, this eliminates the form
$ git submodule add URL
which was confused by more than one person as
$ git submodule add path
With this patch, the URL locating the submodule's origin repository can be
either an absolute URL, or (if it begins with ./ or ../) can express the
submodule's repository location relative to the superproject's origin.
This patch also eliminates a third form of URL, which was relative to the
superproject's top-level directory (not its repository). Any URL that was
neither absolute nor matched ./*|../* was assumed to point to a
subdirectory of the superproject as the location of the submodule's origin
repository. This URL form was confusing and does not seem to correspond
to an important use-case. Specifically, no-one has identified the need to
clone from a repository already in the superproject's tree, but if this is
needed it is easily done using an absolute URL: $(pwd)/relative-path. So,
no functionality is lost with this patch. (t6008-rev-list-submodule.sh did
rely upon this relative URL, fixed by using $(pwd).)
Following this change, there are exactly four variants of
submodule-add, as both arguments have two flavors:
URL can be absolute, or can begin with ./|../ and thus names the
submodule's origin relative to the superproject's origin.
Note: With this patch, "submodule add" discerns an absolute URL as
matching /*|*:*: e.g., URL begins with /, or it contains a :. This works
for all valid URLs, an absolute path in POSIX, as well as an absolute path
on Windows).
path can either already exist as a valid git repo, or will be cloned from
the given URL. The first form here eases creation of a new submodule in
an existing superproject as the submodule can be added and tested in-tree
before pushing to the public repository. However, the more usual form is
the second, where the repo is cloned from the given URL.
This specifically addresses the issue of
$ git submodule add a/b/c
attempting to clone from a repository at "a/b/c" to create a new module
in "c". This also simplifies description of "relative URL" as there is now
exactly *one* form: a URL relative to the parent's origin repo.
Signed-off-by: Mark Levedahl <mlevedahl@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-10 01:05:40 +00:00
|
|
|
to the changeset to be committed next to the current
|
2008-07-26 04:17:42 +00:00
|
|
|
project: the current project is termed the "superproject".
|
git-submodule - make "submodule add" more strict, and document it
This change makes "submodule add" much more strict in the arguments it
takes, and is intended to address confusion as recently noted on the
git-list. With this change, the required syntax is:
$ git submodule add URL path
Specifically, this eliminates the form
$ git submodule add URL
which was confused by more than one person as
$ git submodule add path
With this patch, the URL locating the submodule's origin repository can be
either an absolute URL, or (if it begins with ./ or ../) can express the
submodule's repository location relative to the superproject's origin.
This patch also eliminates a third form of URL, which was relative to the
superproject's top-level directory (not its repository). Any URL that was
neither absolute nor matched ./*|../* was assumed to point to a
subdirectory of the superproject as the location of the submodule's origin
repository. This URL form was confusing and does not seem to correspond
to an important use-case. Specifically, no-one has identified the need to
clone from a repository already in the superproject's tree, but if this is
needed it is easily done using an absolute URL: $(pwd)/relative-path. So,
no functionality is lost with this patch. (t6008-rev-list-submodule.sh did
rely upon this relative URL, fixed by using $(pwd).)
Following this change, there are exactly four variants of
submodule-add, as both arguments have two flavors:
URL can be absolute, or can begin with ./|../ and thus names the
submodule's origin relative to the superproject's origin.
Note: With this patch, "submodule add" discerns an absolute URL as
matching /*|*:*: e.g., URL begins with /, or it contains a :. This works
for all valid URLs, an absolute path in POSIX, as well as an absolute path
on Windows).
path can either already exist as a valid git repo, or will be cloned from
the given URL. The first form here eases creation of a new submodule in
an existing superproject as the submodule can be added and tested in-tree
before pushing to the public repository. However, the more usual form is
the second, where the repo is cloned from the given URL.
This specifically addresses the issue of
$ git submodule add a/b/c
attempting to clone from a repository at "a/b/c" to create a new module
in "c". This also simplifies description of "relative URL" as there is now
exactly *one* form: a URL relative to the parent's origin repo.
Signed-off-by: Mark Levedahl <mlevedahl@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-10 01:05:40 +00:00
|
|
|
+
|
|
|
|
|
<repository> is the URL of the new submodule's origin repository.
|
|
|
|
|
This may be either an absolute URL, or (if it begins with ./
|
submodule init: warn about falling back to a local path
When a submodule is initialized, the config variable 'submodule.<name>.url'
is set depending on the value of the same variable in the .gitmodules
file. When the URL indicates to be relative, then the url is computed
relative to its default remote. The default remote cannot be determined
accurately in all cases, such that it falls back to 'origin'.
The 'origin' remote may not exist, though. In that case we give up looking
for a suitable remote and we'll just assume it to be a local relative path.
This can be confusing to users as there is a lot of guessing involved,
which is not obvious to the user.
So in the corner case of assuming a local autoritative truth, warn the
user to lessen the confusion.
This behavior was introduced in 4d6893200 (submodule add: allow relative
repository path even when no url is set, 2011-06-06), which shared the
code with submodule-init and then ported to C in 3604242f080a (submodule:
port init from shell to C, 2016-04-15).
In case of submodule-add, this behavior makes sense in some use cases[1],
however for submodule-init there does not seem to be an immediate obvious
use case to fall back to a local submodule. However there might be, so
warn instead of die here.
While adding the warning, also clarify the behavior of relative URLs in
the documentation.
[1] e.g. http://stackoverflow.com/questions/8721984/git-ignore-files-for-public-repository-but-not-for-private
"store a secret locally in a submodule, with no intention to publish it"
Reported-by: Shawn Pearce <spearce@spearce.org>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-02-25 01:31:47 +00:00
|
|
|
or ../), the location relative to the superproject's default remote
|
2012-01-01 15:13:16 +00:00
|
|
|
repository (Please note that to specify a repository 'foo.git'
|
|
|
|
|
which is located right next to a superproject 'bar.git', you'll
|
2019-03-06 13:04:46 +00:00
|
|
|
have to use `../foo.git` instead of `./foo.git` - as one might expect
|
2012-01-01 15:13:16 +00:00
|
|
|
when following the rules for relative URLs - because the evaluation
|
|
|
|
|
of relative URLs in Git is identical to that of relative directories).
|
submodule init: warn about falling back to a local path
When a submodule is initialized, the config variable 'submodule.<name>.url'
is set depending on the value of the same variable in the .gitmodules
file. When the URL indicates to be relative, then the url is computed
relative to its default remote. The default remote cannot be determined
accurately in all cases, such that it falls back to 'origin'.
The 'origin' remote may not exist, though. In that case we give up looking
for a suitable remote and we'll just assume it to be a local relative path.
This can be confusing to users as there is a lot of guessing involved,
which is not obvious to the user.
So in the corner case of assuming a local autoritative truth, warn the
user to lessen the confusion.
This behavior was introduced in 4d6893200 (submodule add: allow relative
repository path even when no url is set, 2011-06-06), which shared the
code with submodule-init and then ported to C in 3604242f080a (submodule:
port init from shell to C, 2016-04-15).
In case of submodule-add, this behavior makes sense in some use cases[1],
however for submodule-init there does not seem to be an immediate obvious
use case to fall back to a local submodule. However there might be, so
warn instead of die here.
While adding the warning, also clarify the behavior of relative URLs in
the documentation.
[1] e.g. http://stackoverflow.com/questions/8721984/git-ignore-files-for-public-repository-but-not-for-private
"store a secret locally in a submodule, with no intention to publish it"
Reported-by: Shawn Pearce <spearce@spearce.org>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-02-25 01:31:47 +00:00
|
|
|
+
|
2018-06-07 11:53:36 +00:00
|
|
|
The default remote is the remote of the remote-tracking branch
|
|
|
|
|
of the current branch. If no such remote-tracking branch exists or
|
submodule init: warn about falling back to a local path
When a submodule is initialized, the config variable 'submodule.<name>.url'
is set depending on the value of the same variable in the .gitmodules
file. When the URL indicates to be relative, then the url is computed
relative to its default remote. The default remote cannot be determined
accurately in all cases, such that it falls back to 'origin'.
The 'origin' remote may not exist, though. In that case we give up looking
for a suitable remote and we'll just assume it to be a local relative path.
This can be confusing to users as there is a lot of guessing involved,
which is not obvious to the user.
So in the corner case of assuming a local autoritative truth, warn the
user to lessen the confusion.
This behavior was introduced in 4d6893200 (submodule add: allow relative
repository path even when no url is set, 2011-06-06), which shared the
code with submodule-init and then ported to C in 3604242f080a (submodule:
port init from shell to C, 2016-04-15).
In case of submodule-add, this behavior makes sense in some use cases[1],
however for submodule-init there does not seem to be an immediate obvious
use case to fall back to a local submodule. However there might be, so
warn instead of die here.
While adding the warning, also clarify the behavior of relative URLs in
the documentation.
[1] e.g. http://stackoverflow.com/questions/8721984/git-ignore-files-for-public-repository-but-not-for-private
"store a secret locally in a submodule, with no intention to publish it"
Reported-by: Shawn Pearce <spearce@spearce.org>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-02-25 01:31:47 +00:00
|
|
|
the HEAD is detached, "origin" is assumed to be the default remote.
|
|
|
|
|
If the superproject doesn't have a default remote configured
|
2011-06-06 19:58:04 +00:00
|
|
|
the superproject is its own authoritative upstream and the current
|
|
|
|
|
working directory is used instead.
|
git-submodule - make "submodule add" more strict, and document it
This change makes "submodule add" much more strict in the arguments it
takes, and is intended to address confusion as recently noted on the
git-list. With this change, the required syntax is:
$ git submodule add URL path
Specifically, this eliminates the form
$ git submodule add URL
which was confused by more than one person as
$ git submodule add path
With this patch, the URL locating the submodule's origin repository can be
either an absolute URL, or (if it begins with ./ or ../) can express the
submodule's repository location relative to the superproject's origin.
This patch also eliminates a third form of URL, which was relative to the
superproject's top-level directory (not its repository). Any URL that was
neither absolute nor matched ./*|../* was assumed to point to a
subdirectory of the superproject as the location of the submodule's origin
repository. This URL form was confusing and does not seem to correspond
to an important use-case. Specifically, no-one has identified the need to
clone from a repository already in the superproject's tree, but if this is
needed it is easily done using an absolute URL: $(pwd)/relative-path. So,
no functionality is lost with this patch. (t6008-rev-list-submodule.sh did
rely upon this relative URL, fixed by using $(pwd).)
Following this change, there are exactly four variants of
submodule-add, as both arguments have two flavors:
URL can be absolute, or can begin with ./|../ and thus names the
submodule's origin relative to the superproject's origin.
Note: With this patch, "submodule add" discerns an absolute URL as
matching /*|*:*: e.g., URL begins with /, or it contains a :. This works
for all valid URLs, an absolute path in POSIX, as well as an absolute path
on Windows).
path can either already exist as a valid git repo, or will be cloned from
the given URL. The first form here eases creation of a new submodule in
an existing superproject as the submodule can be added and tested in-tree
before pushing to the public repository. However, the more usual form is
the second, where the repo is cloned from the given URL.
This specifically addresses the issue of
$ git submodule add a/b/c
attempting to clone from a repository at "a/b/c" to create a new module
in "c". This also simplifies description of "relative URL" as there is now
exactly *one* form: a URL relative to the parent's origin repo.
Signed-off-by: Mark Levedahl <mlevedahl@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-10 01:05:40 +00:00
|
|
|
+
|
2017-06-22 02:51:42 +00:00
|
|
|
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 `--name` is used
|
|
|
|
|
to specify a logical name.
|
git-submodule - make "submodule add" more strict, and document it
This change makes "submodule add" much more strict in the arguments it
takes, and is intended to address confusion as recently noted on the
git-list. With this change, the required syntax is:
$ git submodule add URL path
Specifically, this eliminates the form
$ git submodule add URL
which was confused by more than one person as
$ git submodule add path
With this patch, the URL locating the submodule's origin repository can be
either an absolute URL, or (if it begins with ./ or ../) can express the
submodule's repository location relative to the superproject's origin.
This patch also eliminates a third form of URL, which was relative to the
superproject's top-level directory (not its repository). Any URL that was
neither absolute nor matched ./*|../* was assumed to point to a
subdirectory of the superproject as the location of the submodule's origin
repository. This URL form was confusing and does not seem to correspond
to an important use-case. Specifically, no-one has identified the need to
clone from a repository already in the superproject's tree, but if this is
needed it is easily done using an absolute URL: $(pwd)/relative-path. So,
no functionality is lost with this patch. (t6008-rev-list-submodule.sh did
rely upon this relative URL, fixed by using $(pwd).)
Following this change, there are exactly four variants of
submodule-add, as both arguments have two flavors:
URL can be absolute, or can begin with ./|../ and thus names the
submodule's origin relative to the superproject's origin.
Note: With this patch, "submodule add" discerns an absolute URL as
matching /*|*:*: e.g., URL begins with /, or it contains a :. This works
for all valid URLs, an absolute path in POSIX, as well as an absolute path
on Windows).
path can either already exist as a valid git repo, or will be cloned from
the given URL. The first form here eases creation of a new submodule in
an existing superproject as the submodule can be added and tested in-tree
before pushing to the public repository. However, the more usual form is
the second, where the repo is cloned from the given URL.
This specifically addresses the issue of
$ git submodule add a/b/c
attempting to clone from a repository at "a/b/c" to create a new module
in "c". This also simplifies description of "relative URL" as there is now
exactly *one* form: a URL relative to the parent's origin repo.
Signed-off-by: Mark Levedahl <mlevedahl@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-10 01:05:40 +00:00
|
|
|
+
|
2017-06-22 02:51:42 +00:00
|
|
|
The given URL is recorded into `.gitmodules` 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 `.gitmodules`.
|
2007-06-24 21:06:07 +00:00
|
|
|
|
2016-12-27 23:43:08 +00:00
|
|
|
status [--cached] [--recursive] [--] [<path>...]::
|
2007-05-26 13:56:40 +00:00
|
|
|
Show the status of the submodules. This will print the SHA-1 of the
|
|
|
|
|
currently checked out commit for each submodule, along with the
|
2010-01-09 23:33:00 +00:00
|
|
|
submodule path and the output of 'git describe' for the
|
2018-01-14 17:37:37 +00:00
|
|
|
SHA-1. Each SHA-1 will possibly be prefixed with `-` if the submodule is
|
|
|
|
|
not initialized, `+` if the currently checked out submodule commit
|
2007-05-26 13:56:40 +00:00
|
|
|
does not match the SHA-1 found in the index of the containing
|
submodule: process conflicting submodules only once
During a merge module_list returns conflicting submodules several times
(stage 1,2,3) which caused the submodules to be used multiple times in
git submodule init, sync, update and status command.
There are 5 callers of module_list; they all read (mode, sha1, stage,
path) tuple, and most of them care only about path. As a first level
approximation, it should be Ok (in the sense that it does not make things
worse than it currently is) to filter the duplicate paths from module_list
output, but some callers should change their behaviour when the merge in
the superproject still has conflicts.
Notice the higher-stage entries, and emit only one record from
module_list, but while doing so, mark the entry with "U" (not [0-3]) in
the $stage field and null out the SHA-1 part, as the object name for the
lowest stage does not give any useful information to the caller, and this
way any caller that uses the object name would hopefully barf. Then
update the codepaths for each subcommands this way:
- "update" should not touch the submodule repository, because we do not
know what commit should be checked out yet.
- "status" reports the conflicting submodules as 'U000...000' and does
not recurse into them (we might later want to make it recurse).
- The command called by "foreach" may want to do whatever it wants to do
by noticing the merged status in the superproject itself, so feed the
path to it from module_list as before, but only once per submodule.
- "init" and "sync" are unlikely things to do while the superproject is
still not merged, but as long as a submodule is there in $path, there
is no point skipping it. It might however want to take the merged
status of .gitmodules into account, but that is outside of the scope of
this topic.
Acked-by: Jens Lehmann <Jens.Lehmann@web.de>
Thanks-to: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Nicolas Morey-Chaisemartin <nicolas@morey-chaisemartin.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-03-30 05:20:02 +00:00
|
|
|
repository and `U` if the submodule has merge conflicts.
|
2009-08-19 01:45:24 +00:00
|
|
|
+
|
2019-11-23 05:54:28 +00:00
|
|
|
If `--cached` is specified, this command will instead print the SHA-1
|
|
|
|
|
recorded in the superproject for each submodule.
|
|
|
|
|
+
|
2011-08-01 20:49:21 +00:00
|
|
|
If `--recursive` is specified, this command will recurse into nested
|
2009-08-19 01:45:24 +00:00
|
|
|
submodules, and show their status as well.
|
2011-08-01 20:49:21 +00:00
|
|
|
+
|
|
|
|
|
If you are only interested in changes of the currently initialized
|
|
|
|
|
submodules with respect to the commit recorded in the index or the HEAD,
|
|
|
|
|
linkgit:git-status[1] and linkgit:git-diff[1] will provide that information
|
|
|
|
|
too (and can also report changes to a submodule's work tree).
|
2007-05-26 13:56:40 +00:00
|
|
|
|
2016-12-27 23:43:08 +00:00
|
|
|
init [--] [<path>...]::
|
2013-05-15 22:28:39 +00:00
|
|
|
Initialize the submodules recorded in the index (which were
|
submodule init: warn about falling back to a local path
When a submodule is initialized, the config variable 'submodule.<name>.url'
is set depending on the value of the same variable in the .gitmodules
file. When the URL indicates to be relative, then the url is computed
relative to its default remote. The default remote cannot be determined
accurately in all cases, such that it falls back to 'origin'.
The 'origin' remote may not exist, though. In that case we give up looking
for a suitable remote and we'll just assume it to be a local relative path.
This can be confusing to users as there is a lot of guessing involved,
which is not obvious to the user.
So in the corner case of assuming a local autoritative truth, warn the
user to lessen the confusion.
This behavior was introduced in 4d6893200 (submodule add: allow relative
repository path even when no url is set, 2011-06-06), which shared the
code with submodule-init and then ported to C in 3604242f080a (submodule:
port init from shell to C, 2016-04-15).
In case of submodule-add, this behavior makes sense in some use cases[1],
however for submodule-init there does not seem to be an immediate obvious
use case to fall back to a local submodule. However there might be, so
warn instead of die here.
While adding the warning, also clarify the behavior of relative URLs in
the documentation.
[1] e.g. http://stackoverflow.com/questions/8721984/git-ignore-files-for-public-repository-but-not-for-private
"store a secret locally in a submodule, with no intention to publish it"
Reported-by: Shawn Pearce <spearce@spearce.org>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-02-25 01:31:47 +00:00
|
|
|
added and committed elsewhere) by setting `submodule.$name.url`
|
2017-06-22 02:51:42 +00:00
|
|
|
in .git/config. It uses the same setting from `.gitmodules` as
|
submodule init: warn about falling back to a local path
When a submodule is initialized, the config variable 'submodule.<name>.url'
is set depending on the value of the same variable in the .gitmodules
file. When the URL indicates to be relative, then the url is computed
relative to its default remote. The default remote cannot be determined
accurately in all cases, such that it falls back to 'origin'.
The 'origin' remote may not exist, though. In that case we give up looking
for a suitable remote and we'll just assume it to be a local relative path.
This can be confusing to users as there is a lot of guessing involved,
which is not obvious to the user.
So in the corner case of assuming a local autoritative truth, warn the
user to lessen the confusion.
This behavior was introduced in 4d6893200 (submodule add: allow relative
repository path even when no url is set, 2011-06-06), which shared the
code with submodule-init and then ported to C in 3604242f080a (submodule:
port init from shell to C, 2016-04-15).
In case of submodule-add, this behavior makes sense in some use cases[1],
however for submodule-init there does not seem to be an immediate obvious
use case to fall back to a local submodule. However there might be, so
warn instead of die here.
While adding the warning, also clarify the behavior of relative URLs in
the documentation.
[1] e.g. http://stackoverflow.com/questions/8721984/git-ignore-files-for-public-repository-but-not-for-private
"store a secret locally in a submodule, with no intention to publish it"
Reported-by: Shawn Pearce <spearce@spearce.org>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-02-25 01:31:47 +00:00
|
|
|
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.
|
|
|
|
|
+
|
|
|
|
|
Optional <path> arguments limit which submodules will be initialized.
|
2017-03-17 22:38:02 +00:00
|
|
|
If no path is specified and submodule.active has been configured, submodules
|
|
|
|
|
configured to be active will be initialized, otherwise all submodules are
|
|
|
|
|
initialized.
|
submodule init: warn about falling back to a local path
When a submodule is initialized, the config variable 'submodule.<name>.url'
is set depending on the value of the same variable in the .gitmodules
file. When the URL indicates to be relative, then the url is computed
relative to its default remote. The default remote cannot be determined
accurately in all cases, such that it falls back to 'origin'.
The 'origin' remote may not exist, though. In that case we give up looking
for a suitable remote and we'll just assume it to be a local relative path.
This can be confusing to users as there is a lot of guessing involved,
which is not obvious to the user.
So in the corner case of assuming a local autoritative truth, warn the
user to lessen the confusion.
This behavior was introduced in 4d6893200 (submodule add: allow relative
repository path even when no url is set, 2011-06-06), which shared the
code with submodule-init and then ported to C in 3604242f080a (submodule:
port init from shell to C, 2016-04-15).
In case of submodule-add, this behavior makes sense in some use cases[1],
however for submodule-init there does not seem to be an immediate obvious
use case to fall back to a local submodule. However there might be, so
warn instead of die here.
While adding the warning, also clarify the behavior of relative URLs in
the documentation.
[1] e.g. http://stackoverflow.com/questions/8721984/git-ignore-files-for-public-repository-but-not-for-private
"store a secret locally in a submodule, with no intention to publish it"
Reported-by: Shawn Pearce <spearce@spearce.org>
Signed-off-by: Stefan Beller <sbeller@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-02-25 01:31:47 +00:00
|
|
|
+
|
|
|
|
|
When present, it will also copy the value of `submodule.$name.update`.
|
|
|
|
|
This command does not alter existing information in .git/config.
|
|
|
|
|
You can then customize the submodule clone URLs in .git/config
|
|
|
|
|
for your local setup and proceed to `git submodule update`;
|
|
|
|
|
you can also just use `git submodule update --init` without
|
|
|
|
|
the explicit 'init' step if you do not intend to customize
|
|
|
|
|
any submodule locations.
|
|
|
|
|
+
|
2017-06-25 10:20:41 +00:00
|
|
|
See the add subcommand for the definition of default remote.
|
2007-05-26 13:56:40 +00:00
|
|
|
|
2016-12-27 23:43:08 +00:00
|
|
|
deinit [-f|--force] (--all|[--] <path>...)::
|
2013-03-04 21:20:24 +00:00
|
|
|
Unregister the given submodules, i.e. remove the whole
|
|
|
|
|
`submodule.$name` section from .git/config together with their work
|
|
|
|
|
tree. Further calls to `git submodule update`, `git submodule foreach`
|
|
|
|
|
and `git submodule sync` will skip any unregistered submodules until
|
|
|
|
|
they are initialized again, so use this command if you don't want to
|
2017-06-22 21:01:49 +00:00
|
|
|
have a local checkout of the submodule in your working tree anymore.
|
2013-03-04 21:20:24 +00:00
|
|
|
+
|
2016-05-05 19:52:32 +00:00
|
|
|
When the command is run without pathspec, it errors out,
|
|
|
|
|
instead of deinit-ing everything, to prevent mistakes.
|
|
|
|
|
+
|
|
|
|
|
If `--force` is specified, the submodule's working tree will
|
|
|
|
|
be removed even if it contains local modifications.
|
2017-06-22 21:01:49 +00:00
|
|
|
+
|
|
|
|
|
If you really want to remove a submodule from the repository and commit
|
|
|
|
|
that use linkgit:git-rm[1] instead. See linkgit:gitsubmodules[7] for removal
|
|
|
|
|
options.
|
2013-03-04 21:20:24 +00:00
|
|
|
|
2020-02-21 03:10:27 +00:00
|
|
|
update [--init] [--remote] [-N|--no-fetch] [--[no-]recommend-shallow] [-f|--force] [--checkout|--rebase|--merge] [--reference <repository>] [--depth <depth>] [--recursive] [--jobs <n>] [--[no-]single-branch] [--] [<path>...]::
|
2008-05-16 10:23:03 +00:00
|
|
|
+
|
2015-03-02 22:57:58 +00:00
|
|
|
--
|
|
|
|
|
Update the registered submodules to match what the superproject
|
2019-11-24 02:01:35 +00:00
|
|
|
expects by cloning missing submodules, fetching missing commits
|
|
|
|
|
in submodules and updating the working tree of
|
2015-03-02 22:57:58 +00:00
|
|
|
the submodules. The "updating" can be done in several ways depending
|
|
|
|
|
on command line options and the value of `submodule.<name>.update`
|
2016-12-27 23:43:09 +00:00
|
|
|
configuration variable. The command line option takes precedence over
|
2018-01-14 17:37:37 +00:00
|
|
|
the configuration variable. If neither is given, a 'checkout' is performed.
|
|
|
|
|
The 'update' procedures supported both from the command line as well as
|
|
|
|
|
through the `submodule.<name>.update` configuration are:
|
2015-03-02 22:57:58 +00:00
|
|
|
|
|
|
|
|
checkout;; the commit recorded in the superproject will be
|
2016-12-27 23:43:09 +00:00
|
|
|
checked out in the submodule on a detached HEAD.
|
2015-03-02 22:57:58 +00:00
|
|
|
+
|
|
|
|
|
If `--force` is specified, the submodule will be checked out (using
|
2018-01-14 17:37:37 +00:00
|
|
|
`git checkout --force`), even if the commit specified
|
2015-03-02 22:57:58 +00:00
|
|
|
in the index of the containing repository already matches the commit
|
|
|
|
|
checked out in the submodule.
|
|
|
|
|
|
|
|
|
|
rebase;; the current branch of the submodule will be rebased
|
2016-12-27 23:43:09 +00:00
|
|
|
onto the commit recorded in the superproject.
|
2015-03-02 22:57:58 +00:00
|
|
|
|
|
|
|
|
merge;; the commit recorded in the superproject will be merged
|
2016-12-27 23:43:09 +00:00
|
|
|
into the current branch in the submodule.
|
|
|
|
|
|
2018-01-14 17:37:37 +00:00
|
|
|
The following 'update' procedures are only available via the
|
|
|
|
|
`submodule.<name>.update` configuration variable:
|
2015-03-02 22:57:58 +00:00
|
|
|
|
|
|
|
|
custom command;; arbitrary shell command that takes a single
|
|
|
|
|
argument (the sha1 of the commit recorded in the
|
2016-12-27 23:43:09 +00:00
|
|
|
superproject) is executed. When `submodule.<name>.update`
|
|
|
|
|
is set to '!command', the remainder after the exclamation mark
|
|
|
|
|
is the custom command.
|
2015-03-02 22:57:58 +00:00
|
|
|
|
2016-12-27 23:43:09 +00:00
|
|
|
none;; the submodule is not updated.
|
2015-03-02 22:57:58 +00:00
|
|
|
|
2008-05-16 10:23:03 +00:00
|
|
|
If the submodule is not yet initialized, and you just want to use the
|
2017-06-22 02:51:42 +00:00
|
|
|
setting as stored in `.gitmodules`, you can automatically initialize the
|
2011-08-01 20:49:21 +00:00
|
|
|
submodule with the `--init` option.
|
2015-03-02 22:57:58 +00:00
|
|
|
|
2011-08-01 20:49:21 +00:00
|
|
|
If `--recursive` is specified, this command will recurse into the
|
2009-08-19 01:45:23 +00:00
|
|
|
registered submodules, and update any nested submodules within.
|
2015-03-02 22:57:58 +00:00
|
|
|
--
|
2019-09-16 18:19:17 +00:00
|
|
|
set-branch (-b|--branch) <branch> [--] <path>::
|
|
|
|
|
set-branch (-d|--default) [--] <path>::
|
2019-02-08 11:21:34 +00:00
|
|
|
Sets the default remote tracking branch for the submodule. The
|
|
|
|
|
`--branch` option allows the remote branch to be specified. The
|
|
|
|
|
`--default` option removes the submodule.<name>.branch configuration
|
2020-06-24 14:46:30 +00:00
|
|
|
key, which causes the tracking branch to default to the remote 'HEAD'.
|
2019-02-08 11:21:34 +00:00
|
|
|
|
2019-10-29 17:01:52 +00:00
|
|
|
set-url [--] <path> <newurl>::
|
|
|
|
|
Sets the URL of the specified submodule to <newurl>. Then, it will
|
|
|
|
|
automatically synchronize the submodule's new remote URL
|
|
|
|
|
configuration.
|
|
|
|
|
|
2016-12-27 23:43:08 +00:00
|
|
|
summary [--cached|--files] [(-n|--summary-limit) <n>] [commit] [--] [<path>...]::
|
2008-03-11 13:52:18 +00:00
|
|
|
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
|
2011-08-01 20:49:21 +00:00
|
|
|
index or working tree (switched by `--cached`) are shown. If the option
|
|
|
|
|
`--files` is given, show the series of commits in the submodule between
|
2009-08-15 08:40:42 +00:00
|
|
|
the index of the super project and the working tree of the submodule
|
2011-08-01 20:49:21 +00:00
|
|
|
(this option doesn't allow to use the `--cached` option or to provide an
|
2009-08-13 19:32:50 +00:00
|
|
|
explicit commit).
|
2011-08-01 20:49:21 +00:00
|
|
|
+
|
|
|
|
|
Using the `--submodule=log` option with linkgit:git-diff[1] will provide that
|
|
|
|
|
information too.
|
2007-05-26 13:56:40 +00:00
|
|
|
|
2016-12-27 23:43:08 +00:00
|
|
|
foreach [--recursive] <command>::
|
2008-08-10 23:10:04 +00:00
|
|
|
Evaluates an arbitrary shell command in each checked out submodule.
|
2018-05-09 00:29:51 +00:00
|
|
|
The command has access to the variables $name, $sm_path, $displaypath,
|
|
|
|
|
$sha1 and $toplevel:
|
2017-06-22 02:51:42 +00:00
|
|
|
$name is the name of the relevant submodule section in `.gitmodules`,
|
2018-05-09 00:29:50 +00:00
|
|
|
$sm_path is the path of the submodule as recorded in the immediate
|
2018-05-09 00:29:51 +00:00
|
|
|
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
|
2018-05-09 00:29:50 +00:00
|
|
|
superproject, and $toplevel is the absolute path to the top-level
|
|
|
|
|
of the immediate superproject.
|
|
|
|
|
Note that to avoid conflicts with '$PATH' on Windows, the '$path'
|
|
|
|
|
variable is now a deprecated synonym of '$sm_path' variable.
|
2008-08-10 23:10:04 +00:00
|
|
|
Any submodules defined in the superproject but not checked out are
|
2011-08-01 20:49:21 +00:00
|
|
|
ignored by this command. Unless given `--quiet`, foreach prints the name
|
2008-08-10 23:10:04 +00:00
|
|
|
of each submodule before evaluating the command.
|
2011-08-01 20:49:21 +00:00
|
|
|
If `--recursive` is given, submodules are traversed recursively (i.e.
|
2009-08-19 01:45:22 +00:00
|
|
|
the given shell command is evaluated in nested submodules as well).
|
2008-08-10 23:10:04 +00:00
|
|
|
A non-zero return from the command in any submodule causes
|
|
|
|
|
the processing to terminate. This can be overridden by adding '|| :'
|
|
|
|
|
to the end of the command.
|
|
|
|
|
+
|
2017-02-13 21:05:49 +00:00
|
|
|
As an example, the command below will show the path and currently
|
|
|
|
|
checked out commit for each submodule:
|
|
|
|
|
+
|
|
|
|
|
--------------
|
2020-01-31 17:08:43 +00:00
|
|
|
git submodule foreach 'echo $sm_path `git rev-parse HEAD`'
|
2017-02-13 21:05:49 +00:00
|
|
|
--------------
|
2008-08-10 23:10:04 +00:00
|
|
|
|
2016-12-27 23:43:08 +00:00
|
|
|
sync [--recursive] [--] [<path>...]::
|
2008-08-24 19:43:37 +00:00
|
|
|
Synchronizes submodules' remote URL configuration setting
|
2017-06-22 02:51:42 +00:00
|
|
|
to the value specified in `.gitmodules`. It will only affect those
|
2012-03-28 08:41:54 +00:00
|
|
|
submodules which already have a URL entry in .git/config (that is the
|
2011-06-25 20:41:25 +00:00
|
|
|
case when they are initialized or freshly added). This is useful when
|
2008-08-24 19:43:37 +00:00
|
|
|
submodule URLs change upstream and you need to update your local
|
|
|
|
|
repositories accordingly.
|
|
|
|
|
+
|
2018-04-17 19:15:29 +00:00
|
|
|
`git submodule sync` synchronizes all submodules while
|
|
|
|
|
`git submodule sync -- A` synchronizes submodule "A" only.
|
2015-12-03 20:41:02 +00:00
|
|
|
+
|
|
|
|
|
If `--recursive` is specified, this command will recurse into the
|
|
|
|
|
registered submodules, and sync any nested submodules within.
|
2008-08-10 23:10:04 +00:00
|
|
|
|
2016-12-12 19:04:35 +00:00
|
|
|
absorbgitdirs::
|
|
|
|
|
If a git directory of a submodule is inside the submodule,
|
2020-01-06 14:50:13 +00:00
|
|
|
move the git directory of the submodule into its superproject's
|
2016-12-12 19:04:35 +00:00
|
|
|
`$GIT_DIR/modules` path and then connect the git directory and
|
|
|
|
|
its working directory by setting the `core.worktree` and adding
|
|
|
|
|
a .git file pointing to the git directory embedded in the
|
|
|
|
|
superprojects git directory.
|
|
|
|
|
+
|
|
|
|
|
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.
|
|
|
|
|
+
|
|
|
|
|
This command is recursive by default.
|
|
|
|
|
|
2007-05-26 13:56:40 +00:00
|
|
|
OPTIONS
|
|
|
|
|
-------
|
2008-06-08 01:36:09 +00:00
|
|
|
-q::
|
|
|
|
|
--quiet::
|
2007-05-26 13:56:40 +00:00
|
|
|
Only print error messages.
|
|
|
|
|
|
2018-05-03 10:53:45 +00:00
|
|
|
--progress::
|
|
|
|
|
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.
|
|
|
|
|
|
2016-05-05 19:52:32 +00:00
|
|
|
--all::
|
|
|
|
|
This option is only valid for the deinit command. Unregister all
|
|
|
|
|
submodules in the working tree.
|
|
|
|
|
|
2019-02-07 10:18:55 +00:00
|
|
|
-b <branch>::
|
|
|
|
|
--branch <branch>::
|
2007-06-24 21:06:07 +00:00
|
|
|
Branch of repository to add as submodule.
|
2014-03-27 21:06:20 +00:00
|
|
|
The name of the branch is recorded as `submodule.<name>.branch` in
|
2016-10-19 20:42:54 +00:00
|
|
|
`.gitmodules` for `update --remote`. A special value of `.` is used to
|
|
|
|
|
indicate that the name of the branch in the submodule should be the
|
2019-02-07 10:18:55 +00:00
|
|
|
same name as the current branch in the current repository. If the
|
2020-06-24 14:46:30 +00:00
|
|
|
option is not specified, it defaults to the remote 'HEAD'.
|
2007-06-24 21:06:07 +00:00
|
|
|
|
2010-07-17 15:11:43 +00:00
|
|
|
-f::
|
|
|
|
|
--force::
|
2013-03-04 21:20:24 +00:00
|
|
|
This option is only valid for add, deinit and update commands.
|
2011-04-01 09:42:03 +00:00
|
|
|
When running add, allow adding an otherwise ignored submodule path.
|
2016-05-05 19:52:32 +00:00
|
|
|
When running deinit the submodule working trees will be removed even
|
|
|
|
|
if they contain local changes.
|
2015-03-02 22:57:58 +00:00
|
|
|
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.
|
2010-07-17 15:11:43 +00:00
|
|
|
|
2007-05-26 13:56:40 +00:00
|
|
|
--cached::
|
2008-03-11 13:52:18 +00:00
|
|
|
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.
|
|
|
|
|
|
2009-08-13 19:32:50 +00:00
|
|
|
--files::
|
|
|
|
|
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.
|
|
|
|
|
|
2008-06-08 01:36:09 +00:00
|
|
|
-n::
|
|
|
|
|
--summary-limit::
|
2008-03-11 13:52:18 +00:00
|
|
|
This option is only valid for the summary command.
|
|
|
|
|
Limit the summary size (number of commits shown in total).
|
2008-04-13 01:34:39 +00:00
|
|
|
Giving 0 will disable the summary; a negative number means unlimited
|
2008-03-11 13:52:18 +00:00
|
|
|
(the default). This limit only applies to modified submodules. The
|
|
|
|
|
size is always limited to 1 for added/deleted/typechanged submodules.
|
2007-05-26 13:56:40 +00: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 16:03:32 +00:00
|
|
|
--remote::
|
|
|
|
|
This option is only valid for the update command. Instead of using
|
|
|
|
|
the superproject's recorded SHA-1 to update the submodule, use the
|
2013-07-03 09:12:34 +00:00
|
|
|
status of the submodule's remote-tracking branch. The remote used
|
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 16:03:32 +00:00
|
|
|
is branch's remote (`branch.<name>.remote`), defaulting to `origin`.
|
2020-06-24 14:46:30 +00:00
|
|
|
The remote branch used defaults to the remote `HEAD`, but the branch
|
|
|
|
|
name may be overridden by setting the `submodule.<name>.branch`
|
|
|
|
|
option in either `.gitmodules` or `.git/config` (with `.git/config`
|
|
|
|
|
taking precedence).
|
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 16:03:32 +00:00
|
|
|
+
|
|
|
|
|
This works for any of the supported update procedures (`--checkout`,
|
|
|
|
|
`--rebase`, etc.). The only change is the source of the target SHA-1.
|
|
|
|
|
For example, `submodule update --remote --merge` will merge upstream
|
|
|
|
|
submodule changes into the submodules, while `submodule update
|
|
|
|
|
--merge` will merge superproject gitlink changes into the submodules.
|
|
|
|
|
+
|
|
|
|
|
In order to ensure a current tracking branch state, `update --remote`
|
|
|
|
|
fetches the submodule's remote repository before calculating the
|
|
|
|
|
SHA-1. If you don't want to fetch, you should use `submodule update
|
|
|
|
|
--remote --no-fetch`.
|
2014-01-26 20:45:16 +00:00
|
|
|
+
|
|
|
|
|
Use this option to integrate changes from the upstream subproject with
|
|
|
|
|
your submodule's current HEAD. Alternatively, you can run `git pull`
|
|
|
|
|
from the submodule, which is equivalent except for the remote branch
|
|
|
|
|
name: `update --remote` uses the default upstream repository and
|
|
|
|
|
`submodule.<name>.branch`, while `git pull` uses the submodule's
|
|
|
|
|
`branch.<name>.merge`. Prefer `submodule.<name>.branch` if you want
|
|
|
|
|
to distribute the default upstream branch with the superproject and
|
|
|
|
|
`branch.<name>.merge` if you want a more native feel while working in
|
|
|
|
|
the submodule itself.
|
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 16:03:32 +00:00
|
|
|
|
2009-02-05 22:18:32 +00:00
|
|
|
-N::
|
|
|
|
|
--no-fetch::
|
|
|
|
|
This option is only valid for the update command.
|
|
|
|
|
Don't fetch new objects from the remote site.
|
|
|
|
|
|
2014-02-28 22:41:11 +00:00
|
|
|
--checkout::
|
|
|
|
|
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 `submodule.$name.update` when set to
|
2015-03-02 22:57:58 +00:00
|
|
|
a value other than `checkout`.
|
2014-02-28 22:41:11 +00:00
|
|
|
If the key `submodule.$name.update` is either not explicitly set or
|
|
|
|
|
set to `checkout`, this option is implicit.
|
|
|
|
|
|
2009-06-02 22:59:12 +00:00
|
|
|
--merge::
|
|
|
|
|
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 `submodule.$name.update` is set to `merge`, this option is
|
|
|
|
|
implicit.
|
|
|
|
|
|
2009-04-23 23:06:38 +00:00
|
|
|
--rebase::
|
|
|
|
|
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
|
2010-01-31 13:24:39 +00:00
|
|
|
be detached. If a merge failure prevents this process, you will have
|
2009-04-23 23:06:38 +00:00
|
|
|
to resolve these failures with linkgit:git-rebase[1].
|
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 06:27:06 +00:00
|
|
|
If the key `submodule.$name.update` is set to `rebase`, this option is
|
2009-04-23 23:06:38 +00:00
|
|
|
implicit.
|
|
|
|
|
|
2011-08-01 20:49:21 +00:00
|
|
|
--init::
|
|
|
|
|
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.
|
|
|
|
|
|
2012-09-29 23:05:58 +00:00
|
|
|
--name::
|
|
|
|
|
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 '/'.
|
|
|
|
|
|
2009-05-04 19:30:01 +00:00
|
|
|
--reference <repository>::
|
|
|
|
|
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 linkgit:git-clone[1] command.
|
|
|
|
|
+
|
|
|
|
|
*NOTE*: Do *not* use this option unless you have read the note
|
2018-05-03 10:53:46 +00:00
|
|
|
for linkgit:git-clone[1]'s `--reference`, `--shared`, and `--dissociate`
|
|
|
|
|
options carefully.
|
|
|
|
|
|
|
|
|
|
--dissociate::
|
|
|
|
|
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 linkgit:git-clone[1] command.
|
|
|
|
|
+
|
|
|
|
|
*NOTE*: see the NOTE for the `--reference` option.
|
2009-05-04 19:30:01 +00:00
|
|
|
|
2009-08-19 01:45:22 +00:00
|
|
|
--recursive::
|
2015-12-03 20:41:02 +00:00
|
|
|
This option is only valid for foreach, update, status and sync commands.
|
2009-08-19 01:45:22 +00:00
|
|
|
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).
|
|
|
|
|
|
2013-07-02 21:42:56 +00:00
|
|
|
--depth::
|
|
|
|
|
This option is valid for add and update commands. Create a 'shallow'
|
|
|
|
|
clone with a history truncated to the specified number of revisions.
|
|
|
|
|
See linkgit:git-clone[1]
|
|
|
|
|
|
2016-05-26 21:59:43 +00:00
|
|
|
--[no-]recommend-shallow::
|
|
|
|
|
This option is only valid for the update command.
|
|
|
|
|
The initial clone of a submodule will use the recommended
|
2017-06-22 02:51:42 +00:00
|
|
|
`submodule.<name>.shallow` as provided by the `.gitmodules` file
|
2016-05-26 21:59:43 +00:00
|
|
|
by default. To ignore the suggestions use `--no-recommend-shallow`.
|
|
|
|
|
|
2016-03-01 02:07:19 +00:00
|
|
|
-j <n>::
|
|
|
|
|
--jobs <n>::
|
|
|
|
|
This option is only valid for the update command.
|
|
|
|
|
Clone new submodules in parallel with as many jobs.
|
|
|
|
|
Defaults to the `submodule.fetchJobs` option.
|
2013-07-02 21:42:56 +00:00
|
|
|
|
2020-02-21 03:10:27 +00:00
|
|
|
--[no-]single-branch::
|
|
|
|
|
This option is only valid for the update command.
|
|
|
|
|
Clone only one branch during update: HEAD or one specified by --branch.
|
|
|
|
|
|
2008-07-30 09:33:43 +00:00
|
|
|
<path>...::
|
|
|
|
|
Paths to submodule(s). When specified this will restrict the command
|
2007-05-26 13:56:40 +00:00
|
|
|
to only operate on the submodules found at the specified paths.
|
git-submodule - make "submodule add" more strict, and document it
This change makes "submodule add" much more strict in the arguments it
takes, and is intended to address confusion as recently noted on the
git-list. With this change, the required syntax is:
$ git submodule add URL path
Specifically, this eliminates the form
$ git submodule add URL
which was confused by more than one person as
$ git submodule add path
With this patch, the URL locating the submodule's origin repository can be
either an absolute URL, or (if it begins with ./ or ../) can express the
submodule's repository location relative to the superproject's origin.
This patch also eliminates a third form of URL, which was relative to the
superproject's top-level directory (not its repository). Any URL that was
neither absolute nor matched ./*|../* was assumed to point to a
subdirectory of the superproject as the location of the submodule's origin
repository. This URL form was confusing and does not seem to correspond
to an important use-case. Specifically, no-one has identified the need to
clone from a repository already in the superproject's tree, but if this is
needed it is easily done using an absolute URL: $(pwd)/relative-path. So,
no functionality is lost with this patch. (t6008-rev-list-submodule.sh did
rely upon this relative URL, fixed by using $(pwd).)
Following this change, there are exactly four variants of
submodule-add, as both arguments have two flavors:
URL can be absolute, or can begin with ./|../ and thus names the
submodule's origin relative to the superproject's origin.
Note: With this patch, "submodule add" discerns an absolute URL as
matching /*|*:*: e.g., URL begins with /, or it contains a :. This works
for all valid URLs, an absolute path in POSIX, as well as an absolute path
on Windows).
path can either already exist as a valid git repo, or will be cloned from
the given URL. The first form here eases creation of a new submodule in
an existing superproject as the submodule can be added and tested in-tree
before pushing to the public repository. However, the more usual form is
the second, where the repo is cloned from the given URL.
This specifically addresses the issue of
$ git submodule add a/b/c
attempting to clone from a repository at "a/b/c" to create a new module
in "c". This also simplifies description of "relative URL" as there is now
exactly *one* form: a URL relative to the parent's origin repo.
Signed-off-by: Mark Levedahl <mlevedahl@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2008-07-10 01:05:40 +00:00
|
|
|
(This argument is required with add).
|
2007-05-26 13:56:40 +00:00
|
|
|
|
|
|
|
|
FILES
|
|
|
|
|
-----
|
2017-06-22 02:51:42 +00:00
|
|
|
When initializing submodules, a `.gitmodules` file in the top-level directory
|
2007-05-26 13:56:40 +00:00
|
|
|
of the containing repository is used to find the url of each submodule.
|
2007-12-28 07:29:53 +00:00
|
|
|
This file should be formatted in the same way as `$GIT_DIR/config`. The key
|
2007-12-29 06:20:38 +00:00
|
|
|
to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5]
|
2007-12-17 06:03:21 +00:00
|
|
|
for details.
|
2007-05-26 13:56:40 +00:00
|
|
|
|
2017-06-22 21:01:49 +00:00
|
|
|
SEE ALSO
|
|
|
|
|
--------
|
|
|
|
|
linkgit:gitsubmodules[7], linkgit:gitmodules[5].
|
|
|
|
|
|
2007-05-26 13:56:40 +00:00
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 07:07:32 +00:00
|
|
|
Part of the linkgit:git[1] suite
|