netdev - Re: [PATCH] phy.h: fix obvious errors in doc and kerneldoc content

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: <20181226122526.GA5765@lunn.ch>
Date:   Wed, 26 Dec 2018 13:25:26 +0100
From:   Andrew Lunn <andrew@...n.ch>
To:     "Robert P. J. Day" <rpjday@...shcourse.ca>
Cc:     Linux kernel netdev mailing list <netdev@...r.kernel.org>
Subject: Re: [PATCH] phy.h: fix obvious errors in doc and kerneldoc content

On Wed, Dec 26, 2018 at 05:41:29AM -0600, Robert P. J. Day wrote:
> 
>  1) gianfar_phy.c should clearly refer to gianfar.c
>  2) fix obvious copy and paste error in regular doc
>  3) change regular doc into kerneldoc for phy_modes()
> 
> Signed-off-by: Robert P. J. Day <rpjday@...shcourse.ca>
> 
> ---

Hi Robert

> diff --git a/include/linux/phy.h b/include/linux/phy.h
> index 3ea87f774a76..1ca94a51a93e 100644
> --- a/include/linux/phy.h
> +++ b/include/linux/phy.h
> @@ -1,6 +1,6 @@
>  /*
>   * Framework and drivers for configuring and reading different PHYs
> - * Based on code in sungem_phy.c and gianfar_phy.c
> + * Based on code in sungem_phy.c and gianfar.c

Nope, checkout the commit which added this file:

git checkout 00db8189d984

and take a look around. You will find drivers/net/gianfar_phy.c It has
long since gone, but it was the basis for the framework.

>   *
>   * Author: Andy Fleming
>   *
> @@ -106,8 +106,8 @@ typedef enum {
>   * @speeds: buffer to store supported speeds in.
>   * @size: size of speeds buffer.
>   *
> - * Description: Returns the number of supported speeds, and
> - * fills the speeds * buffer with the supported speeds. If speeds buffer is
> + * Description: Returns the number of supported speeds, and fills
> + * the speeds buffer with the supported speeds. If speeds buffer is
>   * too small to contain * all currently supported speeds, will return as

                          ^^^
Don't forget this one.

      Andrew