From: Madhavan Srinivasan <maddy@linux.ibm.com>
To: Andrew Donnellan <ajd@linux.ibm.com>, linuxppc-dev@lists.ozlabs.org
Cc: fbarrat@linux.ibm.com, sfr@canb.auug.org.au,
linux-next@vger.kernel.org, mchehab+huawei@kernel.org,
corbet@lwn.net, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: Re: [PATCH] cxl: Fix cross-reference in documentation and add deprecation warning
Date: Wed, 19 Feb 2025 13:30:01 +0530 [thread overview]
Message-ID: <d5734fe3-813f-4c8b-9ead-3089d3af6274@linux.ibm.com> (raw)
In-Reply-To: <20250219064807.175107-1-ajd@linux.ibm.com>
On 2/19/25 12:18 PM, Andrew Donnellan wrote:
> commit 5731d41af924 ("cxl: Deprecate driver") labelled the cxl driver as
> deprecated and moved the ABI documentation to the obsolete/ subdirectory,
> but didn't update cxl.rst, causing a warning once ff7ff6eb4f809 ("docs:
> media: Allow creating cross-references for RC ABI") was merged.
>
> Fix the cross-reference, and also add a deprecation warning.
>
> Fixes: 5731d41af924 ("cxl: Deprecate driver")
> Reported-by: Bagas Sanjaya <bagasdotme@gmail.com>
> Signed-off-by: Andrew Donnellan <ajd@linux.ibm.com>
>
> ---
>
> Maddy: can we take this by powerpc-fixes?
Yes. Will take this via powerpc-fixes
Maddy
> ---
> Documentation/arch/powerpc/cxl.rst | 3 ++-
> 1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/arch/powerpc/cxl.rst b/Documentation/arch/powerpc/cxl.rst
> index d2d77057610e..778adda740d2 100644
> --- a/Documentation/arch/powerpc/cxl.rst
> +++ b/Documentation/arch/powerpc/cxl.rst
> @@ -18,6 +18,7 @@ Introduction
> both access system memory directly and with the same effective
> addresses.
>
> + **This driver is deprecated and will be removed in a future release.**
>
> Hardware overview
> =================
> @@ -453,7 +454,7 @@ Sysfs Class
>
> A cxl sysfs class is added under /sys/class/cxl to facilitate
> enumeration and tuning of the accelerators. Its layout is
> - described in Documentation/ABI/testing/sysfs-class-cxl
> + described in Documentation/ABI/obsolete/sysfs-class-cxl
>
>
> Udev rules
prev parent reply other threads:[~2025-02-19 8:00 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-02-19 6:48 [PATCH] cxl: Fix cross-reference in documentation and add deprecation warning Andrew Donnellan
2025-02-19 7:38 ` Bagas Sanjaya
2025-02-19 8:00 ` Madhavan Srinivasan [this message]
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=d5734fe3-813f-4c8b-9ead-3089d3af6274@linux.ibm.com \
--to=maddy@linux.ibm.com \
--cc=ajd@linux.ibm.com \
--cc=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=fbarrat@linux.ibm.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-next@vger.kernel.org \
--cc=linuxppc-dev@lists.ozlabs.org \
--cc=mchehab+huawei@kernel.org \
--cc=sfr@canb.auug.org.au \
/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;
as well as URLs for NNTP newsgroup(s).