gitsubmodules man page

gitsubmodules — mounting one repository inside another


.gitmodules, $GIT_DIR/config
git submodule
git <command> --recurse-submodules


A submodule is a repository embedded inside another repository. The submodule has its own history; the repository it is embedded in is called a superproject.

On the filesystem, a submodule usually (but not always - see Forms below) consists of (i) a Git directory located under the $GIT_DIR/modules/ directory of its superproject, (ii) a working directory inside the superproject’s working directory, and a .git file at the root of the submodule’s working directory pointing to (i).

Assuming the submodule has a Git directory at $GIT_DIR/modules/foo/ and a working directory at path/to/bar/, the superproject tracks the submodule via a gitlink entry in the tree at path/to/bar and an entry in its .gitmodules file (see gitmodules(5)) of the form = path/to/bar.

The gitlink entry contains the object name of the commit that the superproject expects the submodule’s working directory to be at.

The section* in the .gitmodules file gives additional hints to Gits porcelain layer such as where to obtain the submodule via the setting.

Submodules can be used for at least two different use cases:

1. Using another project while maintaining independent history. Submodules allow you to contain the working tree of another project within your own working tree while keeping the history of both projects separate. Also, since submodules are fixed to an arbitrary version, the other project can be independently developed without affecting the superproject, allowing the superproject project to fix itself to new versions only when desired.

2. Splitting a (logically single) project into multiple repositories and tying them back together. This can be used to overcome current limitations of Gits implementation to have finer grained access:

  • Size of the git repository: In its current form Git scales up poorly for large repositories containing content that is not compressed by delta computation between trees. However you can also use submodules to e.g. hold large binary assets and these repositories are then shallowly cloned such that you do not have a large history locally.
  • Transfer size: In its current form Git requires the whole working tree present. It does not allow partial trees to be transferred in fetch or clone.
  • Access control: By restricting user access to submodules, this can be used to implement read/write policies for different users.

The Configuration of Submodules

Submodule operations can be configured using the following mechanisms (from highest to lowest precedence):


Submodules can take the following forms:

Workflow for a Third Party Library

# add a submodule
git submodule add <url> <path>
# occasionally update the submodule to a new version:
git -C <path> checkout <new version>
git add <path>
git commit -m "update submodule to new version"
# See the list of submodules in a superproject
git submodule status
# See FORMS on removing submodules

Workflow for an Artificially Split Repo

# Enable recursion for relevant commands, such that
# regular commands recurse into submodules by default
git config --global submodule.recurse true
# Unlike the other commands below clone still needs
# its own recurse flag:
git clone --recurse <URL> <directory>
cd <directory>
# Get to know the code:
git grep foo
git ls-files
# Get new code
git fetch
git pull --rebase
# change worktree
git checkout
git reset

Implementation Details

When cloning or pulling a repository containing submodules the submodules will not be checked out by default; You can instruct clone to recurse into submodules. The init and update subcommands of git submodule will maintain submodules checked out and at an appropriate revision in your working tree. Alternatively you can set submodule.recurse to have checkout recursing into submodules.

See Also

git-submodule(1), gitmodules(5).


Part of the git(1) suite

Referenced By

git-rm(1), git-submodule(1).

11/30/2017 Git 2.15.1 Git Manual