Skip to content

Commit 1316416

Browse files
marmot1123gitster
authored andcommitted
Documentation/gitsubmodules.txt: avoid non-ASCII apostrophes
In gitsubmodules.txt, a few non-ASCII apostrophes are used to spell possessive, e.g. "submodule's". These unfortunately are not rendered at https://git-scm.com/docs/gitsubmodules correctly by the renderer used there. Use ASCII apostrophes instead to work around the problem. It also is good to be consistent, as there are possessives spelled with ASCII apostrophes. Signed-off-by: Motoki Seki <[email protected]> Acked-by: Stefan Beller <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent ffa9524 commit 1316416

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Documentation/gitsubmodules.txt

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ On the filesystem, a submodule usually (but not always - see FORMS below)
2424
consists of (i) a Git directory located under the `$GIT_DIR/modules/`
2525
directory of its superproject, (ii) a working directory inside the
2626
superproject's working directory, and a `.git` file at the root of
27-
the submodules working directory pointing to (i).
27+
the submodule's working directory pointing to (i).
2828

2929
Assuming the submodule has a Git directory at `$GIT_DIR/modules/foo/`
3030
and a working directory at `path/to/bar/`, the superproject tracks the
@@ -33,7 +33,7 @@ in its `.gitmodules` file (see linkgit:gitmodules[5]) of the form
3333
`submodule.foo.path = path/to/bar`.
3434

3535
The `gitlink` entry contains the object name of the commit that the
36-
superproject expects the submodules working directory to be at.
36+
superproject expects the submodule's working directory to be at.
3737

3838
The section `submodule.foo.*` in the `.gitmodules` file gives additional
3939
hints to Gits porcelain layer such as where to obtain the submodule via
@@ -132,27 +132,27 @@ using older versions of Git.
132132
+
133133
It is possible to construct these old form repositories manually.
134134
+
135-
When deinitialized or deleted (see below), the submodules Git
135+
When deinitialized or deleted (see below), the submodule's Git
136136
directory is automatically moved to `$GIT_DIR/modules/<name>/`
137137
of the superproject.
138138

139139
* Deinitialized submodule: A `gitlink`, and a `.gitmodules` entry,
140-
but no submodule working directory. The submodules git directory
140+
but no submodule working directory. The submodule's git directory
141141
may be there as after deinitializing the git directory is kept around.
142142
The directory which is supposed to be the working directory is empty instead.
143143
+
144144
A submodule can be deinitialized by running `git submodule deinit`.
145145
Besides emptying the working directory, this command only modifies
146-
the superprojects `$GIT_DIR/config` file, so the superprojects history
146+
the superproject's `$GIT_DIR/config` file, so the superproject's history
147147
is not affected. This can be undone using `git submodule init`.
148148

149149
* Deleted submodule: A submodule can be deleted by running
150150
`git rm <submodule path> && git commit`. This can be undone
151151
using `git revert`.
152152
+
153-
The deletion removes the superprojects tracking data, which are
153+
The deletion removes the superproject's tracking data, which are
154154
both the `gitlink` entry and the section in the `.gitmodules` file.
155-
The submodules working directory is removed from the file
155+
The submodule's working directory is removed from the file
156156
system, but the Git directory is kept around as it to make it
157157
possible to checkout past commits without requiring fetching
158158
from another repository.

0 commit comments

Comments
 (0)