[PATCH v4 2/3] docs: ABI: sysfs-devices-soc: Fix swapped sample values

Matthew Maurer posted 3 patches 1 month, 1 week ago
[PATCH v4 2/3] docs: ABI: sysfs-devices-soc: Fix swapped sample values
Posted by Matthew Maurer 1 month, 1 week ago
The sample values for `family` and `machine` were swapped relative to
what the driver actually does, and doesn't match the field description.

Reviewed-by: Lee Jones <lee@kernel.org>
Signed-off-by: Matthew Maurer <mmaurer@google.com>
---
 Documentation/ABI/testing/sysfs-devices-soc | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-devices-soc b/Documentation/ABI/testing/sysfs-devices-soc
index 5269808ec35f8e2b18516556f886c77f5fac9401..cb6776a4afe02a76fe27ac6fc236babdc7865287 100644
--- a/Documentation/ABI/testing/sysfs-devices-soc
+++ b/Documentation/ABI/testing/sysfs-devices-soc
@@ -17,14 +17,14 @@ Date:		January 2012
 contact:	Lee Jones <lee@kernel.org>
 Description:
 		Read-only attribute common to all SoCs. Contains the SoC machine
-		name (e.g. Ux500).
+		name (e.g. DB8500).
 
 What:		/sys/devices/socX/family
 Date:		January 2012
 contact:	Lee Jones <lee@kernel.org>
 Description:
 		Read-only attribute common to all SoCs. Contains SoC family name
-		(e.g. DB8500).
+		(e.g. ux500).
 
 		On many of ARM based silicon with SMCCC v1.2+ compliant firmware
 		this will contain the JEDEC JEP106 manufacturer’s identification

-- 
2.52.0.351.gbe84eed79e-goog
Re: [PATCH v4 2/3] docs: ABI: sysfs-devices-soc: Fix swapped sample values
Posted by Danilo Krummrich 1 month, 1 week ago
On Fri Dec 26, 2025 at 9:17 PM CET, Matthew Maurer wrote:
> The sample values for `family` and `machine` were swapped relative to
> what the driver actually does, and doesn't match the field description.
>
> Reviewed-by: Lee Jones <lee@kernel.org>
> Signed-off-by: Matthew Maurer <mmaurer@google.com>

Applied to driver-core-linus, thanks!
Re: [PATCH v4 2/3] docs: ABI: sysfs-devices-soc: Fix swapped sample values
Posted by Danilo Krummrich 1 month, 1 week ago
On Fri Dec 26, 2025 at 9:17 PM CET, Matthew Maurer wrote:
> The sample values for `family` and `machine` were swapped relative to
> what the driver actually does, and doesn't match the field description.
>
> Reviewed-by: Lee Jones <lee@kernel.org>
> Signed-off-by: Matthew Maurer <mmaurer@google.com>

Fixes: da5a70f3519f ("Documentation: add information for new sysfs soc bus functionality")

> ---
>  Documentation/ABI/testing/sysfs-devices-soc | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/ABI/testing/sysfs-devices-soc b/Documentation/ABI/testing/sysfs-devices-soc
> index 5269808ec35f8e2b18516556f886c77f5fac9401..cb6776a4afe02a76fe27ac6fc236babdc7865287 100644
> --- a/Documentation/ABI/testing/sysfs-devices-soc
> +++ b/Documentation/ABI/testing/sysfs-devices-soc
> @@ -17,14 +17,14 @@ Date:		January 2012
>  contact:	Lee Jones <lee@kernel.org>
>  Description:
>  		Read-only attribute common to all SoCs. Contains the SoC machine
> -		name (e.g. Ux500).
> +		name (e.g. DB8500).
>  
>  What:		/sys/devices/socX/family
>  Date:		January 2012
>  contact:	Lee Jones <lee@kernel.org>
>  Description:
>  		Read-only attribute common to all SoCs. Contains SoC family name
> -		(e.g. DB8500).
> +		(e.g. ux500).

Is the change from "Ux500" to "ux500" intended?

(If not, no need to resend, I can fix it up on apply.)
Re: [PATCH v4 2/3] docs: ABI: sysfs-devices-soc: Fix swapped sample values
Posted by Matthew Maurer 1 month, 1 week ago
On Sun, Dec 28, 2025 at 10:12 AM Danilo Krummrich <dakr@kernel.org> wrote:
>
> On Fri Dec 26, 2025 at 9:17 PM CET, Matthew Maurer wrote:
> > The sample values for `family` and `machine` were swapped relative to
> > what the driver actually does, and doesn't match the field description.
> >
> > Reviewed-by: Lee Jones <lee@kernel.org>
> > Signed-off-by: Matthew Maurer <mmaurer@google.com>
>
> Fixes: da5a70f3519f ("Documentation: add information for new sysfs soc bus functionality")
>
> > ---
> >  Documentation/ABI/testing/sysfs-devices-soc | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> >
> > diff --git a/Documentation/ABI/testing/sysfs-devices-soc b/Documentation/ABI/testing/sysfs-devices-soc
> > index 5269808ec35f8e2b18516556f886c77f5fac9401..cb6776a4afe02a76fe27ac6fc236babdc7865287 100644
> > --- a/Documentation/ABI/testing/sysfs-devices-soc
> > +++ b/Documentation/ABI/testing/sysfs-devices-soc
> > @@ -17,14 +17,14 @@ Date:             January 2012
> >  contact:     Lee Jones <lee@kernel.org>
> >  Description:
> >               Read-only attribute common to all SoCs. Contains the SoC machine
> > -             name (e.g. Ux500).
> > +             name (e.g. DB8500).
> >
> >  What:                /sys/devices/socX/family
> >  Date:                January 2012
> >  contact:     Lee Jones <lee@kernel.org>
> >  Description:
> >               Read-only attribute common to all SoCs. Contains SoC family name
> > -             (e.g. DB8500).
> > +             (e.g. ux500).
>
> Is the change from "Ux500" to "ux500" intended?

Yes, the sample SoC being described in the documentation uses
"ux500"[1] for the family value.

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/drivers/soc/ux500/ux500-soc-id.c#n133

>
> (If not, no need to resend, I can fix it up on apply.)