diff mbox series

include/linux/phy/phy.h: fix minor kerneldoc errors

Message ID alpine.LFD.2.21.1812270929370.14304@localhost.localdomain
State Accepted, archived
Delegated to: David Miller
Headers show
Series include/linux/phy/phy.h: fix minor kerneldoc errors | expand

Commit Message

Robert P. J. Day Dec. 27, 2018, 9:10 p.m. UTC
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.

Comments

David Miller Dec. 28, 2018, 12:32 a.m. UTC | #1
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.
diff mbox series

Patch

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