linux-kernel - Re: [PATCH] Documentation: networking: correct spelling

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20240811134453.GJ1951@kernel.org>
Date: Sun, 11 Aug 2024 14:44:53 +0100
From: Simon Horman <horms@...nel.org>
To: Jing-Ping Jan <zoo868e@...il.com>
Cc: "David S. Miller" <davem@...emloft.net>,
	Eric Dumazet <edumazet@...gle.com>,
	Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>,
	Jonathan Corbet <corbet@....net>, netdev@...r.kernel.org,
	linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
	Shuah Khan <skhan@...uxfoundation.org>
Subject: Re: [PATCH] Documentation: networking: correct spelling

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@...il.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@...nel.org>

...