|
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [Xen-changelog] [xen staging] docs/sphinx: Indent cleanup
commit e37058267e33e5e4525f920e3126d15891ee8dbb
Author: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
AuthorDate: Fri Jul 19 08:57:50 2019 +0100
Commit: Andrew Cooper <andrew.cooper3@xxxxxxxxxx>
CommitDate: Mon Oct 14 12:54:14 2019 +0100
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@xxxxxxxxxx>
Reviewed-by: Lars Kurth <lars.kurth@xxxxxxxxxx>
Release-acked-by: Juergen Gross <jgross@xxxxxxxx>
---
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 f725d75ebe..6907d58829 100644
--- 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 108e0b8d77..5bf3ecf541 100644
--- 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 dee25853d4..9964b3dc0b 100644
--- 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 a368392087..2241db9544 100644
--- 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 6c7552d691..d32b128e24 100644
--- 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 cbcae398a2..29facd03db 100644
--- 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 31bb8927f2..470541f007 100644
--- 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
--
generated by git-patchbot for /home/xen/git/xen.git#staging
_______________________________________________
Xen-changelog mailing list
Xen-changelog@xxxxxxxxxxxxxxxxxxxx
https://lists.xenproject.org/xen-changelog
|
 |
Lists.xenproject.org is hosted with RackSpace, monitoring our |