linux-kernel - Re: [RFC PATCH 02/17] cxl: docs/devices - device reference and uefi placeholder

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <87o6wdltic.fsf@trenco.lwn.net>
Date: Wed, 30 Apr 2025 06:32:27 -0600
From: Jonathan Corbet <corbet@....net>
To: Gregory Price <gourry@...rry.net>, linux-cxl@...r.kernel.org
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 kernel-team@...a.com, dave@...olabs.net, jonathan.cameron@...wei.com,
 dave.jiang@...el.com, alison.schofield@...el.com,
 vishal.l.verma@...el.com, ira.weiny@...el.com, dan.j.williams@...el.com
Subject: Re: [RFC PATCH 02/17] cxl: docs/devices - device reference and uefi
 placeholder

Gregory Price <gourry@...rry.net> writes:

> Add a simple device primer sufficient to understand the theory
> of operation documentation.
>
> Add carve-out for CDAT with a TODO.
>
> Signed-off-by: Gregory Price <gourry@...rry.net>
> ---
>  .../driver-api/cxl/devices/device-types.rst   | 169 ++++++++++++++++++
>  Documentation/driver-api/cxl/devices/uefi.rst |   9 +
>  Documentation/driver-api/cxl/index.rst        |   2 +
>  3 files changed, 180 insertions(+)
>  create mode 100644 Documentation/driver-api/cxl/devices/device-types.rst
>  create mode 100644 Documentation/driver-api/cxl/devices/uefi.rst

I'm glad to see all this documentation!  One little nit...

> diff --git a/Documentation/driver-api/cxl/devices/device-types.rst b/Documentation/driver-api/cxl/devices/device-types.rst
> new file mode 100644
> index 000000000000..e8dd051c2c71
> --- /dev/null
> +++ b/Documentation/driver-api/cxl/devices/device-types.rst
> @@ -0,0 +1,169 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +Devices and Protocols
> +#####################

If you could stick with the section markup conventions we have
established in Documentation/doc-guide/sphinx.rst, I'd appreciate it.

Thanks,

jon