2007-05-26 21:56:40 +08:00
|
|
|
git-submodule(1)
|
|
|
|
|
================
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
----
|
|
|
|
|
git-submodule - Initialize, update or inspect submodules
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
--------
|
2007-07-07 08:56:31 +08:00
|
|
|
[verse]
|
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 09:05:40 +08:00
|
|
|
'git submodule' [--quiet] add [-b branch] [--] <repository> <path>
|
2008-06-30 14:09:04 +08:00
|
|
|
'git submodule' [--quiet] status [--cached] [--] [<path>...]
|
|
|
|
|
'git submodule' [--quiet] init [--] [<path>...]
|
|
|
|
|
'git submodule' [--quiet] update [--init] [--] [<path>...]
|
|
|
|
|
'git submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...]
|
2007-05-26 21:56:40 +08:00
|
|
|
|
|
|
|
|
|
2008-07-17 02:44:12 +08:00
|
|
|
DESCRIPTION
|
|
|
|
|
-----------
|
2008-07-18 21:40:41 +08: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.
|
|
|
|
|
A record in the `.gitmodules` 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.
|
|
|
|
|
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-17 02:44:12 +08:00
|
|
|
|
|
|
|
|
|
2007-05-26 21:56:40 +08:00
|
|
|
COMMANDS
|
|
|
|
|
--------
|
2007-06-25 05:06:07 +08: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 09:05:40 +08:00
|
|
|
to the changeset to be committed next to the current
|
2008-07-26 12:17:42 +08: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 09:05:40 +08:00
|
|
|
+
|
|
|
|
|
This requires two arguments: <repository> and <path>.
|
|
|
|
|
+
|
|
|
|
|
<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
|
|
|
|
|
repository.
|
|
|
|
|
+
|
|
|
|
|
<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
|
|
|
|
|
superproject's URL need be provided: git-submodule will correctly
|
|
|
|
|
locate the submodule using the relative URL in .gitmodules.
|
2007-06-25 05:06:07 +08:00
|
|
|
|
2007-05-26 21:56:40 +08: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
|
2008-07-03 13:41:41 +08:00
|
|
|
submodule path and the output of 'git-describe' for the
|
2007-05-26 21:56:40 +08:00
|
|
|
SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not
|
|
|
|
|
initialized and `+` if the currently checked out submodule commit
|
|
|
|
|
does not match the SHA-1 found in the index of the containing
|
2008-07-03 13:41:41 +08:00
|
|
|
repository. This command is the default command for 'git-submodule'.
|
2007-05-26 21:56:40 +08:00
|
|
|
|
|
|
|
|
init::
|
2008-07-18 21:40:41 +08:00
|
|
|
Initialize the submodules, i.e. register each submodule name
|
|
|
|
|
and url found in .gitmodules into .git/config.
|
|
|
|
|
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
|
|
|
|
|
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.
|
2007-05-26 21:56:40 +08:00
|
|
|
|
|
|
|
|
update::
|
2007-06-06 17:13:02 +08:00
|
|
|
Update the registered submodules, i.e. clone missing submodules and
|
|
|
|
|
checkout the commit specified in the index of the containing repository.
|
|
|
|
|
This will make the submodules HEAD be detached.
|
2008-05-16 18:23:03 +08: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
|
|
|
|
|
submodule with the --init option.
|
2007-05-26 21:56:40 +08:00
|
|
|
|
2008-03-11 21:52:18 +08: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
|
|
|
|
|
index or working tree (switched by --cached) are shown.
|
2007-05-26 21:56:40 +08:00
|
|
|
|
|
|
|
|
OPTIONS
|
|
|
|
|
-------
|
2008-06-08 09:36:09 +08:00
|
|
|
-q::
|
|
|
|
|
--quiet::
|
2007-05-26 21:56:40 +08:00
|
|
|
Only print error messages.
|
|
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-b::
|
|
|
|
|
--branch::
|
2007-06-25 05:06:07 +08:00
|
|
|
Branch of repository to add as submodule.
|
|
|
|
|
|
2007-05-26 21:56:40 +08:00
|
|
|
--cached::
|
2008-03-11 21:52:18 +08: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.
|
|
|
|
|
|
2008-06-08 09:36:09 +08:00
|
|
|
-n::
|
|
|
|
|
--summary-limit::
|
2008-03-11 21:52:18 +08:00
|
|
|
This option is only valid for the summary command.
|
|
|
|
|
Limit the summary size (number of commits shown in total).
|
2008-04-13 09:34:39 +08:00
|
|
|
Giving 0 will disable the summary; a negative number means unlimited
|
2008-03-11 21:52:18 +08: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 21:56:40 +08:00
|
|
|
|
2008-07-30 17:33:43 +08:00
|
|
|
<path>...::
|
|
|
|
|
Paths to submodule(s). When specified this will restrict the command
|
2007-05-26 21:56:40 +08: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 09:05:40 +08:00
|
|
|
(This argument is required with add).
|
2007-05-26 21:56:40 +08:00
|
|
|
|
|
|
|
|
FILES
|
|
|
|
|
-----
|
2007-06-06 17:13:02 +08:00
|
|
|
When initializing submodules, a .gitmodules file in the top-level directory
|
2007-05-26 21:56:40 +08:00
|
|
|
of the containing repository is used to find the url of each submodule.
|
2007-12-28 15:29:53 +08:00
|
|
|
This file should be formatted in the same way as `$GIT_DIR/config`. The key
|
2007-12-29 14:20:38 +08:00
|
|
|
to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5]
|
2007-12-17 14:03:21 +08:00
|
|
|
for details.
|
2007-05-26 21:56:40 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
AUTHOR
|
|
|
|
|
------
|
|
|
|
|
Written by Lars Hjemli <hjemli@gmail.com>
|
|
|
|
|
|
|
|
|
|
GIT
|
|
|
|
|
---
|
2008-06-06 15:07:32 +08:00
|
|
|
Part of the linkgit:git[1] suite
|
