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

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

[cvam]

location: 'Documentation/nvme/feature-and-quirk-policy.rst'
tested: Not breaking anything.
Signed-off-by: cvam <cvam0000@gmail.com>
---
 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
 =======================================
 
 This file explains the policy used to decide what is supported by the
-- 
2.34.1

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

[Jonathan Corbet]

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

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

[Matthew Wilcox]

On Mon, Sep 09, 2024 at 02:15:45PM -0600, Jonathan Corbet wrote:
> >  =======================================
> > -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.

Actually, I wouldn't.  The tooling only complains about lines which are
too short (and honestly, I wish it wouldn't).  Lines which are a bit too
long are fine with the tool, and I don't object to how they look in a
text editor either.

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

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 532 bytes --]

On Mon, Sep 09, 2024 at 02:15:45PM -0600, Jonathan Corbet wrote:
> 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.

Something like 'Remove duplicate "and" in 'Linux NVMe feature and quirk policy'
title heading.'

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

[PATCH v2] Remove duplicate "and" in 'Linux NVMe docs.

[Shivam Chaudhary]

From: cvam <cvam0000@gmail.com>

Remove duplicate occurrence of 'and' in
'Linux NVMe Feature and Quirk Policy' title heading.

tested: Not breaking anything.

Signed-off-by: Shivam Chaudhary <cvam0000@gmail.com>
---
 Documentation/nvme/feature-and-quirk-policy.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/nvme/feature-and-quirk-policy.rst b/Documentation/nvme/feature-and-quirk-policy.rst
index c01d836d8e41..e21966bf20a8 100644
--- a/Documentation/nvme/feature-and-quirk-policy.rst
+++ b/Documentation/nvme/feature-and-quirk-policy.rst
@@ -1,8 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-=======================================
-Linux NVMe feature and and quirk policy
-=======================================
+===================================
+Linux NVMe feature and quirk policy
+===================================
 
 This file explains the policy used to decide what is supported by the
 Linux NVMe driver and what is not.
-- 
2.34.1

Re: [PATCH v2] Remove duplicate "and" in 'Linux NVMe docs.

[Jonathan Corbet]

Shivam Chaudhary <cvam0000@gmail.com> writes:

> From: cvam <cvam0000@gmail.com>
>
> Remove duplicate occurrence of 'and' in
> 'Linux NVMe Feature and Quirk Policy' title heading.
>
> tested: Not breaking anything.
>
> Signed-off-by: Shivam Chaudhary <cvam0000@gmail.com>
> ---
>  Documentation/nvme/feature-and-quirk-policy.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)

I have applied this, thanks.

For future reference, a remark like "tested: not breaking anything" is
not helpful.  If you have done testing, reviewers will want to know
*how* you have tested it.  For a patch like this, of course, that
doesn't matter.

jon