1GITMODULES(5)                     Git Manual                     GITMODULES(5)
2
3
4

NAME

6       gitmodules - defining submodule properties
7

SYNOPSIS

9       gitmodules
10

DESCRIPTION

12       The .gitmodules file, located in the top-level directory of a git
13       working tree, is a text file with a syntax matching the requirements of
14       git-config(1).
15
16       The file contains one subsection per submodule, and the subsection
17       value is the name of the submodule. Each submodule section also
18       contains the following required keys:
19
20       submodule.<name>.path
21           Defines the path, relative to the top-level directory of the git
22           working tree, where the submodule is expected to be checked out.
23           The path name must not end with a /. All submodule paths must be
24           unique within the .gitmodules file.
25
26       submodule.<name>.url
27           Defines an url from where the submodule repository can be cloned.
28

EXAMPLES

30       Consider the following .gitmodules file:
31
32
33           [submodule "libfoo"]
34                   path = include/foo
35                   url = git://foo.com/git/lib.git
36
37           [submodule "libbar"]
38                   path = include/bar
39                   url = git://bar.com/git/lib.git
40       This defines two submodules, libfoo and libbar. These are expected to
41       be checked out in the paths include/foo and include/bar, and for both
42       submodules an url is specified which can be used for cloning the
43       submodules.
44

SEE ALSO

46       git-submodule(1) git-config(1)
47

DOCUMENTATION

49       Documentation by Lars Hjemli <hjemli@gmail.com>
50

GIT

52       Part of the git(7) suite
53
54
55
56
57Git 1.5.3.3                       10/09/2007                     GITMODULES(5)