[PATCH] cxl/Documentation: Remove 'mixed' from sysfs mode doc

Ira Weiny posted 1 patch 9 months, 3 weeks ago
Documentation/ABI/testing/sysfs-bus-cxl | 15 +++++++--------
1 file changed, 7 insertions(+), 8 deletions(-)
[PATCH] cxl/Documentation: Remove 'mixed' from sysfs mode doc
Posted by Ira Weiny 9 months, 3 weeks ago
Commit 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")
removed the mixed mode.

Remove it from the sysfs documentation.

Fixes: 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")
Cc: Dan Williams <dan.j.williams@intel.com>
Signed-off-by: Ira Weiny <ira.weiny@intel.com>
---
 Documentation/ABI/testing/sysfs-bus-cxl | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
index 3f5627a1210a16aca7c18d17131a56491048a0c2..3ba551ed10e29f33b9eb873bab9b542c8afb66f0 100644
--- a/Documentation/ABI/testing/sysfs-bus-cxl
+++ b/Documentation/ABI/testing/sysfs-bus-cxl
@@ -321,14 +321,13 @@ KernelVersion:	v6.0
 Contact:	linux-cxl@vger.kernel.org
 Description:
 		(RW) When a CXL decoder is of devtype "cxl_decoder_endpoint" it
-		translates from a host physical address range, to a device local
-		address range. Device-local address ranges are further split
-		into a 'ram' (volatile memory) range and 'pmem' (persistent
-		memory) range. The 'mode' attribute emits one of 'ram', 'pmem',
-		'mixed', or 'none'. The 'mixed' indication is for error cases
-		when a decoder straddles the volatile/persistent partition
-		boundary, and 'none' indicates the decoder is not actively
-		decoding, or no DPA allocation policy has been set.
+		translates from a host physical address range, to a device
+		local address range. Device-local address ranges are further
+		split into a 'ram' (volatile memory) range and 'pmem'
+		(persistent memory) range. The 'mode' attribute emits one of
+		'ram', 'pmem', or 'none'. The 'none' indicates the decoder is
+		not actively decoding, or no DPA allocation policy has been
+		set.
 
 		'mode' can be written, when the decoder is in the 'disabled'
 		state, with either 'ram' or 'pmem' to set the boundaries for the

---
base-commit: 8760c1c0bf7eee63a56b5f9edb42d93737a6a378
change-id: 20250224-remove-mixed-sysfs-e3baa7616bcc

Best regards,
-- 
Ira Weiny <ira.weiny@intel.com>
Re: [PATCH] cxl/Documentation: Remove 'mixed' from sysfs mode doc
Posted by Dave Jiang 9 months, 2 weeks ago

On 2/24/25 11:29 AM, Ira Weiny wrote:
> Commit 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")
> removed the mixed mode.
> 
> Remove it from the sysfs documentation.
> 
> Fixes: 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")
> Cc: Dan Williams <dan.j.williams@intel.com>
> Signed-off-by: Ira Weiny <ira.weiny@intel.com>

Applied to cxl/next

> ---
>  Documentation/ABI/testing/sysfs-bus-cxl | 15 +++++++--------
>  1 file changed, 7 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
> index 3f5627a1210a16aca7c18d17131a56491048a0c2..3ba551ed10e29f33b9eb873bab9b542c8afb66f0 100644
> --- a/Documentation/ABI/testing/sysfs-bus-cxl
> +++ b/Documentation/ABI/testing/sysfs-bus-cxl
> @@ -321,14 +321,13 @@ KernelVersion:	v6.0
>  Contact:	linux-cxl@vger.kernel.org
>  Description:
>  		(RW) When a CXL decoder is of devtype "cxl_decoder_endpoint" it
> -		translates from a host physical address range, to a device local
> -		address range. Device-local address ranges are further split
> -		into a 'ram' (volatile memory) range and 'pmem' (persistent
> -		memory) range. The 'mode' attribute emits one of 'ram', 'pmem',
> -		'mixed', or 'none'. The 'mixed' indication is for error cases
> -		when a decoder straddles the volatile/persistent partition
> -		boundary, and 'none' indicates the decoder is not actively
> -		decoding, or no DPA allocation policy has been set.
> +		translates from a host physical address range, to a device
> +		local address range. Device-local address ranges are further
> +		split into a 'ram' (volatile memory) range and 'pmem'
> +		(persistent memory) range. The 'mode' attribute emits one of
> +		'ram', 'pmem', or 'none'. The 'none' indicates the decoder is
> +		not actively decoding, or no DPA allocation policy has been
> +		set.
>  
>  		'mode' can be written, when the decoder is in the 'disabled'
>  		state, with either 'ram' or 'pmem' to set the boundaries for the
> 
> ---
> base-commit: 8760c1c0bf7eee63a56b5f9edb42d93737a6a378
> change-id: 20250224-remove-mixed-sysfs-e3baa7616bcc
> 
> Best regards,
Re: [PATCH] cxl/Documentation: Remove 'mixed' from sysfs mode doc
Posted by Jonathan Cameron 9 months, 2 weeks ago
On Mon, 24 Feb 2025 12:29:29 -0600
Ira Weiny <ira.weiny@intel.com> wrote:

> Commit 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")
> removed the mixed mode.
> 
> Remove it from the sysfs documentation.
> 
> Fixes: 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")
> Cc: Dan Williams <dan.j.williams@intel.com>
> Signed-off-by: Ira Weiny <ira.weiny@intel.com>
Would be nice to put wrap back in text we aren't changing
as creates unnecessary churn / staring at text to see if
it is different...

Either way
Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>

> ---
>  Documentation/ABI/testing/sysfs-bus-cxl | 15 +++++++--------
>  1 file changed, 7 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
> index 3f5627a1210a16aca7c18d17131a56491048a0c2..3ba551ed10e29f33b9eb873bab9b542c8afb66f0 100644
> --- a/Documentation/ABI/testing/sysfs-bus-cxl
> +++ b/Documentation/ABI/testing/sysfs-bus-cxl
> @@ -321,14 +321,13 @@ KernelVersion:	v6.0
>  Contact:	linux-cxl@vger.kernel.org
>  Description:
>  		(RW) When a CXL decoder is of devtype "cxl_decoder_endpoint" it
> -		translates from a host physical address range, to a device local
> -		address range. Device-local address ranges are further split
> -		into a 'ram' (volatile memory) range and 'pmem' (persistent
> -		memory) range. The 'mode' attribute emits one of 'ram', 'pmem',
> -		'mixed', or 'none'. The 'mixed' indication is for error cases
> -		when a decoder straddles the volatile/persistent partition
> -		boundary, and 'none' indicates the decoder is not actively
> -		decoding, or no DPA allocation policy has been set.
> +		translates from a host physical address range, to a device

Ideally avoid the extra diff from wrap changes in text that isn't changing.


> +		local address range. Device-local address ranges are further
> +		split into a 'ram' (volatile memory) range and 'pmem'
> +		(persistent memory) range. The 'mode' attribute emits one of

I think actual changes only happen here.

> +		'ram', 'pmem', or 'none'. The 'none' indicates the decoder is
> +		not actively decoding, or no DPA allocation policy has been
> +		set.
>  
>  		'mode' can be written, when the decoder is in the 'disabled'
>  		state, with either 'ram' or 'pmem' to set the boundaries for the
> 
> ---
> base-commit: 8760c1c0bf7eee63a56b5f9edb42d93737a6a378
> change-id: 20250224-remove-mixed-sysfs-e3baa7616bcc
> 
> Best regards,
Re: [PATCH] cxl/Documentation: Remove 'mixed' from sysfs mode doc
Posted by Ira Weiny 9 months, 2 weeks ago
Jonathan Cameron wrote:
> On Mon, 24 Feb 2025 12:29:29 -0600
> Ira Weiny <ira.weiny@intel.com> wrote:
> 
> > Commit 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")
> > removed the mixed mode.
> > 
> > Remove it from the sysfs documentation.
> > 
> > Fixes: 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")
> > Cc: Dan Williams <dan.j.williams@intel.com>
> > Signed-off-by: Ira Weiny <ira.weiny@intel.com>
> Would be nice to put wrap back in text we aren't changing
> as creates unnecessary churn / staring at text to see if
> it is different...

100% agree that the review-ability suffers.  But keeping the text
formatted in the file makes it easier to read.  In this case that might
not be as true but I'm just kind of particular when I format paragraphs...
:-/

I hope Dave will just take it.

Thanks,
Ira

> 
> Either way
> Reviewed-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> > ---
> >  Documentation/ABI/testing/sysfs-bus-cxl | 15 +++++++--------
> >  1 file changed, 7 insertions(+), 8 deletions(-)
> > 
> > diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
> > index 3f5627a1210a16aca7c18d17131a56491048a0c2..3ba551ed10e29f33b9eb873bab9b542c8afb66f0 100644
> > --- a/Documentation/ABI/testing/sysfs-bus-cxl
> > +++ b/Documentation/ABI/testing/sysfs-bus-cxl
> > @@ -321,14 +321,13 @@ KernelVersion:	v6.0
> >  Contact:	linux-cxl@vger.kernel.org
> >  Description:
> >  		(RW) When a CXL decoder is of devtype "cxl_decoder_endpoint" it
> > -		translates from a host physical address range, to a device local
> > -		address range. Device-local address ranges are further split
> > -		into a 'ram' (volatile memory) range and 'pmem' (persistent
> > -		memory) range. The 'mode' attribute emits one of 'ram', 'pmem',
> > -		'mixed', or 'none'. The 'mixed' indication is for error cases
> > -		when a decoder straddles the volatile/persistent partition
> > -		boundary, and 'none' indicates the decoder is not actively
> > -		decoding, or no DPA allocation policy has been set.
> > +		translates from a host physical address range, to a device
> 
> Ideally avoid the extra diff from wrap changes in text that isn't changing.
> 
> 
> > +		local address range. Device-local address ranges are further
> > +		split into a 'ram' (volatile memory) range and 'pmem'
> > +		(persistent memory) range. The 'mode' attribute emits one of
> 
> I think actual changes only happen here.
> 
> > +		'ram', 'pmem', or 'none'. The 'none' indicates the decoder is
> > +		not actively decoding, or no DPA allocation policy has been
> > +		set.
> >  
> >  		'mode' can be written, when the decoder is in the 'disabled'
> >  		state, with either 'ram' or 'pmem' to set the boundaries for the
> > 
> > ---
> > base-commit: 8760c1c0bf7eee63a56b5f9edb42d93737a6a378
> > change-id: 20250224-remove-mixed-sysfs-e3baa7616bcc
> > 
> > Best regards,
>
Re: [PATCH] cxl/Documentation: Remove 'mixed' from sysfs mode doc
Posted by Ira Weiny 9 months, 3 weeks ago
Ira Weiny wrote:
> Commit 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")
> removed the mixed mode.
> 
> Remove it from the sysfs documentation.
> 
> Fixes: 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")

I should not have added this fixes line since this patch is just in
cxl-next...

Dave please remove it before applying.
Ira
Re: [PATCH] cxl/Documentation: Remove 'mixed' from sysfs mode doc
Posted by Dave Jiang 9 months, 3 weeks ago

On 2/24/25 11:29 AM, Ira Weiny wrote:
> Commit 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")
> removed the mixed mode.
> 
> Remove it from the sysfs documentation.
> 
> Fixes: 188e9529a606 ("cxl: Remove the CXL_DECODER_MIXED mistake")
> Cc: Dan Williams <dan.j.williams@intel.com>
> Signed-off-by: Ira Weiny <ira.weiny@intel.com>

Reviewed-by: Dave Jiang <dave.jiang@intel.com>

> ---
>  Documentation/ABI/testing/sysfs-bus-cxl | 15 +++++++--------
>  1 file changed, 7 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-cxl b/Documentation/ABI/testing/sysfs-bus-cxl
> index 3f5627a1210a16aca7c18d17131a56491048a0c2..3ba551ed10e29f33b9eb873bab9b542c8afb66f0 100644
> --- a/Documentation/ABI/testing/sysfs-bus-cxl
> +++ b/Documentation/ABI/testing/sysfs-bus-cxl
> @@ -321,14 +321,13 @@ KernelVersion:	v6.0
>  Contact:	linux-cxl@vger.kernel.org
>  Description:
>  		(RW) When a CXL decoder is of devtype "cxl_decoder_endpoint" it
> -		translates from a host physical address range, to a device local
> -		address range. Device-local address ranges are further split
> -		into a 'ram' (volatile memory) range and 'pmem' (persistent
> -		memory) range. The 'mode' attribute emits one of 'ram', 'pmem',
> -		'mixed', or 'none'. The 'mixed' indication is for error cases
> -		when a decoder straddles the volatile/persistent partition
> -		boundary, and 'none' indicates the decoder is not actively
> -		decoding, or no DPA allocation policy has been set.
> +		translates from a host physical address range, to a device
> +		local address range. Device-local address ranges are further
> +		split into a 'ram' (volatile memory) range and 'pmem'
> +		(persistent memory) range. The 'mode' attribute emits one of
> +		'ram', 'pmem', or 'none'. The 'none' indicates the decoder is
> +		not actively decoding, or no DPA allocation policy has been
> +		set.
>  
>  		'mode' can be written, when the decoder is in the 'disabled'
>  		state, with either 'ram' or 'pmem' to set the boundaries for the
> 
> ---
> base-commit: 8760c1c0bf7eee63a56b5f9edb42d93737a6a378
> change-id: 20250224-remove-mixed-sysfs-e3baa7616bcc
> 
> Best regards,