diff mbox series

spi: linux/spi/spi.h: fix Excess & missing kernel-doc description warnings

Message ID 20231223050630.14008-1-rdunlap@infradead.org
State New
Headers
Series spi: linux/spi/spi.h: fix Excess & missing kernel-doc description warnings |

Commit Message

Randy Dunlap Dec. 23, 2023, 5:06 a.m. UTC 
  Remove one struct member description and add another one to prevent
the kernel-doc warnings:

include/linux/spi/spi.h:778: warning: Function parameter or struct member 'last_cs_index_mask' not described in 'spi_controller'
include/linux/spi/spi.h:778: warning: Excess struct member 'multi_cs_cap' description in 'spi_controller'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Mark Brown <broonie@kernel.org>
Cc: linux-spi@vger.kernel.org
---
 include/linux/spi/spi.h |    3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
diff mbox series

Patch

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
@@ -422,8 +422,6 @@  extern struct spi_device *spi_new_ancill
  * @bus_lock_spinlock: spinlock for SPI bus locking
  * @bus_lock_mutex: mutex for exclusion of multiple callers
  * @bus_lock_flag: indicates that the SPI bus is locked for exclusive use
- * @multi_cs_cap: indicates that the SPI Controller can assert/de-assert
- *	more than one chip select at once.
  * @setup: updates the device mode and clocking records used by a
  *	device's SPI controller; protocol code may call this.  This
  *	must fail if an unrecognized or unsupported mode is requested.
@@ -454,6 +452,7 @@  extern struct spi_device *spi_new_ancill
  * @cur_msg_mapped: message has been mapped for DMA
  * @last_cs: the last chip_select that is recorded by set_cs, -1 on non chip
  *           selected
+ * @last_cs_index_mask: records value of the last @cs_index_mask in &spi_device
  * @last_cs_mode_high: was (mode & SPI_CS_HIGH) true on the last call to set_cs.
  * @xfer_completion: used by core transfer_one_message()
  * @busy: message pump is busy