Documentation/git-submodule.txt

   1 git-submodule(1)
   2 ================
   3
   4 NAME
   5 ----
   6 git-submodule - Initialize, update or inspect submodules
   7
   8
   9 SYNOPSIS
  10 --------
  11 'git-submodule' [--quiet] [--cached] [status|init|update] [--] [<path>...]
  12
  13
  14 COMMANDS
  15 --------
  16 status::
  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
  25 init::
  26         Initialize the submodules, i.e. register in .git/config each submodule
  27         path and url found in .gitmodules. The key used in git/config is
  28         `submodule.$path.url`. This command does not alter existing information
  29         in .git/config.
  30
  31 update::
  32         Update the registered submodules, i.e. clone missing submodules and
  33         checkout the commit specified in the index of the containing repository.
  34         This will make the submodules HEAD be detached.
  35
  36
  37 OPTIONS
  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
  51 FILES
  52 -----
  53 When initializing submodules, a .gitmodules file in the top-level directory
  54 of the containing repository is used to find the url of each submodule.
  55 This file should be formatted in the same way as $GIR_DIR/config. The key
  56 to each submodule url is "module.$path.url".
  57
  58
  59 AUTHOR
  60 ------
  61 Written by Lars Hjemli <hjemli@gmail.com>
  62
  63 GIT
  64 ---
  65 Part of the gitlink:git[7] suite