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. The name is set to the path where the
  22 submodule has been added unless it was customized with the '--name'
  23 option of 'git submodule add'. Each submodule section also contains the
  24 following required keys:
  25
  26 submodule.<name>.path::
  27         Defines the path, relative to the top-level directory of the Git
  28         working tree, where the submodule is expected to be checked out.
  29         The path name must not end with a `/`. All submodule paths must
  30         be unique within the .gitmodules file.
  31
  32 submodule.<name>.url::
  33         Defines a URL from which the submodule repository can be cloned.
  34         This may be either an absolute URL ready to be passed to
  35         linkgit:git-clone[1] or (if it begins with ./ or ../) a location
  36         relative to the superproject's origin repository.
  37
  38 In addition, there are a number of optional keys:
  39
  40 submodule.<name>.update::
  41         Defines what to do when the submodule is updated by the
  42         superproject. This is only used by `git submodule init` to
  43         initialize the variable of the same name in .git/config.
  44         Allowed values here are 'checkout', 'rebase', 'merge' or
  45         'none'. See linkgit:git-config[1] for their meaning and other
  46         values that can be configured manually by users.
  47
  48 submodule.<name>.branch::
  49         A remote branch name for tracking updates in the upstream submodule.
  50         If the option is not specified, it defaults to 'master'.  See the
  51         `--remote` documentation in linkgit:git-submodule[1] for details.
  52
  53 submodule.<name>.fetchRecurseSubmodules::
  54         This option can be used to control recursive fetching of this
  55         submodule. If this option is also present in the submodules entry in
  56         .git/config of the superproject, the setting there will override the
  57         one found in .gitmodules.
  58         Both settings can be overridden on the command line by using the
  59         "--[no-]recurse-submodules" option to "git fetch" and "git pull".
  60
  61 submodule.<name>.ignore::
  62         Defines under what circumstances "git status" and the diff family show
  63         a submodule as modified. When set to "all", it will never be considered
  64         modified (but will nonetheless show up in the output of status and
  65         commit when it has been staged), "dirty" will ignore all changes
  66         to the submodules work tree and
  67         takes only differences between the HEAD of the submodule and the commit
  68         recorded in the superproject into account. "untracked" will additionally
  69         let submodules with modified tracked files in their work tree show up.
  70         Using "none" (the default when this option is not set) also shows
  71         submodules that have untracked files in their work tree as changed.
  72         If this option is also present in the submodules entry in .git/config of
  73         the superproject, the setting there will override the one found in
  74         .gitmodules.
  75         Both settings can be overridden on the command line by using the
  76         "--ignore-submodule" option. The 'git submodule' commands are not
  77         affected by this setting.
  78
  79
  80 EXAMPLES
  81 --------
  82
  83 Consider the following .gitmodules file:
  84
  85         [submodule "libfoo"]
  86                 path = include/foo
  87                 url = git://foo.com/git/lib.git
  88
  89         [submodule "libbar"]
  90                 path = include/bar
  91                 url = git://bar.com/git/lib.git
  92
  93
  94 This defines two submodules, `libfoo` and `libbar`. These are expected to
  95 be checked out in the paths 'include/foo' and 'include/bar', and for both
  96 submodules a URL is specified which can be used for cloning the submodules.
  97
  98 SEE ALSO
  99 --------
 100 linkgit:git-submodule[1] linkgit:git-config[1]
 101
 102 GIT
 103 ---
 104 Part of the linkgit:git[1] suite