[PATCH v2] spi: <linux/spi/spi.h>: add missing struct kernel-doc entry

[PATCH v2] spi: <linux/spi/spi.h>: add missing struct kernel-doc entry

[Randy Dunlap]

Fix kernel-doc warning in spi.h by adding the missing kernel-doc entry
and also correct the original comment so that they both indicate the
correct polarity of the flag.

../include/linux/spi/spi.h:673: warning: Function parameter or member 'devm_allocated' not described in 'spi_controller'

Fixes: 794aaf01444d ("spi: Fix use-after-free with devm_spi_alloc_*")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: William A. Kennington III <wak@google.com>
Cc: Mark Brown <broonie@kernel.org>
Cc: linux-spi@vger.kernel.org
Cc: Lukas Wunner <lukas@wunner.de>
---
v2: correct both comments for @devm_allocated to indicate the correct polarity
    (thanks, Lukas)

 include/linux/spi/spi.h |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

--- linux-next-20210628.orig/include/linux/spi/spi.h
+++ linux-next-20210628/include/linux/spi/spi.h
@@ -339,6 +339,7 @@ extern struct spi_device *spi_new_ancill
  * @max_speed_hz: Highest supported transfer speed
  * @flags: other constraints relevant to this driver
  * @slave: indicates that this is an SPI slave controller
+ * @devm_allocated: whether the allocation of this struct is devres-managed
  * @max_transfer_size: function that returns the max transfer size for
  *	a &spi_device; may be %NULL, so the default %SIZE_MAX will be used.
  * @max_message_size: function that returns the max message size for
@@ -511,7 +512,7 @@ struct spi_controller {
 
 #define SPI_MASTER_GPIO_SS		BIT(5)	/* GPIO CS must select slave */
 
-	/* flag indicating this is a non-devres managed controller */
+	/* flag indicating if the allocation of this struct is devres-managed */
 	bool			devm_allocated;
 
 	/* flag indicating this is an SPI slave controller */

Re: [PATCH v2] spi: <linux/spi/spi.h>: add missing struct kernel-doc entry

[Lukas Wunner]

On Mon, Jun 28, 2021 at 02:05:20PM -0700, Randy Dunlap wrote:
> Fix kernel-doc warning in spi.h by adding the missing kernel-doc entry
> and also correct the original comment so that they both indicate the
> correct polarity of the flag.
> 
> ../include/linux/spi/spi.h:673: warning: Function parameter or member 'devm_allocated' not described in 'spi_controller'
> 
> Fixes: 794aaf01444d ("spi: Fix use-after-free with devm_spi_alloc_*")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: William A. Kennington III <wak@google.com>
> Cc: Mark Brown <broonie@kernel.org>
> Cc: linux-spi@vger.kernel.org

Reviewed-by: Lukas Wunner <lukas@wunner.de>

Re: [PATCH v2] spi: <linux/spi/spi.h>: add missing struct kernel-doc entry

[Mark Brown]

On Mon, 28 Jun 2021 14:05:20 -0700, Randy Dunlap wrote:
> Fix kernel-doc warning in spi.h by adding the missing kernel-doc entry
> and also correct the original comment so that they both indicate the
> correct polarity of the flag.
> 
> ../include/linux/spi/spi.h:673: warning: Function parameter or member 'devm_allocated' not described in 'spi_controller'

Applied to

   https://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi.git for-next

Thanks!

[1/1] spi: <linux/spi/spi.h>: add missing struct kernel-doc entry
      commit: 8dd591ad0104593f315b6b2ab636a18c002f7d86

All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.

You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.

If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.

Please add any relevant lists and maintainers to the CCs when replying
to this mail.

Thanks,
Mark