From: Jonathan Corbet <corbet@lwn.net>
To: Gregory Price <gourry@gourry.net>, linux-cxl@vger.kernel.org
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
kernel-team@meta.com, dave@stgolabs.net,
jonathan.cameron@huawei.com, dave.jiang@intel.com,
alison.schofield@intel.com, vishal.l.verma@intel.com,
ira.weiny@intel.com, dan.j.williams@intel.com
Subject: Re: [RFC PATCH 02/17] cxl: docs/devices - device reference and uefi placeholder
Date: Wed, 30 Apr 2025 06:32:27 -0600 [thread overview]
Message-ID: <87o6wdltic.fsf@trenco.lwn.net> (raw)
In-Reply-To: <20250430001224.1028656-3-gourry@gourry.net>
Gregory Price <gourry@gourry.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@gourry.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
next prev parent reply other threads:[~2025-04-30 12:32 UTC|newest]
Thread overview: 20+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-04-30 0:12 [RFC PATCH 00/17] CXL Boot to Bash Documentation Gregory Price
2025-04-30 0:12 ` [RFC PATCH 01/17] cxl: update documentation structure in prep for new docs Gregory Price
2025-04-30 0:12 ` [RFC PATCH 02/17] cxl: docs/devices - device reference and uefi placeholder Gregory Price
2025-04-30 12:32 ` Jonathan Corbet [this message]
2025-04-30 14:08 ` Gregory Price
2025-04-30 0:12 ` [RFC PATCH 03/17] cxl: docs/platform/bios-and-efi documentation Gregory Price
2025-04-30 0:12 ` [RFC PATCH 04/17] cxl: docs/platform/acpi reference documentation Gregory Price
2025-04-30 0:12 ` [RFC PATCH 05/17] cxl: docs/platform/example-configs documentation Gregory Price
2025-04-30 0:12 ` [RFC PATCH 06/17] cxl: docs/linux - overview Gregory Price
2025-04-30 0:12 ` [RFC PATCH 07/17] cxl: docs/linux - early boot configuration Gregory Price
2025-04-30 0:12 ` [RFC PATCH 08/17] cxl: docs/linux - add cxl-driver theory of operation Gregory Price
2025-04-30 0:12 ` [RFC PATCH 09/17] cxl: docs/linux/cxl-driver - add example configurations Gregory Price
2025-04-30 0:12 ` [RFC PATCH 10/17] cxl: docs/linux/dax-driver documentation Gregory Price
2025-04-30 0:12 ` [RFC PATCH 11/17] cxl: docs/linux/memory-hotplug Gregory Price
2025-04-30 0:12 ` [RFC PATCH 12/17] cxl: docs/allocation/dax Gregory Price
2025-04-30 0:12 ` [RFC PATCH 13/17] cxl: docs/allocation/page-allocator Gregory Price
2025-04-30 0:12 ` [RFC PATCH 14/17] cxl: docs/allocation/reclaim Gregory Price
2025-04-30 0:12 ` [RFC PATCH 15/17] cxl: docs/allocation/hugepages Gregory Price
2025-04-30 0:12 ` [RFC PATCH 16/17] cxl: docs/allocation/tiering Gregory Price
2025-04-30 0:12 ` [RFC PATCH 17/17] cxl: docs/use-cases Gregory Price
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=87o6wdltic.fsf@trenco.lwn.net \
--to=corbet@lwn.net \
--cc=alison.schofield@intel.com \
--cc=dan.j.williams@intel.com \
--cc=dave.jiang@intel.com \
--cc=dave@stgolabs.net \
--cc=gourry@gourry.net \
--cc=ira.weiny@intel.com \
--cc=jonathan.cameron@huawei.com \
--cc=kernel-team@meta.com \
--cc=linux-cxl@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=vishal.l.verma@intel.com \
/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