public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: cvam <cvam0000@gmail.com>, kbusch@kernel.org, axboe@kernel.dk
Cc: hch@lst.de, sagi@grimberg.me, linux-nvme@lists.infradead.org,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	cvam <cvam0000@gmail.com>
Subject: Re: [PATCH] Typo in the file 'feature-and-quirk-policy.rst'.
Date: Mon, 09 Sep 2024 14:15:45 -0600	[thread overview]
Message-ID: <8734m8h9ce.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20240909200253.19818-1-cvam0000@gmail.com>

Thanks for working to improve our documentation.  Some notes...

cvam <cvam0000@gmail.com> writes:

> location: 'Documentation/nvme/feature-and-quirk-policy.rst'
> tested: Not breaking anything.

I don't stress a lot over changelogs for simple tweaks like this, but
you could still try to write something in our normal imperative style.

> Signed-off-by: cvam <cvam0000@gmail.com>

There needs to be a blank line before the signed-off-by, and it should
have a full name in it please.

> ---
>  Documentation/nvme/feature-and-quirk-policy.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/nvme/feature-and-quirk-policy.rst b/Documentation/nvme/feature-and-quirk-policy.rst
> index c01d836d8e41..b5461aa303a4 100644
> --- a/Documentation/nvme/feature-and-quirk-policy.rst
> +++ b/Documentation/nvme/feature-and-quirk-policy.rst
> @@ -1,7 +1,7 @@
>  .. SPDX-License-Identifier: GPL-2.0
>  
>  =======================================
> -Linux NVMe feature and and quirk policy
> +Linux NVMe feature and quirk policy
>  =======================================

A nice touch would be to adjust the width of the "====" lines to match.

Thanks,

jon

  reply	other threads:[~2024-09-09 20:15 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-09-09 20:02 [PATCH] Typo in the file 'feature-and-quirk-policy.rst' cvam
2024-09-09 20:15 ` Jonathan Corbet [this message]
2024-09-09 20:30   ` Matthew Wilcox
2024-09-10  2:02   ` Bagas Sanjaya
2024-09-10  5:27   ` [PATCH v2] Remove duplicate "and" in 'Linux NVMe docs Shivam Chaudhary
2024-09-10 21:45     ` Jonathan Corbet

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=8734m8h9ce.fsf@trenco.lwn.net \
    --to=corbet@lwn.net \
    --cc=axboe@kernel.dk \
    --cc=cvam0000@gmail.com \
    --cc=hch@lst.de \
    --cc=kbusch@kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-nvme@lists.infradead.org \
    --cc=sagi@grimberg.me \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox