man7/gitsubmodules.7

   1 '\" t
   2 .\"     Title: gitsubmodules
   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: 2024-08-21
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.46.0.288.g3a7362eb9f
   8 .\"  Language: English
   9 .\"
  10 .TH "GITSUBMODULES" "7" "2024-08-21" "Git 2\&.46\&.0\&.288\&.g3a7362" "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 gitsubmodules \- Mounting one repository inside another
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 \&.gitmodules, $GIT_DIR/config
  36 .fi
  37 .sp
  38 .nf
  39 git submodule
  40 git <command> \-\-recurse\-submodules
  41 .fi
  42 .SH "DESCRIPTION"
  43 .sp
  44 A submodule is a repository embedded inside another repository\&. The submodule has its own history; the repository it is embedded in is called a superproject\&.
  45 .sp
  46 On the filesystem, a submodule usually (but not always \- see FORMS below) consists of (i) a Git directory located under the \fB$GIT_DIR/modules/\fR directory of its superproject, (ii) a working directory inside the superproject\(cqs working directory, and a \fB\&.git\fR file at the root of the submodule\(cqs working directory pointing to (i)\&.
  47 .sp
  48 Assuming the submodule has a Git directory at \fB$GIT_DIR/modules/foo/\fR and a working directory at \fBpath/to/bar/\fR, the superproject tracks the submodule via a \fBgitlink\fR entry in the tree at \fBpath/to/bar\fR and an entry in its \fB\&.gitmodules\fR file (see \fBgitmodules\fR(5)) of the form \fBsubmodule\&.foo\&.path = path/to/bar\fR\&.
  49 .sp
  50 The \fBgitlink\fR entry contains the object name of the commit that the superproject expects the submodule\(cqs working directory to be at\&.
  51 .sp
  52 The section \fBsubmodule\&.foo\&.*\fR in the \fB\&.gitmodules\fR file gives additional hints to Git\(cqs porcelain layer\&. For example, the \fBsubmodule\&.foo\&.url\fR setting specifies where to obtain the submodule\&.
  53 .sp
  54 Submodules can be used for at least two different use cases:
  55 .sp
  56 .RS 4
  57 .ie n \{\
  58 \h'-04' 1.\h'+01'\c
  59 .\}
  60 .el \{\
  61 .sp -1
  62 .IP "  1." 4.2
  63 .\}
  64 Using another project while maintaining independent history\&. Submodules allow you to contain the working tree of another project within your own working tree while keeping the history of both projects separate\&. Also, since submodules are fixed to an arbitrary version, the other project can be independently developed without affecting the superproject, allowing the superproject project to fix itself to new versions only when desired\&.
  65 .RE
  66 .sp
  67 .RS 4
  68 .ie n \{\
  69 \h'-04' 2.\h'+01'\c
  70 .\}
  71 .el \{\
  72 .sp -1
  73 .IP "  2." 4.2
  74 .\}
  75 Splitting a (logically single) project into multiple repositories and tying them back together\&. This can be used to overcome current limitations of Git\(cqs implementation to have finer grained access:
  76 .sp
  77 .RS 4
  78 .ie n \{\
  79 \h'-04'\(bu\h'+03'\c
  80 .\}
  81 .el \{\
  82 .sp -1
  83 .IP \(bu 2.3
  84 .\}
  85 Size of the Git repository: In its current form Git scales up poorly for large repositories containing content that is not compressed by delta computation between trees\&. For example, you can use submodules to hold large binary assets and these repositories can be shallowly cloned such that you do not have a large history locally\&.
  86 .RE
  87 .sp
  88 .RS 4
  89 .ie n \{\
  90 \h'-04'\(bu\h'+03'\c
  91 .\}
  92 .el \{\
  93 .sp -1
  94 .IP \(bu 2.3
  95 .\}
  96 Transfer size: In its current form Git requires the whole working tree present\&. It does not allow partial trees to be transferred in fetch or clone\&. If the project you work on consists of multiple repositories tied together as submodules in a superproject, you can avoid fetching the working trees of the repositories you are not interested in\&.
  97 .RE
  98 .sp
  99 .RS 4
 100 .ie n \{\
 101 \h'-04'\(bu\h'+03'\c
 102 .\}
 103 .el \{\
 104 .sp -1
 105 .IP \(bu 2.3
 106 .\}
 107 Access control: By restricting user access to submodules, this can be used to implement read/write policies for different users\&.
 108 .RE
 109 .RE
 110 .SH "THE CONFIGURATION OF SUBMODULES"
 111 .sp
 112 Submodule operations can be configured using the following mechanisms (from highest to lowest precedence):
 113 .sp
 114 .RS 4
 115 .ie n \{\
 116 \h'-04'\(bu\h'+03'\c
 117 .\}
 118 .el \{\
 119 .sp -1
 120 .IP \(bu 2.3
 121 .\}
 122 The command line for those commands that support taking submodules as part of their pathspecs\&. Most commands have a boolean flag
 123 \fB\-\-recurse\-submodules\fR
 124 which specifies whether to recurse into submodules\&. Examples are
 125 \fBgrep\fR
 126 and
 127 \fBcheckout\fR\&. Some commands take enums, such as
 128 \fBfetch\fR
 129 and
 130 \fBpush\fR, where you can specify how submodules are affected\&.
 131 .RE
 132 .sp
 133 .RS 4
 134 .ie n \{\
 135 \h'-04'\(bu\h'+03'\c
 136 .\}
 137 .el \{\
 138 .sp -1
 139 .IP \(bu 2.3
 140 .\}
 141 The configuration inside the submodule\&. This includes
 142 \fB$GIT_DIR/config\fR
 143 in the submodule, but also settings in the tree such as a
 144 \fB\&.gitattributes\fR
 145 or
 146 \fB\&.gitignore\fR
 147 files that specify behavior of commands inside the submodule\&.
 148 .sp
 149 For example an effect from the submodule\(cqs
 150 \fB\&.gitignore\fR
 151 file would be observed when you run
 152 \fBgit status \-\-ignore\-submodules=none\fR
 153 in the superproject\&. This collects information from the submodule\(cqs working directory by running
 154 \fBstatus\fR
 155 in the submodule while paying attention to the
 156 \fB\&.gitignore\fR
 157 file of the submodule\&.
 158 .sp
 159 The submodule\(cqs
 160 \fB$GIT_DIR/config\fR
 161 file would come into play when running
 162 \fBgit push \-\-recurse\-submodules=check\fR
 163 in the superproject, as this would check if the submodule has any changes not published to any remote\&. The remotes are configured in the submodule as usual in the
 164 \fB$GIT_DIR/config\fR
 165 file\&.
 166 .RE
 167 .sp
 168 .RS 4
 169 .ie n \{\
 170 \h'-04'\(bu\h'+03'\c
 171 .\}
 172 .el \{\
 173 .sp -1
 174 .IP \(bu 2.3
 175 .\}
 176 The configuration file
 177 \fB$GIT_DIR/config\fR
 178 in the superproject\&. Git only recurses into active submodules (see "ACTIVE SUBMODULES" section below)\&.
 179 .sp
 180 If the submodule is not yet initialized, then the configuration inside the submodule does not exist yet, so where to obtain the submodule from is configured here for example\&.
 181 .RE
 182 .sp
 183 .RS 4
 184 .ie n \{\
 185 \h'-04'\(bu\h'+03'\c
 186 .\}
 187 .el \{\
 188 .sp -1
 189 .IP \(bu 2.3
 190 .\}
 191 The
 192 \fB\&.gitmodules\fR
 193 file inside the superproject\&. A project usually uses this file to suggest defaults for the upstream collection of repositories for the mapping that is required between a submodule\(cqs name and its path\&.
 194 .sp
 195 This file mainly serves as the mapping between the name and path of submodules in the superproject, such that the submodule\(cqs Git directory can be located\&.
 196 .sp
 197 If the submodule has never been initialized, this is the only place where submodule configuration is found\&. It serves as the last fallback to specify where to obtain the submodule from\&.
 198 .RE
 199 .SH "FORMS"
 200 .sp
 201 Submodules can take the following forms:
 202 .sp
 203 .RS 4
 204 .ie n \{\
 205 \h'-04'\(bu\h'+03'\c
 206 .\}
 207 .el \{\
 208 .sp -1
 209 .IP \(bu 2.3
 210 .\}
 211 The basic form described in DESCRIPTION with a Git directory, a working directory, a
 212 \fBgitlink\fR, and a
 213 \fB\&.gitmodules\fR
 214 entry\&.
 215 .RE
 216 .sp
 217 .RS 4
 218 .ie n \{\
 219 \h'-04'\(bu\h'+03'\c
 220 .\}
 221 .el \{\
 222 .sp -1
 223 .IP \(bu 2.3
 224 .\}
 225 "Old\-form" submodule: A working directory with an embedded
 226 \fB\&.git\fR
 227 directory, and the tracking
 228 \fBgitlink\fR
 229 and
 230 \fB\&.gitmodules\fR
 231 entry in the superproject\&. This is typically found in repositories generated using older versions of Git\&.
 232 .sp
 233 It is possible to construct these old form repositories manually\&.
 234 .sp
 235 When deinitialized or deleted (see below), the submodule\(cqs Git directory is automatically moved to
 236 \fB$GIT_DIR/modules/<name>/\fR
 237 of the superproject\&.
 238 .RE
 239 .sp
 240 .RS 4
 241 .ie n \{\
 242 \h'-04'\(bu\h'+03'\c
 243 .\}
 244 .el \{\
 245 .sp -1
 246 .IP \(bu 2.3
 247 .\}
 248 Deinitialized submodule: A
 249 \fBgitlink\fR, and a
 250 \fB\&.gitmodules\fR
 251 entry, but no submodule working directory\&. The submodule\(cqs Git directory may be there as after deinitializing the Git directory is kept around\&. The directory which is supposed to be the working directory is empty instead\&.
 252 .sp
 253 A submodule can be deinitialized by running
 254 \fBgit submodule deinit\fR\&. Besides emptying the working directory, this command only modifies the superproject\(cqs
 255 \fB$GIT_DIR/config\fR
 256 file, so the superproject\(cqs history is not affected\&. This can be undone using
 257 \fBgit submodule init\fR\&.
 258 .RE
 259 .sp
 260 .RS 4
 261 .ie n \{\
 262 \h'-04'\(bu\h'+03'\c
 263 .\}
 264 .el \{\
 265 .sp -1
 266 .IP \(bu 2.3
 267 .\}
 268 Deleted submodule: A submodule can be deleted by running
 269 \fBgit rm <submodule\-path> && git commit\fR\&. This can be undone using
 270 \fBgit revert\fR\&.
 271 .sp
 272 The deletion removes the superproject\(cqs tracking data, which are both the
 273 \fBgitlink\fR
 274 entry and the section in the
 275 \fB\&.gitmodules\fR
 276 file\&. The submodule\(cqs working directory is removed from the file system, but the Git directory is kept around as it to make it possible to checkout past commits without requiring fetching from another repository\&.
 277 .sp
 278 To completely remove a submodule, manually delete
 279 \fB$GIT_DIR/modules/<name>/\fR\&.
 280 .RE
 281 .SH "ACTIVE SUBMODULES"
 282 .sp
 283 A submodule is considered active,
 284 .sp
 285 .RS 4
 286 .ie n \{\
 287 \h'-04' 1.\h'+01'\c
 288 .\}
 289 .el \{\
 290 .sp -1
 291 .IP "  1." 4.2
 292 .\}
 293 if
 294 \fBsubmodule\&.<name>\&.active\fR
 295 is set to
 296 \fBtrue\fR
 297 .sp
 298 or
 299 .RE
 300 .sp
 301 .RS 4
 302 .ie n \{\
 303 \h'-04' 2.\h'+01'\c
 304 .\}
 305 .el \{\
 306 .sp -1
 307 .IP "  2." 4.2
 308 .\}
 309 if the submodule\(cqs path matches the pathspec in
 310 \fBsubmodule\&.active\fR
 311 .sp
 312 or
 313 .RE
 314 .sp
 315 .RS 4
 316 .ie n \{\
 317 \h'-04' 3.\h'+01'\c
 318 .\}
 319 .el \{\
 320 .sp -1
 321 .IP "  3." 4.2
 322 .\}
 323 if
 324 \fBsubmodule\&.<name>\&.url\fR
 325 is set\&.
 326 .RE
 327 .sp
 328 and these are evaluated in this order\&.
 329 .sp
 330 For example:
 331 .sp
 332 .if n \{\
 333 .RS 4
 334 .\}
 335 .nf
 336 [submodule "foo"]
 337   active = false
 338   url = https://example\&.org/foo
 339 [submodule "bar"]
 340   active = true
 341   url = https://example\&.org/bar
 342 [submodule "baz"]
 343   url = https://example\&.org/baz
 344 .fi
 345 .if n \{\
 346 .RE
 347 .\}
 348 .sp
 349 In the above config only the submodules \fIbar\fR and \fIbaz\fR are active, \fIbar\fR due to (1) and \fIbaz\fR due to (3)\&. \fIfoo\fR is inactive because (1) takes precedence over (3)
 350 .sp
 351 Note that (3) is a historical artefact and will be ignored if the (1) and (2) specify that the submodule is not active\&. In other words, if we have a \fBsubmodule\&.<name>\&.active\fR set to \fBfalse\fR or if the submodule\(cqs path is excluded in the pathspec in \fBsubmodule\&.active\fR, the url doesn\(cqt matter whether it is present or not\&. This is illustrated in the example that follows\&.
 352 .sp
 353 .if n \{\
 354 .RS 4
 355 .\}
 356 .nf
 357 [submodule "foo"]
 358   active = true
 359   url = https://example\&.org/foo
 360 [submodule "bar"]
 361   url = https://example\&.org/bar
 362 [submodule "baz"]
 363   url = https://example\&.org/baz
 364 [submodule "bob"]
 365   ignore = true
 366 [submodule]
 367   active = b*
 368   active = :(exclude) baz
 369 .fi
 370 .if n \{\
 371 .RE
 372 .\}
 373 .sp
 374 In here all submodules except \fIbaz\fR (foo, bar, bob) are active\&. \fIfoo\fR due to its own active flag and all the others due to the submodule active pathspec, which specifies that any submodule starting with \fIb\fR except \fIbaz\fR are also active, regardless of the presence of the \&.url field\&.
 375 .SH "WORKFLOW FOR A THIRD PARTY LIBRARY"
 376 .sp
 377 .if n \{\
 378 .RS 4
 379 .\}
 380 .nf
 381 # Add a submodule
 382 git submodule add <URL> <path>
 383 .fi
 384 .if n \{\
 385 .RE
 386 .\}
 387 .sp
 388 .if n \{\
 389 .RS 4
 390 .\}
 391 .nf
 392 # Occasionally update the submodule to a new version:
 393 git \-C <path> checkout <new\-version>
 394 git add <path>
 395 git commit \-m "update submodule to new version"
 396 .fi
 397 .if n \{\
 398 .RE
 399 .\}
 400 .sp
 401 .if n \{\
 402 .RS 4
 403 .\}
 404 .nf
 405 # See the list of submodules in a superproject
 406 git submodule status
 407 .fi
 408 .if n \{\
 409 .RE
 410 .\}
 411 .sp
 412 .if n \{\
 413 .RS 4
 414 .\}
 415 .nf
 416 # See FORMS on removing submodules
 417 .fi
 418 .if n \{\
 419 .RE
 420 .\}
 421 .SH "WORKFLOW FOR AN ARTIFICIALLY SPLIT REPO"
 422 .sp
 423 .if n \{\
 424 .RS 4
 425 .\}
 426 .nf
 427 # Enable recursion for relevant commands, such that
 428 # regular commands recurse into submodules by default
 429 git config \-\-global submodule\&.recurse true
 430 .fi
 431 .if n \{\
 432 .RE
 433 .\}
 434 .sp
 435 .if n \{\
 436 .RS 4
 437 .\}
 438 .nf
 439 # Unlike most other commands below, clone still needs
 440 # its own recurse flag:
 441 git clone \-\-recurse <URL> <directory>
 442 cd <directory>
 443 .fi
 444 .if n \{\
 445 .RE
 446 .\}
 447 .sp
 448 .if n \{\
 449 .RS 4
 450 .\}
 451 .nf
 452 # Get to know the code:
 453 git grep foo
 454 git ls\-files \-\-recurse\-submodules
 455 .fi
 456 .if n \{\
 457 .RE
 458 .\}
 459 .if n \{\
 460 .sp
 461 .\}
 462 .RS 4
 463 .it 1 an-trap
 464 .nr an-no-space-flag 1
 465 .nr an-break-flag 1
 466 .br
 467 .ps +1
 468 \fBNote\fR
 469 .ps -1
 470 .br
 471 .sp
 472 \fBgit ls\-files\fR also requires its own \fB\-\-recurse\-submodules\fR flag\&.
 473 .sp .5v
 474 .RE
 475 .sp
 476 .if n \{\
 477 .RS 4
 478 .\}
 479 .nf
 480 # Get new code
 481 git fetch
 482 git pull \-\-rebase
 483 .fi
 484 .if n \{\
 485 .RE
 486 .\}
 487 .sp
 488 .if n \{\
 489 .RS 4
 490 .\}
 491 .nf
 492 # Change worktree
 493 git checkout
 494 git reset
 495 .fi
 496 .if n \{\
 497 .RE
 498 .\}
 499 .SH "IMPLEMENTATION DETAILS"
 500 .sp
 501 When cloning or pulling a repository containing submodules the submodules will not be checked out by default; you can instruct \fBclone\fR to recurse into submodules\&. The \fBinit\fR and \fBupdate\fR subcommands of \fBgit submodule\fR will maintain submodules checked out and at an appropriate revision in your working tree\&. Alternatively you can set \fBsubmodule\&.recurse\fR to have \fBcheckout\fR recurse into submodules (note that \fBsubmodule\&.recurse\fR also affects other Git commands, see \fBgit-config\fR(1) for a complete list)\&.
 502 .SH "SEE ALSO"
 503 .sp
 504 \fBgit-submodule\fR(1), \fBgitmodules\fR(5)\&.
 505 .SH "GIT"
 506 .sp
 507 Part of the \fBgit\fR(1) suite