All of lore.kernel.org
 help / color / mirror / Atom feed
From: Weijie Yuan <wy@wyuan.org>
To: Nguyen Duc Thinh <ducthinh100812@gmail.com>
Cc: Jonathan Corbet <corbet@lwn.net>,
	Shuah Khan <skhan@linuxfoundation.org>,
	Randy Dunlap <rdunlap@infradead.org>,
	workflows@vger.kernel.org, linux-doc@vger.kernel.org,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] Documentation : process : Capitalize Git, Quilt, and Mercurial consistently
Date: Mon, 24 Aug 2026 17:13:09 +0800	[thread overview]
Message-ID: <aowLJUv1VVri3UKw@wyuan.org> (raw)
In-Reply-To: <20260824084235.9396-1-ducthinh100812@gmail.com>

Nit: why are there extra <space> befoer ':'?

On Mon, Aug 24, 2026 at 03:42:35PM +0700, Nguyen Duc Thinh wrote:
> Update various process documentation files to properly capitalize "Git",
> "Quilt", and "Mercurial" as proper nouns when referring to the source
> management tools themselves.
> 
> Instances explicitly referring to literal command-line invocations
> (such as "git log" or "git bisect") have been left lowercase.

Yep, Documentation/CodingGuideLines of Git says:

  A note on notation:
   Use 'git' (all lowercase) when talking about commands i.e. something
   the user would type into a shell and use 'Git' (uppercase first letter)
   when talking about the version control system and its properties.
                                                        (ln~1016)

I would say this is a powerful argument.

> Signed-off-by: Nguyen Duc Thinh <ducthinh100812@gmail.com>
> ---
>  Documentation/process/1.Intro.rst             |  2 +-
>  Documentation/process/2.Process.rst           | 18 ++++-----
>  Documentation/process/3.Early-stage.rst       |  2 +-
>  Documentation/process/5.Posting.rst           | 10 ++---
>  Documentation/process/7.AdvancedTopics.rst    | 36 +++++++++---------
>  Documentation/process/backporting.rst         | 18 ++++-----
>  .../process/embargoed-hardware-issues.rst     |  2 +-
>  .../process/maintainer-pgp-guide.rst          | 38 +++++++++----------
>  Documentation/process/submitting-patches.rst  |  4 +-
>  9 files changed, 65 insertions(+), 65 deletions(-)

Sorry, I wonder if this is all? Is there any place that has been
forgotten? Or you have already matched it all with a script.

[...]

> diff --git a/Documentation/process/submitting-patches.rst b/Documentation/process/submitting-patches.rst
> index 7ae79452e..b6ca49437 100644
> --- a/Documentation/process/submitting-patches.rst
> +++ b/Documentation/process/submitting-patches.rst
> @@ -866,7 +866,7 @@ automatically include the base tree information in your submission by
>  using the ``--base`` flag. The easiest and most convenient way to use
>  this option is with topical branches::
>  
> -    $ git checkout -t -b my-topical-branch master
> +    $ git switch -t -c my-topical-branch master
>      Branch 'my-topical-branch' set up to track local branch 'master'.
>      Switched to a new branch 'my-topical-branch'
>  
> @@ -882,7 +882,7 @@ notice that it will have the ``base-commit:`` trailer at the very
>  bottom, which provides the reviewer and the CI tools enough information
>  to properly perform ``git am`` without worrying about conflicts::
>  
> -    $ git checkout -b patch-review [base-commit-id]
> +    $ git switch -c patch-review [base-commit-id]
>      Switched to a new branch 'patch-review'
>      $ git am patches.mbox
>      Applying: First Commit

But you casually changed this part but didn't mention it in the commit
message. (So it is not a logically relevant modification.) I think it's
even better to attach a reason for it, e.g. Git now recommends to use
'git switch' instead of 'git checkout' or so.

Thanks.

      reply	other threads:[~2026-08-24  9:13 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-08-24  8:42 [PATCH] Documentation : process : Capitalize Git, Quilt, and Mercurial consistently Nguyen Duc Thinh
2026-08-24  9:13 ` Weijie Yuan [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

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

  git send-email \
    --in-reply-to=aowLJUv1VVri3UKw@wyuan.org \
    --to=wy@wyuan.org \
    --cc=corbet@lwn.net \
    --cc=ducthinh100812@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=skhan@linuxfoundation.org \
    --cc=workflows@vger.kernel.org \
    /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.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.