LKML Archive on lore.kernel.org
help / color / mirror / Atom feed
* [PATCH] Documentation: driver-api: fix device_connection.rst kernel-doc error
@ 2018-04-27  1:29 Randy Dunlap
  2018-04-27 11:30 ` Heikki Krogerus
  2018-04-27 23:17 ` Jonathan Corbet
  0 siblings, 2 replies; 3+ messages in thread
From: Randy Dunlap @ 2018-04-27  1:29 UTC (permalink / raw)
  To: linux-doc, LKML, Greg Kroah-Hartman; +Cc: Heikki Krogerus, Jonathan Corbet

From: Randy Dunlap <rdunlap@infradead.org>

Using incorrect :functions: syntax (extra space) causes an odd kernel-doc
warning, so fix that.

Documentation/driver-api/device_connection.rst:42: ERROR: Error in "kernel-doc" directive:

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Heikki Krogerus <heikki.krogerus@linux.intel.com>
---
 Documentation/driver-api/device_connection.rst |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20180426.orig/Documentation/driver-api/device_connection.rst
+++ linux-next-20180426/Documentation/driver-api/device_connection.rst
@@ -40,4 +40,4 @@ API
 ---
 
 .. kernel-doc:: drivers/base/devcon.c
-   : functions: device_connection_find_match device_connection_find device_connection_add device_connection_remove
+   :functions: device_connection_find_match device_connection_find device_connection_add device_connection_remove

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] Documentation: driver-api: fix device_connection.rst kernel-doc error
  2018-04-27  1:29 [PATCH] Documentation: driver-api: fix device_connection.rst kernel-doc error Randy Dunlap
@ 2018-04-27 11:30 ` Heikki Krogerus
  2018-04-27 23:17 ` Jonathan Corbet
  1 sibling, 0 replies; 3+ messages in thread
From: Heikki Krogerus @ 2018-04-27 11:30 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: linux-doc, LKML, Greg Kroah-Hartman, Jonathan Corbet

On Thu, Apr 26, 2018 at 06:29:41PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@infradead.org>
> 
> Using incorrect :functions: syntax (extra space) causes an odd kernel-doc
> warning, so fix that.
> 
> Documentation/driver-api/device_connection.rst:42: ERROR: Error in "kernel-doc" directive:
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Heikki Krogerus <heikki.krogerus@linux.intel.com>

FWIW:

Reviewed-by: Heikki Krogerus <heikki.krogerus@linux.intel.com>

> ---
>  Documentation/driver-api/device_connection.rst |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- linux-next-20180426.orig/Documentation/driver-api/device_connection.rst
> +++ linux-next-20180426/Documentation/driver-api/device_connection.rst
> @@ -40,4 +40,4 @@ API
>  ---
>  
>  .. kernel-doc:: drivers/base/devcon.c
> -   : functions: device_connection_find_match device_connection_find device_connection_add device_connection_remove
> +   :functions: device_connection_find_match device_connection_find device_connection_add device_connection_remove
> 

Thanks,

-- 
heikki

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: [PATCH] Documentation: driver-api: fix device_connection.rst kernel-doc error
  2018-04-27  1:29 [PATCH] Documentation: driver-api: fix device_connection.rst kernel-doc error Randy Dunlap
  2018-04-27 11:30 ` Heikki Krogerus
@ 2018-04-27 23:17 ` Jonathan Corbet
  1 sibling, 0 replies; 3+ messages in thread
From: Jonathan Corbet @ 2018-04-27 23:17 UTC (permalink / raw)
  To: Randy Dunlap; +Cc: linux-doc, LKML, Greg Kroah-Hartman, Heikki Krogerus

On Thu, 26 Apr 2018 18:29:41 -0700
Randy Dunlap <rdunlap@infradead.org> wrote:

> Using incorrect :functions: syntax (extra space) causes an odd kernel-doc
> warning, so fix that.
> 
> Documentation/driver-api/device_connection.rst:42: ERROR: Error in "kernel-doc" directive:

Applied, thanks.

jon

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2018-04-27 23:17 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-04-27  1:29 [PATCH] Documentation: driver-api: fix device_connection.rst kernel-doc error Randy Dunlap
2018-04-27 11:30 ` Heikki Krogerus
2018-04-27 23:17 ` Jonathan Corbet

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).