diff mbox series

[for-4.18,1/3] docs/sphinx: Fix syntax issues in hyperlaunch.rst

Message ID 20231108152727.58764-2-andrew.cooper3@citrix.com (mailing list archive)
State New, archived
Headers show
Series docs/sphinx: Fix syntax errors and warnings | expand

Commit Message

Andrew Cooper Nov. 8, 2023, 3:27 p.m. UTC
sphinx-build reports:

  docs/designs/launch/hyperlaunch.rst:111: WARNING: Title underline too short.
  docs/designs/launch/hyperlaunch.rst:203: WARNING: Unexpected indentation.
  docs/designs/launch/hyperlaunch.rst:216: WARNING: Unexpected indentation.

Nested lists require newlines as delimiters.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
---
CC: George Dunlap <George.Dunlap@citrix.com>
CC: Jan Beulich <JBeulich@suse.com>
CC: Stefano Stabellini <sstabellini@kernel.org>
CC: Wei Liu <wl@xen.org>
CC: Julien Grall <julien@xen.org>
CC: Christopher Clark <christopher.clark@starlab.io>
CC: Daniel P. Smith <dpsmith@apertussolutions.com>
CC: Henry Wang <Henry.Wang@arm.com>
---
 docs/designs/launch/hyperlaunch.rst | 19 +++++++++++--------
 1 file changed, 11 insertions(+), 8 deletions(-)

Comments

Henry Wang Nov. 9, 2023, 1:22 a.m. UTC | #1
Hi Andrew,

> On Nov 8, 2023, at 23:27, Andrew Cooper <andrew.cooper3@citrix.com> wrote:
> 
> sphinx-build reports:
> 
>  docs/designs/launch/hyperlaunch.rst:111: WARNING: Title underline too short.
>  docs/designs/launch/hyperlaunch.rst:203: WARNING: Unexpected indentation.
>  docs/designs/launch/hyperlaunch.rst:216: WARNING: Unexpected indentation.
> 
> Nested lists require newlines as delimiters.
> 
> Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>

Release-acked-by: Henry Wang <Henry.Wang@arm.com>

Kind regards,
Henry
Stefano Stabellini Nov. 10, 2023, midnight UTC | #2
On Wed, 8 Nov 2023, Andrew Cooper wrote:
> sphinx-build reports:
> 
>   docs/designs/launch/hyperlaunch.rst:111: WARNING: Title underline too short.
>   docs/designs/launch/hyperlaunch.rst:203: WARNING: Unexpected indentation.
>   docs/designs/launch/hyperlaunch.rst:216: WARNING: Unexpected indentation.
> 
> Nested lists require newlines as delimiters.
> 
> Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>

Acked-by: Stefano Stabellini <sstabellini@kernel.org>
diff mbox series

Patch

diff --git a/docs/designs/launch/hyperlaunch.rst b/docs/designs/launch/hyperlaunch.rst
index 4c138da884cc..3bed36f97637 100644
--- a/docs/designs/launch/hyperlaunch.rst
+++ b/docs/designs/launch/hyperlaunch.rst
@@ -108,7 +108,7 @@  both modes of configuration from the same binary and when paired with its XSM
 flask, provides strong controls that enable fine grained system partitioning.
 
 Hypervisor Launch Landscape
----------
+---------------------------
 
 This comparison table presents the distinctive capabilities of Hyperlaunch with
 reference to existing launch configurations currently available in Xen and
@@ -200,11 +200,13 @@  The benefits of this structure include:
   domains.
 * Commonality: Reuses the same logic for initial basic domain building across
   diverse Xen deployments.
-	* It aligns the x86 initial domain construction with the existing Arm
-	  dom0less feature for construction of multiple domains at boot.
-	* The boot domain implementation may vary significantly with different
-	  deployment use cases, whereas the hypervisor implementation is
-	  common.
+
+  * It aligns the x86 initial domain construction with the existing Arm
+    dom0less feature for construction of multiple domains at boot.
+
+  * The boot domain implementation may vary significantly with different
+    deployment use cases, whereas the hypervisor implementation is common.
+
 * Correctness: Increases confidence in the implementation of domain
   construction, since it is performed by the hypervisor in well maintained and
   centrally tested logic.
@@ -213,8 +215,9 @@  The benefits of this structure include:
 * Capability: Supports launch of advanced configurations where a sequenced
   start of multiple domains is required, or multiple domains are involved in
   startup of the running system configuration
-	* eg. for PCI passthrough on systems where the toolstack runs in a
-	  separate domain to the hardware management.
+
+  * eg. for PCI passthrough on systems where the toolstack runs in a separate
+    domain to the hardware management.
 
 Please, see the ‘Hyperlaunch Device Tree’ design document, which describes the
 configuration module that is provided to the hypervisor by the bootloader.