* [PATCH] spi: fix spi.h kernel-doc warning
@ 2016-02-06 1:31 Randy Dunlap
2016-02-08 16:55 ` Mark Brown
[not found] ` <56B54CFB.9050904-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
0 siblings, 2 replies; 4+ messages in thread
From: Randy Dunlap @ 2016-02-06 1:31 UTC (permalink / raw)
To: LKML, Mark Brown, linux-spi; +Cc: Andrew Morton
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
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] spi: fix spi.h kernel-doc warning
[not found] ` <56B54CFB.9050904-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
@ 2016-02-08 16:55 ` Mark Brown
0 siblings, 0 replies; 4+ messages in thread
From: Mark Brown @ 2016-02-08 16:55 UTC (permalink / raw)
To: Randy Dunlap; +Cc: LKML, linux-spi, Andrew Morton
[-- 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 --]
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] spi: fix spi.h kernel-doc warning
@ 2016-02-08 16:55 ` Mark Brown
0 siblings, 0 replies; 4+ messages in thread
From: Mark Brown @ 2016-02-08 16:55 UTC (permalink / raw)
To: Randy Dunlap; +Cc: LKML, linux-spi-u79uwXL29TY76Z2rM5mHXA, Andrew Morton
[-- Attachment #1: Type: text/plain, Size: 468 bytes --]
On Fri, Feb 05, 2016 at 05:31:39PM -0800, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.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 --]
^ permalink raw reply [flat|nested] 4+ messages in thread
* Applied "spi: Document max_transfer_size" to the spi tree
[not found] ` <56B54CFB.9050904-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
@ 2016-02-08 18:01 ` Mark Brown
0 siblings, 0 replies; 4+ messages in thread
From: Mark Brown @ 2016-02-08 18:01 UTC (permalink / raw)
To: Randy Dunlap, Mark Brown; +Cc: linux-spi-u79uwXL29TY76Z2rM5mHXA
The patch
spi: Document max_transfer_size
has been applied to the spi tree at
git://git.kernel.org/pub/scm/linux/kernel/git/broonie/spi.git
All being well this means that it will be integrated into the linux-next
tree (usually sometime in the next 24 hours) and sent to Linus during
the next merge window (or sooner if it is a bug fix), however if
problems are discovered then the patch may be dropped or reverted.
You may get further e-mails resulting from automated or manual testing
and review of the tree, please engage with people reporting problems and
send followup patches addressing any issues that are reported if needed.
If any updates are required or you are submitting further changes they
should be sent as incremental updates against current git, existing
patches will not be replaced.
Please add any relevant lists and maintainers to the CCs when replying
to this mail.
Thanks,
Mark
>From ee7683a31683c6368a66a83c555600dfd704e543 Mon Sep 17 00:00:00 2001
From: Randy Dunlap <rdunlap-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
Date: Fri, 5 Feb 2016 17:31:39 -0800
Subject: [PATCH] spi: Document max_transfer_size
Fix kernel-doc warning for missing struct field notation.
..//include/linux/spi/spi.h:540: warning: No description found for parameter 'max_transfer_size'
[Meaningful subject -- broonie]
Signed-off-by: Randy Dunlap <rdunlap-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
Signed-off-by: Mark Brown <broonie-DgEjT+Ai2ygdnm+yROfE0A@public.gmane.org>
---
include/linux/spi/spi.h | 2 ++
1 file changed, 2 insertions(+)
diff --git a/include/linux/spi/spi.h b/include/linux/spi/spi.h
index 53be3a4c60cb..e9290c335cc4 100644
--- a/include/linux/spi/spi.h
+++ b/include/linux/spi/spi.h
@@ -303,6 +303,8 @@ static inline void spi_unregister_driver(struct spi_driver *sdrv)
* @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
--
2.7.0.rc3
--
To unsubscribe from this list: send the line "unsubscribe linux-spi" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
^ permalink raw reply related [flat|nested] 4+ messages in thread
end of thread, other threads:[~2016-02-08 18:01 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-02-06 1:31 [PATCH] spi: fix spi.h kernel-doc warning Randy Dunlap
2016-02-08 16:55 ` Mark Brown
2016-02-08 16:55 ` Mark Brown
[not found] ` <56B54CFB.9050904-wEGCiKHe2LqWVfeAwA7xHQ@public.gmane.org>
2016-02-08 18:01 ` Applied "spi: Document max_transfer_size" to the spi tree Mark Brown
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.