2007-05-26 15:56:40 +02:00
|
|
|
git-submodule(1)
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
git-submodule - Initialize, update or inspect submodules
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2007-07-07 02:56:31 +02:00
|
|
|
[verse]
|
2010-07-17 17:11:43 +02:00
|
|
|
'git submodule' [--quiet] add [-b branch] [-f|--force]
|
2009-09-22 17:10:12 +02:00
|
|
|
[--reference <repository>] [--] <repository> [<path>]
|
2009-08-19 03:45:24 +02:00
|
|
|
'git submodule' [--quiet] status [--cached] [--recursive] [--] [<path>...]
|
2008-06-30 08:09:04 +02:00
|
|
|
'git submodule' [--quiet] init [--] [<path>...]
|
2009-06-13 21:49:50 +02:00
|
|
|
'git submodule' [--quiet] update [--init] [-N|--no-fetch] [--rebase]
|
2009-08-19 03:45:23 +02:00
|
|
|
[--reference <repository>] [--merge] [--recursive] [--] [<path>...]
|
2011-08-01 22:49:21 +02:00
|
|
|
'git submodule' [--quiet] summary [--cached|--files] [(-n|--summary-limit) <n>]
|
|
|
|
|
[commit] [--] [<path>...]
|
2009-08-19 03:45:22 +02:00
|
|
|
'git submodule' [--quiet] foreach [--recursive] <command>
|
2008-08-24 21:43:37 +02:00
|
|
|
'git submodule' [--quiet] sync [--] [<path>...]
|
2007-05-26 15:56:40 +02:00
|
|
|
|
|
|
|
|
|
2008-07-16 20:44:12 +02:00
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
2008-07-18 15:40:41 +02:00
|
|
|
Submodules allow foreign repositories to be embedded within
|
|
|
|
|
a dedicated subdirectory of the source tree, always pointed
|
|
|
|
|
at a particular commit.
|
|
|
|
|
|
|
|
|
|
They are not to be confused with remotes, which are meant mainly
|
|
|
|
|
for branches of the same project; submodules are meant for
|
|
|
|
|
different projects you would like to make part of your source tree,
|
|
|
|
|
while the history of the two projects still stays completely
|
|
|
|
|
independent and you cannot modify the contents of the submodule
|
|
|
|
|
from within the main project.
|
|
|
|
|
If you want to merge the project histories and want to treat the
|
|
|
|
|
aggregated whole as a single project from then on, you may want to
|
|
|
|
|
add a remote for the other project and use the 'subtree' merge strategy,
|
|
|
|
|
instead of treating the other project as a submodule. Directories
|
|
|
|
|
that come from both projects can be cloned and checked out as a whole
|
|
|
|
|
if you choose to go that route.
|
|
|
|
|
|
|
|
|
|
Submodules are composed from a so-called `gitlink` tree entry
|
|
|
|
|
in the main repository that refers to a particular commit object
|
|
|
|
|
within the inner repository that is completely separate.
|
2012-05-14 19:32:08 +02:00
|
|
|
A record in the `.gitmodules` (see linkgit:gitmodules[5]) file at the
|
|
|
|
|
root of the source tree assigns a logical name to the submodule and
|
|
|
|
|
describes the default URL the submodule shall be cloned from.
|
2008-07-18 15:40:41 +02:00
|
|
|
The logical name can be used for overriding this URL within your
|
|
|
|
|
local repository configuration (see 'submodule init').
|
|
|
|
|
|
|
|
|
|
This command will manage the tree entries and contents of the
|
|
|
|
|
gitmodules file for you, as well as inspect the status of your
|
|
|
|
|
submodules and update them.
|
|
|
|
|
When adding a new submodule to the tree, the 'add' subcommand
|
|
|
|
|
is to be used. However, when pulling a tree containing submodules,
|
|
|
|
|
these will not be checked out by default;
|
|
|
|
|
the 'init' and 'update' subcommands will maintain submodules
|
|
|
|
|
checked out and at appropriate revision in your working tree.
|
|
|
|
|
You can briefly inspect the up-to-date status of your submodules
|
|
|
|
|
using the 'status' subcommand and get a detailed overview of the
|
|
|
|
|
difference between the index and checkouts using the 'summary'
|
|
|
|
|
subcommand.
|
2008-07-16 20:44:12 +02:00
|
|
|
|
|
|
|
|
|
2007-05-26 15:56:40 +02:00
|
|
|
COMMANDS
|
|
|
|
|
--------
|
2007-06-24 23:06:07 +02:00
|
|
|
add::
|
|
|
|
|
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 03:05:40 +02:00
|
|
|
to the changeset to be committed next to the current
|
2008-07-26 06:17:42 +02: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 03:05:40 +02:00
|
|
|
+
|
2009-09-22 17:10:12 +02:00
|
|
|
This requires at least one argument: <repository>. The optional
|
|
|
|
|
argument <path> is the relative location for the cloned submodule
|
|
|
|
|
to exist in the superproject. If <path> is not given, the
|
|
|
|
|
"humanish" part of the source repository is used ("repo" for
|
|
|
|
|
"/path/to/repo.git" and "foo" for "host.xz:foo/.git").
|
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 03:05:40 +02:00
|
|
|
+
|
|
|
|
|
<repository> is the URL of the new submodule's origin repository.
|
|
|
|
|
This may be either an absolute URL, or (if it begins with ./
|
|
|
|
|
or ../), the location relative to the superproject's origin
|
2012-01-01 16:13:16 +01:00
|
|
|
repository (Please note that to specify a repository 'foo.git'
|
|
|
|
|
which is located right next to a superproject 'bar.git', you'll
|
|
|
|
|
have to use '../foo.git' instead of './foo.git' - as one might expect
|
|
|
|
|
when following the rules for relative URLs - because the evaluation
|
|
|
|
|
of relative URLs in Git is identical to that of relative directories).
|
|
|
|
|
If the superproject doesn't have an origin configured
|
2011-06-06 21:58:04 +02: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 03:05:40 +02:00
|
|
|
+
|
|
|
|
|
<path> is the relative location for the cloned submodule to
|
|
|
|
|
exist in the superproject. If <path> does not exist, then the
|
|
|
|
|
submodule is created by cloning from the named URL. If <path> does
|
|
|
|
|
exist and is already a valid git repository, then this is added
|
|
|
|
|
to the changeset without cloning. This second form is provided
|
|
|
|
|
to ease creating a new submodule from scratch, and presumes
|
|
|
|
|
the user will later push the submodule to the given URL.
|
|
|
|
|
+
|
|
|
|
|
In either case, 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
|
2008-12-19 13:14:18 +01:00
|
|
|
superproject's URL needs to be provided: git-submodule will correctly
|
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 03:05:40 +02:00
|
|
|
locate the submodule using the relative URL in .gitmodules.
|
2007-06-24 23:06:07 +02:00
|
|
|
|
2007-05-26 15:56:40 +02:00
|
|
|
status::
|
|
|
|
|
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-10 00:33:00 +01:00
|
|
|
submodule path and the output of 'git describe' for the
|
2007-05-26 15:56:40 +02:00
|
|
|
SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not
|
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 07:20:02 +02:00
|
|
|
initialized, `+` if the currently checked out submodule commit
|
2007-05-26 15:56:40 +02: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 07:20:02 +02:00
|
|
|
repository and `U` if the submodule has merge conflicts.
|
|
|
|
|
This command is the default command for 'git submodule'.
|
2009-08-19 03:45:24 +02:00
|
|
|
+
|
2011-08-01 22:49:21 +02:00
|
|
|
If `--recursive` is specified, this command will recurse into nested
|
2009-08-19 03:45:24 +02:00
|
|
|
submodules, and show their status as well.
|
2011-08-01 22:49:21 +02: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 15:56:40 +02:00
|
|
|
|
|
|
|
|
init::
|
2008-07-18 15:40:41 +02:00
|
|
|
Initialize the submodules, i.e. register each submodule name
|
|
|
|
|
and url found in .gitmodules into .git/config.
|
2011-08-11 19:51:46 +02:00
|
|
|
It will also copy the value of `submodule.$name.update` into
|
|
|
|
|
.git/config.
|
2008-07-18 15:40:41 +02:00
|
|
|
The key used in .git/config is `submodule.$name.url`.
|
|
|
|
|
This command does not alter existing information in .git/config.
|
|
|
|
|
You can then customize the submodule clone URLs in .git/config
|
2010-01-07 17:49:12 +01:00
|
|
|
for your local setup and proceed to `git submodule update`;
|
|
|
|
|
you can also just use `git submodule update --init` without
|
2008-07-18 15:40:41 +02:00
|
|
|
the explicit 'init' step if you do not intend to customize
|
|
|
|
|
any submodule locations.
|
2007-05-26 15:56:40 +02:00
|
|
|
|
|
|
|
|
update::
|
2007-06-06 11:13:02 +02:00
|
|
|
Update the registered submodules, i.e. clone missing submodules and
|
|
|
|
|
checkout the commit specified in the index of the containing repository.
|
2011-08-01 22:49:21 +02:00
|
|
|
This will make the submodules HEAD be detached unless `--rebase` or
|
|
|
|
|
`--merge` is specified or the key `submodule.$name.update` is set to
|
2012-05-10 20:59:04 +02:00
|
|
|
`rebase`, `merge` or `none`. `none` can be overriden by specifying
|
|
|
|
|
`--checkout`.
|
2008-05-16 12:23:03 +02:00
|
|
|
+
|
|
|
|
|
If the submodule is not yet initialized, and you just want to use the
|
|
|
|
|
setting as stored in .gitmodules, you can automatically initialize the
|
2011-08-01 22:49:21 +02:00
|
|
|
submodule with the `--init` option.
|
2009-08-19 03:45:23 +02:00
|
|
|
+
|
2011-08-01 22:49:21 +02:00
|
|
|
If `--recursive` is specified, this command will recurse into the
|
2009-08-19 03:45:23 +02:00
|
|
|
registered submodules, and update any nested submodules within.
|
2007-05-26 15:56:40 +02:00
|
|
|
|
2008-03-11 14:52:18 +01:00
|
|
|
summary::
|
|
|
|
|
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 22:49:21 +02: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 10:40:42 +02:00
|
|
|
the index of the super project and the working tree of the submodule
|
2011-08-01 22:49:21 +02:00
|
|
|
(this option doesn't allow to use the `--cached` option or to provide an
|
2009-08-13 21:32:50 +02:00
|
|
|
explicit commit).
|
2011-08-01 22:49:21 +02:00
|
|
|
+
|
|
|
|
|
Using the `--submodule=log` option with linkgit:git-diff[1] will provide that
|
|
|
|
|
information too.
|
2007-05-26 15:56:40 +02:00
|
|
|
|
2008-08-11 01:10:04 +02:00
|
|
|
foreach::
|
|
|
|
|
Evaluates an arbitrary shell command in each checked out submodule.
|
2010-05-21 18:10:10 +02:00
|
|
|
The command has access to the variables $name, $path, $sha1 and
|
|
|
|
|
$toplevel:
|
2009-08-16 03:10:08 +02:00
|
|
|
$name is the name of the relevant submodule section in .gitmodules,
|
2008-08-11 01:10:04 +02:00
|
|
|
$path is the name of the submodule directory relative to the
|
2010-05-21 18:10:10 +02:00
|
|
|
superproject, $sha1 is the commit as recorded in the superproject,
|
|
|
|
|
and $toplevel is the absolute path to the top-level of the superproject.
|
2008-08-11 01:10:04 +02:00
|
|
|
Any submodules defined in the superproject but not checked out are
|
2011-08-01 22:49:21 +02:00
|
|
|
ignored by this command. Unless given `--quiet`, foreach prints the name
|
2008-08-11 01:10:04 +02:00
|
|
|
of each submodule before evaluating the command.
|
2011-08-01 22:49:21 +02:00
|
|
|
If `--recursive` is given, submodules are traversed recursively (i.e.
|
2009-08-19 03:45:22 +02:00
|
|
|
the given shell command is evaluated in nested submodules as well).
|
2008-08-11 01:10:04 +02: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.
|
|
|
|
|
+
|
2009-06-28 14:55:45 +02:00
|
|
|
As an example, +git submodule foreach \'echo $path {backtick}git
|
|
|
|
|
rev-parse HEAD{backtick}'+ will show the path and currently checked out
|
|
|
|
|
commit for each submodule.
|
2008-08-11 01:10:04 +02:00
|
|
|
|
2008-08-24 21:43:37 +02:00
|
|
|
sync::
|
|
|
|
|
Synchronizes submodules' remote URL configuration setting
|
2011-06-25 22:41:25 +02:00
|
|
|
to the value specified in .gitmodules. It will only affect those
|
2012-03-28 10:41:54 +02:00
|
|
|
submodules which already have a URL entry in .git/config (that is the
|
2011-06-25 22:41:25 +02:00
|
|
|
case when they are initialized or freshly added). This is useful when
|
2008-08-24 21:43:37 +02:00
|
|
|
submodule URLs change upstream and you need to update your local
|
|
|
|
|
repositories accordingly.
|
|
|
|
|
+
|
|
|
|
|
"git submodule sync" synchronizes all submodules while
|
Documentation: quote double-dash for AsciiDoc
AsciiDoc versions since 5.0.6 treat a double-dash surrounded by spaces
(outside of verbatim environments) as a request to insert an em dash.
Such versions also treat the three-character sequence "\--", when not
followed by another dash, as a request to insert two literal minus
signs. Thus from time to time there have been patches to add
backslashes to AsciiDoc markup to escape double-dashes that are meant
to be represent '--' characters used literally on the command line;
see v1.4.0-rc1~174, Fix up docs where "--" isn't displayed correctly,
2006-05-05, for example.
AsciiDoc 6.0.3 (2005-04-20) made life harder by also treating
double-dashes without surrounding whitespace as markup for an em dash,
though only when formatting for backends other than the manpages
(e.g., HTML). Many pages needed to be changed to use a backslash
before the "--" in names of command-line flags like "--add" (see
v0.99.6~37, Update tutorial, 2005-08-30).
AsciiDoc 8.3.0 (2008-11-29) refined the em-dash rule to avoid that
requirement. Double-dashes without surrounding spaces are not
rendered as em dashes any more unless bordered on both sides by
alphanumeric characters. The unescaped markup for option names (e.g.,
"--add") works fine, and many instances of this style have leaked into
Documentation/; git's HTML documentation contains many spurious em
dashes when formatted by an older toolchain. (This patch will not
change that.)
The upshot: "--" as an isolated word and in phrases like "git
web--browse" must be escaped if it is not to be rendered as an em dash
by current asciidoc. Use "\--" to avoid such misformatting in
sentences in which "--" represents a literal double-minus command line
argument that separates options and revs from pathspecs, and use
"{litdd}" in cases where the double-dash is embedded in the command
name. The latter is just for consistency with v1.7.3-rc0~13^2 (Work
around em-dash handling in newer AsciiDoc, 2010-08-23).
List of lines to fix found by grepping manpages for "(em".
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Improved-by: Junio C Hamano <gitster@pobox.com>
Improved-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2011-06-29 07:35:10 +02:00
|
|
|
"git submodule sync \-- A" synchronizes submodule "A" only.
|
2008-08-11 01:10:04 +02:00
|
|
|
|
2007-05-26 15:56:40 +02:00
|
|
|
OPTIONS
|
|
|
|
|
-------
|
2008-06-08 03:36:09 +02:00
|
|
|
-q::
|
|
|
|
|
--quiet::
|
2007-05-26 15:56:40 +02:00
|
|
|
Only print error messages.
|
|
|
|
|
|
2008-06-08 03:36:09 +02:00
|
|
|
-b::
|
|
|
|
|
--branch::
|
2007-06-24 23:06:07 +02:00
|
|
|
Branch of repository to add as submodule.
|
|
|
|
|
|
2010-07-17 17:11:43 +02:00
|
|
|
-f::
|
|
|
|
|
--force::
|
2011-04-01 11:42:03 +02:00
|
|
|
This option is only valid for add and update commands.
|
|
|
|
|
When running add, allow adding an otherwise ignored submodule path.
|
|
|
|
|
When running update, throw away local changes in submodules when
|
|
|
|
|
switching to a different commit.
|
2010-07-17 17:11:43 +02:00
|
|
|
|
2007-05-26 15:56:40 +02:00
|
|
|
--cached::
|
2008-03-11 14:52:18 +01: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 21:32:50 +02: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 03:36:09 +02:00
|
|
|
-n::
|
|
|
|
|
--summary-limit::
|
2008-03-11 14:52:18 +01:00
|
|
|
This option is only valid for the summary command.
|
|
|
|
|
Limit the summary size (number of commits shown in total).
|
2008-04-13 03:34:39 +02:00
|
|
|
Giving 0 will disable the summary; a negative number means unlimited
|
2008-03-11 14:52:18 +01: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 15:56:40 +02:00
|
|
|
|
2009-02-05 23:18:32 +01:00
|
|
|
-N::
|
|
|
|
|
--no-fetch::
|
|
|
|
|
This option is only valid for the update command.
|
|
|
|
|
Don't fetch new objects from the remote site.
|
|
|
|
|
|
2009-06-03 00:59:12 +02: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-24 01:06:38 +02: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 14:24:39 +01:00
|
|
|
be detached. If a merge failure prevents this process, you will have
|
2009-04-24 01:06:38 +02: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 08:27:06 +02:00
|
|
|
If the key `submodule.$name.update` is set to `rebase`, this option is
|
2009-04-24 01:06:38 +02:00
|
|
|
implicit.
|
|
|
|
|
|
2011-08-01 22:49:21 +02: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.
|
|
|
|
|
|
2009-05-04 21:30:01 +02: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
|
2011-08-01 22:49:21 +02:00
|
|
|
for linkgit:git-clone[1]'s `--reference` and `--shared` options carefully.
|
2009-05-04 21:30:01 +02:00
|
|
|
|
2009-08-19 03:45:22 +02:00
|
|
|
--recursive::
|
2009-08-19 03:45:24 +02:00
|
|
|
This option is only valid for foreach, update and status commands.
|
2009-08-19 03:45:22 +02: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).
|
|
|
|
|
|
2008-07-30 11:33:43 +02:00
|
|
|
<path>...::
|
|
|
|
|
Paths to submodule(s). When specified this will restrict the command
|
2007-05-26 15:56:40 +02: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 03:05:40 +02:00
|
|
|
(This argument is required with add).
|
2007-05-26 15:56:40 +02:00
|
|
|
|
|
|
|
|
FILES
|
|
|
|
|
-----
|
2007-06-06 11:13:02 +02:00
|
|
|
When initializing submodules, a .gitmodules file in the top-level directory
|
2007-05-26 15:56:40 +02:00
|
|
|
of the containing repository is used to find the url of each submodule.
|
2007-12-28 08:29:53 +01:00
|
|
|
This file should be formatted in the same way as `$GIT_DIR/config`. The key
|
2007-12-29 07:20:38 +01:00
|
|
|
to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5]
|
2007-12-17 07:03:21 +01:00
|
|
|
for details.
|
2007-05-26 15:56:40 +02:00
|
|
|
|
|
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 09:07:32 +02:00
|
|
|
Part of the linkgit:git[1] suite
|