linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Randy Dunlap <rdunlap@infradead.org>
To: Alok Tiwari <alok.a.tiwari@oracle.com>,
	linux-nvme@lists.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 5/5] docs: nvme: fix grammar in nvme-pci-endpoint-target.rst
Date: Mon, 23 Jun 2025 13:39:03 -0700	[thread overview]
Message-ID: <e2b0e9fc-c1dc-4f2e-9a6d-c92d25f28fed@infradead.org> (raw)
In-Reply-To: <20250623064036.4187788-6-alok.a.tiwari@oracle.com>

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@oracle.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@infradead.org>

Thanks.
-- 
~Randy

  reply	other threads:[~2025-06-23 20:39 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-06-23  6:40 [PATCH 1/5] nvme: Fix multiple spelling and grammar issues in host drivers Alok Tiwari
2025-06-23  6:40 ` [PATCH 2/5] nvme: Fix incorrect variable in io cqes error message Alok Tiwari
2025-06-23 20:44   ` Randy Dunlap
2025-06-23  6:40 ` [PATCH 3/5] nvmet: Remove redundant assignment of error code in nvmet_ns_enable() Alok Tiwari
2025-06-23 20:45   ` Randy Dunlap
2025-06-23  6:40 ` [PATCH 4/5] nvme: Fix typo in status code constant for self-test in progress Alok Tiwari
2025-06-23 20:46   ` Randy Dunlap
2025-06-23  6:40 ` [PATCH 5/5] docs: nvme: fix grammar in nvme-pci-endpoint-target.rst Alok Tiwari
2025-06-23 20:39   ` Randy Dunlap [this message]
2025-06-23 20:44 ` [PATCH 1/5] nvme: Fix multiple spelling and grammar issues in host drivers Randy Dunlap

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=e2b0e9fc-c1dc-4f2e-9a6d-c92d25f28fed@infradead.org \
    --to=rdunlap@infradead.org \
    --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=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;
as well as URLs for NNTP newsgroup(s).