linux-mtd.lists.infradead.org archive mirror
 help / color / mirror / Atom feed
From: Lee Jones <lee.jones@linaro.org>
To: lee.jones@linaro.org
Cc: Vignesh Raghavendra <vigneshr@ti.com>,
	Richard Weinberger <richard@nod.at>,
	linux-mtd@lists.infradead.org, linux-kernel@vger.kernel.org,
	Miquel Raynal <miquel.raynal@bootlin.com>
Subject: [PATCH v2 11/23] mtd: ubi: eba: Fix a couple of misdocumentation issues
Date: Fri,  6 Nov 2020 21:36:43 +0000	[thread overview]
Message-ID: <20201106213655.1838861-12-lee.jones@linaro.org> (raw)
In-Reply-To: <20201106213655.1838861-1-lee.jones@linaro.org>

Fixes the following W=1 kernel build warning(s):

 drivers/mtd/ubi/eba.c:1304: warning: Function parameter or member 'vidb' not described in 'ubi_eba_copy_leb'
 drivers/mtd/ubi/eba.c:1304: warning: Excess function parameter 'vid_hdr' description in 'ubi_eba_copy_leb'
 drivers/mtd/ubi/eba.c:1483: warning: Function parameter or member 'ai' not described in 'print_rsvd_warning'

Cc: Richard Weinberger <richard@nod.at>
Cc: Miquel Raynal <miquel.raynal@bootlin.com>
Cc: Vignesh Raghavendra <vigneshr@ti.com>
Cc: linux-mtd@lists.infradead.org
Signed-off-by: Lee Jones <lee.jones@linaro.org>
---
 drivers/mtd/ubi/eba.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/mtd/ubi/eba.c b/drivers/mtd/ubi/eba.c
index 0edecfdbd01f3..892494c8cb7c7 100644
--- a/drivers/mtd/ubi/eba.c
+++ b/drivers/mtd/ubi/eba.c
@@ -1290,7 +1290,7 @@ static int is_error_sane(int err)
  * @ubi: UBI device description object
  * @from: physical eraseblock number from where to copy
  * @to: physical eraseblock number where to copy
- * @vid_hdr: VID header of the @from physical eraseblock
+ * @vidb: data structure from where the VID header is derived
  *
  * This function copies logical eraseblock from physical eraseblock @from to
  * physical eraseblock @to. The @vid_hdr buffer may be changed by this
@@ -1463,6 +1463,7 @@ int ubi_eba_copy_leb(struct ubi_device *ubi, int from, int to,
 /**
  * print_rsvd_warning - warn about not having enough reserved PEBs.
  * @ubi: UBI device description object
+ * @ai: UBI attach info object
  *
  * This is a helper function for 'ubi_eba_init()' which is called when UBI
  * cannot reserve enough PEBs for bad block handling. This function makes a
-- 
2.25.1


______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/

  parent reply	other threads:[~2020-11-06 21:39 UTC|newest]

Thread overview: 31+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-06 21:36 [PATCH v2 00/23] Rid W=1 warnings in MTD Lee Jones
2020-11-06 21:36 ` [PATCH v2 01/23] mtd: mtdpart: Fix misdocumented function parameter 'mtd' Lee Jones
2020-11-19  9:14   ` Lee Jones
2020-11-19 11:08     ` Miquel Raynal
2020-11-06 21:36 ` [PATCH v2 02/23] mtd: devices: phram: File headers are not good candidates for kernel-doc Lee Jones
2020-11-06 21:36 ` [PATCH v2 03/23] mtd: nand: onenand: onenand_base: Fix expected kernel-doc formatting Lee Jones
2020-11-06 21:36 ` [PATCH v2 04/23] mtd: devices: docg3: Fix kernel-doc 'bad line' and 'excessive doc' issues Lee Jones
2020-11-06 21:36 ` [PATCH v2 05/23] mtd: mtdcore: Fix misspelled function parameter 'section' Lee Jones
2020-11-09 14:19   ` Alexander Dahl
2020-11-06 21:36 ` [PATCH v2 06/23] mtd: nand: onenand: onenand_bbt: Fix expected kernel-doc formatting Lee Jones
2020-11-06 21:36 ` [PATCH v2 07/23] mtd: spi-nor: controllers: hisi-sfc: Demote non-conformant kernel-doc Lee Jones
2020-11-06 21:36 ` [PATCH v2 08/23] mtd: ubi: build: Document 'ubi_num' in struct mtd_dev_param Lee Jones
2020-11-06 21:36 ` [PATCH v2 09/23] mtd: nand: spi: toshiba: Demote non-conformant kernel-doc header Lee Jones
2020-11-06 21:36 ` [PATCH v2 10/23] mtd: ubi: kapi: Correct documentation for 'ubi_leb_read_sg's 'sgl' parameter Lee Jones
2020-11-06 21:36 ` Lee Jones [this message]
2020-11-06 21:36 ` [PATCH v2 12/23] mtd: ubi: wl: Fix a couple of kernel-doc issues Lee Jones
2020-11-06 21:36 ` [PATCH v2 13/23] mtd: nand: raw: brcmnand: brcmnand: Demote non-conformant kernel-doc headers Lee Jones
2020-11-12 15:46   ` Kamal Dasu
2020-11-12 15:52     ` Miquel Raynal
2020-11-06 21:36 ` [PATCH v2 14/23] mtd: ubi: gluebi: Fix misnamed function parameter documentation Lee Jones
2020-11-06 21:36 ` [PATCH v2 15/23] mtd: nand: raw: diskonchip: Marking unused variables as __always_unused Lee Jones
2020-11-06 21:36 ` [PATCH v2 16/23] mtd: nand: raw: cafe_nand: Remove superfluous param doc and add another Lee Jones
2020-11-06 21:36 ` [PATCH v2 17/23] mtd: nand: raw: s3c2410: Add documentation for 2 missing struct members Lee Jones
2020-11-06 21:36 ` [PATCH v2 18/23] mtd: nand: raw: omap_elm: Finish half populated function header, demote empty ones Lee Jones
2020-11-06 21:36 ` [PATCH v2 19/23] mtd: nand: raw: omap2: Fix a bunch of kernel-doc misdemeanours Lee Jones
2020-11-06 21:36 ` [PATCH v2 20/23] mtd: nand: raw: sunxi_nand: Document 'sunxi_nfc's 'caps' member Lee Jones
2020-11-12 11:52   ` Chen-Yu Tsai
2020-11-06 21:36 ` [PATCH v2 21/23] mtd: nand: raw: arasan-nand-controller: Document 'anfc_op's 'buf' member Lee Jones
2020-11-06 21:36 ` [PATCH v2 22/23] mtd: nand: onenand: onenand_base: Fix some kernel-doc misdemeanours Lee Jones
2020-11-06 21:36 ` [PATCH v2 23/23] mtd: devices: powernv_flash: Add function names to headers and fix 'dev' Lee Jones
2020-11-09  8:28 ` [PATCH v2 00/23] Rid W=1 warnings in MTD Miquel Raynal

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=20201106213655.1838861-12-lee.jones@linaro.org \
    --to=lee.jones@linaro.org \
    --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).