From: Lee Jones <lee.jones@linaro.org>
To: vigneshr@ti.com
Cc: Richard Weinberger <richard@nod.at>,
linux-kernel@vger.kernel.org,
Kyungmin Park <kyungmin.park@samsung.com>,
linux-mtd@lists.infradead.org,
Miquel Raynal <miquel.raynal@bootlin.com>,
Lee Jones <lee.jones@linaro.org>
Subject: [PATCH 06/23] mtd: nand: onenand: onenand_bbt: Fix expected kernel-doc formatting
Date: Mon, 2 Nov 2020 11:53:49 +0000 [thread overview]
Message-ID: <20201102115406.1074327-7-lee.jones@linaro.org> (raw)
In-Reply-To: <20201102115406.1074327-1-lee.jones@linaro.org>
Fixes the following W=1 kernel build warning(s):
drivers/mtd/nand/onenand/onenand_bbt.c:33: warning: Function parameter or member 'buf' not described in 'check_short_pattern'
drivers/mtd/nand/onenand/onenand_bbt.c:33: warning: Function parameter or member 'len' not described in 'check_short_pattern'
drivers/mtd/nand/onenand/onenand_bbt.c:33: warning: Function parameter or member 'paglen' not described in 'check_short_pattern'
drivers/mtd/nand/onenand/onenand_bbt.c:33: warning: Function parameter or member 'td' not described in 'check_short_pattern'
drivers/mtd/nand/onenand/onenand_bbt.c:57: warning: Function parameter or member 'mtd' not described in 'create_bbt'
drivers/mtd/nand/onenand/onenand_bbt.c:57: warning: Function parameter or member 'buf' not described in 'create_bbt'
drivers/mtd/nand/onenand/onenand_bbt.c:57: warning: Function parameter or member 'bd' not described in 'create_bbt'
drivers/mtd/nand/onenand/onenand_bbt.c:57: warning: Function parameter or member 'chip' not described in 'create_bbt'
drivers/mtd/nand/onenand/onenand_bbt.c:132: warning: Function parameter or member 'mtd' not described in 'onenand_memory_bbt'
drivers/mtd/nand/onenand/onenand_bbt.c:132: warning: Function parameter or member 'bd' not described in 'onenand_memory_bbt'
drivers/mtd/nand/onenand/onenand_bbt.c:145: warning: Function parameter or member 'mtd' not described in 'onenand_isbad_bbt'
drivers/mtd/nand/onenand/onenand_bbt.c:145: warning: Function parameter or member 'offs' not described in 'onenand_isbad_bbt'
drivers/mtd/nand/onenand/onenand_bbt.c:145: warning: Function parameter or member 'allowbbt' not described in 'onenand_isbad_bbt'
drivers/mtd/nand/onenand/onenand_bbt.c:182: warning: Function parameter or member 'mtd' not described in 'onenand_scan_bbt'
drivers/mtd/nand/onenand/onenand_bbt.c:182: warning: Function parameter or member 'bd' not described in 'onenand_scan_bbt'
drivers/mtd/nand/onenand/onenand_bbt.c:230: warning: Function parameter or member 'mtd' not described in 'onenand_default_bbt'
Cc: Kyungmin Park <kyungmin.park@samsung.com>
Cc: Miquel Raynal <miquel.raynal@bootlin.com>
Cc: Richard Weinberger <richard@nod.at>
Cc: Vignesh Raghavendra <vigneshr@ti.com>
Cc: linux-mtd@lists.infradead.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
drivers/mtd/nand/onenand/onenand_bbt.c | 32 +++++++++++++-------------
1 file changed, 16 insertions(+), 16 deletions(-)
diff --git a/drivers/mtd/nand/onenand/onenand_bbt.c b/drivers/mtd/nand/onenand/onenand_bbt.c
index 57c31c81be186..def89f1080071 100644
--- a/drivers/mtd/nand/onenand/onenand_bbt.c
+++ b/drivers/mtd/nand/onenand/onenand_bbt.c
@@ -18,10 +18,10 @@
/**
* check_short_pattern - [GENERIC] check if a pattern is in the buffer
- * @param buf the buffer to search
- * @param len the length of buffer to search
- * @param paglen the pagelength
- * @param td search pattern descriptor
+ * @buf: the buffer to search
+ * @len: the length of buffer to search
+ * @paglen: the pagelength
+ * @td: search pattern descriptor
*
* Check for a pattern at the given place. Used to search bad block
* tables and good / bad block identifiers. Same as check_pattern, but
@@ -44,10 +44,10 @@ static int check_short_pattern(uint8_t *buf, int len, int paglen, struct nand_bb
/**
* create_bbt - [GENERIC] Create a bad block table by scanning the device
- * @param mtd MTD device structure
- * @param buf temporary buffer
- * @param bd descriptor for the good/bad block search pattern
- * @param chip create the table for a specific chip, -1 read all chips.
+ * @mtd: MTD device structure
+ * @buf: temporary buffer
+ * @bd: descriptor for the good/bad block search pattern
+ * @chip: create the table for a specific chip, -1 read all chips.
* Applies only if NAND_BBT_PERCHIP option is set
*
* Create a bad block table by scanning the device
@@ -122,8 +122,8 @@ static int create_bbt(struct mtd_info *mtd, uint8_t *buf, struct nand_bbt_descr
/**
* onenand_memory_bbt - [GENERIC] create a memory based bad block table
- * @param mtd MTD device structure
- * @param bd descriptor for the good/bad block search pattern
+ * @mtd: MTD device structure
+ * @bd: descriptor for the good/bad block search pattern
*
* The function creates a memory based bbt by scanning the device
* for manufacturer / software marked good / bad blocks
@@ -137,9 +137,9 @@ static inline int onenand_memory_bbt (struct mtd_info *mtd, struct nand_bbt_desc
/**
* onenand_isbad_bbt - [OneNAND Interface] Check if a block is bad
- * @param mtd MTD device structure
- * @param offs offset in the device
- * @param allowbbt allow access to bad block table region
+ * @mtd: MTD device structure
+ * @offs: offset in the device
+ * @allowbbt: allow access to bad block table region
*/
static int onenand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt)
{
@@ -166,8 +166,8 @@ static int onenand_isbad_bbt(struct mtd_info *mtd, loff_t offs, int allowbbt)
/**
* onenand_scan_bbt - [OneNAND Interface] scan, find, read and maybe create bad block table(s)
- * @param mtd MTD device structure
- * @param bd descriptor for the good/bad block search pattern
+ * @mtd: MTD device structure
+ * @bd: descriptor for the good/bad block search pattern
*
* The function checks, if a bad block table(s) is/are already
* available. If not it scans the device for manufacturer
@@ -221,7 +221,7 @@ static struct nand_bbt_descr largepage_memorybased = {
/**
* onenand_default_bbt - [OneNAND Interface] Select a default bad block table for the device
- * @param mtd MTD device structure
+ * @mtd: MTD device structure
*
* This function selects the default bad block table
* support for the device and calls the onenand_scan_bbt function
--
2.25.1
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
next prev parent reply other threads:[~2020-11-02 11:56 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20201102115406.1074327-1-lee.jones@linaro.org>
2020-11-02 11:53 ` [PATCH 01/23] mtd: mtdpart: Fix misdocumented function parameter 'mtd' Lee Jones
2020-11-02 11:53 ` [PATCH 02/23] mtd: devices: phram: File headers are not good candidates for kernel-doc Lee Jones
2020-11-02 11:53 ` [PATCH 03/23] mtd: nand: onenand: onenand_base: Fix expected kernel-doc formatting Lee Jones
2020-11-02 12:33 ` Miquel Raynal
2020-11-02 11:53 ` [PATCH 04/23] mtd: devices: docg3: Fix kernel-doc 'bad line' and 'excessive doc' issues Lee Jones
2020-11-02 12:34 ` Miquel Raynal
2020-11-02 11:53 ` [PATCH 05/23] mtd: mtdcore: Fix misspelled function parameter 'section' Lee Jones
2020-11-02 11:53 ` Lee Jones [this message]
2020-11-02 11:53 ` [PATCH 07/23] mtd: spi-nor: controllers: hisi-sfc: Demote non-conformant kernel-doc Lee Jones
2020-11-06 13:37 ` Vignesh Raghavendra
2020-11-02 11:53 ` [PATCH 08/23] mtd: ubi: build: Document 'ubi_num' in struct mtd_dev_param Lee Jones
2020-11-02 11:53 ` [PATCH 09/23] mtd: nand: spi: toshiba: Demote non-conformant kernel-doc header Lee Jones
2020-11-02 12:29 ` Frieder Schrempf
2020-11-02 11:53 ` [PATCH 10/23] mtd: ubi: kapi: Correct documentation for 'ubi_leb_read_sg's 'sgl' parameter Lee Jones
2020-11-02 11:53 ` [PATCH 11/23] mtd: ubi: eba: Fix a couple of misdocumentation issues Lee Jones
2020-11-02 11:53 ` [PATCH 12/23] mtd: ubi: wl: Fix a couple of kernel-doc issues Lee Jones
2020-11-02 11:53 ` [PATCH 13/23] mtd: nand: raw: brcmnand: brcmnand: Demote non-conformant kernel-doc headers Lee Jones
2020-11-04 3:38 ` Florian Fainelli
2020-11-02 11:53 ` [PATCH 14/23] mtd: ubi: gluebi: Fix misnamed function parameter documentation Lee Jones
2020-11-02 11:53 ` [PATCH 15/23] mtd: nand: raw: diskonchip: Marking unused variables as __always_unused Lee Jones
2020-11-02 11:53 ` [PATCH 16/23] mtd: nand: raw: cafe_nand: Remove superfluous param doc and add another Lee Jones
2020-11-02 11:54 ` [PATCH 17/23] mtd: nand: raw: s3c2410: Add documentation for 2 missing struct members Lee Jones
2020-11-02 12:41 ` Krzysztof Kozlowski
2020-11-02 11:54 ` [PATCH 18/23] mtd: nand: raw: omap_elm: Finish half populated function header, demote empty ones Lee Jones
2020-11-02 11:54 ` [PATCH 19/23] mtd: nand: raw: omap2: Fix a bunch of kernel-doc misdemeanours Lee Jones
2020-11-02 12:44 ` Miquel Raynal
2020-11-02 11:54 ` [PATCH 20/23] mtd: nand: raw: sunxi_nand: Document 'sunxi_nfc's 'caps' member Lee Jones
2020-11-02 12:48 ` Miquel Raynal
2020-11-02 11:54 ` [PATCH 21/23] mtd: nand: raw: arasan-nand-controller: Document 'anfc_op's 'buf' member Lee Jones
2020-11-02 11:54 ` [PATCH 22/23] mtd: nand: onenand: onenand_base: Fix some kernel-doc misdemeanours Lee Jones
2020-11-02 12:51 ` Miquel Raynal
2020-11-02 11:54 ` [PATCH 23/23] mtd: devices: powernv_flash: Add function names to headers and fix 'dev' Lee Jones
2020-11-02 12:52 ` Miquel Raynal
2020-11-06 13:32 ` [PATCH 00/23] Rid W=1 warnings in MTD Lee Jones
2020-11-06 13:44 ` Miquel Raynal
2020-11-06 14:33 ` Lee Jones
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=20201102115406.1074327-7-lee.jones@linaro.org \
--to=lee.jones@linaro.org \
--cc=kyungmin.park@samsung.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mtd@lists.infradead.org \
--cc=miquel.raynal@bootlin.com \
--cc=richard@nod.at \
--cc=vigneshr@ti.com \
/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;
as well as URLs for NNTP newsgroup(s).