linux-kernel - Re: [PATCH] docs: arch/x86/sva: Fix two grammar errors under Background and FAQ

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] [day] [month] [year] [list]

Message-ID: <Z6r1H5V-m_xuEu0q@vaxr-BM6660-BM6360>
Date: Tue, 11 Feb 2025 14:58:39 +0800
From: I Hsin Cheng <richard120310@...il.com>
To: Brian Ochoa <brianeochoa@...il.com>
Cc: tglx@...utronix.de, mingo@...hat.com, bp@...en8.de,
	dave.hansen@...ux.intel.com, hpa@...or.com, corbet@....net,
	x86@...nel.org, linux-kernel@...r.kernel.org,
	linux-doc@...r.kernel.org, skhan@...uxfoundation.org,
	linux-kernel-mentees@...ts.linux.dev
Subject: Re: [PATCH] docs: arch/x86/sva: Fix two grammar errors under
 Background and FAQ

On Mon, Feb 10, 2025 at 09:50:54PM -0500, Brian Ochoa wrote:
> - Insert missing "to" to a sentence under Background
> - Insert missing "an" to a sentence under FAQ
> 
> Signed-off-by: Brian Ochoa <brianeochoa@...il.com>
> ---
>  Documentation/arch/x86/sva.rst | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/arch/x86/sva.rst b/Documentation/arch/x86/sva.rst
> index 33cb05005982..6a759984d471 100644
> --- a/Documentation/arch/x86/sva.rst
> +++ b/Documentation/arch/x86/sva.rst
> @@ -25,7 +25,7 @@ to cache translations for virtual addresses. The IOMMU driver uses the
>  mmu_notifier() support to keep the device TLB cache and the CPU cache in
>  sync. When an ATS lookup fails for a virtual address, the device should
>  use the PRI in order to request the virtual address to be paged into the
> -CPU page tables. The device must use ATS again in order the fetch the
> +CPU page tables. The device must use ATS again in order to fetch the
>  translation before use.
>  
>  Shared Hardware Workqueues
> @@ -216,7 +216,7 @@ submitting work and processing completions.
>  
>  Single Root I/O Virtualization (SR-IOV) focuses on providing independent
>  hardware interfaces for virtualizing hardware. Hence, it's required to be
> -almost fully functional interface to software supporting the traditional
> +an almost fully functional interface to software supporting the traditional
>  BARs, space for interrupts via MSI-X, its own register layout.
>  Virtual Functions (VFs) are assisted by the Physical Function (PF)
>  driver.
> -- 
> 2.34.1
> 
>

Hello Brian,

It looks good to me, though the commit message is kinda redundant and
confusing.

> - Insert missing "to" to a sentence under Background
> - Insert missing "an" to a sentence under FAQ

"a sentence" doesn't really help us understand which sentence you are
refering to, use "insert" here is kind of weird to me, too. Maybe
something like the following will be more direct

- Correct "in order" to "in order to"
- Append missing quantifier

What do you think?

Best regards,
I Hsin Cheng