linux-kernel - Re: [PATCH v2 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] [day] [month] [year] [list]

Message-ID: <aFuYYwceVvdc896_@archie.me>
Date: Wed, 25 Jun 2025 13:34:11 +0700
From: Bagas Sanjaya <bagasdotme@...il.com>
To: Alok Tiwari <alok.a.tiwari@...cle.com>, linux-nvme@...ts.infradead.org,
	rdunlap@...radead.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 v2 5/5] docs: nvme: fix grammar in
 nvme-pci-endpoint-target.rst

On Tue, Jun 24, 2025 at 09:16:34PM -0700, Alok Tiwari wrote:
> diff --git a/Documentation/nvme/nvme-pci-endpoint-target.rst b/Documentation/nvme/nvme-pci-endpoint-target.rst
> index b699595d1762b..2f75c8a267de5 100644
> --- a/Documentation/nvme/nvme-pci-endpoint-target.rst
> +++ b/Documentation/nvme/nvme-pci-endpoint-target.rst
> @@ -6,20 +6,20 @@ NVMe PCI Endpoint Function Target
>  
>  :Author: Damien Le Moal <dlemoal@...nel.org>
>  
> -The NVMe PCI endpoint function target driver implements a NVMe PCIe controller
> -using a NVMe fabrics target controller configured with the PCI transport type.
> +The NVMe PCI endpoint function target driver implements an NVMe PCIe controller
> +using an NVMe fabrics target controller configured with the PCI transport type.
>  
>  Overview
>  ========
>  
> -The NVMe PCI endpoint function target driver allows exposing a NVMe target
> +The NVMe PCI endpoint function target driver allows exposing an NVMe target
>  controller over a PCIe link, thus implementing an NVMe PCIe device similar to a
>  regular M.2 SSD. The target controller is created in the same manner as when
>  using NVMe over fabrics: the controller represents the interface to an NVMe
>  subsystem using a port. The port transfer type must be configured to be
>  "pci". The subsystem can be configured to have namespaces backed by regular
>  files or block devices, or can use NVMe passthrough to expose to the PCI host an
> -existing physical NVMe device or a NVMe fabrics host controller (e.g. a NVMe TCP
> +existing physical NVMe device or an NVMe fabrics host controller (e.g. a NVMe TCP
>  host controller).
>  
>  The NVMe PCI endpoint function target driver relies as much as possible on the
> @@ -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
> +-----------------------------------
>  
> -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,8 +234,8 @@ 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
> +------------------------------------
>  
>  With the NVMe target subsystem and port ready for use, the NVMe PCI endpoint
>  device can now be created and enabled. The NVMe PCI endpoint target driver
> @@ -303,7 +303,7 @@ device controller::
>  
>          nvmet_pci_epf nvmet_pci_epf.0: Enabling controller
>  
> -On the host side, the NVMe PCI endpoint function target device will is
> +On the host side, the NVMe PCI endpoint function target device is
>  discoverable as a PCI device, with the vendor ID and device ID as configured::
>  
>          # lspci -n

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@...il.com>

-- 
An old man doll... just what I always wanted! - Clara

Download attachment "signature.asc" of type "application/pgp-signature" (229 bytes)