Skip to contentSkip to conversation

powerpc/doc: Fix htmldocs errors

PATCH Applied Aneesh Kumar K.V 3 participants 3 messages Aug 25, 2021 – Aug 27, 2021 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 powerpc/doc: Fix htmldocs errors

Fix make htmldocs related errors with the newly added associativity.rst doc file.

---
 Documentation/powerpc/associativity.rst | 29 +++++++++++++------------
 Documentation/powerpc/index.rst         |  1 +
 2 files changed, 16 insertions(+), 14 deletions(-)
Documentation/powerpc/associativity.rst +15 -14
index 07e7dd3d6c87..4d01c7368561 100644
@@ -1,6 +1,6 @@
 ============================
 NUMA resource associativity
-=============================
+============================
 
 Associativity represents the groupings of the various platform resources into
 domains of substantially similar mean performance relative to resources outside
@@ -20,11 +20,11 @@ A value of 1 indicates the usage of Form 1 associativity. For Form 2 associativi
 bit 2 of byte 5 in the "ibm,architecture-vec-5" property is used.
 
 Form 0
------
+------
 Form 0 associativity supports only two NUMA distances (LOCAL and REMOTE).
 
 Form 1
------
+------
 With Form 1 a combination of ibm,associativity-reference-points, and ibm,associativity
 device tree properties are used to determine the NUMA distance between resource groups/domains.
 
@@ -78,17 +78,18 @@ numa-lookup-index-table.
 
 For ex:
 ibm,numa-lookup-index-table = <3 0 8 40>;
-ibm,numa-distace-table = <9>, /bits/ 8 < 10  20  80
-					 20  10 160
-					 80 160  10>;
-  | 0    8   40
---|------------
-  |
-0 | 10   20  80
-  |
-8 | 20   10  160
-  |
-40| 80   160  10
+ibm,numa-distace-table = <9>, /bits/ 8 < 10  20  80 20  10 160 80 160  10>;
+
+::
+
+	  | 0    8   40
+	--|------------
+	  |
+	0 | 10   20  80
+	  |
+	8 | 20   10  160
+	  |
+	40| 80   160  10
 
 A possible "ibm,associativity" property for resources in node 0, 8 and 40
 
Documentation/powerpc/index.rst +1 -0
index bf5f1a2bdbdf..0f7d3c495693 100644
@@ -7,6 +7,7 @@ powerpc
 .. toctree::
     :maxdepth: 1
 
+    associativity
     booting
     bootwrapper
     cpu_families
Signature · 1 line
2.31.1
Tested-by on v1 1/1
#1 lore raw

Hi Aneesh,

Quoted 10 lines · On Wed, 25 Aug 2021 09:54:47 +0530 "Aneesh Kumar K.V"…

Fix make htmldocs related errors with the newly added associativity.rst doc file.

---
 Documentation/powerpc/associativity.rst | 29 +++++++++++++------------
 Documentation/powerpc/index.rst         |  1 +
 2 files changed, 16 insertions(+), 14 deletions(-)

This fixes all the warnings related to this file for me.

Michael, it would be good if this could go in soon as without this patch my "make htmldocs" run livelocks. :-(

Signature · 2 lines
Cheers,
Stephen Rothwell