threads / patch / 47879

patchFix misconversion of gitsubmodule.txt

Subject: [PATCH] Fix misconversion of gitsubmodule.txt

## tl;dr

9 messages between Feb 20, 2018 and Feb 20, 2018. Diffs are folded; open one to read it.

replies: 8people: 7as markdown or json

marmot1123· Feb 20, 2018, 08:51 UTC · lore
In the 2nd and 4th paragraph of DESCRIPTION, there ware misconversions `submodule’s`.
It seems non-ASCII apostrophes, so I rewrite ASCII apostrophes.
---
 Documentation/gitsubmodules.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Show changes to Documentation/gitsubmodules.txt +2 −3
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
Eric Sunshine· Feb 20, 2018, 10:02 UTC · re: marmot1123 · lore

Re: [PATCH] Fix misconversion of gitsubmodule.txt

On Tue, Feb 20, 2018 at 3:51 AM, marmot1123 <marmot.motoki@gmail.com> wrote:
> In the 2nd and 4th paragraph of DESCRIPTION, there ware misconversions `submodule’s`.
> It seems non-ASCII apostrophes, so I rewrite ASCII apostrophes.

Thanks for the contribution. Please sign-off your patch; see Documentation/SubmittingPatches.

brian m. carlson· Feb 20, 2018, 11:30 UTC · re: marmot1123 · lore

Re: [PATCH] Fix misconversion of gitsubmodule.txt

On Tue, Feb 20, 2018 at 08:51:46AM +0000, 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.

While I agree consistency is good, does this have any effect on the output? I think AsciiDoc (and Asciidoctor) produce the non-ASCII format for output, so this should be a no-op for all known output formats.

-- 
brian m. carlson / brian with sandals: Houston, Texas, US
https://www.crustytoothpaste.net/~bmc | My opinion only
OpenPGP: https://keybase.io/bk2204
marmot1123· Feb 20, 2018, 11:48 UTC · re: marmot1123 · lore

[PATCH v2] Fix misconversion of gitsubmodule.txt

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 <marmot.motoki@gmail.com>
---
 Documentation/gitsubmodules.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
Show changes to Documentation/gitsubmodules.txt +2 −3
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· Feb 20, 2018, 18:50 UTC · re: marmot1123 · lore

Re: [PATCH v2] Fix misconversion of gitsubmodule.txt

Kaartic was the last to touch that file, (as found via git log origin/master -- Documentation/gitsubmodules.txt), sorry I did not find this in the review.

Thanks for the patch! Stefan

On Tue, Feb 20, 2018 at 3:48 AM, marmot1123 <marmot.motoki@gmail.com> wrote:
Show 33 quoted lines
> 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 <marmot.motoki@gmail.com>
> ---
>  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
Kaartic Sivaraam· Feb 20, 2018, 19:36 UTC · re: Stefan Beller · lore

Re: [PATCH v2] Fix misconversion of gitsubmodule.txt

Hi,
On Wednesday 21 February 2018 12:20 AM, Stefan Beller wrote:
> Kaartic was the last to touch that file,
> (as found via git log origin/master -- Documentation/gitsubmodules.txt),
> sorry I did not find this in the review.
>

"Non-ASCII characters" made me dig into to this a little deeper as I generally don't use them particularly for text files.

"git blame" points at d48034551 (submodules: overhaul documentation, 2017-06-22) as the offending comment.

> Thanks for the patch!
Yeah, nice catch!

-- Kaartic

QUOTE

“It is impossible to live without failing at something, unless you live so cautiously that you might as well not have lived at all – in which case, you fail by default.”

      - J. K. Rowling
Stefan Beller· Feb 20, 2018, 19:44 UTC · re: Kaartic Sivaraam · lore

Re: [PATCH v2] Fix misconversion of gitsubmodule.txt

On Tue, Feb 20, 2018 at 11:36 AM, Kaartic Sivaraam <kaartic.sivaraam@gmail.com> wrote:

Show 13 quoted lines
> Hi,
>
> On Wednesday 21 February 2018 12:20 AM, Stefan Beller wrote:
>> Kaartic was the last to touch that file,
>> (as found via git log origin/master -- Documentation/gitsubmodules.txt),
>> sorry I did not find this in the review.
>>
>
> "Non-ASCII characters" made me dig into to this a little deeper as I
> generally don't use them particularly for text files.
>
> "git blame" points at d48034551 (submodules: overhaul documentation,
> 2017-06-22) as the offending comment.
Hah, good catch! Sorry for my assumptions there.
Todd Zullinger· Feb 20, 2018, 19:38 UTC · re: marmot1123 · lore

Re: [PATCH v2] Fix misconversion of gitsubmodule.txt

Hi,
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.

If replacing the non-ASCI apostrophes is the goal, aren't there a number of others in the same file worth cleaning up at the same time?

$ grep '’' Documentation/gitsubmodules.txt the submodule’s working directory pointing to (i). superproject expects the submodule’s working directory to be at. When deinitialized or deleted (see below), the submodule’s Git but no submodule working directory. The submodule’s Git directory the superproject’s `$GIT_DIR/config` file, so the superproject’s history The deletion removes the superproject’s tracking data, which are The submodule’s working directory is removed from the file

This does seem to be the only file which includes the non-ASCII apostrophe under Documentation.

Some tests include it (intentionally) as does contrib/credential/netrc/git-credential-netrc.

-- 
Todd
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The direct use of physical force is so poor a solution to the problem
of limited resources that it is commonly employed only by small
children and great nations.
    -- David Friedman
Junio C Hamano· Feb 20, 2018, 20:12 UTC · re: Todd Zullinger · lore

Re: [PATCH v2] Fix misconversion of gitsubmodule.txt

Todd Zullinger <tmz@pobox.com> writes:
Show 15 quoted lines
> If replacing the non-ASCI apostrophes is the goal, aren't
> there a number of others in the same file worth cleaning up
> at the same time?
>
> $ grep '’' Documentation/gitsubmodules.txt
> the submodule’s working directory pointing to (i).
> superproject expects the submodule’s working directory to be at.
> When deinitialized or deleted (see below), the submodule’s Git
> but no submodule working directory. The submodule’s Git directory
> the superproject’s `$GIT_DIR/config` file, so the superproject’s history
> The deletion removes the superproject’s tracking data, which are
> The submodule’s working directory is removed from the file
>
> This does seem to be the only file which includes the
> non-ASCII apostrophe under Documentation.

Thanks for checking. I agree that it is a good idea to clean the whole file up at the same time. The title would need to be updated, as it will no longer be "fix misconversion". The justification would also become different---"the 'overhaul' did not just move the text but made the apostrophe style changes and reverting that change is a good thing" was a good justification for "fix misconversion", but now we need to explain to the future readers of "git log" why we prefer to turn all of them in this file to ASCII single quotes (just saying "make it consistent" is sufficient).

Thanks.

← back to recent threads