* [PATCH] Fix misconversion of gitsubmodule.txt @ 2018-02-20 8:51 marmot1123 2018-02-20 10:02 ` Eric Sunshine ` (2 more replies) 0 siblings, 3 replies; 16+ messages in thread From: marmot1123 @ 2018-02-20 8:51 UTC (permalink / raw) To: git 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 ^ permalink raw reply related [flat|nested] 16+ messages in thread
* Re: [PATCH] Fix misconversion of gitsubmodule.txt 2018-02-20 8:51 [PATCH] Fix misconversion of gitsubmodule.txt marmot1123 @ 2018-02-20 10:02 ` Eric Sunshine 2018-02-20 11:30 ` brian m. carlson 2018-02-20 11:48 ` [PATCH v2] " marmot1123 2 siblings, 0 replies; 16+ messages in thread From: Eric Sunshine @ 2018-02-20 10:02 UTC (permalink / raw) To: marmot1123; +Cc: Git List 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. ^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [PATCH] Fix misconversion of gitsubmodule.txt 2018-02-20 8:51 [PATCH] Fix misconversion of gitsubmodule.txt marmot1123 2018-02-20 10:02 ` Eric Sunshine @ 2018-02-20 11:30 ` brian m. carlson 2018-02-20 11:48 ` [PATCH v2] " marmot1123 2 siblings, 0 replies; 16+ messages in thread From: brian m. carlson @ 2018-02-20 11:30 UTC (permalink / raw) To: marmot1123; +Cc: git [-- Attachment #1: Type: text/plain, Size: 591 bytes --] 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 [-- Attachment #2: signature.asc --] [-- Type: application/pgp-signature, Size: 867 bytes --] ^ permalink raw reply [flat|nested] 16+ messages in thread
* [PATCH v2] Fix misconversion of gitsubmodule.txt 2018-02-20 8:51 [PATCH] Fix misconversion of gitsubmodule.txt marmot1123 2018-02-20 10:02 ` Eric Sunshine 2018-02-20 11:30 ` brian m. carlson @ 2018-02-20 11:48 ` marmot1123 2018-02-20 18:50 ` Stefan Beller ` (2 more replies) 2 siblings, 3 replies; 16+ messages in thread From: marmot1123 @ 2018-02-20 11:48 UTC (permalink / raw) To: git 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 ^ permalink raw reply related [flat|nested] 16+ messages in thread
* Re: [PATCH v2] Fix misconversion of gitsubmodule.txt 2018-02-20 11:48 ` [PATCH v2] " marmot1123 @ 2018-02-20 18:50 ` Stefan Beller 2018-02-20 19:36 ` Kaartic Sivaraam 2018-02-20 19:38 ` Todd Zullinger 2018-02-22 8:52 ` [PATCH v3 1/2] " marmot1123 2 siblings, 1 reply; 16+ messages in thread From: Stefan Beller @ 2018-02-20 18:50 UTC (permalink / raw) To: marmot1123, Kaartic Sivaraam; +Cc: git 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: > 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 ^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [PATCH v2] Fix misconversion of gitsubmodule.txt 2018-02-20 18:50 ` Stefan Beller @ 2018-02-20 19:36 ` Kaartic Sivaraam 2018-02-20 19:44 ` Stefan Beller 0 siblings, 1 reply; 16+ messages in thread From: Kaartic Sivaraam @ 2018-02-20 19:36 UTC (permalink / raw) To: Stefan Beller, marmot1123; +Cc: git [-- Attachment #1.1: Type: text/plain, Size: 759 bytes --] 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 [-- Attachment #2: OpenPGP digital signature --] [-- Type: application/pgp-signature, Size: 870 bytes --] ^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [PATCH v2] Fix misconversion of gitsubmodule.txt 2018-02-20 19:36 ` Kaartic Sivaraam @ 2018-02-20 19:44 ` Stefan Beller 0 siblings, 0 replies; 16+ messages in thread From: Stefan Beller @ 2018-02-20 19:44 UTC (permalink / raw) To: Kaartic Sivaraam; +Cc: marmot1123, git On Tue, Feb 20, 2018 at 11:36 AM, Kaartic Sivaraam <kaartic.sivaraam@gmail.com> 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. ^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [PATCH v2] Fix misconversion of gitsubmodule.txt 2018-02-20 11:48 ` [PATCH v2] " marmot1123 2018-02-20 18:50 ` Stefan Beller @ 2018-02-20 19:38 ` Todd Zullinger 2018-02-20 20:12 ` Junio C Hamano 2018-02-22 8:52 ` [PATCH v3 1/2] " marmot1123 2 siblings, 1 reply; 16+ messages in thread From: Todd Zullinger @ 2018-02-20 19:38 UTC (permalink / raw) To: marmot1123 Cc: git, Eric Sunshine, brian m. carlson, Stefan Beller, Kaartic Sivaraam 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 ^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [PATCH v2] Fix misconversion of gitsubmodule.txt 2018-02-20 19:38 ` Todd Zullinger @ 2018-02-20 20:12 ` Junio C Hamano 0 siblings, 0 replies; 16+ messages in thread From: Junio C Hamano @ 2018-02-20 20:12 UTC (permalink / raw) To: Todd Zullinger Cc: marmot1123, git, Eric Sunshine, brian m. carlson, Stefan Beller, Kaartic Sivaraam Todd Zullinger <tmz@pobox.com> 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. ^ permalink raw reply [flat|nested] 16+ messages in thread
* [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt 2018-02-20 11:48 ` [PATCH v2] " marmot1123 2018-02-20 18:50 ` Stefan Beller 2018-02-20 19:38 ` Todd Zullinger @ 2018-02-22 8:52 ` marmot1123 2018-02-22 8:52 ` [PATCH v3 2/2] Replace non-ASCII apostrophes to ASCII single quotes in gitsubmodules.txt marmot1123 2018-02-22 18:38 ` [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt Stefan Beller 2 siblings, 2 replies; 16+ messages in thread From: marmot1123 @ 2018-02-22 8:52 UTC (permalink / raw) To: git 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 ^ permalink raw reply related [flat|nested] 16+ messages in thread
* [PATCH v3 2/2] Replace non-ASCII apostrophes to ASCII single quotes in gitsubmodules.txt 2018-02-22 8:52 ` [PATCH v3 1/2] " marmot1123 @ 2018-02-22 8:52 ` marmot1123 2018-02-22 20:30 ` Junio C Hamano 2018-02-22 18:38 ` [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt Stefan Beller 1 sibling, 1 reply; 16+ messages in thread From: marmot1123 @ 2018-02-22 8:52 UTC (permalink / raw) To: git 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 <marmot.motoki@gmail.com> --- 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 ^ permalink raw reply related [flat|nested] 16+ messages in thread
* Re: [PATCH v3 2/2] Replace non-ASCII apostrophes to ASCII single quotes in gitsubmodules.txt 2018-02-22 8:52 ` [PATCH v3 2/2] Replace non-ASCII apostrophes to ASCII single quotes in gitsubmodules.txt marmot1123 @ 2018-02-22 20:30 ` Junio C Hamano 0 siblings, 0 replies; 16+ messages in thread From: Junio C Hamano @ 2018-02-22 20:30 UTC (permalink / raw) To: marmot1123; +Cc: git marmot1123 <marmot.motoki@gmail.com> 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 <marmot.motoki@gmail.com> > --- 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/<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 ^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt 2018-02-22 8:52 ` [PATCH v3 1/2] " marmot1123 2018-02-22 8:52 ` [PATCH v3 2/2] Replace non-ASCII apostrophes to ASCII single quotes in gitsubmodules.txt marmot1123 @ 2018-02-22 18:38 ` Stefan Beller 2018-02-22 20:20 ` Junio C Hamano 1 sibling, 1 reply; 16+ messages in thread From: Stefan Beller @ 2018-02-22 18:38 UTC (permalink / raw) To: marmot1123, Junio C Hamano; +Cc: git On Thu, Feb 22, 2018 at 12:52 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. > > 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 ^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt 2018-02-22 18:38 ` [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt Stefan Beller @ 2018-02-22 20:20 ` Junio C Hamano 2018-02-22 20:36 ` Stefan Beller 0 siblings, 1 reply; 16+ messages in thread From: Junio C Hamano @ 2018-02-22 20:20 UTC (permalink / raw) To: Stefan Beller; +Cc: marmot1123, git Stefan Beller <sbeller@google.com> writes: > On Thu, Feb 22, 2018 at 12:52 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. >> >> 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 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? ^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt 2018-02-22 20:20 ` Junio C Hamano @ 2018-02-22 20:36 ` Stefan Beller 2018-02-22 20:42 ` Junio C Hamano 0 siblings, 1 reply; 16+ messages in thread From: Stefan Beller @ 2018-02-22 20:36 UTC (permalink / raw) To: Junio C Hamano; +Cc: marmot1123, git On Thu, Feb 22, 2018 at 12:20 PM, Junio C Hamano <gitster@pobox.com> 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 ^ permalink raw reply [flat|nested] 16+ messages in thread
* Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt 2018-02-22 20:36 ` Stefan Beller @ 2018-02-22 20:42 ` Junio C Hamano 0 siblings, 0 replies; 16+ messages in thread From: Junio C Hamano @ 2018-02-22 20:42 UTC (permalink / raw) To: Stefan Beller; +Cc: marmot1123, git Stefan Beller <sbeller@google.com> writes: > On Thu, Feb 22, 2018 at 12:20 PM, Junio C Hamano <gitster@pobox.com> 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 <marmot.motoki@gmail.com> 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 <marmot.motoki@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com> --- 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 ^ permalink raw reply related [flat|nested] 16+ messages in thread
end of thread, other threads:[~2018-02-22 20:42 UTC | newest] Thread overview: 16+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 2018-02-20 8:51 [PATCH] Fix misconversion of gitsubmodule.txt marmot1123 2018-02-20 10:02 ` Eric Sunshine 2018-02-20 11:30 ` brian m. carlson 2018-02-20 11:48 ` [PATCH v2] " marmot1123 2018-02-20 18:50 ` Stefan Beller 2018-02-20 19:36 ` Kaartic Sivaraam 2018-02-20 19:44 ` Stefan Beller 2018-02-20 19:38 ` Todd Zullinger 2018-02-20 20:12 ` Junio C Hamano 2018-02-22 8:52 ` [PATCH v3 1/2] " marmot1123 2018-02-22 8:52 ` [PATCH v3 2/2] Replace non-ASCII apostrophes to ASCII single quotes in gitsubmodules.txt marmot1123 2018-02-22 20:30 ` Junio C Hamano 2018-02-22 18:38 ` [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt Stefan Beller 2018-02-22 20:20 ` Junio C Hamano 2018-02-22 20:36 ` Stefan Beller 2018-02-22 20:42 ` Junio C Hamano
Code repositories for project(s) associated with this public inbox https://80x24.org/mirrors/git.git This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).