git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Stefan Beller <sbeller@google.com>
Cc: marmot1123 <marmot.motoki@gmail.com>, git <git@vger.kernel.org>
Subject: Re: [PATCH v3 1/2] Fix misconversion of gitsubmodule.txt
Date: Thu, 22 Feb 2018 12:42:03 -0800	[thread overview]
Message-ID: <xmqqpo4wvjs4.fsf@gitster-ct.c.googlers.com> (raw)
In-Reply-To: <CAGZ79kZMkuek_yVAfrTBz6jbeamc3JDjPg2JTnYb45tONAj1iQ@mail.gmail.com> (Stefan Beller's message of "Thu, 22 Feb 2018 12:36:40 -0800")

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




      reply	other threads:[~2018-02-22 20:42 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqpo4wvjs4.fsf@gitster-ct.c.googlers.com \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=marmot.motoki@gmail.com \
    --cc=sbeller@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).