]> git.ipfire.org Git - thirdparty/git.git/commit - Documentation/git-submodule.txt
Add git-submodule command
authorLars Hjemli <hjemli@gmail.com>
Sat, 26 May 2007 13:56:40 +0000 (15:56 +0200)
committerJunio C Hamano <junkio@cox.net>
Sun, 27 May 2007 03:24:07 +0000 (20:24 -0700)
commit70c7ac22de681a83621bda03e676348170c8d8a2
tree604b5ea434354562c978a5ce479c95af0c147118
parent99b5a79e1329468bee26ae3bd9070c47418279d0
Add git-submodule command

This command can be used to initialize, update and inspect submodules. It
uses a .gitmodules file, readable by git-config, in the top level directory
of the 'superproject' to specify a mapping between submodule paths and
repository url.

Example .gitmodules layout:

[module "git"]
url = git://git.kernel.org/pub/scm/git/git.git

With this entry in .gitmodules (and a commit reference in the index entry for
the path "git"), the command 'git submodule init' will clone the repository
at kernel.org into the directory "git".

Known issues
============
There is currently no way to override the url found in the .gitmodules file,
except by manually creating the subproject repository. The place to fix this
in the script has a rather long comment about a possible plan.

Funny paths will be quoted in the output from git-ls-files, but git-submodule
does not attempt to unquote (or even detect the presence of) such paths.

Signed-off-by: Lars Hjemli <hjemli@gmail.com>
Signed-off-by: Junio C Hamano <junkio@cox.net>
.gitignore
Documentation/cmd-list.perl
Documentation/git-submodule.txt [new file with mode: 0644]
Makefile
git-submodule.sh [new file with mode: 0755]