Documentation: networking: Fix missing PSE documentation issue

[PATCH net-next] Documentation: networking: Fix missing PSE documentation issue

Posted by Kory Maincent 1 year, 4 months ago

Fix a missing end of phrase in the documentation. It describes the
ETHTOOL_A_C33_PSE_ACTUAL_PW attribute, which was not fully explained.

Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>
---
 Documentation/networking/ethtool-netlink.rst | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
index ba90457b8b2d..b1390878ba84 100644
--- a/Documentation/networking/ethtool-netlink.rst
+++ b/Documentation/networking/ethtool-netlink.rst
@@ -1801,8 +1801,9 @@ the PSE and the PD. This option is corresponding to ``IEEE 802.3-2022``
 30.9.1.1.8 aPSEPowerClassification.
 
 When set, the optional ``ETHTOOL_A_C33_PSE_ACTUAL_PW`` attribute identifies
-This option is corresponding to ``IEEE 802.3-2022`` 30.9.1.1.23 aPSEActualPower.
-Actual power is reported in mW.
+the actual power drawn by the C33 PSE. This option is corresponding to
+``IEEE 802.3-2022`` 30.9.1.1.23 aPSEActualPower. Actual power is reported
+in mW.
 
 When set, the optional ``ETHTOOL_A_C33_PSE_EXT_STATE`` attribute identifies
 the extended error state of the C33 PSE. Possible values are:
-- 
2.34.1

Re: [PATCH net-next] Documentation: networking: Fix missing PSE documentation issue

Posted by Simon Horman 1 year, 4 months ago

On Wed, Sep 11, 2024 at 04:47:11PM +0200, Kory Maincent wrote:
> Fix a missing end of phrase in the documentation. It describes the
> ETHTOOL_A_C33_PSE_ACTUAL_PW attribute, which was not fully explained.
> 
> Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>
> ---
>  Documentation/networking/ethtool-netlink.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
> index ba90457b8b2d..b1390878ba84 100644
> --- a/Documentation/networking/ethtool-netlink.rst
> +++ b/Documentation/networking/ethtool-netlink.rst
> @@ -1801,8 +1801,9 @@ the PSE and the PD. This option is corresponding to ``IEEE 802.3-2022``
>  30.9.1.1.8 aPSEPowerClassification.
>  
>  When set, the optional ``ETHTOOL_A_C33_PSE_ACTUAL_PW`` attribute identifies
> -This option is corresponding to ``IEEE 802.3-2022`` 30.9.1.1.23 aPSEActualPower.
> -Actual power is reported in mW.
> +the actual power drawn by the C33 PSE. This option is corresponding to

nit: While we are here, perhaps we can also update the grammar.

     This attribute corresponds to...

> +``IEEE 802.3-2022`` 30.9.1.1.23 aPSEActualPower. Actual power is reported
> +in mW.
>  
>  When set, the optional ``ETHTOOL_A_C33_PSE_EXT_STATE`` attribute identifies
>  the extended error state of the C33 PSE. Possible values are:
> -- 
> 2.34.1
> 
>

Re: [PATCH net-next] Documentation: networking: Fix missing PSE documentation issue

Posted by Kory Maincent 1 year, 4 months ago

On Thu, 12 Sep 2024 09:09:29 +0100
Simon Horman <horms@kernel.org> wrote:

> On Wed, Sep 11, 2024 at 04:47:11PM +0200, Kory Maincent wrote:
> > Fix a missing end of phrase in the documentation. It describes the
> > ETHTOOL_A_C33_PSE_ACTUAL_PW attribute, which was not fully explained.
> > 
> > Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>
> > ---
> >  Documentation/networking/ethtool-netlink.rst | 5 +++--
> >  1 file changed, 3 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/networking/ethtool-netlink.rst
> > b/Documentation/networking/ethtool-netlink.rst index
> > ba90457b8b2d..b1390878ba84 100644 ---
> > a/Documentation/networking/ethtool-netlink.rst +++
> > b/Documentation/networking/ethtool-netlink.rst @@ -1801,8 +1801,9 @@ the
> > PSE and the PD. This option is corresponding to ``IEEE 802.3-2022``
> > 30.9.1.1.8 aPSEPowerClassification. 
> >  When set, the optional ``ETHTOOL_A_C33_PSE_ACTUAL_PW`` attribute identifies
> > -This option is corresponding to ``IEEE 802.3-2022`` 30.9.1.1.23
> > aPSEActualPower. -Actual power is reported in mW.
> > +the actual power drawn by the C33 PSE. This option is corresponding to  
> 
> nit: While we are here, perhaps we can also update the grammar.
> 
>      This attribute corresponds to...

Yes, indeed. Thanks.

Regards,
-- 
Köry Maincent, Bootlin
Embedded Linux and kernel engineering
https://bootlin.com

Re: [PATCH net-next] Documentation: networking: Fix missing PSE documentation issue

Posted by Oleksij Rempel 1 year, 4 months ago

On Wed, Sep 11, 2024 at 04:47:11PM +0200, Kory Maincent wrote:
> Fix a missing end of phrase in the documentation. It describes the
> ETHTOOL_A_C33_PSE_ACTUAL_PW attribute, which was not fully explained.
> 
> Signed-off-by: Kory Maincent <kory.maincent@bootlin.com>

Reviewed-by: Oleksij Rempel <o.rempel@pengutronix.de>

Thank you!

Regards,
Oleksij
-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |