diff mbox series

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

Message ID 20240911144711.693216-1-kory.maincent@bootlin.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series [net-next] Documentation: networking: Fix missing PSE documentation issue | expand

Checks

Context Check Description
netdev/series_format success Single patches do not need cover letters
netdev/tree_selection success Clearly marked for net-next
netdev/ynl success Generated files up to date; no warnings/errors; no diff in generated;
netdev/fixes_present success Fixes tag not required for -next series
netdev/header_inline success No static functions without inline keyword in header files
netdev/build_32bit success Errors and warnings before: 7 this patch: 7
netdev/build_tools success No tools touched, skip
netdev/cc_maintainers success CCed 6 of 6 maintainers
netdev/build_clang success Errors and warnings before: 7 this patch: 7
netdev/verify_signedoff success Signed-off-by tag matches author and committer
netdev/deprecated_api success None detected
netdev/check_selftest success No net selftest shell script
netdev/verify_fixes success No Fixes tag
netdev/build_allmodconfig_warn success Errors and warnings before: 7 this patch: 7
netdev/checkpatch success total: 0 errors, 0 warnings, 0 checks, 11 lines checked
netdev/build_clang_rust success No Rust files in patch. Skipping build
netdev/kdoc success Errors and warnings before: 0 this patch: 0
netdev/source_inline success Was 0 now: 0
netdev/contest success net-next-2024-09-12--00-00 (tests: 764)

Commit Message

Kory Maincent Sept. 11, 2024, 2:47 p.m. UTC
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(-)

Comments

Oleksij Rempel Sept. 11, 2024, 6:21 p.m. UTC | #1
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
Simon Horman Sept. 12, 2024, 8:09 a.m. UTC | #2
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
> 
>
Kory Maincent Sept. 12, 2024, 8:59 a.m. UTC | #3
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,
diff mbox series

Patch

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: