diff mbox series

[v2] Documentation, dt, numa: Add note to empty NUMA node

Message ID 20210625020322.43825-1-gshan@redhat.com
State Superseded, archived
Headers show
Series [v2] Documentation, dt, numa: Add note to empty NUMA node | expand

Checks

Context Check Description
robh/checkpatch success

Commit Message

Gavin Shan June 25, 2021, 2:03 a.m. UTC
The empty NUMA nodes, where no memory resides in, are allowed. For
these empty NUMA nodes, the 'len' of 'reg' property is zero. These
empty NUMA node IDs are still valid and parsed. I finds difficulty
to get where it's properly documented.

So lets add note to empty NUMA nodes in the NUMA binding doc.

Signed-off-by: Gavin Shan <gshan@redhat.com>
---
v2: Update to address Randy's comments
---
 Documentation/devicetree/bindings/numa.txt | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Randy Dunlap June 25, 2021, 1:49 a.m. UTC | #1
On 6/24/21 7:03 PM, Gavin Shan wrote:
> The empty NUMA nodes, where no memory resides in, are allowed. For
> these empty NUMA nodes, the 'len' of 'reg' property is zero. These
> empty NUMA node IDs are still valid and parsed. I finds difficulty
> to get where it's properly documented.
> 
> So lets add note to empty NUMA nodes in the NUMA binding doc.
> 
> Signed-off-by: Gavin Shan <gshan@redhat.com>
> ---
> v2: Update to address Randy's comments

Hi Gavin,

Sorry, there has been some misunderstanding. Please see below.


> ---
>  Documentation/devicetree/bindings/numa.txt | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/numa.txt b/Documentation/devicetree/bindings/numa.txt
> index 21b35053ca5a..08e361f9954c 100644
> --- a/Documentation/devicetree/bindings/numa.txt
> +++ b/Documentation/devicetree/bindings/numa.txt
> @@ -109,6 +109,10 @@ Example:
>  Dual socket system consists of 2 boards connected through ccn bus and
>  each board having one socket/soc of 8 cpus, memory and pci bus.
>  
> +Note that the empty NUMA nodes, which no memory resides in period, are

In patch v1, this was:

  +Note that the empty NUMA nodes, which no memory resides in, are allowed 

and I said:

  Missing period at end of the sentence above.

What I meant by that was "Missing 'period' ('.') punctuation at the end
of the sentence above. So it should simply be changed to:


  +Note that the empty NUMA nodes, which no memory resides in, are allowed.



> +allowed. Their NUMA node IDs are still valid so that memory can be added
> +into these NUMA nodes through hotplug afterwards.
> +
>  	memory@c00000 {
>  		device_type = "memory";
>  		reg = <0x0 0xc00000 0x0 0x80000000>;

Sorry about the confusion.
Gavin Shan June 25, 2021, 4:27 a.m. UTC | #2
On 6/25/21 11:49 AM, Randy Dunlap wrote:
> On 6/24/21 7:03 PM, Gavin Shan wrote:
>> The empty NUMA nodes, where no memory resides in, are allowed. For
>> these empty NUMA nodes, the 'len' of 'reg' property is zero. These
>> empty NUMA node IDs are still valid and parsed. I finds difficulty
>> to get where it's properly documented.
>>
>> So lets add note to empty NUMA nodes in the NUMA binding doc.
>>
>> Signed-off-by: Gavin Shan <gshan@redhat.com>
>> ---
>> v2: Update to address Randy's comments
> 
> Hi Gavin,
> 
> Sorry, there has been some misunderstanding. Please see below.
> 
> 
>> ---
>>   Documentation/devicetree/bindings/numa.txt | 4 ++++
>>   1 file changed, 4 insertions(+)
>>
>> diff --git a/Documentation/devicetree/bindings/numa.txt b/Documentation/devicetree/bindings/numa.txt
>> index 21b35053ca5a..08e361f9954c 100644
>> --- a/Documentation/devicetree/bindings/numa.txt
>> +++ b/Documentation/devicetree/bindings/numa.txt
>> @@ -109,6 +109,10 @@ Example:
>>   Dual socket system consists of 2 boards connected through ccn bus and
>>   each board having one socket/soc of 8 cpus, memory and pci bus.
>>   
>> +Note that the empty NUMA nodes, which no memory resides in period, are
> 
> In patch v1, this was:
> 
>    +Note that the empty NUMA nodes, which no memory resides in, are allowed
> 
> and I said:
> 
>    Missing period at end of the sentence above.
> 
> What I meant by that was "Missing 'period' ('.') punctuation at the end
> of the sentence above. So it should simply be changed to:
> 
> 
>    +Note that the empty NUMA nodes, which no memory resides in, are allowed.
> 

Thanks, Randy. v3 will be posted shortly to have everything corrected.
Sorry about the misunderstanding.

I thought "in period" means "temporarily" and it makes sense to me :)

> 
>> +allowed. Their NUMA node IDs are still valid so that memory can be added
>> +into these NUMA nodes through hotplug afterwards.
>> +
>>   	memory@c00000 {
>>   		device_type = "memory";
>>   		reg = <0x0 0xc00000 0x0 0x80000000>;
> 
> Sorry about the confusion.
> 

Sorry to take more of your time to review :)

Thanks,
Gavin
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/numa.txt b/Documentation/devicetree/bindings/numa.txt
index 21b35053ca5a..08e361f9954c 100644
--- a/Documentation/devicetree/bindings/numa.txt
+++ b/Documentation/devicetree/bindings/numa.txt
@@ -109,6 +109,10 @@  Example:
 Dual socket system consists of 2 boards connected through ccn bus and
 each board having one socket/soc of 8 cpus, memory and pci bus.
 
+Note that the empty NUMA nodes, which no memory resides in period, are
+allowed. Their NUMA node IDs are still valid so that memory can be added
+into these NUMA nodes through hotplug afterwards.
+
 	memory@c00000 {
 		device_type = "memory";
 		reg = <0x0 0xc00000 0x0 0x80000000>;