diff mbox series

[2/2] mtd: rawnand: rockchip: Add missing title to a kernel doc comment

Message ID 20231211150704.109138-2-miquel.raynal@bootlin.com (mailing list archive)
State New, archived
Headers show
Series [1/2] mtd: rawnand: rockchip: Rename a structure | expand

Commit Message

Miquel Raynal Dec. 11, 2023, 3:07 p.m. UTC
All fields of the nfc_cfg structure are documented but the name, which
leads to a W=1 warning. Add a title.

Fixes: 058e0e847d54 ("mtd: rawnand: rockchip: NFC driver for RK3308, RK2928 and others")
Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>
---
 drivers/mtd/nand/raw/rockchip-nand-controller.c | 1 +
 1 file changed, 1 insertion(+)

Comments

Tudor Ambarus Dec. 12, 2023, 3:41 a.m. UTC | #1
On 12/11/23 15:07, Miquel Raynal wrote:
> All fields of the nfc_cfg structure are documented but the name, which
> leads to a W=1 warning. Add a title.
> 
> Fixes: 058e0e847d54 ("mtd: rawnand: rockchip: NFC driver for RK3308, RK2928 and others")
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>

Reviewed-by Tudor Ambarus <tudor.ambarus@linaro.org>
> ---
>  drivers/mtd/nand/raw/rockchip-nand-controller.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/mtd/nand/raw/rockchip-nand-controller.c b/drivers/mtd/nand/raw/rockchip-nand-controller.c
> index ab1a9e8687e0..7baaef69d70a 100644
> --- a/drivers/mtd/nand/raw/rockchip-nand-controller.c
> +++ b/drivers/mtd/nand/raw/rockchip-nand-controller.c
> @@ -108,6 +108,7 @@ struct rk_ecc_cnt_status {
>  };
>  
>  /**
> + * struct nfc_cfg: Rockchip NAND controller configuration
>   * @type: NFC version
>   * @ecc_strengths: ECC strengths
>   * @ecc_cfgs: ECC config values
Miquel Raynal Dec. 15, 2023, 10:59 a.m. UTC | #2
On Mon, 2023-12-11 at 15:07:04 UTC, Miquel Raynal wrote:
> All fields of the nfc_cfg structure are documented but the name, which
> leads to a W=1 warning. Add a title.
> 
> Fixes: 058e0e847d54 ("mtd: rawnand: rockchip: NFC driver for RK3308, RK2928 and others")
> Signed-off-by: Miquel Raynal <miquel.raynal@bootlin.com>

Applied to https://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git nand/next.

Miquel
diff mbox series

Patch

diff --git a/drivers/mtd/nand/raw/rockchip-nand-controller.c b/drivers/mtd/nand/raw/rockchip-nand-controller.c
index ab1a9e8687e0..7baaef69d70a 100644
--- a/drivers/mtd/nand/raw/rockchip-nand-controller.c
+++ b/drivers/mtd/nand/raw/rockchip-nand-controller.c
@@ -108,6 +108,7 @@  struct rk_ecc_cnt_status {
 };
 
 /**
+ * struct nfc_cfg: Rockchip NAND controller configuration
  * @type: NFC version
  * @ecc_strengths: ECC strengths
  * @ecc_cfgs: ECC config values