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

Jonathan Corbet corbet at lwn.net
Mon Sep 9 13:15:45 PDT 2024


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

cvam <cvam0000 at 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 at 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



More information about the Linux-nvme mailing list