linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Miquel Raynal <miquel.raynal@bootlin.com>
To: Lee Jones <lee.jones@linaro.org>
Cc: vigneshr@ti.com, linux-kernel@vger.kernel.org,
	Richard Weinberger <richard@nod.at>,
	Michael Ellerman <mpe@ellerman.id.au>,
	Benjamin Herrenschmidt <benh@kernel.crashing.org>,
	Paul Mackerras <paulus@samba.org>,
	Cyril Bur <cyril.bur@au1.ibm.com>,
	linux-mtd@lists.infradead.org, linuxppc-dev@lists.ozlabs.org
Subject: Re: [PATCH 23/23] mtd: devices: powernv_flash: Add function names to headers and fix 'dev'
Date: Mon, 2 Nov 2020 13:52:37 +0100	[thread overview]
Message-ID: <20201102135237.7a03b817@xps13> (raw)
In-Reply-To: <20201102115406.1074327-24-lee.jones@linaro.org>

Hi Lee,

Lee Jones <lee.jones@linaro.org> wrote on Mon,  2 Nov 2020 11:54:06
+0000:

> Fixes the following W=1 kernel build warning(s):
> 
>  drivers/mtd/devices/powernv_flash.c:129: warning: Cannot understand  * @mtd: the device
>  drivers/mtd/devices/powernv_flash.c:145: warning: Cannot understand  * @mtd: the device
>  drivers/mtd/devices/powernv_flash.c:161: warning: Cannot understand  * @mtd: the device
>  drivers/mtd/devices/powernv_flash.c:184: warning: Function parameter or member 'dev' not described in 'powernv_flash_set_driver_info'
> 
> Cc: Miquel Raynal <miquel.raynal@bootlin.com>
> Cc: Richard Weinberger <richard@nod.at>
> Cc: Vignesh Raghavendra <vigneshr@ti.com>
> Cc: Michael Ellerman <mpe@ellerman.id.au>
> Cc: Benjamin Herrenschmidt <benh@kernel.crashing.org>
> Cc: Paul Mackerras <paulus@samba.org>
> Cc: Cyril Bur <cyril.bur@au1.ibm.com>
> Cc: linux-mtd@lists.infradead.org
> Cc: linuxppc-dev@lists.ozlabs.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
>  drivers/mtd/devices/powernv_flash.c | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/drivers/mtd/devices/powernv_flash.c b/drivers/mtd/devices/powernv_flash.c
> index 0b757d9ba2f6b..32cb0e649096f 100644
> --- a/drivers/mtd/devices/powernv_flash.c
> +++ b/drivers/mtd/devices/powernv_flash.c
> @@ -126,6 +126,8 @@ static int powernv_flash_async_op(struct mtd_info *mtd, enum flash_op op,
>  }
>  
>  /**
> + * powernv_flash_read
> + *

Perhaps we should not add blank lines if the rest of the file does not
already have such spacing (see below).

>   * @mtd: the device
>   * @from: the offset to read from
>   * @len: the number of bytes to read
> @@ -142,6 +144,7 @@ static int powernv_flash_read(struct mtd_info *mtd, loff_t from, size_t len,
>  }
>  
>  /**
> + * powernv_flash_write
>   * @mtd: the device
>   * @to: the offset to write to
>   * @len: the number of bytes to write
> @@ -158,6 +161,7 @@ static int powernv_flash_write(struct mtd_info *mtd, loff_t to, size_t len,
>  }
>  
>  /**
> + * powernv_flash_erase
>   * @mtd: the device
>   * @erase: the erase info
>   * Returns 0 if erase successful or -ERRNO if an error occurred
> @@ -176,7 +180,7 @@ static int powernv_flash_erase(struct mtd_info *mtd, struct erase_info *erase)
>  
>  /**
>   * powernv_flash_set_driver_info - Fill the mtd_info structure and docg3
> - * structure @pdev: The platform device
> + * @dev: The device structure
>   * @mtd: The structure to fill
>   */
>  static int powernv_flash_set_driver_info(struct device *dev,


Thanks,
Miquèl

  reply	other threads:[~2020-11-02 12:52 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-02 11:53 [PATCH 00/23] Rid W=1 warnings in MTD Lee Jones
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 ` [PATCH 06/23] mtd: nand: onenand: onenand_bbt: Fix expected kernel-doc formatting Lee Jones
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 [this message]
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=20201102135237.7a03b817@xps13 \
    --to=miquel.raynal@bootlin.com \
    --cc=benh@kernel.crashing.org \
    --cc=cyril.bur@au1.ibm.com \
    --cc=lee.jones@linaro.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mtd@lists.infradead.org \
    --cc=linuxppc-dev@lists.ozlabs.org \
    --cc=mpe@ellerman.id.au \
    --cc=paulus@samba.org \
    --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).