[PATCH] spi: fix spi.h kernel-doc warning

[PATCH] spi: fix spi.h kernel-doc warning

[Randy Dunlap]

From: Randy Dunlap <rdunlap@xenotime.net>

Fix kernel-doc warning in spi.h (copy/pasto):

Warning(include/linux/spi/spi.h:365): No description found for parameter 'unprepare_transfer_hardware'

Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>
---
 include/linux/spi/spi.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- lnx-34-rc3.orig/include/linux/spi/spi.h
+++ lnx-34-rc3/include/linux/spi/spi.h
@@ -254,7 +254,7 @@ static inline void spi_unregister_driver
  *	driver is finished with this message, it must call
  *	spi_finalize_current_message() so the subsystem can issue the next
  *	transfer
- * @prepare_transfer_hardware: there are currently no more messages on the
+ * @unprepare_transfer_hardware: there are currently no more messages on the
  *	queue so the subsystem notifies the driver that it may relax the
  *	hardware by issuing this call
  *

Re: [PATCH] spi: fix spi.h kernel-doc warning

[Grant Likely]

On Tue, 17 Apr 2012 17:03:50 -0700, Randy Dunlap <rdunlap@xenotime.net> wrote:
> From: Randy Dunlap <rdunlap@xenotime.net>
> 
> Fix kernel-doc warning in spi.h (copy/pasto):
> 
> Warning(include/linux/spi/spi.h:365): No description found for parameter 'unprepare_transfer_hardware'
> 
> Signed-off-by: Randy Dunlap <rdunlap@xenotime.net>

Applied, thanks.

g.

> ---
>  include/linux/spi/spi.h |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- lnx-34-rc3.orig/include/linux/spi/spi.h
> +++ lnx-34-rc3/include/linux/spi/spi.h
> @@ -254,7 +254,7 @@ static inline void spi_unregister_driver
>   *	driver is finished with this message, it must call
>   *	spi_finalize_current_message() so the subsystem can issue the next
>   *	transfer
> - * @prepare_transfer_hardware: there are currently no more messages on the
> + * @unprepare_transfer_hardware: there are currently no more messages on the
>   *	queue so the subsystem notifies the driver that it may relax the
>   *	hardware by issuing this call
>   *

-- 
Grant Likely, B.Sc, P.Eng.
Secret Lab Technologies, Ltd.

[PATCH] spi: fix spi.h kernel-doc warning

[Randy Dunlap]

From: Randy Dunlap <rdunlap@infradead.org>

Fix kernel-doc warning for missing struct field notation.

..//include/linux/spi/spi.h:540: warning: No description found for parameter 'max_transfer_size'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
 include/linux/spi/spi.h |    2 ++
 1 file changed, 2 insertions(+)

--- lnx-45-rc2.orig/include/linux/spi/spi.h
+++ lnx-45-rc2/include/linux/spi/spi.h
@@ -303,6 +303,8 @@ static inline void spi_unregister_driver
  * @min_speed_hz: Lowest supported transfer speed
  * @max_speed_hz: Highest supported transfer speed
  * @flags: other constraints relevant to this driver
+ * @max_transfer_size: function that returns the max transfer size for
+ *	a &spi_device; may be %NULL, so the default %SIZE_MAX will be used.
  * @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

Re: [PATCH] spi: fix spi.h kernel-doc warning

[Mark Brown]

[-- Attachment #1: Type: text/plain, Size: 442 bytes --]

On Fri, Feb 05, 2016 at 05:31:39PM -0800, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Fix kernel-doc warning for missing struct field notation.
> 
> ..//include/linux/spi/spi.h:540: warning: No description found for parameter 'max_transfer_size'

The patch description and especially subject here should be something
along the lines of "Document max_transfer_size" - describe what you
think the change is.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 473 bytes --]