[PATCH] mtd: nand: fix spelling in driver api documentation

[PATCH] mtd: nand: fix spelling in driver api documentation

[Marcel Ziswiler]

From: Marcel Ziswiler <marcel.ziswiler@toradex.com>

This fixes some spelling mistakes.

Signed-off-by: Marcel Ziswiler <marcel.ziswiler@toradex.com>

---

 Documentation/driver-api/mtdnand.rst | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/driver-api/mtdnand.rst b/Documentation/driver-api/mtdnand.rst
index dcd63599f700..c55a6034c397 100644
--- a/Documentation/driver-api/mtdnand.rst
+++ b/Documentation/driver-api/mtdnand.rst
@@ -374,7 +374,7 @@ The nand driver supports three different types of hardware ECC.
 
 -  NAND_ECC_HW8_512
 
-   Hardware ECC generator providing 6 bytes ECC per 512 byte.
+   Hardware ECC generator providing 8 bytes ECC per 512 byte.
 
 If your hardware generator has a different functionality add it at the
 appropriate place in nand_base.c
@@ -889,7 +889,7 @@ Use these constants to select the ECC algorithm::
     #define NAND_ECC_HW3_512    3
     /* Hardware ECC 6 byte ECC per 512 Byte data */
     #define NAND_ECC_HW6_512    4
-    /* Hardware ECC 6 byte ECC per 512 Byte data */
+    /* Hardware ECC 8 byte ECC per 512 Byte data */
     #define NAND_ECC_HW8_512    6
 
 
-- 
2.14.4

Re: [PATCH] mtd: nand: fix spelling in driver api documentation

[Jonathan Corbet]

On Fri, 20 Jul 2018 09:53:33 +0200
Marcel Ziswiler <marcel@ziswiler.com> wrote:

> From: Marcel Ziswiler <marcel.ziswiler@toradex.com>
> 
> This fixes some spelling mistakes.

So I hate to complain about a documentation improvement, but...

> 
> Signed-off-by: Marcel Ziswiler <marcel.ziswiler@toradex.com>
> 
> ---
> 
>  Documentation/driver-api/mtdnand.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/driver-api/mtdnand.rst b/Documentation/driver-api/mtdnand.rst
> index dcd63599f700..c55a6034c397 100644
> --- a/Documentation/driver-api/mtdnand.rst
> +++ b/Documentation/driver-api/mtdnand.rst
> @@ -374,7 +374,7 @@ The nand driver supports three different types of hardware ECC.
>  
>  -  NAND_ECC_HW8_512
>  
> -   Hardware ECC generator providing 6 bytes ECC per 512 byte.
> +   Hardware ECC generator providing 8 bytes ECC per 512 byte.

That's not a spelling mistake, that's a factual change.  I'll apply the
patch since it appears to be correct, but will be tweaking the changelog.

Thanks,

jon

Re: [PATCH] mtd: nand: fix spelling in driver api documentation

[Marcel Ziswiler]

On Mon, 2018-07-23 at 09:39 -0600, Jonathan Corbet wrote:
> On Fri, 20 Jul 2018 09:53:33 +0200
> Marcel Ziswiler <marcel@ziswiler.com> wrote:
> 
> > From: Marcel Ziswiler <marcel.ziswiler@toradex.com>
> > 
> > This fixes some spelling mistakes.
> 
> So I hate to complain about a documentation improvement, but...
> 
> > 
> > Signed-off-by: Marcel Ziswiler <marcel.ziswiler@toradex.com>
> > 
> > ---
> > 
> >  Documentation/driver-api/mtdnand.rst | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/driver-api/mtdnand.rst
> > b/Documentation/driver-api/mtdnand.rst
> > index dcd63599f700..c55a6034c397 100644
> > --- a/Documentation/driver-api/mtdnand.rst
> > +++ b/Documentation/driver-api/mtdnand.rst
> > @@ -374,7 +374,7 @@ The nand driver supports three different types
> > of hardware ECC.
> >  
> >  -  NAND_ECC_HW8_512
> >  
> > -   Hardware ECC generator providing 6 bytes ECC per 512 byte.
> > +   Hardware ECC generator providing 8 bytes ECC per 512 byte.
> 
> That's not a spelling mistake, that's a factual change.  I'll apply
> the
> patch since it appears to be correct, but will be tweaking the
> changelog.

Yeah, probably a copy/paste mistake. No pun intended.

> Thanks,
> 
> jon

Re: [PATCH] mtd: nand: fix spelling in driver api documentation

[Boris Brezillon]

Hi Jonathan,

On Mon, 23 Jul 2018 09:39:24 -0600
Jonathan Corbet <corbet@lwn.net> wrote:

> On Fri, 20 Jul 2018 09:53:33 +0200
> Marcel Ziswiler <marcel@ziswiler.com> wrote:
> 
> > From: Marcel Ziswiler <marcel.ziswiler@toradex.com>
> > 
> > This fixes some spelling mistakes.  
> 
> So I hate to complain about a documentation improvement, but...
> 
> > 
> > Signed-off-by: Marcel Ziswiler <marcel.ziswiler@toradex.com>
> > 
> > ---
> > 
> >  Documentation/driver-api/mtdnand.rst | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/driver-api/mtdnand.rst b/Documentation/driver-api/mtdnand.rst
> > index dcd63599f700..c55a6034c397 100644
> > --- a/Documentation/driver-api/mtdnand.rst
> > +++ b/Documentation/driver-api/mtdnand.rst
> > @@ -374,7 +374,7 @@ The nand driver supports three different types of hardware ECC.
> >  
> >  -  NAND_ECC_HW8_512
> >  
> > -   Hardware ECC generator providing 6 bytes ECC per 512 byte.
> > +   Hardware ECC generator providing 8 bytes ECC per 512 byte.  
> 
> That's not a spelling mistake, that's a factual change.  I'll apply the
> patch since it appears to be correct, but will be tweaking the changelog.

I think Miquel had planned to apply this patch to the NAND tree, but we
don't seem to have conflicting changes on this file, so feel free to
take it in the doc tree.

Acked-by: Boris Brezillon <boris.brezillon@bootlin.com>

Regards,

Boris

Re: [PATCH] mtd: nand: fix spelling in driver api documentation

[Miquel Raynal]

Hi Jonathan,

Boris Brezillon <boris.brezillon@bootlin.com> wrote on Mon, 23 Jul 2018
18:19:15 +0200:

> Hi Jonathan,
> 
> On Mon, 23 Jul 2018 09:39:24 -0600
> Jonathan Corbet <corbet@lwn.net> wrote:
> 
> > On Fri, 20 Jul 2018 09:53:33 +0200
> > Marcel Ziswiler <marcel@ziswiler.com> wrote:
> >   
> > > From: Marcel Ziswiler <marcel.ziswiler@toradex.com>
> > > 
> > > This fixes some spelling mistakes.    
> > 
> > So I hate to complain about a documentation improvement, but...
> >   
> > > 
> > > Signed-off-by: Marcel Ziswiler <marcel.ziswiler@toradex.com>
> > > 
> > > ---
> > > 
> > >  Documentation/driver-api/mtdnand.rst | 4 ++--
> > >  1 file changed, 2 insertions(+), 2 deletions(-)
> > > 
> > > diff --git a/Documentation/driver-api/mtdnand.rst b/Documentation/driver-api/mtdnand.rst
> > > index dcd63599f700..c55a6034c397 100644
> > > --- a/Documentation/driver-api/mtdnand.rst
> > > +++ b/Documentation/driver-api/mtdnand.rst
> > > @@ -374,7 +374,7 @@ The nand driver supports three different types of hardware ECC.
> > >  
> > >  -  NAND_ECC_HW8_512
> > >  
> > > -   Hardware ECC generator providing 6 bytes ECC per 512 byte.
> > > +   Hardware ECC generator providing 8 bytes ECC per 512 byte.    
> > 
> > That's not a spelling mistake, that's a factual change.  I'll apply the
> > patch since it appears to be correct, but will be tweaking the changelog.  
> 
> I think Miquel had planned to apply this patch to the NAND tree, but we
> don't seem to have conflicting changes on this file, so feel free to
> take it in the doc tree.
> 
> Acked-by: Boris Brezillon <boris.brezillon@bootlin.com>

Can you confirm you will take this patch?

Thanks,
Miquèl

Re: [PATCH] mtd: nand: fix spelling in driver api documentation

[Jonathan Corbet]

On Wed, 25 Jul 2018 09:29:28 +0200
Miquel Raynal <miquel.raynal@bootlin.com> wrote:

> > > That's not a spelling mistake, that's a factual change.  I'll apply the
> > > patch since it appears to be correct, but will be tweaking the changelog.    
> > 
> > I think Miquel had planned to apply this patch to the NAND tree, but we
> > don't seem to have conflicting changes on this file, so feel free to
> > take it in the doc tree.
> > 
> > Acked-by: Boris Brezillon <boris.brezillon@bootlin.com>  
> 
> Can you confirm you will take this patch?

Yeah, that's what the "I'll apply the patch" part above means :)  It's
already in docs-next.

Thanks,

jon