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>
Kaartic Sivaraam committed
Jan 14, 2018 at 23:07 UTC
e1b3f3dd38c05187ed44939b9c67e96f0ce32d50
1 file changed
+8
-8
Documentation/git-submodule.txt
+8
-8
@@ -70,8 +70,8 @@ status [--cached] [--recursive] [--] [<path>...]::
70
Show the status of the submodules. This will print the SHA-1 of the
71
currently checked out commit for each submodule, along with the
72
submodule path and the output of 'git describe' for the
73
- SHA-1. Each SHA-1 will be prefixed with `-` if the submodule is not
74
- initialized, `+` if the currently checked out submodule commit
73
+ SHA-1. Each SHA-1 will possibly be prefixed with `-` if the submodule is
74
+ not initialized, `+` if the currently checked out submodule commit
75
does not match the SHA-1 found in the index of the containing
76
repository and `U` if the submodule has merge conflicts.
77
+
@@ -132,15 +132,15 @@ expects by cloning missing submodules and updating the working tree of
132
the submodules. The "updating" can be done in several ways depending
133
on command line options and the value of `submodule.<name>.update`
134
configuration variable. The command line option takes precedence over
135
-the configuration variable. if neither is given, a checkout is performed.
136
-update procedures supported both from the command line as well as setting
137
-`submodule.<name>.update`:
135
+the configuration variable. If neither is given, a 'checkout' is performed.
136
+The 'update' procedures supported both from the command line as well as
137
+through the `submodule.<name>.update` configuration are:
138
139
checkout;; the commit recorded in the superproject will be
140
checked out in the submodule on a detached HEAD.
141
+
142
If `--force` is specified, the submodule will be checked out (using
143
-`git checkout --force` if appropriate), even if the commit specified
143
+`git checkout --force`), even if the commit specified
144
in the index of the containing repository already matches the commit
145
checked out in the submodule.
146
@@ -150,8 +150,8 @@ checked out in the submodule.
150
merge;; the commit recorded in the superproject will be merged
151
into the current branch in the submodule.
152
153
-The following procedures are only available via the `submodule.<name>.update`
154
-configuration variable:
153
+The following 'update' procedures are only available via the
154
+`submodule.<name>.update` configuration variable:
155
156
custom command;; arbitrary shell command that takes a single
157
argument (the sha1 of the commit recorded in the