[PATCH] mtd: nand: fix DocBook warnings on nand_sdr_timings doc

[PATCH] mtd: nand: fix DocBook warnings on nand_sdr_timings doc

[Boris BREZILLON]

Change the comment type (from /** to /*) to prevent DocBook from
complaining about missing description for nand_sdr_timings fields.

There is currently no need in documenting those fields because they are
fully described in the ONFI specification (which is pointed out in the
comment).

Signed-off-by: Boris BREZILLON <boris.brezillon@free-electrons.com>
---
 include/linux/mtd/nand.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/linux/mtd/nand.h b/include/linux/mtd/nand.h
index 3083c53..c300db3 100644
--- a/include/linux/mtd/nand.h
+++ b/include/linux/mtd/nand.h
@@ -949,7 +949,7 @@ static inline int jedec_feature(struct nand_chip *chip)
 		: 0;
 }
 
-/**
+/*
  * struct nand_sdr_timings - SDR NAND chip timings
  *
  * This struct defines the timing requirements of a SDR NAND chip.
-- 
1.8.3.2

Re: [PATCH] mtd: nand: fix DocBook warnings on nand_sdr_timings doc

[Randy Dunlap]

On 08/17/14 01:29, Boris BREZILLON wrote:
> Change the comment type (from /** to /*) to prevent DocBook from
> complaining about missing description for nand_sdr_timings fields.
> 
> There is currently no need in documenting those fields because they are
> fully described in the ONFI specification (which is pointed out in the
> comment).
> 
> Signed-off-by: Boris BREZILLON <boris.brezillon@free-electrons.com>

Reported-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
>  include/linux/mtd/nand.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/linux/mtd/nand.h b/include/linux/mtd/nand.h
> index 3083c53..c300db3 100644
> --- a/include/linux/mtd/nand.h
> +++ b/include/linux/mtd/nand.h
> @@ -949,7 +949,7 @@ static inline int jedec_feature(struct nand_chip *chip)
>  		: 0;
>  }
>  
> -/**
> +/*
>   * struct nand_sdr_timings - SDR NAND chip timings
>   *
>   * This struct defines the timing requirements of a SDR NAND chip.
> 


-- 
~Randy

Re: [PATCH] mtd: nand: fix DocBook warnings on nand_sdr_timings doc

[Brian Norris]

On Sun, Aug 17, 2014 at 10:29:42AM +0200, Boris BREZILLON wrote:
> Change the comment type (from /** to /*) to prevent DocBook from
> complaining about missing description for nand_sdr_timings fields.
> 
> There is currently no need in documenting those fields because they are
> fully described in the ONFI specification (which is pointed out in the
> comment).
> 
> Signed-off-by: Boris BREZILLON <boris.brezillon@free-electrons.com>

Pushed to linux-mtd.git. Thanks!

Brian