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 [verse]
  12 'git submodule' [--quiet] add [-b branch] [--] <repository> <path>
  13 'git submodule' [--quiet] status [--cached] [--] [<path>...]
  14 'git submodule' [--quiet] init [--] [<path>...]
  15 'git submodule' [--quiet] update [--init] [--] [<path>...]
  16 'git submodule' [--quiet] summary [--summary-limit <n>] [commit] [--] [<path>...]
  17
  18
  19 DESCRIPTION
  20 -----------
  21 Submodules allow foreign repositories to be embedded within
  22 a dedicated subdirectory of the source tree, always pointed
  23 at a particular commit.
  24
  25 They are not to be confused with remotes, which are meant mainly
  26 for branches of the same project; submodules are meant for
  27 different projects you would like to make part of your source tree,
  28 while the history of the two projects still stays completely
  29 independent and you cannot modify the contents of the submodule
  30 from within the main project.
  31 If you want to merge the project histories and want to treat the
  32 aggregated whole as a single project from then on, you may want to
  33 add a remote for the other project and use the 'subtree' merge strategy,
  34 instead of treating the other project as a submodule. Directories
  35 that come from both projects can be cloned and checked out as a whole
  36 if you choose to go that route.
  37
  38 Submodules are composed from a so-called `gitlink` tree entry
  39 in the main repository that refers to a particular commit object
  40 within the inner repository that is completely separate.
  41 A record in the `.gitmodules` file at the root of the source
  42 tree assigns a logical name to the submodule and describes
  43 the default URL the submodule shall be cloned from.
  44 The logical name can be used for overriding this URL within your
  45 local repository configuration (see 'submodule init').
  46
  47 This command will manage the tree entries and contents of the
  48 gitmodules file for you, as well as inspect the status of your
  49 submodules and update them.
  50 When adding a new submodule to the tree, the 'add' subcommand
  51 is to be used.  However, when pulling a tree containing submodules,
  52 these will not be checked out by default;
  53 the 'init' and 'update' subcommands will maintain submodules
  54 checked out and at appropriate revision in your working tree.
  55 You can briefly inspect the up-to-date status of your submodules
  56 using the 'status' subcommand and get a detailed overview of the
  57 difference between the index and checkouts using the 'summary'
  58 subcommand.
  59
  60
  61 COMMANDS
  62 --------
  63 add::
  64         Add the given repository as a submodule at the given path
  65         to the changeset to be committed next to the current
  66         project: the current project is termed the "superproject".
  67 +
  68 This requires two arguments: <repository> and <path>.
  69 +
  70 <repository> is the URL of the new submodule's origin repository.
  71 This may be either an absolute URL, or (if it begins with ./
  72 or ../), the location relative to the superproject's origin
  73 repository.
  74 +
  75 <path> is the relative location for the cloned submodule to
  76 exist in the superproject. If <path> does not exist, then the
  77 submodule is created by cloning from the named URL. If <path> does
  78 exist and is already a valid git repository, then this is added
  79 to the changeset without cloning. This second form is provided
  80 to ease creating a new submodule from scratch, and presumes
  81 the user will later push the submodule to the given URL.
  82 +
  83 In either case, the given URL is recorded into .gitmodules for
  84 use by subsequent users cloning the superproject. If the URL is
  85 given relative to the superproject's repository, the presumption
  86 is the superproject and submodule repositories will be kept
  87 together in the same relative location, and only the
  88 superproject's URL need be provided: git-submodule will correctly
  89 locate the submodule using the relative URL in .gitmodules.
  90
  91 status::
  92         Show the status of the submodules. This will print the SHA-1 of the
  93         currently checked out commit for each submodule, along with the
  94         submodule path and the output of 'git-describe' for the
  95         SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not
  96         initialized and `+` if the currently checked out submodule commit
  97         does not match the SHA-1 found in the index of the containing
  98         repository. This command is the default command for 'git-submodule'.
  99
 100 init::
 101         Initialize the submodules, i.e. register each submodule name
 102         and url found in .gitmodules into .git/config.
 103         The key used in .git/config is `submodule.$name.url`.
 104         This command does not alter existing information in .git/config.
 105         You can then customize the submodule clone URLs in .git/config
 106         for your local setup and proceed to 'git submodule update';
 107         you can also just use 'git submodule update --init' without
 108         the explicit 'init' step if you do not intend to customize
 109         any submodule locations.
 110
 111 update::
 112         Update the registered submodules, i.e. clone missing submodules and
 113         checkout the commit specified in the index of the containing repository.
 114         This will make the submodules HEAD be detached.
 115 +
 116 If the submodule is not yet initialized, and you just want to use the
 117 setting as stored in .gitmodules, you can automatically initialize the
 118 submodule with the --init option.
 119
 120 summary::
 121         Show commit summary between the given commit (defaults to HEAD) and
 122         working tree/index. For a submodule in question, a series of commits
 123         in the submodule between the given super project commit and the
 124         index or working tree (switched by --cached) are shown.
 125
 126 OPTIONS
 127 -------
 128 -q::
 129 --quiet::
 130         Only print error messages.
 131
 132 -b::
 133 --branch::
 134         Branch of repository to add as submodule.
 135
 136 --cached::
 137         This option is only valid for status and summary commands.  These
 138         commands typically use the commit found in the submodule HEAD, but
 139         with this option, the commit stored in the index is used instead.
 140
 141 -n::
 142 --summary-limit::
 143         This option is only valid for the summary command.
 144         Limit the summary size (number of commits shown in total).
 145         Giving 0 will disable the summary; a negative number means unlimited
 146         (the default). This limit only applies to modified submodules. The
 147         size is always limited to 1 for added/deleted/typechanged submodules.
 148
 149 <path>::
 150         Path to submodule(s). When specified this will restrict the command
 151         to only operate on the submodules found at the specified paths.
 152         (This argument is required with add).
 153
 154 FILES
 155 -----
 156 When initializing submodules, a .gitmodules file in the top-level directory
 157 of the containing repository is used to find the url of each submodule.
 158 This file should be formatted in the same way as `$GIT_DIR/config`. The key
 159 to each submodule url is "submodule.$name.url".  See linkgit:gitmodules[5]
 160 for details.
 161
 162
 163 AUTHOR
 164 ------
 165 Written by Lars Hjemli <hjemli@gmail.com>
 166
 167 GIT
 168 ---
 169 Part of the linkgit:git[1] suite