2021-05-21 20:12:37

by Yanan Wang

[permalink] [raw]
Subject: [PATCH] Documentation: dt-bindings: Fix incorrect statement

It's found when reading the Doc.

In a SMP system, the hierarchy of CPUs now can be defined through
four not three entities (socket/cluster/core/thread), so correct
the statement to avoid possible confusion.

Since we are already there, also drop an extra space and tweak
the title alignment. No real context change at all.

Cc: Rob Herring <[email protected]>
Cc: Paul Walmsley <[email protected]>
Cc: Palmer Dabbelt <[email protected]>
Cc: Albert Ou <[email protected]>
Signed-off-by: Yanan Wang <[email protected]>
---
Documentation/devicetree/bindings/cpu/cpu-topology.txt | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/devicetree/bindings/cpu/cpu-topology.txt b/Documentation/devicetree/bindings/cpu/cpu-topology.txt
index 9bd530a35d14..8b23a98c283c 100644
--- a/Documentation/devicetree/bindings/cpu/cpu-topology.txt
+++ b/Documentation/devicetree/bindings/cpu/cpu-topology.txt
@@ -6,7 +6,7 @@ CPU topology binding description
1 - Introduction
===========================================

-In a SMP system, the hierarchy of CPUs is defined through three entities that
+In a SMP system, the hierarchy of CPUs is defined through four entities that
are used to describe the layout of physical CPUs in the system:

- socket
@@ -75,7 +75,7 @@ whose bindings are described in paragraph 3.

The nodes describing the CPU topology (socket/cluster/core/thread) can
only be defined within the cpu-map node and every core/thread in the
-system must be defined within the topology. Any other configuration is
+system must be defined within the topology. Any other configuration is
invalid and therefore must be ignored.

===========================================
@@ -91,9 +91,9 @@ cpu-map child nodes which do not share a common parent node can have the same
name (ie same number N as other cpu-map child nodes at different device tree
levels) since name uniqueness will be guaranteed by the device tree hierarchy.

-===========================================
+============================================
3 - socket/cluster/core/thread node bindings
-===========================================
+============================================

Bindings for socket/cluster/cpu/thread nodes are defined as follows:

--
2.19.1


2021-06-04 19:45:01

by Rob Herring

[permalink] [raw]
Subject: Re: [PATCH] Documentation: dt-bindings: Fix incorrect statement

On Fri, May 21, 2021 at 05:57:20PM +0800, Yanan Wang wrote:
> It's found when reading the Doc.

Please improve the subject so we have some clue as to what the change is
and what it applies to.

> In a SMP system, the hierarchy of CPUs now can be defined through
> four not three entities (socket/cluster/core/thread), so correct
> the statement to avoid possible confusion.
>
> Since we are already there, also drop an extra space and tweak
> the title alignment. No real context change at all.

Since already here, converting to schema would be preferred over trivial
fixes.

>
> Cc: Rob Herring <[email protected]>
> Cc: Paul Walmsley <[email protected]>
> Cc: Palmer Dabbelt <[email protected]>
> Cc: Albert Ou <[email protected]>
> Signed-off-by: Yanan Wang <[email protected]>
> ---
> Documentation/devicetree/bindings/cpu/cpu-topology.txt | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/devicetree/bindings/cpu/cpu-topology.txt b/Documentation/devicetree/bindings/cpu/cpu-topology.txt
> index 9bd530a35d14..8b23a98c283c 100644
> --- a/Documentation/devicetree/bindings/cpu/cpu-topology.txt
> +++ b/Documentation/devicetree/bindings/cpu/cpu-topology.txt
> @@ -6,7 +6,7 @@ CPU topology binding description
> 1 - Introduction
> ===========================================
>
> -In a SMP system, the hierarchy of CPUs is defined through three entities that
> +In a SMP system, the hierarchy of CPUs is defined through four entities that
> are used to describe the layout of physical CPUs in the system:
>
> - socket
> @@ -75,7 +75,7 @@ whose bindings are described in paragraph 3.
>
> The nodes describing the CPU topology (socket/cluster/core/thread) can
> only be defined within the cpu-map node and every core/thread in the
> -system must be defined within the topology. Any other configuration is
> +system must be defined within the topology. Any other configuration is
> invalid and therefore must be ignored.
>
> ===========================================
> @@ -91,9 +91,9 @@ cpu-map child nodes which do not share a common parent node can have the same
> name (ie same number N as other cpu-map child nodes at different device tree
> levels) since name uniqueness will be guaranteed by the device tree hierarchy.
>
> -===========================================
> +============================================
> 3 - socket/cluster/core/thread node bindings
> -===========================================
> +============================================
>
> Bindings for socket/cluster/cpu/thread nodes are defined as follows:
>
> --
> 2.19.1

2021-06-07 02:16:10

by Yanan Wang

[permalink] [raw]
Subject: Re: [PATCH] Documentation: dt-bindings: Fix incorrect statement



On 2021/6/5 3:41, Rob Herring wrote:
> On Fri, May 21, 2021 at 05:57:20PM +0800, Yanan Wang wrote:
>> It's found when reading the Doc.
> Please improve the subject so we have some clue as to what the change is
> and what it applies to.
>
Ok, I will improve the subject to make it more readable.
>> In a SMP system, the hierarchy of CPUs now can be defined through
>> four not three entities (socket/cluster/core/thread), so correct
>> the statement to avoid possible confusion.
>>
>> Since we are already there, also drop an extra space and tweak
>> the title alignment. No real context change at all.
> Since already here, converting to schema would be preferred over trivial
> fixes.
With pleasure to do this. I will send a v2 including this part of work.

Thanks,
Yanan
>> Cc: Rob Herring <[email protected]>
>> Cc: Paul Walmsley <[email protected]>
>> Cc: Palmer Dabbelt <[email protected]>
>> Cc: Albert Ou <[email protected]>
>> Signed-off-by: Yanan Wang <[email protected]>
>> ---
>> Documentation/devicetree/bindings/cpu/cpu-topology.txt | 8 ++++----
>> 1 file changed, 4 insertions(+), 4 deletions(-)
>>
>> diff --git a/Documentation/devicetree/bindings/cpu/cpu-topology.txt b/Documentation/devicetree/bindings/cpu/cpu-topology.txt
>> index 9bd530a35d14..8b23a98c283c 100644
>> --- a/Documentation/devicetree/bindings/cpu/cpu-topology.txt
>> +++ b/Documentation/devicetree/bindings/cpu/cpu-topology.txt
>> @@ -6,7 +6,7 @@ CPU topology binding description
>> 1 - Introduction
>> ===========================================
>>
>> -In a SMP system, the hierarchy of CPUs is defined through three entities that
>> +In a SMP system, the hierarchy of CPUs is defined through four entities that
>> are used to describe the layout of physical CPUs in the system:
>>
>> - socket
>> @@ -75,7 +75,7 @@ whose bindings are described in paragraph 3.
>>
>> The nodes describing the CPU topology (socket/cluster/core/thread) can
>> only be defined within the cpu-map node and every core/thread in the
>> -system must be defined within the topology. Any other configuration is
>> +system must be defined within the topology. Any other configuration is
>> invalid and therefore must be ignored.
>>
>> ===========================================
>> @@ -91,9 +91,9 @@ cpu-map child nodes which do not share a common parent node can have the same
>> name (ie same number N as other cpu-map child nodes at different device tree
>> levels) since name uniqueness will be guaranteed by the device tree hierarchy.
>>
>> -===========================================
>> +============================================
>> 3 - socket/cluster/core/thread node bindings
>> -===========================================
>> +============================================
>>
>> Bindings for socket/cluster/cpu/thread nodes are defined as follows:
>>
>> --
>> 2.19.1
> .