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

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

[Robert P. J. Day]

 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@crashcourse.ca>

---

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
  *
  * 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
  * many speeds as can fit.
  */
@@ -116,7 +116,10 @@ unsigned int phy_supported_speeds(struct phy_device *phy,
 				      unsigned int size);

 /**
- * It maps 'enum phy_interface_t' found in include/linux/phy.h
+ * phy_modes - map phy_interface_t enum to device tree binding of phy-mode
+ * @interface: enum phy_interface_t value
+ *
+ * Description: maps 'enum phy_interface_t' defined in this file
  * into the device tree binding of 'phy-mode', so that Ethernet
  * device driver can get phy interface from device tree.
  */

-- 

========================================================================
Robert P. J. Day                                 Ottawa, Ontario, CANADA
                  http://crashcourse.ca/dokuwiki

Twitter:                                       http://twitter.com/rpjday
LinkedIn:                               http://ca.linkedin.com/in/rpjday
========================================================================

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

[Andrew Lunn]

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@crashcourse.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

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

[Robert P. J. Day]

On Wed, 26 Dec 2018, Andrew Lunn wrote:

> 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@crashcourse.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.

  ... snip ...

  ack, i used "git log" assuming it had originally been under
drivers/phy ... my bad. will fix that and the other issue.

rday