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 vsnapshot <http://docbook.sf.net/>
   5 .\"      Date: 2024-05-28
   6 .\"    Manual: Git Manual
   7 .\"    Source: Git 2.45.1.313.g3a57aa566a
   8 .\"  Language: English
   9 .\"
  10 .TH "GITSUBMODULES" "7" "2024\-05\-28" "Git 2\&.45\&.1\&.313\&.g3a57aa" "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 .sp
  43 .SH "DESCRIPTION"
  44 .sp
  45 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\&.
  46 .sp
  47 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)\&.
  48 .sp
  49 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\&.
  50 .sp
  51 The \fBgitlink\fR entry contains the object name of the commit that the superproject expects the submodule\(cqs working directory to be at\&.
  52 .sp
  53 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\&.
  54 .sp
  55 Submodules can be used for at least two different use cases:
  56 .sp
  57 .RS 4
  58 .ie n \{\
  59 \h'-04' 1.\h'+01'\c
  60 .\}
  61 .el \{\
  62 .sp -1
  63 .IP "  1." 4.2
  64 .\}
  65 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\&.
  66 .RE
  67 .sp
  68 .RS 4
  69 .ie n \{\
  70 \h'-04' 2.\h'+01'\c
  71 .\}
  72 .el \{\
  73 .sp -1
  74 .IP "  2." 4.2
  75 .\}
  76 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:
  77 .sp
  78 .RS 4
  79 .ie n \{\
  80 \h'-04'\(bu\h'+03'\c
  81 .\}
  82 .el \{\
  83 .sp -1
  84 .IP \(bu 2.3
  85 .\}
  86 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\&.
  87 .RE
  88 .sp
  89 .RS 4
  90 .ie n \{\
  91 \h'-04'\(bu\h'+03'\c
  92 .\}
  93 .el \{\
  94 .sp -1
  95 .IP \(bu 2.3
  96 .\}
  97 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\&.
  98 .RE
  99 .sp
 100 .RS 4
 101 .ie n \{\
 102 \h'-04'\(bu\h'+03'\c
 103 .\}
 104 .el \{\
 105 .sp -1
 106 .IP \(bu 2.3
 107 .\}
 108 Access control: By restricting user access to submodules, this can be used to implement read/write policies for different users\&.
 109 .RE
 110 .RE
 111 .SH "THE CONFIGURATION OF SUBMODULES"
 112 .sp
 113 Submodule operations can be configured using the following mechanisms (from highest to lowest precedence):
 114 .sp
 115 .RS 4
 116 .ie n \{\
 117 \h'-04'\(bu\h'+03'\c
 118 .\}
 119 .el \{\
 120 .sp -1
 121 .IP \(bu 2.3
 122 .\}
 123 The command line for those commands that support taking submodules as part of their pathspecs\&. Most commands have a boolean flag
 124 \fB\-\-recurse\-submodules\fR
 125 which specifies whether to recurse into submodules\&. Examples are
 126 \fBgrep\fR
 127 and
 128 \fBcheckout\fR\&. Some commands take enums, such as
 129 \fBfetch\fR
 130 and
 131 \fBpush\fR, where you can specify how submodules are affected\&.
 132 .RE
 133 .sp
 134 .RS 4
 135 .ie n \{\
 136 \h'-04'\(bu\h'+03'\c
 137 .\}
 138 .el \{\
 139 .sp -1
 140 .IP \(bu 2.3
 141 .\}
 142 The configuration inside the submodule\&. This includes
 143 \fB$GIT_DIR/config\fR
 144 in the submodule, but also settings in the tree such as a
 145 \fB\&.gitattributes\fR
 146 or
 147 \fB\&.gitignore\fR
 148 files that specify behavior of commands inside the submodule\&.
 149 .sp
 150 For example an effect from the submodule\(cqs
 151 \fB\&.gitignore\fR
 152 file would be observed when you run
 153 \fBgit status \-\-ignore\-submodules=none\fR
 154 in the superproject\&. This collects information from the submodule\(cqs working directory by running
 155 \fBstatus\fR
 156 in the submodule while paying attention to the
 157 \fB\&.gitignore\fR
 158 file of the submodule\&.
 159 .sp
 160 The submodule\(cqs
 161 \fB$GIT_DIR/config\fR
 162 file would come into play when running
 163 \fBgit push \-\-recurse\-submodules=check\fR
 164 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
 165 \fB$GIT_DIR/config\fR
 166 file\&.
 167 .RE
 168 .sp
 169 .RS 4
 170 .ie n \{\
 171 \h'-04'\(bu\h'+03'\c
 172 .\}
 173 .el \{\
 174 .sp -1
 175 .IP \(bu 2.3
 176 .\}
 177 The configuration file
 178 \fB$GIT_DIR/config\fR
 179 in the superproject\&. Git only recurses into active submodules (see "ACTIVE SUBMODULES" section below)\&.
 180 .sp
 181 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\&.
 182 .RE
 183 .sp
 184 .RS 4
 185 .ie n \{\
 186 \h'-04'\(bu\h'+03'\c
 187 .\}
 188 .el \{\
 189 .sp -1
 190 .IP \(bu 2.3
 191 .\}
 192 The
 193 \fB\&.gitmodules\fR
 194 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\&.
 195 .sp
 196 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\&.
 197 .sp
 198 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\&.
 199 .RE
 200 .SH "FORMS"
 201 .sp
 202 Submodules can take the following forms:
 203 .sp
 204 .RS 4
 205 .ie n \{\
 206 \h'-04'\(bu\h'+03'\c
 207 .\}
 208 .el \{\
 209 .sp -1
 210 .IP \(bu 2.3
 211 .\}
 212 The basic form described in DESCRIPTION with a Git directory, a working directory, a
 213 \fBgitlink\fR, and a
 214 \fB\&.gitmodules\fR
 215 entry\&.
 216 .RE
 217 .sp
 218 .RS 4
 219 .ie n \{\
 220 \h'-04'\(bu\h'+03'\c
 221 .\}
 222 .el \{\
 223 .sp -1
 224 .IP \(bu 2.3
 225 .\}
 226 "Old\-form" submodule: A working directory with an embedded
 227 \fB\&.git\fR
 228 directory, and the tracking
 229 \fBgitlink\fR
 230 and
 231 \fB\&.gitmodules\fR
 232 entry in the superproject\&. This is typically found in repositories generated using older versions of Git\&.
 233 .sp
 234 It is possible to construct these old form repositories manually\&.
 235 .sp
 236 When deinitialized or deleted (see below), the submodule\(cqs Git directory is automatically moved to
 237 \fB$GIT_DIR/modules/<name>/\fR
 238 of the superproject\&.
 239 .RE
 240 .sp
 241 .RS 4
 242 .ie n \{\
 243 \h'-04'\(bu\h'+03'\c
 244 .\}
 245 .el \{\
 246 .sp -1
 247 .IP \(bu 2.3
 248 .\}
 249 Deinitialized submodule: A
 250 \fBgitlink\fR, and a
 251 \fB\&.gitmodules\fR
 252 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\&.
 253 .sp
 254 A submodule can be deinitialized by running
 255 \fBgit submodule deinit\fR\&. Besides emptying the working directory, this command only modifies the superproject\(cqs
 256 \fB$GIT_DIR/config\fR
 257 file, so the superproject\(cqs history is not affected\&. This can be undone using
 258 \fBgit submodule init\fR\&.
 259 .RE
 260 .sp
 261 .RS 4
 262 .ie n \{\
 263 \h'-04'\(bu\h'+03'\c
 264 .\}
 265 .el \{\
 266 .sp -1
 267 .IP \(bu 2.3
 268 .\}
 269 Deleted submodule: A submodule can be deleted by running
 270 \fBgit rm <submodule\-path> && git commit\fR\&. This can be undone using
 271 \fBgit revert\fR\&.
 272 .sp
 273 The deletion removes the superproject\(cqs tracking data, which are both the
 274 \fBgitlink\fR
 275 entry and the section in the
 276 \fB\&.gitmodules\fR
 277 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\&.
 278 .sp
 279 To completely remove a submodule, manually delete
 280 \fB$GIT_DIR/modules/<name>/\fR\&.
 281 .RE
 282 .SH "ACTIVE SUBMODULES"
 283 .sp
 284 A submodule is considered active,
 285 .sp
 286 .RS 4
 287 .ie n \{\
 288 \h'-04' 1.\h'+01'\c
 289 .\}
 290 .el \{\
 291 .sp -1
 292 .IP "  1." 4.2
 293 .\}
 294 if
 295 \fBsubmodule\&.<name>\&.active\fR
 296 is set to
 297 \fBtrue\fR
 298 .sp
 299 or
 300 .RE
 301 .sp
 302 .RS 4
 303 .ie n \{\
 304 \h'-04' 2.\h'+01'\c
 305 .\}
 306 .el \{\
 307 .sp -1
 308 .IP "  2." 4.2
 309 .\}
 310 if the submodule\(cqs path matches the pathspec in
 311 \fBsubmodule\&.active\fR
 312 .sp
 313 or
 314 .RE
 315 .sp
 316 .RS 4
 317 .ie n \{\
 318 \h'-04' 3.\h'+01'\c
 319 .\}
 320 .el \{\
 321 .sp -1
 322 .IP "  3." 4.2
 323 .\}
 324 if
 325 \fBsubmodule\&.<name>\&.url\fR
 326 is set\&.
 327 .RE
 328 .sp
 329 and these are evaluated in this order\&.
 330 .sp
 331 For example:
 332 .sp
 333 .if n \{\
 334 .RS 4
 335 .\}
 336 .nf
 337 [submodule "foo"]
 338   active = false
 339   url = https://example\&.org/foo
 340 [submodule "bar"]
 341   active = true
 342   url = https://example\&.org/bar
 343 [submodule "baz"]
 344   url = https://example\&.org/baz
 345 .fi
 346 .if n \{\
 347 .RE
 348 .\}
 349 .sp
 350 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)
 351 .sp
 352 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\&.
 353 .sp
 354 .if n \{\
 355 .RS 4
 356 .\}
 357 .nf
 358 [submodule "foo"]
 359   active = true
 360   url = https://example\&.org/foo
 361 [submodule "bar"]
 362   url = https://example\&.org/bar
 363 [submodule "baz"]
 364   url = https://example\&.org/baz
 365 [submodule "bob"]
 366   ignore = true
 367 [submodule]
 368   active = b*
 369   active = :(exclude) baz
 370 .fi
 371 .if n \{\
 372 .RE
 373 .\}
 374 .sp
 375 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\&.
 376 .SH "WORKFLOW FOR A THIRD PARTY LIBRARY"
 377 .sp
 378 .if n \{\
 379 .RS 4
 380 .\}
 381 .nf
 382 # Add a submodule
 383 git submodule add <URL> <path>
 384 .fi
 385 .if n \{\
 386 .RE
 387 .\}
 388 .sp
 389 .if n \{\
 390 .RS 4
 391 .\}
 392 .nf
 393 # Occasionally update the submodule to a new version:
 394 git \-C <path> checkout <new\-version>
 395 git add <path>
 396 git commit \-m "update submodule to new version"
 397 .fi
 398 .if n \{\
 399 .RE
 400 .\}
 401 .sp
 402 .if n \{\
 403 .RS 4
 404 .\}
 405 .nf
 406 # See the list of submodules in a superproject
 407 git submodule status
 408 .fi
 409 .if n \{\
 410 .RE
 411 .\}
 412 .sp
 413 .if n \{\
 414 .RS 4
 415 .\}
 416 .nf
 417 # See FORMS on removing submodules
 418 .fi
 419 .if n \{\
 420 .RE
 421 .\}
 422 .SH "WORKFLOW FOR AN ARTIFICIALLY SPLIT REPO"
 423 .sp
 424 .if n \{\
 425 .RS 4
 426 .\}
 427 .nf
 428 # Enable recursion for relevant commands, such that
 429 # regular commands recurse into submodules by default
 430 git config \-\-global submodule\&.recurse true
 431 .fi
 432 .if n \{\
 433 .RE
 434 .\}
 435 .sp
 436 .if n \{\
 437 .RS 4
 438 .\}
 439 .nf
 440 # Unlike most other commands below, clone still needs
 441 # its own recurse flag:
 442 git clone \-\-recurse <URL> <directory>
 443 cd <directory>
 444 .fi
 445 .if n \{\
 446 .RE
 447 .\}
 448 .sp
 449 .if n \{\
 450 .RS 4
 451 .\}
 452 .nf
 453 # Get to know the code:
 454 git grep foo
 455 git ls\-files \-\-recurse\-submodules
 456 .fi
 457 .if n \{\
 458 .RE
 459 .\}
 460 .if n \{\
 461 .sp
 462 .\}
 463 .RS 4
 464 .it 1 an-trap
 465 .nr an-no-space-flag 1
 466 .nr an-break-flag 1
 467 .br
 468 .ps +1
 469 \fBNote\fR
 470 .ps -1
 471 .br
 472 .sp
 473 \fBgit ls\-files\fR also requires its own \fB\-\-recurse\-submodules\fR flag\&.
 474 .sp .5v
 475 .RE
 476 .sp
 477 .if n \{\
 478 .RS 4
 479 .\}
 480 .nf
 481 # Get new code
 482 git fetch
 483 git pull \-\-rebase
 484 .fi
 485 .if n \{\
 486 .RE
 487 .\}
 488 .sp
 489 .if n \{\
 490 .RS 4
 491 .\}
 492 .nf
 493 # Change worktree
 494 git checkout
 495 git reset
 496 .fi
 497 .if n \{\
 498 .RE
 499 .\}
 500 .SH "IMPLEMENTATION DETAILS"
 501 .sp
 502 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)\&.
 503 .SH "SEE ALSO"
 504 .sp
 505 \fBgit-submodule\fR(1), \fBgitmodules\fR(5)\&.
 506 .SH "GIT"
 507 .sp
 508 Part of the \fBgit\fR(1) suite