projects / thirdparty / git.git / blame
| Commit | Line | Data |
|---|---|---|
| 70c7ac22 LH |
1 | git-submodule(1) |
| 2 | ================ | |
| 3 | ||
| 4 | NAME | |
| 5 | ---- | |
| 6 | git-submodule - Initialize, update or inspect submodules | |
| 7 | ||
| 8 | ||
| 9 | SYNOPSIS | |
| 10 | -------- | |
| b2493649 | 11 | [verse] |
| c4a95c9f SP |
12 | 'git-submodule' [--quiet] add [-b branch] [--] <repository> [<path>] |
| 13 | 'git-submodule' [--quiet] status [--cached] [--] [<path>...] | |
| 14 | 'git-submodule' [--quiet] [init|update] [--] [<path>...] | |
| 70c7ac22 LH |
15 | |
| 16 | ||
| 17 | COMMANDS | |
| 18 | -------- | |
| ecda0723 SV |
19 | add:: |
| 20 | Add the given repository as a submodule at the given path | |
| 21 | to the changeset to be committed next. In particular, the | |
| 22 | repository is cloned at the specified path, added to the | |
| 23 | changeset and registered in .gitmodules. If no path is | |
| 24 | specified, the path is deduced from the repository specification. | |
| f31a522a ML |
25 | If the repository url begins with ./ or ../, it is stored as |
| 26 | given but resolved as a relative path from the main project's | |
| 27 | url when cloning. | |
| ecda0723 | 28 | |
| 70c7ac22 LH |
29 | status:: |
| 30 | Show the status of the submodules. This will print the SHA-1 of the | |
| 31 | currently checked out commit for each submodule, along with the | |
| 5162e697 | 32 | submodule path and the output of linkgit:git-describe[1] for the |
| 70c7ac22 LH |
33 | SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not |
| 34 | initialized and `+` if the currently checked out submodule commit | |
| 35 | does not match the SHA-1 found in the index of the containing | |
| 36 | repository. This command is the default command for git-submodule. | |
| 37 | ||
| 38 | init:: | |
| 211b7f19 | 39 | Initialize the submodules, i.e. register in .git/config each submodule |
| 813a0bd8 LH |
40 | name and url found in .gitmodules. The key used in .git/config is |
| 41 | `submodule.$name.url`. This command does not alter existing information | |
| 211b7f19 | 42 | in .git/config. |
| 70c7ac22 LH |
43 | |
| 44 | update:: | |
| 211b7f19 LH |
45 | Update the registered submodules, i.e. clone missing submodules and |
| 46 | checkout the commit specified in the index of the containing repository. | |
| 47 | This will make the submodules HEAD be detached. | |
| 70c7ac22 LH |
48 | |
| 49 | ||
| 50 | OPTIONS | |
| 51 | ------- | |
| 52 | -q, --quiet:: | |
| 53 | Only print error messages. | |
| 54 | ||
| ecda0723 SV |
55 | -b, --branch:: |
| 56 | Branch of repository to add as submodule. | |
| 57 | ||
| 70c7ac22 LH |
58 | --cached:: |
| 59 | Display the SHA-1 stored in the index, not the SHA-1 of the currently | |
| 60 | checked out submodule commit. This option is only valid for the | |
| 61 | status command. | |
| 62 | ||
| 63 | <path>:: | |
| 64 | Path to submodule(s). When specified this will restrict the command | |
| 65 | to only operate on the submodules found at the specified paths. | |
| 66 | ||
| 67 | FILES | |
| 68 | ----- | |
| 211b7f19 | 69 | When initializing submodules, a .gitmodules file in the top-level directory |
| 70c7ac22 | 70 | of the containing repository is used to find the url of each submodule. |
| c4585701 | 71 | This file should be formatted in the same way as `$GIT_DIR/config`. The key |
| 5162e697 | 72 | to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5] |
| 6fbe42c7 | 73 | for details. |
| 70c7ac22 LH |
74 | |
| 75 | ||
| 76 | AUTHOR | |
| 77 | ------ | |
| 78 | Written by Lars Hjemli <hjemli@gmail.com> | |
| 79 | ||
| 80 | GIT | |
| 81 | --- | |
| 5162e697 | 82 | Part of the linkgit:git[7] suite |