lkml.org 
[lkml]   [2022]   [Jun]   [8]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Date
SubjectRe: [PATCH v2] spi: <linux/spi/spi.h>: Add missing documentation for struct members
On Wed, Jun 8, 2022 at 5:33 PM David Jander <david@protonic.nl> wrote:
>
> Fixes these "make htmldocs" warnings:
>
> include/linux/spi/spi.h:82: warning: Function parameter or member 'syncp' not described in 'spi_statistics'
> include/linux/spi/spi.h:213: warning: Function parameter or member 'pcpu_statistics' not described in 'spi_device'
> include/linux/spi/spi.h:676: warning: Function parameter or member 'pcpu_statistics' not described in 'spi_controller'

Thanks, you may add my
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>

However, you don't need to put that "<include/...>:" part in the subject line.

> Fixes: 6598b91b5ac3 ("spi: spi.c: Convert statistics to per-cpu u64_stats_t")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Signed-off-by: David Jander <david@protonic.nl>
> ---
> v2:
> - Correct patch subject line style
> - Add the text of the actual warnings that are being fixed
> - Add a Fixes: tag
> ---
> include/linux/spi/spi.h | 7 ++++---
> 1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/include/linux/spi/spi.h b/include/linux/spi/spi.h
> index eac8d3caf954..2e63b4935deb 100644
> --- a/include/linux/spi/spi.h
> +++ b/include/linux/spi/spi.h
> @@ -35,7 +35,8 @@ extern struct bus_type spi_bus_type;
>
> /**
> * struct spi_statistics - statistics for spi transfers
> - * @lock: lock protecting this structure
> + * @syncp: seqcount to protect members in this struct for per-cpu udate
> + * on 32-bit systems
> *
> * @messages: number of spi-messages handled
> * @transfers: number of spi_transfers handled
> @@ -155,7 +156,7 @@ extern int spi_delay_exec(struct spi_delay *_delay, struct spi_transfer *xfer);
> * @cs_inactive: delay to be introduced by the controller after CS is
> * deasserted. If @cs_change_delay is used from @spi_transfer, then the
> * two delays will be added up.
> - * @statistics: statistics for the spi_device
> + * @pcpu_statistics: statistics for the spi_device
> *
> * A @spi_device is used to interchange data between an SPI slave
> * (usually a discrete chip) and CPU memory.
> @@ -439,7 +440,7 @@ extern struct spi_device *spi_new_ancillary_device(struct spi_device *spi, u8 ch
> * @max_native_cs: When cs_gpiods is used, and this field is filled in,
> * spi_register_controller() will validate all native CS (including the
> * unused native CS) against this value.
> - * @statistics: statistics for the spi_controller
> + * @pcpu_statistics: statistics for the spi_controller
> * @dma_tx: DMA transmit channel
> * @dma_rx: DMA receive channel
> * @dummy_rx: dummy receive buffer for full-duplex devices
> --
> 2.32.0
>


--
With Best Regards,
Andy Shevchenko

\
 
 \ /
  Last update: 2022-06-08 18:45    [W:0.056 / U:0.800 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site