mtd: ubi: kapi: Correct documentation for 'ubi_leb_read_sg's 'sgl' parameter
authorLee Jones <lee.jones@linaro.org>
Mon, 9 Nov 2020 18:21:53 +0000 (18:21 +0000)
committerMiquel Raynal <miquel.raynal@bootlin.com>
Fri, 20 Nov 2020 11:37:31 +0000 (12:37 +0100)
Fixes the following W=1 kernel build warning(s):

 drivers/mtd/ubi/kapi.c:464: warning: Function parameter or member 'sgl' not described in 'ubi_leb_read_sg'
 drivers/mtd/ubi/kapi.c:464: warning: Excess function parameter 'buf' description in 'ubi_leb_read_sg'

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>
Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
Link: https://lore.kernel.org/linux-mtd/20201109182206.3037326-11-lee.jones@linaro.org
drivers/mtd/ubi/kapi.c

index 9718f5aaaf694934b9bb4a26db93ad322d2673f3..0fce99ff29b583639723676b24341231f731952a 100644 (file)
@@ -450,7 +450,7 @@ EXPORT_SYMBOL_GPL(ubi_leb_read);
  * ubi_leb_read_sg - read data into a scatter gather list.
  * @desc: volume descriptor
  * @lnum: logical eraseblock number to read from
- * @buf: buffer where to store the read data
+ * @sgl: UBI scatter gather list to store the read data
  * @offset: offset within the logical eraseblock to read from
  * @len: how many bytes to read
  * @check: whether UBI has to check the read data's CRC or not.