Skip to contentSkip to conversation

spi: spi.h: add missing kernel-doc for @last_cs_index_mask

PATCH In review Randy Dunlap 3 participants 3 messages Mar 28, 2024 – Mar 29, 2024 SPI

lore
Share & tools
lore
#0 lore raw

PATCH v2 1/1 spi: spi.h: add missing kernel-doc for @last_cs_index_mask

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")

---
Cc: Mark Brown <[email protected]>
Cc: Andy Shevchenko <[email protected]>
Cc: [email protected]
Cc: Amit Kumar Mahapatra <[email protected]>

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

 include/linux/spi/spi.h |    1 +
 1 file changed, 1 insertion(+)
include/linux/spi/spi.h +1 -0
diff -- 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
Reviewed-by on v2 1/1
#1 lore raw
Quoted 5 lines · 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'

Signature · 2 lines
With Best Regards,
Andy Shevchenko
maintainer
#2 lore raw
In reply to Randy Dunlap
Quoted 6 lines · 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'

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