| Message ID | 20200920171703.3692328-1-andrew@lunn.ch |
|---|---|
| Headers | show |
| Series | PHY subsystem kernel doc | expand |
On 9/20/20 10:16 AM, Andrew Lunn wrote: > The first two patches just fixed warnings seen while trying to work on > PHY documentation. > > The following patches then first fix existing warnings in the > kerneldoc for the PHY subsystem, and then extend the kernel > documentation for the major structures and functions in the PHY > subsystem. > > Andrew Lunn (5): > net: netdevice.h: Document proto_down_reason > net: netdevice.h: Document xdp_state > net: phy: Fixup kernel doc > net: phy: Document core PHY structures > net: mdio: Add kerneldoc for main data structures and some functions > > Documentation/networking/kapi.rst | 24 ++ > drivers/net/phy/mdio_bus.c | 37 +++ > drivers/net/phy/mdio_device.c | 21 ++ > drivers/net/phy/phy-core.c | 30 +++ > drivers/net/phy/phy.c | 69 ++++- > include/linux/mdio.h | 91 ++++++- > include/linux/netdevice.h | 3 + > include/linux/phy.h | 414 +++++++++++++++++++++--------- > 8 files changed, 554 insertions(+), 135 deletions(-) Note: Jakub has already merged my fixes for your patches 1 & 2... The series LGTM. Thanks. series: Reviewed-by: Randy Dunlap <rdunlap@infradead.org> -- ~Randy
On 9/20/2020 10:16 AM, Andrew Lunn wrote: > Fix the Sphinx warning: > > ./include/linux/netdevice.h:2162: warning: Function parameter or member > 'proto_down_reason' not described in 'net_device' > > by adding the needed documentation. > > Cc: Roopa Prabhu <roopa@cumulusnetworks.com> > Signed-off-by: Andrew Lunn <andrew@lunn.ch> Reviewed-by: Florian Fainelli <f.fainelli@gmail.com> -- Florian
On 9/20/2020 10:17 AM, Andrew Lunn wrote: > Document the main structures, a few inline helpers and exported > functions which are not already documented. > > Signed-off-by: Andrew Lunn <andrew@lunn.ch> Reviewed-by: Florian Fainelli <f.fainelli@gmail.com> -- Florian
From: Andrew Lunn <andrew@lunn.ch> Date: Sun, 20 Sep 2020 19:16:58 +0200 > The first two patches just fixed warnings seen while trying to work on > PHY documentation. > > The following patches then first fix existing warnings in the > kerneldoc for the PHY subsystem, and then extend the kernel > documentation for the major structures and functions in the PHY > subsystem. Please respin with the minor feedback Florian gave for patch #4. Thanks.