netdev.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] include/linux/phy/phy.h: fix minor kerneldoc errors
@ 2018-12-27 21:10 Robert P. J. Day
  2018-12-28  0:32 ` David Miller
  0 siblings, 1 reply; 2+ messages in thread
From: Robert P. J. Day @ 2018-12-27 21:10 UTC (permalink / raw)
  To: Linux kernel netdev mailing list


Correct two minor kerneldoc errors:

 1) missing reference to @mode in struct phy_ops
 2) obsolete reference to @init_data in struct_phy_attrs,
    removed in dbc98635e0d42f0e62ea92813df1e0e4c90f8375

Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

---

  AFAICT, none of this is actually included in the current
sphinx-based kerneldoc generation, but in preparation for it someday
being included, might as well make sure it's correct.

diff --git a/include/linux/phy/phy.h
b/include/linux/phy/phy.h index 03b319f89a34..66d1560f1a26 100644
--- a/include/linux/phy/phy.h
+++ b/include/linux/phy/phy.h
@@ -69,6 +69,7 @@ struct phy_ops {
 /**
  * struct phy_attrs - represents phy attributes
  * @bus_width: Data path width implemented by PHY
+ * @mode: PHY mode
  */
 struct phy_attrs {
 	u32			bus_width;
@@ -80,7 +81,6 @@ struct phy_attrs {
  * @dev: phy device
  * @id: id of the phy device
  * @ops: function pointers for performing phy operations
- * @init_data: list of PHY consumers (non-dt only)
  * @mutex: mutex to protect phy_ops
  * @init_count: used to protect when the PHY is used by multiple consumers
  * @power_count: used to protect when the PHY is used by multiple consumers

-- 

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

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

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

* Re: [PATCH] include/linux/phy/phy.h: fix minor kerneldoc errors
  2018-12-27 21:10 [PATCH] include/linux/phy/phy.h: fix minor kerneldoc errors Robert P. J. Day
@ 2018-12-28  0:32 ` David Miller
  0 siblings, 0 replies; 2+ messages in thread
From: David Miller @ 2018-12-28  0:32 UTC (permalink / raw)
  To: rpjday; +Cc: netdev

From: "Robert P. J. Day" <rpjday@crashcourse.ca>
Date: Thu, 27 Dec 2018 16:10:59 -0500 (EST)

> 
> Correct two minor kerneldoc errors:
> 
>  1) missing reference to @mode in struct phy_ops
>  2) obsolete reference to @init_data in struct_phy_attrs,
>     removed in dbc98635e0d42f0e62ea92813df1e0e4c90f8375
> 
> Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>

Applied.

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

end of thread, other threads:[~2018-12-28  0:32 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-12-27 21:10 [PATCH] include/linux/phy/phy.h: fix minor kerneldoc errors Robert P. J. Day
2018-12-28  0:32 ` David Miller

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).