1git-submodule(1) 2================ 3 4NAME 5---- 6git-submodule - Initialize, update or inspect submodules 7 8 9SYNOPSIS 10-------- 11[verse] 12'git-submodule' [--quiet] add [-b branch] [--] <repository> [<path>] 13'git-submodule' [--quiet] status [--cached] [--] [<path>...] 14'git-submodule' [--quiet] [init|update] [--] [<path>...] 15'git-submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...] 16 17 18COMMANDS 19-------- 20add:: 21 Add the given repository as a submodule at the given path 22 to the changeset to be committed next. In particular, the 23 repository is cloned at the specified path, added to the 24 changeset and registered in .gitmodules. If no path is 25 specified, the path is deduced from the repository specification. 26 If the repository url begins with ./ or ../, it is stored as 27 given but resolved as a relative path from the main project's 28 url when cloning. 29 30status:: 31 Show the status of the submodules. This will print the SHA-1 of the 32 currently checked out commit for each submodule, along with the 33 submodule path and the output of linkgit:git-describe[1] for the 34 SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not 35 initialized and `+` if the currently checked out submodule commit 36 does not match the SHA-1 found in the index of the containing 37 repository. This command is the default command for git-submodule. 38 39init:: 40 Initialize the submodules, i.e. register in .git/config each submodule 41 name and url found in .gitmodules. The key used in .git/config is 42 `submodule.$name.url`. This command does not alter existing information 43 in .git/config. 44 45update:: 46 Update the registered submodules, i.e. clone missing submodules and 47 checkout the commit specified in the index of the containing repository. 48 This will make the submodules HEAD be detached. 49 50summary:: 51 Show commit summary between the given commit (defaults to HEAD) and 52 working tree/index. For a submodule in question, a series of commits 53 in the submodule between the given super project commit and the 54 index or working tree (switched by --cached) are shown. 55 56OPTIONS 57------- 58-q, --quiet:: 59 Only print error messages. 60 61-b, --branch:: 62 Branch of repository to add as submodule. 63 64--cached:: 65 This option is only valid for status and summary commands. These 66 commands typically use the commit found in the submodule HEAD, but 67 with this option, the commit stored in the index is used instead. 68 69-n, --summary-limit:: 70 This option is only valid for the summary command. 71 Limit the summary size (number of commits shown in total). 72 Giving 0 will disable the summary; a negative number means unlimted 73 (the default). This limit only applies to modified submodules. The 74 size is always limited to 1 for added/deleted/typechanged submodules. 75 76<path>:: 77 Path to submodule(s). When specified this will restrict the command 78 to only operate on the submodules found at the specified paths. 79 80FILES 81----- 82When initializing submodules, a .gitmodules file in the top-level directory 83of the containing repository is used to find the url of each submodule. 84This file should be formatted in the same way as `$GIT_DIR/config`. The key 85to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5] 86for details. 87 88 89AUTHOR 90------ 91Written by Lars Hjemli <hjemli@gmail.com> 92 93GIT 94--- 95Part of the linkgit:git[7] suite