Re: [PATCH] Typo in the file 'feature-and-quirk-policy.rst'.

From: Jonathan Corbet
Date: Mon Sep 09 2024 - 16:15:56 EST


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

cvam <cvam0000@xxxxxxxxx> 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@xxxxxxxxx>

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