Skip to contentSkip to conversation

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

PATCH Superseded Randy Dunlap 2 participants 3 messages Mar 28, 2024 SPI

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 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 decscription.

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

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

 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
#1 lore raw
Quoted 3 lines · Randy Dunlap

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

description

Quoted 1 line

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

Do we need a Fixes tag?

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#2 lore raw
Quoted 6 lines · Andy Shevchenko
Quoted 3 lines · Randy Dunlap

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

description

Fixed in v2.

Quoted 3 lines
Quoted 1 line

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

Do we need a Fixes tag?

I'll add one.

Thanks.

Signature · 1 line
#Randy