# [PATCH v3 2/2] Replace non-ASCII apostrophes to ASCII single quotes in gitsubmodules.txt 7 messages from 2018-02-22 to 2018-02-22. Participants: marmot1123, Stefan Beller, Junio C Hamano. Thread: https://gitlist.dev/t/47901 ## marmot1123, 2018-02-22 08:52 Subject: [PATCH v3 2/2] Replace non-ASCII apostrophes to ASCII single quotes in gitsubmodules.txt Message-ID: <01020161bcb6b3db-dd4dc2a0-4426-4bf0-97f3-18b299d91400-000000@eu-west-1.amazonses.com> URL: https://gitlist.dev/e/01020161bcb6b3db-dd4dc2a0-4426-4bf0-97f3-18b299d91400-000000%40eu-west-1.amazonses.com In-Reply-To: <01020161bcb6b2b5-6a915ec6-57e5-4619-b281-0e2a193c69a2-000000@eu-west-1.amazonses.com> ``` Before this patch, there are several non-ASCII apostrophes in gitsubmodules.txt, and misconverged at the https://git-scm.com/docs/gitsubmodules/ . To make codes consistent, these non-ASCII apostrophes are replaced with ASCII single quotes. This patch also makes the document readable on the website. Signed-off-by: Motoki Seki --- Documentation/gitsubmodules.txt | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt index 0d59ab4cdfb1c..030c974c25606 100644 --- a/Documentation/gitsubmodules.txt +++ b/Documentation/gitsubmodules.txt @@ -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//` 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 && 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. -- https://github.com/git/git/pull/459 ``` ## marmot1123, 2018-02-22 08:52 Subject: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt Message-ID: <01020161bcb6b2b5-6a915ec6-57e5-4619-b281-0e2a193c69a2-000000@eu-west-1.amazonses.com> URL: https://gitlist.dev/e/01020161bcb6b2b5-6a915ec6-57e5-4619-b281-0e2a193c69a2-000000%40eu-west-1.amazonses.com In-Reply-To: <01020161b30b99df-5029ec2b-a5cb-475b-b54f-9879a117a7f3-000000@eu-west-1.amazonses.com> ``` In the 2nd and 4th paragraph of DESCRIPTION, there ware misconversions `submodule’s`. It seems non-ASCII apostrophes, so I rewrite ASCII apostrophes. Signed-off-by: Motoki Seki --- Documentation/gitsubmodules.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt index 46cf120f666df..0d59ab4cdfb1c 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 -- https://github.com/git/git/pull/459 ``` ## Stefan Beller, 2018-02-22 18:38 Subject: Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt Message-ID: URL: https://gitlist.dev/e/CAGZ79kYLtXJZA865DS2JRi1RRw_L0t%3Df1iKJzvN%2BUyroeg-pbw%40mail.gmail.com In-Reply-To: <01020161bcb6b2b5-6a915ec6-57e5-4619-b281-0e2a193c69a2-000000@eu-west-1.amazonses.com> ``` On Thu, Feb 22, 2018 at 12:52 AM, marmot1123 wrote: > In the 2nd and 4th paragraph of DESCRIPTION, there ware misconversions `submodule’s`. > It seems non-ASCII apostrophes, so I rewrite ASCII apostrophes. > > Signed-off-by: Motoki Seki > --- > Documentation/gitsubmodules.txt | 4 ++-- > 1 file changed, 2 insertions(+), 2 deletions(-) > > diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt > index 46cf120f666df..0d59ab4cdfb1c 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 > > -- > https://github.com/git/git/pull/459 ``` ## Junio C Hamano, 2018-02-22 20:20 Subject: Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt Message-ID: URL: https://gitlist.dev/e/xmqqy3jkvkr9.fsf%40gitster-ct.c.googlers.com In-Reply-To: ``` Stefan Beller writes: > On Thu, Feb 22, 2018 at 12:52 AM, marmot1123 wrote: >> In the 2nd and 4th paragraph of DESCRIPTION, there ware misconversions `submodule’s`. >> It seems non-ASCII apostrophes, so I rewrite ASCII apostrophes. >> >> Signed-off-by: Motoki Seki >> --- >> Documentation/gitsubmodules.txt | 4 ++-- >> 1 file changed, 2 insertions(+), 2 deletions(-) >> >> diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt >> index 46cf120f666df..0d59ab4cdfb1c 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 >> >> -- >> https://github.com/git/git/pull/459 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? ``` ## Junio C Hamano, 2018-02-22 20:30 Subject: Re: [PATCH v3 2/2] Replace non-ASCII apostrophes to ASCII single quotes in gitsubmodules.txt Message-ID: URL: https://gitlist.dev/e/xmqqtvu8vkbo.fsf%40gitster-ct.c.googlers.com In-Reply-To: <01020161bcb6b3db-dd4dc2a0-4426-4bf0-97f3-18b299d91400-000000@eu-west-1.amazonses.com> ``` marmot1123 writes: > Before this patch, there are several non-ASCII apostrophes in > gitsubmodules.txt, and misconverged at the https://git-scm.com/docs/gitsubmodules/ . > To make codes consistent, these non-ASCII apostrophes are replaced > with ASCII single quotes. This patch also makes the document readable > on the website. > > Signed-off-by: Motoki Seki > --- Interesting. I didn't know the AsciiDoc renderer used there mishandled these non-ASCII ticks. Thanks for writing it down in the log message. When we say "there are ..." in a proposed commit log message (i.e. in the present tense), it is the norm to talk about the current state of affairs, so "Before this patch," is redundant. I'd drop it myself while queuing, and possibly applying other typofixes. Thanks. > Documentation/gitsubmodules.txt | 10 +++++----- > 1 file changed, 5 insertions(+), 5 deletions(-) > > diff --git a/Documentation/gitsubmodules.txt b/Documentation/gitsubmodules.txt > index 0d59ab4cdfb1c..030c974c25606 100644 > --- a/Documentation/gitsubmodules.txt > +++ b/Documentation/gitsubmodules.txt > @@ -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//` > 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 && 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. > > -- > https://github.com/git/git/pull/459 ``` ## Stefan Beller, 2018-02-22 20:36 Subject: Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt Message-ID: URL: https://gitlist.dev/e/CAGZ79kZMkuek_yVAfrTBz6jbeamc3JDjPg2JTnYb45tONAj1iQ%40mail.gmail.com In-Reply-To: ``` On Thu, Feb 22, 2018 at 12:20 PM, Junio C Hamano wrote: > > 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. Thanks, Stefan ``` ## Junio C Hamano, 2018-02-22 20:42 Subject: Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt Message-ID: URL: https://gitlist.dev/e/xmqqpo4wvjs4.fsf%40gitster-ct.c.googlers.com In-Reply-To: ``` Stefan Beller writes: > On Thu, Feb 22, 2018 at 12:20 PM, Junio C Hamano wrote: > >> >> 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 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 Signed-off-by: Junio C Hamano --- 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//` 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 && 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 ```