Skip to content

Commit 3be8ad8

Browse files
aloktiwaChristoph Hellwig
authored andcommitted
docs: nvme: fix grammar in nvme-pci-endpoint-target.rst
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 <[email protected]> Reviewed-by: Randy Dunlap <[email protected]> Reviewed-by: Chaitanya Kulkarni <[email protected]> Signed-off-by: Christoph Hellwig <[email protected]>
1 parent b5cd5f1 commit 3be8ad8

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

Documentation/nvme/nvme-pci-endpoint-target.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ NVMe PCI Endpoint Function Target
66

77
:Author: Damien Le Moal <[email protected]>
88

9-
The NVMe PCI endpoint function target driver implements a NVMe PCIe controller
10-
using a NVMe fabrics target controller configured with the PCI transport type.
9+
The NVMe PCI endpoint function target driver implements an NVMe PCIe controller
10+
using an NVMe fabrics target controller configured with the PCI transport type.
1111

1212
Overview
1313
========
1414

15-
The NVMe PCI endpoint function target driver allows exposing a NVMe target
15+
The NVMe PCI endpoint function target driver allows exposing an NVMe target
1616
controller over a PCIe link, thus implementing an NVMe PCIe device similar to a
1717
regular M.2 SSD. The target controller is created in the same manner as when
1818
using NVMe over fabrics: the controller represents the interface to an NVMe
1919
subsystem using a port. The port transfer type must be configured to be
2020
"pci". The subsystem can be configured to have namespaces backed by regular
2121
files or block devices, or can use NVMe passthrough to expose to the PCI host an
22-
existing physical NVMe device or a NVMe fabrics host controller (e.g. a NVMe TCP
23-
host controller).
22+
existing physical NVMe device or an NVMe fabrics host controller (e.g. a NVMe
23+
TCP host controller).
2424

2525
The NVMe PCI endpoint function target driver relies as much as possible on the
2626
NVMe target core code to parse and execute NVMe commands submitted by the PCIe
@@ -181,10 +181,10 @@ Creating an NVMe endpoint device is a two step process. First, an NVMe target
181181
subsystem and port must be defined. Second, the NVMe PCI endpoint device must
182182
be setup and bound to the subsystem and port created.
183183

184-
Creating a NVMe Subsystem and Port
185-
----------------------------------
184+
Creating an NVMe Subsystem and Port
185+
-----------------------------------
186186

187-
Details about how to configure a NVMe target subsystem and port are outside the
187+
Details about how to configure an NVMe target subsystem and port are outside the
188188
scope of this document. The following only provides a simple example of a port
189189
and subsystem with a single namespace backed by a null_blk device.
190190

@@ -234,8 +234,8 @@ Finally, create the target port and link it to the subsystem::
234234
# ln -s /sys/kernel/config/nvmet/subsystems/nvmepf.0.nqn \
235235
/sys/kernel/config/nvmet/ports/1/subsystems/nvmepf.0.nqn
236236

237-
Creating a NVMe PCI Endpoint Device
238-
-----------------------------------
237+
Creating an NVMe PCI Endpoint Device
238+
------------------------------------
239239

240240
With the NVMe target subsystem and port ready for use, the NVMe PCI endpoint
241241
device can now be created and enabled. The NVMe PCI endpoint target driver
@@ -303,7 +303,7 @@ device controller::
303303

304304
nvmet_pci_epf nvmet_pci_epf.0: Enabling controller
305305

306-
On the host side, the NVMe PCI endpoint function target device will is
306+
On the host side, the NVMe PCI endpoint function target device is
307307
discoverable as a PCI device, with the vendor ID and device ID as configured::
308308

309309
# lspci -n

0 commit comments

Comments
 (0)