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
---
CC: Lars Kurth
CC: George Dunlap
CC: Ian Jackson
CC: Jan Beulich
CC: Konrad Rzeszutek Wilk
CC: Stefano Stabellini
CC: Tim Deegan
CC: Wei Liu
CC: Julien Grall
CC: Juergen Gross
---
docs/admin-guide/index.rst | 2 +-
docs/guest-guide/index.rst | 4 +--
docs/guest-guide/x86/hypercall-abi.rst | 50 -
docs/guest-guide/x86/index.rst | 4 +--
docs/hypervisor-guide/code-coverage.rst | 4 +--
docs/hypervisor-guide/index.rst | 4 +--
docs/index.rst | 16 +--
7 files changed, 42 insertions(+), 42 deletions(-)
diff --git a/docs/admin-guide/index.rst b/docs/admin-guide/index.rst
index ad1f508a79..1da7c8bf4d 100644
--- a/docs/admin-guide/index.rst
+++ b/docs/admin-guide/index.rst
@@ -4,4 +4,4 @@ Admin Guide
===
.. toctree::
- microcode-loading
+ microcode-loading
diff --git a/docs/guest-guide/index.rst b/docs/guest-guide/index.rst
index 03c5b37bd1..5455c67479 100644
--- a/docs/guest-guide/index.rst
+++ b/docs/guest-guide/index.rst
@@ -4,6 +4,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 edb10b1b2e..14c48929d7 100644
--- a/docs/guest-guide/x86/hypercall-abi.rst
+++ b/docs/guest-guide/x86/hypercall-abi.rst
@@ -14,22 +14,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
@@ -53,22 +53,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
@@ -91,7 +91,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 121cddca62..502968490d 100644
--- a/docs/guest-guide/x86/index.rst
+++ b/docs/guest-guide/x86/index.rst
@@ -4,6 +4,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 641aac25fc..49c4a8ad3b 100644
--- a/docs/hypervisor-guide/code-coverage.rst
+++ b/docs/hypervisor-guide/code-coverage.rst
@@ -10,8 +10,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 7ba37b6e54..8ea8fcb145 100644
--- a/docs/hypervisor-guide/index.rst
+++ b/docs/hypervisor-guide/index.rst
@@ -4,6 +4,6 @@ Hypervisor documentation
.. toctree::
- :maxdepth: 2
+ :maxdepth: 2
- code-coverage
+ code-coverage
diff --git a/docs/index.rst b/docs/index.rst
index 7bd9955a97..7b441c4180 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -5,8 +5,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
