2024-03-28 04:38:55

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] 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'

Signed-off-by: Randy Dunlap <[email protected]>
---
Cc: Mark Brown <[email protected]>
Cc: Andy Shevchenko <[email protected]>
Cc: [email protected]

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


2024-03-28 09:05:57

by Andy Shevchenko

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

On Thu, Mar 28, 2024 at 6:38 AM Randy Dunlap <[email protected]> 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?

--
With Best Regards,
Andy Shevchenko

2024-03-28 22:33:10

by Randy Dunlap

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



On 3/28/24 01:51, Andy Shevchenko wrote:
> On Thu, Mar 28, 2024 at 6:38 AM Randy Dunlap <[email protected]> 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.
--
#Randy