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 <marmot.motoki@gmail.com> Acked-by: Stefan Beller <sbeller@google.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Motoki Seki committed
Feb 22, 2018 at 08:52 UTC
13164169036e5362bad4351edae58669f7b493f3
1 file changed
+7
-7
Documentation/gitsubmodules.txt
+7
-7
@@ -24,7 +24,7 @@ On the filesystem, a submodule usually (but not always - see FORMS below)
24
consists of (i) a Git directory located under the `$GIT_DIR/modules/`
25
directory of its superproject, (ii) a working directory inside the
26
superproject's working directory, and a `.git` file at the root of
27
-the submodule’s working directory pointing to (i).
27
+the submodule's working directory pointing to (i).
28
29
Assuming the submodule has a Git directory at `$GIT_DIR/modules/foo/`
30
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
33
`submodule.foo.path = path/to/bar`.
34
35
The `gitlink` entry contains the object name of the commit that the
36
-superproject expects the submodule’s working directory to be at.
36
+superproject expects the submodule's working directory to be at.
37
38
The section `submodule.foo.*` in the `.gitmodules` file gives additional
39
hints to Gits porcelain layer such as where to obtain the submodule via
@@ -132,27 +132,27 @@ using older versions of Git.
132
+
133
It is possible to construct these old form repositories manually.
134
+
135
-When deinitialized or deleted (see below), the submodule’s Git
135
+When deinitialized or deleted (see below), the submodule's Git
136
directory is automatically moved to `$GIT_DIR/modules/<name>/`
137
of the superproject.
138
139
* Deinitialized submodule: A `gitlink`, and a `.gitmodules` entry,
140
-but no submodule working directory. The submodule’s git directory
140
+but no submodule working directory. The submodule's git directory
141
may be there as after deinitializing the git directory is kept around.
142
The directory which is supposed to be the working directory is empty instead.
143
+
144
A submodule can be deinitialized by running `git submodule deinit`.
145
Besides emptying the working directory, this command only modifies
146
-the superproject’s `$GIT_DIR/config` file, so the superproject’s history
146
+the superproject's `$GIT_DIR/config` file, so the superproject's history
147
is not affected. This can be undone using `git submodule init`.
148
149
* Deleted submodule: A submodule can be deleted by running
150
`git rm <submodule path> && git commit`. This can be undone
151
using `git revert`.
152
+
153
-The deletion removes the superproject’s tracking data, which are
153
+The deletion removes the superproject's tracking data, which are
154
both the `gitlink` entry and the section in the `.gitmodules` file.
155
-The submodule’s working directory is removed from the file
155
+The submodule's working directory is removed from the file
156
system, but the Git directory is kept around as it to make it
157
possible to checkout past commits without requiring fetching
158
from another repository.