2010-08-15 17:32:08

by Randy Dunlap

Subject: spi.h: missing kernel-doc notation, please fix

Hi Ernst,

This patch in mainline:

commit cf32b71e981ca63e8f349d8585ca2a3583b556e0
Author: Ernst Schwab <[email protected]>
Date: Mon Jun 28 17:49:29 2010 -0700

spi/mmc_spi: SPI bus locking API, using mutex

adds some struct fields but does not add kernel-doc notation for them.
Please add that missing struct documentation.

Warning(include/linux/spi/spi.h:304): No description found for parameter 'bus_lock_spinlock'
Warning(include/linux/spi/spi.h:304): No description found for parameter 'bus_lock_mutex'
Warning(include/linux/spi/spi.h:304): No description found for parameter 'bus_lock_flag'

thanks,
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

2010-08-16 13:11:14

by Ernst Schwab

Subject: Re: spi.h: missing kernel-doc notation, please fix

Added comments in kernel-doc notation for previously added struct fields.

Signed-off-by: Ernst Schwab <[email protected]>
---
On Sun, 15 Aug 2010 10:31:56 -0700
Randy Dunlap <[email protected]> wrote:

> This patch in mainline:
>
> commit cf32b71e981ca63e8f349d8585ca2a3583b556e0
> Author: Ernst Schwab <[email protected]>
> Date: Mon Jun 28 17:49:29 2010 -0700
>
> spi/mmc_spi: SPI bus locking API, using mutex
>
> adds some struct fields but does not add kernel-doc notation for them.
> Please add that missing struct documentation.

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
@@ -213,6 +213,9 @@ static inline void spi_unregister_driver
* @dma_alignment: SPI controller constraint on DMA buffers alignment.
* @mode_bits: flags understood by this controller driver
* @flags: other constraints relevant to this driver
+ * @bus_lock_spinlock: spinlock for SPI bus locking
+ * @bus_lock_mutex: mutex for SPI bus locking
+ * @bus_lock_flag: indicates that the SPI bus is locked for exclusive use
* @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.

2010-08-16 15:36:44

by Randy Dunlap

Subject: Re: spi.h: missing kernel-doc notation, please fix

On Mon, 16 Aug 2010 15:10:11 +0200 Ernst Schwab wrote:

> Added comments in kernel-doc notation for previously added struct fields.
>
> Signed-off-by: Ernst Schwab <[email protected]>

Thanks.

Acked-by: Randy Dunlap <[email protected]>

> ---
> On Sun, 15 Aug 2010 10:31:56 -0700
> Randy Dunlap <[email protected]> wrote:
>
> > This patch in mainline:
> >
> > commit cf32b71e981ca63e8f349d8585ca2a3583b556e0
> > Author: Ernst Schwab <[email protected]>
> > Date: Mon Jun 28 17:49:29 2010 -0700
> >
> > spi/mmc_spi: SPI bus locking API, using mutex
> >
> > adds some struct fields but does not add kernel-doc notation for them.
> > Please add that missing struct documentation.
>
> 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
> @@ -213,6 +213,9 @@ static inline void spi_unregister_driver
> * @dma_alignment: SPI controller constraint on DMA buffers alignment.
> * @mode_bits: flags understood by this controller driver
> * @flags: other constraints relevant to this driver
> + * @bus_lock_spinlock: spinlock for SPI bus locking
> + * @bus_lock_mutex: mutex for SPI bus locking
> + * @bus_lock_flag: indicates that the SPI bus is locked for exclusive use
> * @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.


---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***

2010-08-16 21:09:17

by Grant Likely

Subject: Re: spi.h: missing kernel-doc notation, please fix

On Mon, Aug 16, 2010 at 03:10:11PM +0200, Ernst Schwab wrote:
> Added comments in kernel-doc notation for previously added struct fields.
>
> Signed-off-by: Ernst Schwab <[email protected]>

Applied, thanks.

> ---
> On Sun, 15 Aug 2010 10:31:56 -0700
> Randy Dunlap <[email protected]> wrote:
>
> > This patch in mainline:
> >
> > commit cf32b71e981ca63e8f349d8585ca2a3583b556e0
> > Author: Ernst Schwab <[email protected]>
> > Date: Mon Jun 28 17:49:29 2010 -0700
> >
> > spi/mmc_spi: SPI bus locking API, using mutex
> >
> > adds some struct fields but does not add kernel-doc notation for them.
> > Please add that missing struct documentation.
>
> 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
> @@ -213,6 +213,9 @@ static inline void spi_unregister_driver
> * @dma_alignment: SPI controller constraint on DMA buffers alignment.
> * @mode_bits: flags understood by this controller driver
> * @flags: other constraints relevant to this driver
> + * @bus_lock_spinlock: spinlock for SPI bus locking
> + * @bus_lock_mutex: mutex for SPI bus locking
> + * @bus_lock_flag: indicates that the SPI bus is locked for exclusive use
> * @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.