logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

gitmodules.5 (6482B)

    

  1. '\" t
  2. .\"     Title: gitmodules
  3. .\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
  4. .\" Generator: DocBook XSL Stylesheets v1.79.2 <http://docbook.sf.net/>
  5. .\"      Date: 2025-03-14
  6. .\"    Manual: Git Manual
  7. .\"    Source: Git 2.49.0
  8. .\"  Language: English
  9. .\"
  10. .TH "GITMODULES" "5" "2025-03-14" "Git 2\&.49\&.0" "Git Manual"
  11. .\" -----------------------------------------------------------------
  12. .\" * Define some portability stuff
  13. .\" -----------------------------------------------------------------
  14. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15. .\" http://bugs.debian.org/507673
  16. .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17. .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18. .ie \n(.g .ds Aq \(aq
  19. .el       .ds Aq '
  20. .\" -----------------------------------------------------------------
  21. .\" * set default formatting
  22. .\" -----------------------------------------------------------------
  23. .\" disable hyphenation
  24. .nh
  25. .\" disable justification (adjust text to left margin only)
  26. .ad l
  27. .\" -----------------------------------------------------------------
  28. .\" * MAIN CONTENT STARTS HERE *
  29. .\" -----------------------------------------------------------------
  30. .SH "NAME"
  31. gitmodules \- Defining submodule properties
  32. .SH "SYNOPSIS"
  33. .sp
  34. $GIT_WORK_TREE/\&.gitmodules
  35. .SH "DESCRIPTION"
  36. .sp
  37. The \&.\fBgitmodules\fR file, located in the top\-level directory of a Git working tree, is a text file with a syntax matching the requirements of \fBgit-config\fR(1)\&.
  38. .sp
  39. The file contains one subsection per submodule, and the subsection value is the name of the submodule\&. The name is set to the path where the submodule has been added unless it was customized with the \fB\-\-name\fR option of \fIgit submodule add\fR\&. Each submodule section also contains the following required keys:
  40. .PP
  41. submodule\&.<name>\&.path
  42. .RS 4
  43. Defines the path, relative to the top\-level directory of the Git working tree, where the submodule is expected to be checked out\&. The path name must not end with a
  44. \fB/\fR\&. All submodule paths must be unique within the \&.\fBgitmodules\fR
  45. file\&.
  46. .RE
  47. .PP
  48. submodule\&.<name>\&.url
  49. .RS 4
  50. Defines a URL from which the submodule repository can be cloned\&. This may be either an absolute URL ready to be passed to
  51. \fBgit-clone\fR(1)
  52. or (if it begins with \&.\fB/\fR
  53. or
  54. \fB\&.\&.\fR\fB/\fR) a location relative to the superproject\(cqs origin repository\&.
  55. .RE
  56. .sp
  57. In addition, there are a number of optional keys:
  58. .PP
  59. submodule\&.<name>\&.update
  60. .RS 4
  61. Defines the default update procedure for the named submodule, i\&.e\&. how the submodule is updated by the
  62. \fBgit\fR
  63. \fBsubmodule\fR
  64. \fBupdate\fR
  65. command in the superproject\&. This is only used by
  66. \fBgit\fR
  67. \fBsubmodule\fR
  68. \fBinit\fR
  69. to initialize the configuration variable of the same name\&. Allowed values here are
  70. \fIcheckout\fR,
  71. \fIrebase\fR,
  72. \fImerge\fR
  73. or
  74. \fInone\fR, but not
  75. \fI!command\fR
  76. (for security reasons)\&. See the description of the
  77. \fIupdate\fR
  78. command in
  79. \fBgit-submodule\fR(1)
  80. for more details\&.
  81. .RE
  82. .PP
  83. submodule\&.<name>\&.branch
  84. .RS 4
  85. A remote branch name for tracking updates in the upstream submodule\&. If the option is not specified, it defaults to the remote
  86. \fBHEAD\fR\&. A special value of \&. is used to indicate that the name of the branch in the submodule should be the same name as the current branch in the current repository\&. See the
  87. \fB\-\-remote\fR
  88. documentation in
  89. \fBgit-submodule\fR(1)
  90. for details\&.
  91. .RE
  92. .PP
  93. submodule\&.<name>\&.fetchRecurseSubmodules
  94. .RS 4
  95. This option can be used to control recursive fetching of this submodule\&. If this option is also present in the submodule\(cqs entry in \&.\fBgit/config\fR
  96. of the superproject, the setting there will override the one found in \&.\fBgitmodules\fR\&. Both settings can be overridden on the command line by using the
  97. \fB\-\-\fR[\fBno\-\fR]\fBrecurse\-submodules\fR
  98. option to
  99. \fBgit\fR
  100. \fBfetch\fR
  101. and
  102. \fBgit\fR
  103. \fBpull\fR\&.
  104. .RE
  105. .PP
  106. submodule\&.<name>\&.ignore
  107. .RS 4
  108. Defines under what circumstances
  109. \fBgit\fR
  110. \fBstatus\fR
  111. and the diff family show a submodule as modified\&. The following values are supported:
  112. .PP
  113. all
  114. .RS 4
  115. The submodule will never be considered modified (but will nonetheless show up in the output of status and commit when it has been staged)\&.
  116. .RE
  117. .PP
  118. dirty
  119. .RS 4
  120. All changes to the submodule\(cqs work tree will be ignored, only committed differences between the
  121. \fBHEAD\fR
  122. of the submodule and its recorded state in the superproject are taken into account\&.
  123. .RE
  124. .PP
  125. untracked
  126. .RS 4
  127. Only untracked files in submodules will be ignored\&. Committed differences and modifications to tracked files will show up\&.
  128. .RE
  129. .PP
  130. none
  131. .RS 4
  132. No modifications to submodules are ignored, all of committed differences, and modifications to tracked and untracked files are shown\&. This is the default option\&.
  133. .RE
  134. .sp
  135. If this option is also present in the submodule\(cqs entry in \&.\fBgit/config\fR
  136. of the superproject, the setting there will override the one found in \&.\fBgitmodules\fR\&.
  137. .sp
  138. Both settings can be overridden on the command line by using the
  139. \fB\-\-ignore\-submodules\fR
  140. option\&. The
  141. \fBgit\fR
  142. \fBsubmodule\fR
  143. commands are not affected by this setting\&.
  144. .RE
  145. .PP
  146. submodule\&.<name>\&.shallow
  147. .RS 4
  148. When set to true, a clone of this submodule will be performed as a shallow clone (with a history depth of 1) unless the user explicitly asks for a non\-shallow clone\&.
  149. .RE
  150. .SH "NOTES"
  151. .sp
  152. Git does not allow the \&.\fBgitmodules\fR file within a working tree to be a symbolic link, and will refuse to check out such a tree entry\&. This keeps behavior consistent when the file is accessed from the index or a tree versus from the filesystem, and helps Git reliably enforce security checks of the file contents\&.
  153. .SH "EXAMPLES"
  154. .sp
  155. Consider the following \&.\fBgitmodules\fR file:
  156. .sp
  157. .if n \{\
  158. .RS 4
  159. .\}
  160. .nf
  161. [submodule "libfoo"]
  162.         path = include/foo
  163.         url = git://foo\&.com/git/lib\&.git
  165. [submodule "libbar"]
  166.         path = include/bar
  167.         url = git://bar\&.com/git/lib\&.git
  168. .fi
  169. .if n \{\
  170. .RE
  171. .\}
  172. .sp
  173. This defines two submodules, \fBlibfoo\fR and \fBlibbar\fR\&. These are expected to be checked out in the paths \fBinclude/foo\fR and \fBinclude/bar\fR, and for both submodules a URL is specified which can be used for cloning the submodules\&.
  174. .SH "SEE ALSO"
  175. .sp
  176. \fBgit-submodule\fR(1), \fBgitsubmodules\fR(7), \fBgit-config\fR(1)
  177. .SH "GIT"
  178. .sp
  179. Part of the \fBgit\fR(1) suite