Re: [PATCH net-next v2 1/1] Documentation: networking: expand and clarify EEE_GET/EEE_SET documentation

[Russell King (Oracle)]

On Fri, May 02, 2025 at 10:46:02AM +0200, Paolo Abeni wrote:
> On 4/27/25 3:40 PM, Oleksij Rempel wrote:
> > Improve the documentation for ETHTOOL_MSG_EEE_GET and ETHTOOL_MSG_EEE_SET
> > to provide accurate descriptions of all netlink attributes involved.
> > 
> > Signed-off-by: Oleksij Rempel <o.rempel@xxxxxxxxxxxxxx>
> 
> This looks like an almost complete rewrite WRT v1, a changelog would
> have helped reviewing. I'm unsure if it captures all the feedback from
> Russell,

Indeed, because I'm still of the opinion that we shouldn't be trying to
document the same thing in two different places, but differently, which
will only add confusion, and over time the two descriptions will diverge
making the problem harder.

We need to document this in exactly one place, not two places.

So please, choose one of:

* Documentation/devicetree/bindings/net/ethernet-phy.yaml
* Documentation/networking/phy.rst

and reference one from the other, if necessary improving the
documentation.

Given that phylib is not a DT thing, I believe it should not be
documented in the DT bindings, but people directed to the phylib
documentation (the second) for the clarification of our implementation.

-- 
RMK's Patch system: https://www.armlinux.org.uk/developer/patches/
FTTP is here! 80Mbps down 10Mbps up. Decent connectivity at last!