diff mbox series

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

Message ID 20240328043845.28882-1-rdunlap@infradead.org (mailing list archive)
State Superseded
Headers show
Series spi: spi.h: add missing kernel-doc for @last_cs_index_mask | expand

Commit Message

Randy Dunlap March 28, 2024, 4:38 a.m. UTC 
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'

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

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

Comments

Andy Shevchenko March 28, 2024, 8:51 a.m. UTC | #1 
On Thu, Mar 28, 2024 at 6:38 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> kernel-doc complains about last_cs_index_mask not described, so add its
> decscription.

description

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

Do we need a Fixes tag?
Randy Dunlap March 28, 2024, 10:33 p.m. UTC | #2 
On 3/28/24 01:51, Andy Shevchenko wrote:
> On Thu, Mar 28, 2024 at 6:38 AM Randy Dunlap <rdunlap@infradead.org> wrote:
>>
>> kernel-doc complains about last_cs_index_mask not described, so add its
>> decscription.
> 
> description

Fixed in v2.

>> 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.
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
@@ -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