Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt
From: Junio C Hamano <hidden>
Date: 2018-02-22 20:42:11
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
Possibly related (same subject, not in this thread)
- 2018-02-22 · Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt · Stefan Beller <hidden>
- 2018-02-22 · Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt · Junio C Hamano <hidden>
- 2018-02-22 · Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt · Stefan Beller <hidden>
- 2018-02-22 · [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt · marmot1123 <hidden>
Stefan Beller [off-list ref] writes:
On Thu, Feb 22, 2018 at 12:20 PM, Junio C Hamano [off-list ref] wrote:quoted
Forgot to say something of your own? Perhaps wanted to (1) show a sample of a better log message, (2) say "Acked-by", (3) re-raise the point that the same "error" already appears in the same file and it is better to clean them up all at once, or (4) something else?(2) Acked-by and (4) I-am-sorry-for.
OK, I think the two patches are better squashed into one; in the larger picture, it really does not matter where the problem originated from. Here is what I tentatively queued with copyedited log message. -- >8 -- From: Motoki Seki <redacted> Date: Thu, 22 Feb 2018 08:52:25 +0000 Subject: [PATCH] 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 <redacted> Signed-off-by: Junio C Hamano <redacted> --- Documentation/gitsubmodules.txt | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-)
diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt
index 46cf120f66..030c974c25 100644
--- a/Documentation/gitsubmodules.txt
+++ b/Documentation/gitsubmodules.txt@@ -24,7 +24,7 @@ On the filesystem, a submodule usually (but not always - see FORMS below) consists of (i) a Git directory located under the `$GIT_DIR/modules/` directory of its superproject, (ii) a working directory inside the superproject's working directory, and a `.git` file at the root of -the submodule’s working directory pointing to (i). +the submodule's working directory pointing to (i). Assuming the submodule has a Git directory at `$GIT_DIR/modules/foo/` 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 `submodule.foo.path = path/to/bar`. The `gitlink` entry contains the object name of the commit that the -superproject expects the submodule’s working directory to be at. +superproject expects the submodule's working directory to be at. The section `submodule.foo.*` in the `.gitmodules` file gives additional hints to Gits porcelain layer such as where to obtain the submodule via
@@ -132,27 +132,27 @@ using older versions of Git. + It is possible to construct these old form repositories manually. + -When deinitialized or deleted (see below), the submodule’s Git +When deinitialized or deleted (see below), the submodule's Git directory is automatically moved to `$GIT_DIR/modules/<name>/` of the superproject. * Deinitialized submodule: A `gitlink`, and a `.gitmodules` entry, -but no submodule working directory. The submodule’s git directory +but no submodule working directory. The submodule's git directory may be there as after deinitializing the git directory is kept around. The directory which is supposed to be the working directory is empty instead. + A submodule can be deinitialized by running `git submodule deinit`. Besides emptying the working directory, this command only modifies -the superproject’s `$GIT_DIR/config` file, so the superproject’s history +the superproject's `$GIT_DIR/config` file, so the superproject's history is not affected. This can be undone using `git submodule init`. * Deleted submodule: A submodule can be deleted by running `git rm <submodule path> && git commit`. This can be undone using `git revert`. + -The deletion removes the superproject’s tracking data, which are +The deletion removes the superproject's tracking data, which are both the `gitlink` entry and the section in the `.gitmodules` file. -The submodule’s working directory is removed from the file +The submodule's working directory is removed from the file system, but the Git directory is kept around as it to make it possible to checkout past commits without requiring fetching from another repository.
--
2.16.2-264-ge3a80781f5