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

[Junio C Hamano]

Todd Zullinger  writes:

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

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

[Stefan Beller]

On Tue, Feb 20, 2018 at 11:36 AM, Kaartic Sivaraam
 wrote:
> 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.

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

[Todd Zullinger]

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

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

[Kaartic Sivaraam]

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



signature.asc
Description: OpenPGP digital signature

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

[Stefan Beller]

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  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