Linux-ARM-Kernel Archive on lore.kernel.org
 help / color / mirror / Atom feed
From: Tudor Ambarus <tudor.ambarus@linaro.org>
To: Randy Dunlap <rdunlap@infradead.org>,
	linux-kernel@vger.kernel.org, Mark Brown <broonie@kernel.org>
Cc: "Krzysztof Kozlowski" <krzysztof.kozlowski@oss.qualcomm.com>,
	"Andi Shyti" <andi.shyti@kernel.org>,
	linux-spi@vger.kernel.org, linux-samsung-soc@vger.kernel.org,
	linux-arm-kernel@lists.infradead.org,
	"Juan Yescas" <jyescas@google.com>,
	"Peter Griffin" <peter.griffin@linaro.org>,
	"André Draszik" <andre.draszik@linaro.org>
Subject: Re: [PATCH v2] spi: s3c64xx: fix all kernel-doc warnings
Date: Wed, 6 May 2026 15:28:05 +0300	[thread overview]
Message-ID: <06406c7b-c141-4997-9921-9358cdea7641@linaro.org> (raw)
In-Reply-To: <20260416224056.985233-1-rdunlap@infradead.org>

Hi!

You missed adding the SPI maintainer. +Mark.

Also, there's another kdoc warning in that file. Do you care to fix it?

scripts/kernel-doc -none include/linux/platform_data/spi-s3c64xx.h
Warning: include/linux/platform_data/spi-s3c64xx.h:40 struct member 'polling' not described in 's3c64xx_spi_info'
Warning: include/linux/platform_data/spi-s3c64xx.h:51 expecting prototype for s3c64xx_spi_set_platdata(). Prototype was for s3c64xx_spi0_set_platdata() instead

Cheers,
ta

On 4/17/26 1:40 AM, Randy Dunlap wrote:
> Add kernel-doc for one struct member and use the correct function name
> to eliminate kernel-doc warnings:
> 
> Warning: include/linux/platform_data/spi-s3c64xx.h:40 struct member
>  'polling' not described in 's3c64xx_spi_info'
> Warning: include/linux/platform_data/spi-s3c64xx.h:51 expecting prototype
>  for s3c64xx_spi_set_platdata(). Prototype was for
>  s3c64xx_spi0_set_platdata() instead
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Reviewed-by: Krzysztof Kozlowski <krzysztof.kozlowski@oss.qualcomm.com>
> ---
> v2: add tag; rebase & resend
> 
> Cc: Andi Shyti <andi.shyti@kernel.org>
> Cc: Tudor Ambarus <tudor.ambarus@linaro.org>
> Cc: linux-spi@vger.kernel.org
> Cc: linux-samsung-soc@vger.kernel.org
> Cc: linux-arm-kernel@lists.infradead.org
> 
>  include/linux/platform_data/spi-s3c64xx.h |    3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> --- linux-next-20260415.orig/include/linux/platform_data/spi-s3c64xx.h
> +++ linux-next-20260415/include/linux/platform_data/spi-s3c64xx.h
> @@ -30,6 +30,7 @@ struct s3c64xx_spi_csinfo {
>   * @src_clk_nr: Clock source index for the CLK_CFG[SPI_CLKSEL] field.
>   * @num_cs: Number of CS this controller emulates.
>   * @no_cs: Used when CS line is not connected.
> + * @polling: Using polling mode when %true (no 'dmas' property in devicetree)
>   * @cfg_gpio: Configure pins for this SPI controller.
>   */
>  struct s3c64xx_spi_info {
> @@ -41,7 +42,7 @@ struct s3c64xx_spi_info {
>  };
>  
>  /**
> - * s3c64xx_spi_set_platdata - SPI Controller configure callback by the board
> + * s3c64xx_spi0_set_platdata - SPI Controller configure callback by the board
>   *				initialization code.
>   * @src_clk_nr: Clock the SPI controller is to use to generate SPI clocks.
>   * @num_cs: Number of elements in the 'cs' array.



  reply	other threads:[~2026-05-06 12:28 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-16 22:40 [PATCH v2] spi: s3c64xx: fix all kernel-doc warnings Randy Dunlap
2026-05-06 12:28 ` Tudor Ambarus [this message]
2026-05-06 12:29   ` Tudor Ambarus

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=06406c7b-c141-4997-9921-9358cdea7641@linaro.org \
    --to=tudor.ambarus@linaro.org \
    --cc=andi.shyti@kernel.org \
    --cc=andre.draszik@linaro.org \
    --cc=broonie@kernel.org \
    --cc=jyescas@google.com \
    --cc=krzysztof.kozlowski@oss.qualcomm.com \
    --cc=linux-arm-kernel@lists.infradead.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-samsung-soc@vger.kernel.org \
    --cc=linux-spi@vger.kernel.org \
    --cc=peter.griffin@linaro.org \
    --cc=rdunlap@infradead.org \
    /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