linux-kernel - Re: [PATCH 5/5] docs: nvme: fix grammar in nvme-pci-endpoint-target.rst

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: <e2b0e9fc-c1dc-4f2e-9a6d-c92d25f28fed@infradead.org>
Date: Mon, 23 Jun 2025 13:39:03 -0700
From: Randy Dunlap <rdunlap@...radead.org>
To: Alok Tiwari <alok.a.tiwari@...cle.com>, linux-nvme@...ts.infradead.org,
 kbusch@...nel.org, axboe@...nel.dk, hch@....de, sagi@...mberg.me,
 kch@...dia.com, nilay@...ux.ibm.com, corbet@....net
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH 5/5] docs: nvme: fix grammar in
 nvme-pci-endpoint-target.rst

Hi,

On 6/22/25 11:40 PM, Alok Tiwari wrote:
> Notable changes:
> Use "an NVMe" instead of "a NVMe" throughout the document
> Fix incorrect phrasing such as "will is discoverable" -> "is
> discoverable"
> Ensure consistent and proper article usage for clarity.
> 
> Signed-off-by: Alok Tiwari <alok.a.tiwari@...cle.com>
> ---
>  Documentation/nvme/nvme-pci-endpoint-target.rst | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/nvme/nvme-pci-endpoint-target.rst b/Documentation/nvme/nvme-pci-endpoint-target.rst
> index b699595d1762b..48f3b7f685945 100644
> --- a/Documentation/nvme/nvme-pci-endpoint-target.rst
> +++ b/Documentation/nvme/nvme-pci-endpoint-target.rst

[snip]

> @@ -181,10 +181,10 @@ Creating an NVMe endpoint device is a two step process. First, an NVMe target
>  subsystem and port must be defined. Second, the NVMe PCI endpoint device must
>  be setup and bound to the subsystem and port created.
>  
> -Creating a NVMe Subsystem and Port
> +Creating an NVMe Subsystem and Port
>  ----------------------------------

The underline needs to be extended one more character.

>  
> -Details about how to configure a NVMe target subsystem and port are outside the
> +Details about how to configure an NVMe target subsystem and port are outside the
>  scope of this document. The following only provides a simple example of a port
>  and subsystem with a single namespace backed by a null_blk device.
>  
> @@ -234,7 +234,7 @@ Finally, create the target port and link it to the subsystem::
>          # ln -s /sys/kernel/config/nvmet/subsystems/nvmepf.0.nqn \
>                  /sys/kernel/config/nvmet/ports/1/subsystems/nvmepf.0.nqn
>  
> -Creating a NVMe PCI Endpoint Device
> +Creating an NVMe PCI Endpoint Device
>  -----------------------------------

Same here.

>  
>  With the NVMe target subsystem and port ready for use, the NVMe PCI endpoint

With those changes made, you can add:
Reviewed-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.
-- 
~Randy