The Linux Kernel Mailing List
 help / color / mirror / Atom feed
From: Bagas Sanjaya <bagasdotme@gmail.com>
To: Alok Tiwari <alok.a.tiwari@oracle.com>,
	linux-nvme@lists.infradead.org, rdunlap@infradead.org,
	kbusch@kernel.org, axboe@kernel.dk, hch@lst.de, sagi@grimberg.me,
	kch@nvidia.com, nilay@linux.ibm.com, corbet@lwn.net
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 5/5] docs: nvme: fix grammar in nvme-pci-endpoint-target.rst
Date: Wed, 25 Jun 2025 13:34:11 +0700	[thread overview]
Message-ID: <aFuYYwceVvdc896_@archie.me> (raw)
In-Reply-To: <20250625041643.174110-6-alok.a.tiwari@oracle.com>

[-- Attachment #1: Type: text/plain, Size: 3554 bytes --]

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@kernel.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@gmail.com>

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

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

  reply	other threads:[~2025-06-25  6:34 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-25  4:16 [PATCH v2 0/5] nvme: typo and minor cleanup fixes across host and target driver Alok Tiwari
2025-06-25  4:16 ` [PATCH v2 1/5] nvme: Fix multiple spelling and grammar issues in host drivers Alok Tiwari
2025-06-25  4:16 ` [PATCH v2 2/5] nvme: Fix incorrect variable in io cqes error message Alok Tiwari
2025-06-25  4:16 ` [PATCH v2 3/5] nvmet: Remove redundant assignment of error code in nvmet_ns_enable() Alok Tiwari
2025-06-25  4:16 ` [PATCH v2 4/5] nvme: Fix typo in status code constant for self-test in progress Alok Tiwari
2025-06-25  4:16 ` [PATCH v2 5/5] docs: nvme: fix grammar in nvme-pci-endpoint-target.rst Alok Tiwari
2025-06-25  6:34   ` Bagas Sanjaya [this message]
2025-06-25  4:24 ` [PATCH v2 0/5] nvme: typo and minor cleanup fixes across host and target driver Chaitanya Kulkarni
2025-07-03 11:43 ` Christoph Hellwig

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aFuYYwceVvdc896_@archie.me \
    --to=bagasdotme@gmail.com \
    --cc=alok.a.tiwari@oracle.com \
    --cc=axboe@kernel.dk \
    --cc=corbet@lwn.net \
    --cc=hch@lst.de \
    --cc=kbusch@kernel.org \
    --cc=kch@nvidia.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-nvme@lists.infradead.org \
    --cc=nilay@linux.ibm.com \
    --cc=rdunlap@infradead.org \
    --cc=sagi@grimberg.me \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox