[PATCH] cxl: docs/devices Fix typos and clarify wording in device-types.rst

[PATCH] cxl: docs/devices Fix typos and clarify wording in device-types.rst

[Alok Tiwari]

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 hosts" in MLD description

These changes improve readability and enhance the documentation quality.

Signed-off-by: Alok Tiwari <alok.a.tiwari@oracle.com>
---
 Documentation/driver-api/cxl/devices/device-types.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/Documentation/driver-api/cxl/devices/device-types.rst b/Documentation/driver-api/cxl/devices/device-types.rst
index f5e4330c1cfe..401c463af3ba 100644
--- a/Documentation/driver-api/cxl/devices/device-types.rst
+++ b/Documentation/driver-api/cxl/devices/device-types.rst
@@ -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 hosts.
 
 A Single-Headed Device exposes only a single physical connection.
 
-- 
2.47.1

Re: [PATCH] cxl: docs/devices Fix typos and clarify wording in device-types.rst

[Gregory Price]

On Sun, Jun 15, 2025 at 11:07:32PM -0700, Alok Tiwari wrote:
>  Documentation/driver-api/cxl/devices/device-types.rst | 10 +++++-----
>  1 file changed, 5 insertions(+), 5 deletions(-)
> 
...
>  
>  A Multi-Logical Device (MLD) is a device which may present multiple devices
> -to one or more devices.
> +to one or more hosts.

This is subtly incorrect.

A *Multi-Headed* MLD presents one or more devices to one or more hosts.

A *Multi-logical Device* presents one or more devices to one or more
upstream devices (such as a switch).

You can have a Single-Headed Multi-Logical Device that presents 2
"Logical Devices" to a single upstream device (host or switch).

So please change "one or more hosts" to "one or more upstream devices".


With that change you may add

Reviewed-by: Gregory Price <gourry@gourry.net>

~Gregory

Re: [PATCH] cxl: docs/devices Fix typos and clarify wording in device-types.rst

[Dave Jiang]

On 6/16/25 10:27 AM, Gregory Price wrote:
> On Sun, Jun 15, 2025 at 11:07:32PM -0700, Alok Tiwari wrote:
>>  Documentation/driver-api/cxl/devices/device-types.rst | 10 +++++-----
>>  1 file changed, 5 insertions(+), 5 deletions(-)
>>
> ...
>>  
>>  A Multi-Logical Device (MLD) is a device which may present multiple devices
>> -to one or more devices.
>> +to one or more hosts.
> 
> This is subtly incorrect.
> 
> A *Multi-Headed* MLD presents one or more devices to one or more hosts.
> 
> A *Multi-logical Device* presents one or more devices to one or more
> upstream devices (such as a switch).
> 
> You can have a Single-Headed Multi-Logical Device that presents 2
> "Logical Devices" to a single upstream device (host or switch).
> 
> So please change "one or more hosts" to "one or more upstream devices".
> 
> 
> With that change you may add
> 
> Reviewed-by: Gregory Price <gourry@gourry.net>

I fixed it up with your suggestion and applied to cxl/next. Please check and make sure the fix is correct. Thanks!

> 
> ~Gregory

Re: [PATCH] cxl: docs/devices Fix typos and clarify wording in device-types.rst

[Gregory Price]

On Mon, Jun 16, 2025 at 03:32:44PM -0700, Dave Jiang wrote:
> > With that change you may add
> > 
> > Reviewed-by: Gregory Price <gourry@gourry.net>
> 
> I fixed it up with your suggestion and applied to cxl/next. Please check and make sure the fix is correct. Thanks!

lgtm