All of lore.kernel.org
 help / color / mirror / Atom feed
* spi.h: missing kernel-doc notation, please fix
@ 2010-08-15 17:31 ` Randy Dunlap
  0 siblings, 0 replies; 6+ messages in thread
From: Randy Dunlap @ 2010-08-15 17:31 UTC (permalink / raw)
  To: Ernst Schwab, spi-devel-general, lkml; +Cc: David Brownell, Grant Likely

Hi Ernst,

This patch in mainline:

commit cf32b71e981ca63e8f349d8585ca2a3583b556e0
Author: Ernst Schwab <eschwab@online.de>
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 ***

^ permalink raw reply	[flat|nested] 6+ messages in thread
* spi.h: missing kernel-doc notation, please fix
@ 2010-08-15 17:31 ` Randy Dunlap
  0 siblings, 0 replies; 6+ messages in thread
From: Randy Dunlap @ 2010-08-15 17:31 UTC (permalink / raw)
  To: Ernst Schwab, spi-devel-general-5NWGOfrQmneRv+LV9MX5uipxlwaOVQ5f, lkml
  Cc: David Brownell

Hi Ernst,

This patch in mainline:

commit cf32b71e981ca63e8f349d8585ca2a3583b556e0
Author: Ernst Schwab <eschwab-BGeptl67XyCzQB+pC5nmwQ@public.gmane.org>
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 ***

------------------------------------------------------------------------------
This SF.net email is sponsored by 

Make an app they can't live without
Enter the BlackBerry Developer Challenge
http://p.sf.net/sfu/RIM-dev2dev 

^ permalink raw reply	[flat|nested] 6+ messages in thread
* Re: spi.h: missing kernel-doc notation, please fix
@ 2010-08-16 13:10   ` Ernst Schwab
  0 siblings, 0 replies; 6+ messages in thread
From: Ernst Schwab @ 2010-08-16 13:10 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: spi-devel-general, lkml, David Brownell, Grant Likely

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

Signed-off-by: Ernst Schwab <eschwab@online.de>
---
On Sun, 15 Aug 2010 10:31:56 -0700
Randy Dunlap <rdunlap@xenotime.net> wrote:

> This patch in mainline:
> 
> commit cf32b71e981ca63e8f349d8585ca2a3583b556e0
> Author: Ernst Schwab <eschwab@online.de>
> 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.

^ permalink raw reply	[flat|nested] 6+ messages in thread
* Re: spi.h: missing kernel-doc notation, please fix
@ 2010-08-16 13:10   ` Ernst Schwab
  0 siblings, 0 replies; 6+ messages in thread
From: Ernst Schwab @ 2010-08-16 13:10 UTC (permalink / raw)
  To: Randy Dunlap
  Cc: spi-devel-general-5NWGOfrQmneRv+LV9MX5uipxlwaOVQ5f, David Brownell, lkml

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

Signed-off-by: Ernst Schwab <eschwab-BGeptl67XyCzQB+pC5nmwQ@public.gmane.org>
---
On Sun, 15 Aug 2010 10:31:56 -0700
Randy Dunlap <rdunlap-/UHa2rfvQTnk1uMJSBkQmQ@public.gmane.org> wrote:

> This patch in mainline:
> 
> commit cf32b71e981ca63e8f349d8585ca2a3583b556e0
> Author: Ernst Schwab <eschwab-BGeptl67XyCzQB+pC5nmwQ@public.gmane.org>
> 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.

------------------------------------------------------------------------------
This SF.net email is sponsored by 

Make an app they can't live without
Enter the BlackBerry Developer Challenge
http://p.sf.net/sfu/RIM-dev2dev 

^ permalink raw reply	[flat|nested] 6+ messages in thread
* Re: spi.h: missing kernel-doc notation, please fix
  2010-08-16 13:10   ` Ernst Schwab
  (?)
@ 2010-08-16 15:36   ` Randy Dunlap
  -1 siblings, 0 replies; 6+ messages in thread
From: Randy Dunlap @ 2010-08-16 15:36 UTC (permalink / raw)
  To: Ernst Schwab; +Cc: spi-devel-general, lkml, David Brownell, Grant Likely

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

Thanks.

Acked-by: Randy Dunlap <rdunlap@xenotime.net>

> ---
> On Sun, 15 Aug 2010 10:31:56 -0700
> Randy Dunlap <rdunlap@xenotime.net> wrote:
> 
> > This patch in mainline:
> > 
> > commit cf32b71e981ca63e8f349d8585ca2a3583b556e0
> > Author: Ernst Schwab <eschwab@online.de>
> > 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 ***

^ permalink raw reply	[flat|nested] 6+ messages in thread
* Re: spi.h: missing kernel-doc notation, please fix
  2010-08-16 13:10   ` Ernst Schwab
  (?)
  (?)
@ 2010-08-16 21:09   ` Grant Likely
  -1 siblings, 0 replies; 6+ messages in thread
From: Grant Likely @ 2010-08-16 21:09 UTC (permalink / raw)
  To: Ernst Schwab; +Cc: Randy Dunlap, spi-devel-general, lkml, David Brownell

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 <eschwab@online.de>

Applied, thanks.

> ---
> On Sun, 15 Aug 2010 10:31:56 -0700
> Randy Dunlap <rdunlap@xenotime.net> wrote:
> 
> > This patch in mainline:
> > 
> > commit cf32b71e981ca63e8f349d8585ca2a3583b556e0
> > Author: Ernst Schwab <eschwab@online.de>
> > 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.

^ permalink raw reply	[flat|nested] 6+ messages in thread
end of thread, other threads:[~2010-08-16 21:09 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2010-08-15 17:31 spi.h: missing kernel-doc notation, please fix Randy Dunlap
2010-08-15 17:31 ` Randy Dunlap
2010-08-16 13:10 ` Ernst Schwab
2010-08-16 13:10   ` Ernst Schwab
2010-08-16 15:36   ` Randy Dunlap
2010-08-16 21:09   ` Grant Likely

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.