linux-kernel - Re: [PATCH 16/26] docs: i2c: smbus-protocol: fix kernel-doc function syntax

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 for Android: free password hash cracker in your pocket

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

Date:   Mon, 20 Jan 2020 15:51:07 +0100
From:   Jean Delvare <jdelvare@...e.de>
To:     Luca Ceresoli <luca@...aceresoli.net>
Cc:     linux-doc@...r.kernel.org, linux-i2c@...r.kernel.org,
        Wolfram Sang <wsa@...-dreams.de>,
        Peter Rosin <peda@...ntia.se>, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 16/26] docs: i2c: smbus-protocol: fix kernel-doc
 function syntax

On Sun,  5 Jan 2020 23:50:02 +0100, Luca Ceresoli wrote:
> This clarifies these are functions (and would/will adds a hyperlink to the
> function documentation if/when documented).
> 
> Signed-off-by: Luca Ceresoli <luca@...aceresoli.net>
> ---
>  Documentation/i2c/smbus-protocol.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/i2c/smbus-protocol.rst b/Documentation/i2c/smbus-protocol.rst
> index 997945e90419..3c0fb3a2044d 100644
> --- a/Documentation/i2c/smbus-protocol.rst
> +++ b/Documentation/i2c/smbus-protocol.rst
> @@ -118,7 +118,7 @@ byte. But this time, the data is a complete word (16 bits)::
>  
>  Functionality flag: I2C_FUNC_SMBUS_READ_WORD_DATA
>  
> -Note the convenience function i2c_smbus_read_word_swapped is
> +Note the convenience function i2c_smbus_read_word_swapped() is
>  available for reads where the two data bytes are the other way
>  around (not SMBus compliant, but very popular.)
>  
> @@ -152,7 +152,7 @@ specified through the Comm byte.::
>  
>  Functionality flag: I2C_FUNC_SMBUS_WRITE_WORD_DATA
>  
> -Note the convenience function i2c_smbus_write_word_swapped is
> +Note the convenience function i2c_smbus_write_word_swapped() is
>  available for writes where the two data bytes are the other way
>  around (not SMBus compliant, but very popular.)
>  

Reviewed-by: Jean Delvare <jdelvare@...e.de>


-- 
Jean Delvare
SUSE L3 Support