Linux CXL
 help / color / mirror / Atom feed
From: sashiko-bot@kernel.org
To: alucerop@amd.com, linux-cxl@vger.kernel.org
Subject: Re: [RFC 3/3] Documentation/cxl: add document about Type2 binding and unbinding
Date: Wed, 18 Nov 2026 18:04:50 +0000	[thread overview]
Message-ID: <sashiko-outbox-221722@kernel.org> (raw)
In-Reply-To: <20261118191431.21781-4-alucerop@amd.com>

Thank you for your contribution! Sashiko AI review found 2 potential
issues to consider:
- [Low] Documentation/cxl: missing toctree entry for
  cxl_type2_objects_unwinding.rst
- [Low] Documentation/cxl: broken RST list numbering and literal blocks
  in type2 doc
--

commit b833f3f32d3c092128799e7d5375466321b53bec
Author: Alejandro Lucero <alucerop@amd.com>

Documentation/cxl: add document about Type2 binding and unbinding

This commit adds documentation describing CXL Type 2 device chain creation
and unwinding across devres and explicit unbind paths.

> diff --git a/Documentation/driver-api/cxl/type2/cxl_type2_objects_unwinding.rst b/Documentation/driver-api/cxl/type2/cxl_type2_objects_unwinding.rst
> new file mode 100644
> index 0000000000000..873f95d9c202b
> --- /dev/null
> +++ b/Documentation/driver-api/cxl/type2/cxl_type2_objects_unwinding.rst
> @@ -0,0 +1,102 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +
> +=====================================
> +Compute Express Link: Type2 unwinding
> +=====================================

[Severity: Low]
Should type2/cxl_type2_objects_unwinding be added to a toctree in
Documentation/driver-api/cxl/index.rst?  Without a toctree reference, make
htmldocs emits a "WARNING: document isn't included in any toctree" warning
and leaves this page unlinked from the CXL documentation index.

> +
> +The CXL subsystem relies on the linux kernel device abstraction for representing
> +the different componentes building up the subsystem itself. The core or root

[ ... ]

> + 1) The pci device owning the Type2 CXL "device" unbinds from its driver.
> + 2) The type2 driver is removed triggering the pci device unbinding.
> + 3) The cxl memdev is unbound from the cxl mem driver through sysfs.
> + 4) The cxl endpoint port is unbound from the cxl port driver through systfs.
> + 5) The cxl_region is unbound from the cxl region driver through sysfs.
> + 8) Root port linked to the device is unbound frmo the cxl port through sysfs.
> + 9) cxl acpi kernel module is removed.

[ ... ]

> +Visualizing the different unwinding cases
> +=========================================
> +
> +For helping with the debugging and/or understanding of current Type2, or even
> +Type3 devices, unwinding some tracepoints are available for enabling them all:
> +
> +
> +   # echo 1 > /sys/kernel/debug/tracing/events/cxl_unwinding/enable
> +
> +or individually as for example:
> +
> +   # echo 1 > /sys/kernel/debug/tracing/events/cxl_unwinding/cxl_memdev_release/enable
> +
> +	or
> +
> +   # echo "cxl_unwinding:cxl_memdev_release" > /sys/kernel/debug/tracing/set_event

[Severity: Low]
The numbered list jumps from 5) to 8) and 9) without a blank line, which
causes Sphinx/Docutils to fold items 8) and 9) into item 5) as
continuation text rather than separate list entries.

In the tracepoint section, the lines introducing the shell commands end
with ":" instead of "::", and "or" is indented with a tab while the
commands use three spaces, so Sphinx renders them as nested blockquotes
instead of literal code blocks.

There are also a few typos in the text: "componentes" ("components"),
"systfs" ("sysfs"), and "frmo" ("from").

-- 
Sashiko AI review · https://sashiko.dev/#/patchset/20261118191431.21781-2-alucerop@amd.com?part=3

  reply	other threads:[~2026-11-18 18:04 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-18 19:14 [RFC 0/3] Type2 unwinding ordering change alucerop
2026-11-18 19:14 ` [RFC 1/3] cxl: add tracepoints to the unwinding code path alucerop
2026-11-18 18:00   ` sashiko-bot
2026-11-18 19:14 ` [RFC 2/3] cxl: make explicit removal of endpoint and decoder for Type2 alucerop
2026-11-18 18:09   ` sashiko-bot
2026-11-18 19:14 ` [RFC 3/3] Documentation/cxl: add document about Type2 binding and unbinding alucerop
2026-11-18 18:04   ` sashiko-bot [this message]
2026-11-18 23:39 ` [RFC 0/3] Type2 unwinding ordering change Dave Jiang
2026-11-19  8:13   ` Lucero Palau, Alejandro
2026-11-19 10:00   ` Lucero Palau, Alejandro

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=sashiko-outbox-221722@kernel.org \
    --to=sashiko-bot@kernel.org \
    --cc=alucerop@amd.com \
    --cc=linux-cxl@vger.kernel.org \
    --cc=sashiko-reviews@lists.linux.dev \
    /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