]> git.ipfire.org Git - thirdparty/kernel/linux.git/commitdiff
cxl: docs/devices Fix typos and clarify wording in device-types.rst
authorAlok Tiwari <alok.a.tiwari@oracle.com>
Mon, 16 Jun 2025 06:07:32 +0000 (23:07 -0700)
committerDave Jiang <dave.jiang@intel.com>
Mon, 30 Jun 2025 23:36:06 +0000 (16:36 -0700)
Fix several typos and improve comment clarity in the CXL device types
docs:
 "w/" replaced with "with"
 "sill" -> "still"
 "The allows" -> "This allows"
 "capacity" corrected to "capable"
 "more devices" corrected to "more upstream devices" in MLD description

These changes improve readability and enhance the documentation quality.

[ dj: Fix up "one or more hosts" to "one or more upstream devices" from
      Gregory ]

Signed-off-by: Alok Tiwari <alok.a.tiwari@oracle.com>
Reviewed-by: Gregory Price <gourry@gourry.net>
Link: https://patch.msgid.link/20250616060737.1645393-1-alok.a.tiwari@oracle.com
Signed-off-by: Dave Jiang <dave.jiang@intel.com>
Documentation/driver-api/cxl/devices/device-types.rst

index f5e4330c1cfedde0111e1ef3e262235e6277f043..923f5d89bc044a927caab521550ac439d791b7d3 100644 (file)
@@ -63,13 +63,13 @@ A Type-2 CXL Device:
 
 * Supports cxl.io, cxl.cache, and cxl.mem protocols
 * Optionally implements coherent cache and Host-Managed Device Memory
-* Is typically an accelerator device w/ high bandwidth memory.
+* Is typically an accelerator device with high bandwidth memory.
 
 The primary difference between a type-1 and type-2 device is the presence
 of host-managed device memory, which allows the device to operate on a
-local memory bank - while the CPU sill has coherent DMA to the same memory.
+local memory bank - while the CPU still has coherent DMA to the same memory.
 
-The allows things like GPUs to expose their memory via DAX devices or file
+This allows things like GPUs to expose their memory via DAX devices or file
 descriptors, allows drivers and programs direct access to device memory
 rather than use block-transfer semantics.
 
@@ -89,7 +89,7 @@ basic coherent DMA.
 Switch
 ------
 
-A CXL switch is a device capacity of routing any CXL (and by extension, PCIe)
+A CXL switch is a device capable of routing any CXL (and by extension, PCIe)
 protocol between an upstream, downstream, or peer devices.  Many devices, such
 as Multi-Logical Devices, imply the presence of switching in some manner.
 
@@ -103,7 +103,7 @@ A Single-Logical Device (SLD) is a device which presents a single device to
 one or more heads.
 
 A Multi-Logical Device (MLD) is a device which may present multiple devices
-to one or more devices.
+to one or more upstream devices.
 
 A Single-Headed Device exposes only a single physical connection.