diff mbox series

Documentation: networking: correct spelling

Message ID 20240809181750.62522-1-zoo868e@gmail.com (mailing list archive)
State Superseded
Delegated to: Netdev Maintainers
Headers show
Series Documentation: networking: correct spelling | expand

Checks

Context Check Description
netdev/series_format warning Single patches do not need cover letters; Target tree name not specified in the subject
netdev/tree_selection success Guessed tree name to be 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, 40 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-08-10--18-00 (tests: 707)

Commit Message

Jing-Ping Jan Aug. 9, 2024, 6:17 p.m. UTC
Correct spelling problems for Documentation/networking/ as reported
by ispell.

Signed-off-by: Jing-Ping Jan <zoo868e@gmail.com>
---
 Documentation/networking/ethtool-netlink.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

Comments

Simon Horman Aug. 11, 2024, 1:44 p.m. UTC | #1
On Sat, Aug 10, 2024 at 02:17:50AM +0800, Jing-Ping Jan wrote:
> Correct spelling problems for Documentation/networking/ as reported
> by ispell.
> 
> Signed-off-by: Jing-Ping Jan <zoo868e@gmail.com>
> ---
>  Documentation/networking/ethtool-netlink.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
> diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
> index d5f246aceb9f..9ecfc4f0f980 100644
> --- a/Documentation/networking/ethtool-netlink.rst
> +++ b/Documentation/networking/ethtool-netlink.rst
> @@ -934,7 +934,7 @@ Request contents:
>    ====================================  ======  ===========================
>  
>  Kernel checks that requested ring sizes do not exceed limits reported by
> -driver. Driver may impose additional constraints and may not suspport all
> +driver. Driver may impose additional constraints and may not support all
>  attributes.
>  
>  
> @@ -943,7 +943,7 @@ Completion queue events(CQE) are the events posted by NIC to indicate the
>  completion status of a packet when the packet is sent(like send success or
>  error) or received(like pointers to packet fragments). The CQE size parameter
>  enables to modify the CQE size other than default size if NIC supports it.
> -A bigger CQE can have more receive buffer pointers inturn NIC can transfer
> +A bigger CQE can have more receive buffer pointers in turn NIC can transfer
>  a bigger frame from wire. Based on the NIC hardware, the overall completion
>  queue size can be adjusted in the driver if CQE size is modified.

FWIIW, it is not clear to me that the sentence that is being updated is
grammatically correct either before or after the change: some words seem to
be missing.

Perhaps:

A bigger CQE can have more receive buffer pointers, and in turn the NIC can
transfer a bigger frame from the wire.

Also, 'NIC/ -> 'the NIC' in the previous sentence.

And there should be a space before each '('/

I guess this document could do with an edit.

But, regardless of my comments above, your changes look like
good steps in the right direction to me. Thanks.

Reviewed-by: Simon Horman <horms@kernel.org>

...
diff mbox series

Patch

diff --git a/Documentation/networking/ethtool-netlink.rst b/Documentation/networking/ethtool-netlink.rst
index d5f246aceb9f..9ecfc4f0f980 100644
--- a/Documentation/networking/ethtool-netlink.rst
+++ b/Documentation/networking/ethtool-netlink.rst
@@ -934,7 +934,7 @@  Request contents:
   ====================================  ======  ===========================
 
 Kernel checks that requested ring sizes do not exceed limits reported by
-driver. Driver may impose additional constraints and may not suspport all
+driver. Driver may impose additional constraints and may not support all
 attributes.
 
 
@@ -943,7 +943,7 @@  Completion queue events(CQE) are the events posted by NIC to indicate the
 completion status of a packet when the packet is sent(like send success or
 error) or received(like pointers to packet fragments). The CQE size parameter
 enables to modify the CQE size other than default size if NIC supports it.
-A bigger CQE can have more receive buffer pointers inturn NIC can transfer
+A bigger CQE can have more receive buffer pointers in turn NIC can transfer
 a bigger frame from wire. Based on the NIC hardware, the overall completion
 queue size can be adjusted in the driver if CQE size is modified.
 
@@ -989,7 +989,7 @@  Request contents:
   =====================================  ======  ==========================
 
 Kernel checks that requested channel counts do not exceed limits reported by
-driver. Driver may impose additional constraints and may not suspport all
+driver. Driver may impose additional constraints and may not support all
 attributes.
 
 
@@ -1927,7 +1927,7 @@  When set, the optional ``ETHTOOL_A_PLCA_VERSION`` attribute indicates which
 standard and version the PLCA management interface complies to. When not set,
 the interface is vendor-specific and (possibly) supplied by the driver.
 The OPEN Alliance SIG specifies a standard register map for 10BASE-T1S PHYs
-embedding the PLCA Reconcialiation Sublayer. See "10BASE-T1S PLCA Management
+embedding the PLCA Reconciliation Sublayer. See "10BASE-T1S PLCA Management
 Registers" at https://www.opensig.org/about/specifications/.
 
 When set, the optional ``ETHTOOL_A_PLCA_ENABLED`` attribute indicates the
@@ -1989,7 +1989,7 @@  Request contents:
   ``ETHTOOL_A_PLCA_ENABLED``              u8      PLCA Admin State
   ``ETHTOOL_A_PLCA_NODE_ID``              u8      PLCA unique local node ID
   ``ETHTOOL_A_PLCA_NODE_CNT``             u8      Number of PLCA nodes on the
-                                                  netkork, including the
+                                                  network, including the
                                                   coordinator
   ``ETHTOOL_A_PLCA_TO_TMR``               u8      Transmit Opportunity Timer
                                                   value in bit-times (BT)