git.oblomov.eu Git - git/blob - Documentation/gitmodules.txt

   1 gitmodules(5)
   2 =============
   3
   4 NAME
   5 ----
   6 gitmodules - defining submodule properties
   7
   8 SYNOPSIS
   9 --------
  10 $GIT_WORK_DIR/.gitmodules
  11
  12
  13 DESCRIPTION
  14 -----------
  15
  16 The `.gitmodules` file, located in the top-level directory of a git
  17 working tree, is a text file with a syntax matching the requirements
  18 of linkgit:git-config[1].
  19
  20 The file contains one subsection per submodule, and the subsection value
  21 is the name of the submodule. Each submodule section also contains the
  22 following required keys:
  23
  24 submodule.<name>.path::
  25         Defines the path, relative to the top-level directory of the git
  26         working tree, where the submodule is expected to be checked out.
  27         The path name must not end with a `/`. All submodule paths must
  28         be unique within the .gitmodules file.
  29
  30 submodule.<name>.url::
  31         Defines an url from where the submodule repository can be cloned.
  32
  33 submodule.<name>.rebase::
  34         Defines that the submodule should be rebased by default.
  35
  36
  37 EXAMPLES
  38 --------
  39
  40 Consider the following .gitmodules file:
  41
  42         [submodule "libfoo"]
  43                 path = include/foo
  44                 url = git://foo.com/git/lib.git
  45
  46         [submodule "libbar"]
  47                 path = include/bar
  48                 url = git://bar.com/git/lib.git
  49
  50
  51 This defines two submodules, `libfoo` and `libbar`. These are expected to
  52 be checked out in the paths 'include/foo' and 'include/bar', and for both
  53 submodules an url is specified which can be used for cloning the submodules.
  54
  55 SEE ALSO
  56 --------
  57 linkgit:git-submodule[1] linkgit:git-config[1]
  58
  59 DOCUMENTATION
  60 -------------
  61 Documentation by Lars Hjemli <hjemli@gmail.com>
  62
  63 GIT
  64 ---
  65 Part of the linkgit:git[1] suite