From: Boris BREZILLON <boris.brezillon@free-electrons.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: Brian Norris <computersforpeace@gmail.com>,
linux-mtd@lists.infradead.org
Subject: Re: struct nand_sdr_timings kernel-doc
Date: Sun, 17 Aug 2014 10:16:59 +0200 [thread overview]
Message-ID: <20140817101659.55176635@bbrezillon> (raw)
In-Reply-To: <53EF9C23.1050006@infradead.org>
Hi Randy,
On Sat, 16 Aug 2014 11:00:03 -0700
Randy Dunlap <rdunlap@infradead.org> wrote:
> Hi,
>
> Current DocBook complains as follows:
>
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tALH_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tADL_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tALS_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tAR_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCEA_max'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCEH_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCH_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCHZ_max'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCLH_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCLR_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCLS_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCOH_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tCS_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tDH_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tDS_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tFEAT_max'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tIR_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tITC_max'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRC_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tREA_max'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tREH_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRHOH_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRHW_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRHZ_max'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRLOH_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRP_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRR_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tRST_max'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWB_max'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWC_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWH_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWHR_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWP_min'
> Warning(..//include/linux/mtd/nand.h:999): No description found for parameter 'tWW_min'
>
>
> Please eliminate all of those warnings by:
> a. adding kernel-doc notation for each struct field; or
> b. changing the beginning /** to /*; or
If you don't mind I'll go for this solution.
Brian, is that okay for you ?
> c. add /* private */ before the first struct member so that each struct item
> does not need to be described; or
> d. some other way that suits you.
>
Best Regards,
Boris
--
Boris Brezillon, Free Electrons
Embedded Linux and Kernel engineering
http://free-electrons.com
prev parent reply other threads:[~2014-08-17 8:17 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-08-16 18:00 struct nand_sdr_timings kernel-doc Randy Dunlap
2014-08-17 8:16 ` Boris BREZILLON [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20140817101659.55176635@bbrezillon \
--to=boris.brezillon@free-electrons.com \
--cc=computersforpeace@gmail.com \
--cc=linux-mtd@lists.infradead.org \
--cc=rdunlap@infradead.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox