[PATCH] Fix misconversion of gitsubmodule.txt

Subsystems: documentation, the rest

STALE3136d

11 messages, 6 authors, 2018-02-22 · open the first message on its own page

[PATCH] Fix misconversion of gitsubmodule.txt

From: marmot1123 <hidden>
Date: 2018-02-20 08:51:52

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

Re: [PATCH] Fix misconversion of gitsubmodule.txt

From: Eric Sunshine <hidden>
Date: 2018-02-20 10:02:13

On Tue, Feb 20, 2018 at 3:51 AM, marmot1123 [off-list ref] 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.

Re: [PATCH] Fix misconversion of gitsubmodule.txt

From: brian m. carlson <hidden>
Date: 2018-02-20 11:30:50

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

[PATCH v2] Fix misconversion of gitsubmodule.txt

From: marmot1123 <hidden>
Date: 2018-02-20 11:49:03

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

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

From: Stefan Beller <hidden>
Date: 2018-02-20 18:51:06

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 [off-list ref] wrote:
quoted hunk
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 <redacted>
---
 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

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

From: Kaartic Sivaraam <hidden>
Date: 2018-02-20 19:36:49

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

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

From: Todd Zullinger <hidden>
Date: 2018-02-20 19:38:45

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

From: Stefan Beller <hidden>
Date: 2018-02-20 19:45:04

On Tue, Feb 20, 2018 at 11:36 AM, Kaartic Sivaraam
[off-list ref] wrote:
Hi,

On Wednesday 21 February 2018 12:20 AM, Stefan Beller wrote:
quoted
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.

[PATCH v3 2/2] Replace non-ASCII apostrophes to ASCII single quotes in gitsubmodules.txt

From: marmot1123 <hidden>
Date: 2018-02-22 08:52:33

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

--
https://github.com/git/git/pull/459

[PATCH v3 1/2] Fix misconversion of gitsubmodule.txt

From: marmot1123 <hidden>
Date: 2018-02-22 08:52:36

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

Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt

From: Stefan Beller <hidden>
Date: 2018-02-22 18:38:07

On Thu, Feb 22, 2018 at 12:52 AM, marmot1123 [off-list ref] wrote:
quoted hunk
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 <redacted>
---
 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
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help