linux-kernel - Re: [PATCH] Documentation: driver-api: fix device

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20180427113032.GB31265@kuha.fi.intel.com>
Date:   Fri, 27 Apr 2018 14:30:32 +0300
From:   Heikki Krogerus <heikki.krogerus@...ux.intel.com>
To:     Randy Dunlap <rdunlap@...radead.org>
Cc:     "linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
        LKML <linux-kernel@...r.kernel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH] Documentation: driver-api: fix device_connection.rst
 kernel-doc error

On Thu, Apr 26, 2018 at 06:29:41PM -0700, Randy Dunlap wrote:
> From: Randy Dunlap <rdunlap@...radead.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@...radead.org>
> Cc: Heikki Krogerus <heikki.krogerus@...ux.intel.com>

FWIW:

Reviewed-by: Heikki Krogerus <heikki.krogerus@...ux.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