Skip to content

Commit e1b3f3d

Browse files
sivaraamgitster
authored andcommitted
Doc/git-submodule: improve readability and grammar of a sentence
While at it, correctly quote important words. Signed-off-by: Kaartic Sivaraam <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 4f73a7f commit e1b3f3d

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

Documentation/git-submodule.txt

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ status [--cached] [--recursive] [--] [<path>...]::
7070
Show the status of the submodules. This will print the SHA-1 of the
7171
currently checked out commit for each submodule, along with the
7272
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
7575
does not match the SHA-1 found in the index of the containing
7676
repository and `U` if the submodule has merge conflicts.
7777
+
@@ -132,15 +132,15 @@ expects by cloning missing submodules and updating the working tree of
132132
the submodules. The "updating" can be done in several ways depending
133133
on command line options and the value of `submodule.<name>.update`
134134
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:
138138

139139
checkout;; the commit recorded in the superproject will be
140140
checked out in the submodule on a detached HEAD.
141141
+
142142
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
144144
in the index of the containing repository already matches the commit
145145
checked out in the submodule.
146146

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

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:
155155

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

0 commit comments

Comments
 (0)