kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

Doc/git-submodule: improve readability and grammar of a sentence 

While at it, correctly quote important words.

Signed-off-by: Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
maint
Kaartic Sivaraam 2018-01-14 23:07:37 +05:30 committed by Junio C Hamano
parent 4f73a7f124
commit e1b3f3dd38
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/git-submodule.txt
View File

@ -70,8 +70,8 @@ status [--cached] [--recursive] [--] [<path>...]::
Show the status of the submodules. This will print the SHA-1 of the Show the status of the submodules. This will print the SHA-1 of the
currently checked out commit for each submodule, along with the currently checked out commit for each submodule, along with the
submodule path and the output of 'git describe' for the submodule path and the output of 'git describe' for the
SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not SHA-1. Each SHA-1 will possibly be prefixed with `-` if the submodule is
initialized, `+` if the currently checked out submodule commit not initialized, `+` if the currently checked out submodule commit
does not match the SHA-1 found in the index of the containing does not match the SHA-1 found in the index of the containing
repository and `U` if the submodule has merge conflicts. repository and `U` if the submodule has merge conflicts.
+ +
@ -132,15 +132,15 @@ expects by cloning missing submodules and updating the working tree of
the submodules. The "updating" can be done in several ways depending the submodules. The "updating" can be done in several ways depending
on command line options and the value of `submodule.<name>.update` on command line options and the value of `submodule.<name>.update`
configuration variable. The command line option takes precedence over configuration variable. The command line option takes precedence over
the configuration variable. if neither is given, a checkout is performed. the configuration variable. If neither is given, a 'checkout' is performed.
update procedures supported both from the command line as well as setting The 'update' procedures supported both from the command line as well as
`submodule.<name>.update`: through the `submodule.<name>.update` configuration are:


checkout;; the commit recorded in the superproject will be checkout;; the commit recorded in the superproject will be
checked out in the submodule on a detached HEAD. checked out in the submodule on a detached HEAD.
+ +
If `--force` is specified, the submodule will be checked out (using If `--force` is specified, the submodule will be checked out (using
`git checkout --force` if appropriate), even if the commit specified `git checkout --force`), even if the commit specified
in the index of the containing repository already matches the commit in the index of the containing repository already matches the commit
checked out in the submodule. checked out in the submodule.


@ -150,8 +150,8 @@ checked out in the submodule.
merge;; the commit recorded in the superproject will be merged merge;; the commit recorded in the superproject will be merged
into the current branch in the submodule. into the current branch in the submodule.


The following procedures are only available via the `submodule.<name>.update` The following 'update' procedures are only available via the
configuration variable: `submodule.<name>.update` configuration variable:


custom command;; arbitrary shell command that takes a single custom command;; arbitrary shell command that takes a single
argument (the sha1 of the commit recorded in the argument (the sha1 of the commit recorded in the