1git-submodule(1) 2================ 3 4NAME 5---- 6git-submodule - Initialize, update or inspect submodules 7 8 9SYNOPSIS 10-------- 11'git-submodule' [--quiet] [--cached] [status|init|update] [--] [<path>...] 12 13 14COMMANDS 15-------- 16status:: 17 Show the status of the submodules. This will print the SHA-1 of the 18 currently checked out commit for each submodule, along with the 19 submodule path and the output of gitlink:git-describe[1] for the 20 SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not 21 initialized and `+` if the currently checked out submodule commit 22 does not match the SHA-1 found in the index of the containing 23 repository. This command is the default command for git-submodule. 24 25init:: 26 Initialize the submodules, i.e. clone the git repositories specified 27 in the .gitmodules file and checkout the submodule commits specified 28 in the index of the containing repository. This will make the 29 submodules HEAD be detached. 30 31update:: 32 Update the initialized submodules, i.e. checkout the submodule commits 33 specified in the index of the containing repository. This will make 34 the submodules HEAD be detached. 35 36 37OPTIONS 38------- 39-q, --quiet:: 40 Only print error messages. 41 42--cached:: 43 Display the SHA-1 stored in the index, not the SHA-1 of the currently 44 checked out submodule commit. This option is only valid for the 45 status command. 46 47<path>:: 48 Path to submodule(s). When specified this will restrict the command 49 to only operate on the submodules found at the specified paths. 50 51FILES 52----- 53When cloning submodules, a .gitmodules file in the top-level directory 54of the containing repository is used to find the url of each submodule. 55This file should be formatted in the same way as $GIR_DIR/config. The key 56to each submodule url is "module.$path.url". 57 58 59AUTHOR 60------ 61Written by Lars Hjemli <hjemli@gmail.com> 62 63GIT 64--- 65Part of the gitlink:git[7] suite