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

[Randy Dunlap]

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 <eschwab@xxxxxxxxx>

Thanks.

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxx>

> ---
> On Sun, 15 Aug 2010 10:31:56 -0700
> Randy Dunlap <rdunlap@xxxxxxxxxxxx> wrote:
> 
> > This patch in mainline:
> > 
> > commit cf32b71e981ca63e8f349d8585ca2a3583b556e0
> > Author: Ernst Schwab <eschwab@xxxxxxxxx>
> > 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 ***
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/