docs/sphinx: Indent cleanup

Sphinx, its linters, and RST modes in common editors, expect 3 spaces of
indentation.  Some bits already conform to this expectation.  Update the
rest to match.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
Reviewed-by: Lars Kurth <lars.kurth@citrix.com>
Release-acked-by: Juergen Gross <jgross@suse.com>

diff --git a/docs/admin-guide/index.rst b/docs/admin-guide/index.rst
index f725d75ebee39254d8630db7096d5634c62b5376..6907d5882965c3982a28f6f883e14850e41ca1d0 100644 (file)
--- a/docs/admin-guide/index.rst
+++ b/docs/admin-guide/index.rst
@@ -2,4 +2,4 @@ Admin Guide
 ===========
 
 .. toctree::
-  microcode-loading
+   microcode-loading

diff --git a/docs/guest-guide/index.rst b/docs/guest-guide/index.rst
index 108e0b8d7730c3222919b7748ad96a69165c3cdc..5bf3ecf541e62d57b7d2e8980fde986a69e961f9 100644 (file)
--- a/docs/guest-guide/index.rst
+++ b/docs/guest-guide/index.rst
@@ -2,6 +2,6 @@ Guest documentation
 ===================
 
 .. toctree::
-  :maxdepth: 2
+   :maxdepth: 2
 
-  x86/index
+   x86/index

diff --git a/docs/guest-guide/x86/hypercall-abi.rst b/docs/guest-guide/x86/hypercall-abi.rst
index dee25853d4f68806a28794dc7eb076e91b82c977..9964b3dc0b157b9d3ed70a7ca3e1ff5949a854fd 100644 (file)
--- a/docs/guest-guide/x86/hypercall-abi.rst
+++ b/docs/guest-guide/x86/hypercall-abi.rst
@@ -12,22 +12,22 @@ Registers
 The registers used for hypercalls depends on the operating mode of the guest.
 
 .. list-table::
-  :header-rows: 1
+   :header-rows: 1
 
-  * - ABI
-    - Hypercall Index
-    - Parameters (1 - 6)
-    - Result
+   * - ABI
+     - Hypercall Index
+     - Parameters (1 - 6)
+     - Result
 
-  * - 64bit
-    - RAX
-    - RDI RSI RDX R10 R8 R9
-    - RAX
+   * - 64bit
+     - RAX
+     - RDI RSI RDX R10 R8 R9
+     - RAX
 
-  * - 32bit
-    - EAX
-    - EBX ECX EDX ESI EDI EBP
-    - EAX
+   * - 32bit
+     - EAX
+     - EBX ECX EDX ESI EDI EBP
+     - EAX
 
 32 and 64bit PV guests have an ABI fixed by their guest type.  The ABI for an
 HVM guest depends on whether the vCPU is operating in a 64bit segment or not
@@ -51,22 +51,22 @@ The exact sequence of instructions required to issue a hypercall differs
 between virtualisation mode and hardware vendor.
 
 .. list-table::
-  :header-rows: 1
+   :header-rows: 1
 
-  * - Guest
-    - Transfer instruction
+   * - Guest
+     - Transfer instruction
 
-  * - 32bit PV
-    - INT 0x82
+   * - 32bit PV
+     - INT 0x82
 
-  * - 64bit PV
-    - SYSCALL
+   * - 64bit PV
+     - SYSCALL
 
-  * - Intel HVM
-    - VMCALL
+   * - Intel HVM
+     - VMCALL
 
-  * - AMD HVM
-    - VMMCALL
+   * - AMD HVM
+     - VMMCALL
 
 To abstract away the details, Xen implements an interface known as the
 Hypercall Page.  This allows a guest to make a hypercall without needing to
@@ -89,7 +89,7 @@ To invoke a specific hypercall, ``call`` the relevant stub [3]_:
 
 .. code-block:: none
 
-  call hypercall_page + index * 32
+   call hypercall_page + index * 32
 
 There result is an ABI which is invariant of the exact operating mode or
 hardware vendor.  This is intended to simplify guest kernel interfaces by

diff --git a/docs/guest-guide/x86/index.rst b/docs/guest-guide/x86/index.rst
index a3683920878975c8cc5c69fa2287e02fefb95b0a..2241db95442f486b2643cb074d5212429c313bce 100644 (file)
--- a/docs/guest-guide/x86/index.rst
+++ b/docs/guest-guide/x86/index.rst
@@ -2,6 +2,6 @@ x86
 ===
 
 .. toctree::
-  :maxdepth: 2
+   :maxdepth: 2
 
-  hypercall-abi
+   hypercall-abi

diff --git a/docs/hypervisor-guide/code-coverage.rst b/docs/hypervisor-guide/code-coverage.rst
index 6c7552d69128225c20c551d2881294572421b9f3..d32b128e24cd787ccba485d14d9608923f1293c3 100644 (file)
--- a/docs/hypervisor-guide/code-coverage.rst
+++ b/docs/hypervisor-guide/code-coverage.rst
@@ -8,8 +8,8 @@ so some extra steps are required to collect and process the data.
 
 .. warning::
 
-  ARM doesn't currently boot when the final binary exceeds 2MB in size,
-  and the coverage build tends to exceed this limit.
+   ARM doesn't currently boot when the final binary exceeds 2MB in size,
+   and the coverage build tends to exceed this limit.
 
 
 Compiling Xen

diff --git a/docs/hypervisor-guide/index.rst b/docs/hypervisor-guide/index.rst
index cbcae398a2fc38ab4f83232c79e92b56582f752e..29facd03db7968fcf1d4d19bf95e7b3936bd29d9 100644 (file)
--- a/docs/hypervisor-guide/index.rst
+++ b/docs/hypervisor-guide/index.rst
@@ -2,6 +2,6 @@ Hypervisor documentation
 ========================
 
 .. toctree::
-  :maxdepth: 2
+   :maxdepth: 2
 
-  code-coverage
+   code-coverage

diff --git a/docs/index.rst b/docs/index.rst
index 31bb8927f29e4a2321c13413ad8352b76ce611e2..470541f007cc8ecf7823fbe398186a5136cdd1b2 100644 (file)
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,8 +3,8 @@ The Xen Hypervisor documentation
 
 .. note::
 
-  Xen's Sphinx/RST documentation is a work in progress.  The existing
-  documentation can be found at https://xenbits.xen.org/docs/
+   Xen's Sphinx/RST documentation is a work in progress.  The existing
+   documentation can be found at https://xenbits.xen.org/docs/
 
 
 User documentation
@@ -16,9 +16,9 @@ preferred distribution, and is attempting to run virtual machines and
 configure the system.
 
 .. toctree::
-  :maxdepth: 2
+   :maxdepth: 2
 
-  admin-guide/index
+   admin-guide/index
 
 
 Guest documentation
@@ -29,9 +29,9 @@ intended for OS developers trying to use a Xen feature, and for Xen developers
 to avoid breaking things.
 
 .. toctree::
-  :maxdepth: 3
+   :maxdepth: 3
 
-  guest-guide/index
+   guest-guide/index
 
 
 Hypervisor developer documentation
@@ -42,6 +42,6 @@ who is building Xen from source, and is running the new hypervisor in some
 kind of development environment.
 
 .. toctree::
-  :maxdepth: 2
+   :maxdepth: 2
 
-  hypervisor-guide/index
+   hypervisor-guide/index