[PATCH] cxl: Fix cross-reference in documentation and add deprecation warning

[PATCH] cxl: Fix cross-reference in documentation and add deprecation warning

[Andrew Donnellan]

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?
---
 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
-- 
2.48.1

Re: [PATCH] cxl: Fix cross-reference in documentation and add deprecation warning

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 542 bytes --]

On Wed, Feb 19, 2025 at 05:48:07PM +1100, 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.

Acked-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] cxl: Fix cross-reference in documentation and add deprecation warning

[Madhavan Srinivasan]

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