[PATCH v2] spi: spi.h: add missing kernel-doc for @last_cs_index_mask

[PATCH v2] spi: spi.h: add missing kernel-doc for @last_cs_index_mask

[Randy Dunlap]

kernel-doc complains about last_cs_index_mask not described, so add its
description.

spi.h:778: warning: Function parameter or struct member 'last_cs_index_mask' not described in 'spi_controller'

Fixes: 4d8ff6b0991d ("spi: Add multi-cs memories support in SPI core")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Mark Brown <broonie@kernel.org>
Cc: Andy Shevchenko <andy@kernel.org>
Cc: linux-spi@vger.kernel.org
Cc: Amit Kumar Mahapatra <amit.kumar-mahapatra@amd.com>

v2: fix spello in commit message (Andy)
    add Fixes: tag (Andy)

 include/linux/spi/spi.h |    1 +
 1 file changed, 1 insertion(+)

diff -- a/include/linux/spi/spi.h b/include/linux/spi/spi.h
--- a/include/linux/spi/spi.h
+++ b/include/linux/spi/spi.h
@@ -453,6 +453,7 @@ extern struct spi_device *spi_new_ancill
  * @last_cs_mode_high: was (mode & SPI_CS_HIGH) true on the last call to set_cs.
  * @last_cs: the last chip_select that is recorded by set_cs, -1 on non chip
  *           selected
+ * @last_cs_index_mask: bit mask the last chip selects that were used
  * @xfer_completion: used by core transfer_one_message()
  * @busy: message pump is busy
  * @running: message pump is running

Re: [PATCH v2] spi: spi.h: add missing kernel-doc for @last_cs_index_mask

[Andy Shevchenko]

On Fri, Mar 29, 2024 at 12:33 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> kernel-doc complains about last_cs_index_mask not described, so add its
> description.
>
> spi.h:778: warning: Function parameter or struct member 'last_cs_index_mask' not described in 'spi_controller'

Reviewed-by: Andy Shevchenko <andy@kernel.org>

-- 
With Best Regards,
Andy Shevchenko

Re: [PATCH v2] spi: spi.h: add missing kernel-doc for @last_cs_index_mask

[Mark Brown]

On Thu, 28 Mar 2024 15:33:40 -0700, Randy Dunlap wrote:
> kernel-doc complains about last_cs_index_mask not described, so add its
> description.
> 
> spi.h:778: warning: Function parameter or struct member 'last_cs_index_mask' 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: spi.h: add missing kernel-doc for @last_cs_index_mask
      commit: ba5206881843e16b74a07c37970dcc44d22f8f6f

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