From: Junio C Hamano Date: Fri, 30 Jun 2017 20:45:25 +0000 (-0700) Subject: Merge branch 'vs/typofixes' X-Git-Tag: v2.14.0-rc0~40 X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/748cffc22bbe769b3b2fba90ae98db4719b90bb4?ds=inline;hp=-c Merge branch 'vs/typofixes' Many typofixes. * vs/typofixes: Spelling fixes --- 748cffc22bbe769b3b2fba90ae98db4719b90bb4 diff --combined Documentation/git-submodule.txt index 6e07bade39,2aea2c1b9b..b9a56d4c6e --- a/Documentation/git-submodule.txt +++ b/Documentation/git-submodule.txt @@@ -63,6 -63,14 +63,6 @@@ add [-b ] [-f|--force] [--name to the changeset to be committed next to the current project: the current project is termed the "superproject". + -This requires at least one argument: . The optional -argument is the relative location for the cloned submodule -to exist in the superproject. If is not given, the -"humanish" part of the source repository is used ("repo" for -"/path/to/repo.git" and "foo" for "host.xz:foo/.git"). -The is also used as the submodule's logical name in its -configuration entries unless `--name` is used to specify a logical name. -+ is the URL of the new submodule's origin repository. This may be either an absolute URL, or (if it begins with ./ or ../), the location relative to the superproject's default remote @@@ -79,22 -87,21 +79,22 @@@ If the superproject doesn't have a defa the superproject is its own authoritative upstream and the current working directory is used instead. + - is the relative location for the cloned submodule to -exist in the superproject. If does not exist, then the -submodule is created by cloning from the named URL. If does -exist and is already a valid Git repository, then this is added -to the changeset without cloning. This second form is provided -to ease creating a new submodule from scratch, and presumes -the user will later push the submodule to the given URL. +The optional argument is the relative location for the cloned +submodule to exist in the superproject. If is not given, the +canonical part of the source repository is used ("repo" for +"/path/to/repo.git" and "foo" for "host.xz:foo/.git"). If +exists and is already a valid Git repository, then it is staged +for commit without cloning. The is also used as the submodule's +logical name in its configuration entries unless `--name` is used +to specify a logical name. + -In either case, the given URL is recorded into .gitmodules for -use by subsequent users cloning the superproject. If the URL is -given relative to the superproject's repository, the presumption -is the superproject and submodule repositories will be kept -together in the same relative location, and only the -superproject's URL needs to be provided: git-submodule will correctly -locate the submodule using the relative URL in .gitmodules. +The given URL is recorded into `.gitmodules` for use by subsequent users +cloning the superproject. If the URL is given relative to the +superproject's repository, the presumption is the superproject and +submodule repositories will be kept together in the same relative +location, and only the superproject's URL needs to be provided. +git-submodule will correctly locate the submodule using the relative +URL in `.gitmodules`. status [--cached] [--recursive] [--] [...]:: Show the status of the submodules. This will print the SHA-1 of the @@@ -116,7 -123,7 +116,7 @@@ too (and can also report changes to a s init [--] [...]:: Initialize the submodules recorded in the index (which were added and committed elsewhere) by setting `submodule.$name.url` - in .git/config. It uses the same setting from .gitmodules as + in .git/config. It uses the same setting from `.gitmodules` as a template. If the URL is relative, it will be resolved using the default remote. If there is no default remote, the current repository will be assumed to be upstream. @@@ -134,7 -141,7 +134,7 @@@ you can also just use `git submodule up the explicit 'init' step if you do not intend to customize any submodule locations. + - See the add subcommand for the defintion of default remote. + See the add subcommand for the definition of default remote. deinit [-f|--force] (--all|[--] ...):: Unregister the given submodules, i.e. remove the whole @@@ -190,7 -197,7 +190,7 @@@ configuration variable none;; the submodule is not updated. If the submodule is not yet initialized, and you just want to use the -setting as stored in .gitmodules, you can automatically initialize the +setting as stored in `.gitmodules`, you can automatically initialize the submodule with the `--init` option. If `--recursive` is specified, this command will recurse into the @@@ -213,7 -220,7 +213,7 @@@ foreach [--recursive] : Evaluates an arbitrary shell command in each checked out submodule. The command has access to the variables $name, $path, $sha1 and $toplevel: - $name is the name of the relevant submodule section in .gitmodules, + $name is the name of the relevant submodule section in `.gitmodules`, $path is the name of the submodule directory relative to the superproject, $sha1 is the commit as recorded in the superproject, and $toplevel is the absolute path to the top-level of the superproject. @@@ -235,7 -242,7 +235,7 @@@ git submodule foreach 'echo $path `git sync [--recursive] [--] [...]:: Synchronizes submodules' remote URL configuration setting - to the value specified in .gitmodules. It will only affect those + to the value specified in `.gitmodules`. It will only affect those submodules which already have a URL entry in .git/config (that is the case when they are initialized or freshly added). This is useful when submodule URLs change upstream and you need to update your local @@@ -406,7 -413,7 +406,7 @@@ for linkgit:git-clone[1]'s `--reference --[no-]recommend-shallow:: This option is only valid for the update command. The initial clone of a submodule will use the recommended - `submodule..shallow` as provided by the .gitmodules file + `submodule..shallow` as provided by the `.gitmodules` file by default. To ignore the suggestions use `--no-recommend-shallow`. -j :: @@@ -422,7 -429,7 +422,7 @@@ FILES ----- -When initializing submodules, a .gitmodules file in the top-level directory +When initializing submodules, a `.gitmodules` file in the top-level directory of the containing repository is used to find the url of each submodule. This file should be formatted in the same way as `$GIT_DIR/config`. The key to each submodule url is "submodule.$name.url". See linkgit:gitmodules[5]