Documentation: networking: correct spelling
Subsystems (4)
PATCH 1/1 Documentation: networking: correct spelling
Correct spelling problems for Documentation/networking/ as reported by ispell.
--- Documentation/networking/ethtool-netlink.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)
Documentation/networking/ethtool-netlink.rst +5 -5
@@ -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)
Signature · 1 line
2.25.1
Quoted 22 lines · Jing-Ping Jan
Correct spelling problems for
Documentation/networking/as reported by ispell.Signed-off-by Jing-Ping Jan <[email protected]>--- Documentation/networking/ethtool-netlink.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-)Documentation/networking/ethtool-netlink.rst +1
-1@@ -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.
Documentation/networking/ethtool-netlink.rst Completion queue events(CQE) are the events posted by NIC to indicate the · line 948
Quoted 7 lines
Documentation/networking/ethtool-netlink.rst +1
-1@@ -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.
...
PATCH v2 1/1 Documentation: networking: correct spelling
Correct spelling problems for Documentation/networking/ as reported by ispell.
---
Thank you Simon, for the review.
Changes in v2: corrected the grammer and added the missing spaces before each '('.
Documentation/networking/ethtool-netlink.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-)
Documentation/networking/ethtool-netlink.rst +10 -10
@@ -934,18 +934,18 @@ 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. ``ETHTOOL_A_RINGS_CQE_SIZE`` specifies the completion queue event size. -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 +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 frame from wire. Based on the NIC hardware, the overall completion -queue size can be adjusted in the driver if CQE size is modified. +A bigger CQE can have more receive buffer pointers, and in turn the 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. CHANNELS_GET ============
@@ -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)
Signature · 1 line
2.25.1
Quoted 8 lines · Jing-Ping Jan
Correct spelling problems for
Documentation/networking/as reported by ispell.Signed-off-by Jing-Ping Jan <[email protected]>---
Thank you Simon, for the review.
Changes in v2: corrected the grammer and added the missing spaces before each '('.
Thanks,
I agree that these changes improve the document.
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Hello:
This patch was applied to netdev/net-next.git (main) by Jakub Kicinski <[email protected]>:
Quoted 10 lines · On Tue, 13 Aug 2024 01:09:10 +0800 you wrote:
Correct spelling problems for
Documentation/networking/as reported by ispell.Signed-off-by Jing-Ping Jan <[email protected]>---
Thank you Simon, for the review.
Changes in v2: corrected the grammer and added the missing spaces before each '('.[...]
Here is the summary with links:
- [v2] Documentation: networking: correct spelling
https://git.kernel.org/netdev/net-next/c/baae8b0ba835
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html