* [PATCH] mtd: nand: fix DocBook warnings on nand_sdr_timings doc
@ 2014-08-17 8:29 Boris BREZILLON
2014-08-17 16:30 ` Randy Dunlap
2014-08-19 19:00 ` Brian Norris
0 siblings, 2 replies; 3+ messages in thread
From: Boris BREZILLON @ 2014-08-17 8:29 UTC (permalink / raw)
To: David Woodhouse, Brian Norris, linux-mtd, Randy Dunlap; +Cc: 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
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH] mtd: nand: fix DocBook warnings on nand_sdr_timings doc
2014-08-17 8:29 [PATCH] mtd: nand: fix DocBook warnings on nand_sdr_timings doc Boris BREZILLON
@ 2014-08-17 16:30 ` Randy Dunlap
2014-08-19 19:00 ` Brian Norris
1 sibling, 0 replies; 3+ messages in thread
From: Randy Dunlap @ 2014-08-17 16:30 UTC (permalink / raw)
To: Boris BREZILLON, David Woodhouse, Brian Norris, linux-mtd
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
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: [PATCH] mtd: nand: fix DocBook warnings on nand_sdr_timings doc
2014-08-17 8:29 [PATCH] mtd: nand: fix DocBook warnings on nand_sdr_timings doc Boris BREZILLON
2014-08-17 16:30 ` Randy Dunlap
@ 2014-08-19 19:00 ` Brian Norris
1 sibling, 0 replies; 3+ messages in thread
From: Brian Norris @ 2014-08-19 19:00 UTC (permalink / raw)
To: Boris BREZILLON; +Cc: linux-mtd, Randy Dunlap, David Woodhouse
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
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2014-08-19 19:00 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-08-17 8:29 [PATCH] mtd: nand: fix DocBook warnings on nand_sdr_timings doc Boris BREZILLON
2014-08-17 16:30 ` Randy Dunlap
2014-08-19 19:00 ` Brian Norris
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox