From nobody Tue Feb 10 11:34:20 2026 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=fail; spf=none (zoho.com: 192.237.175.120 is neither permitted nor denied by domain of lists.xenproject.org) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org ARC-Seal: i=1; a=rsa-sha256; t=1570136260; cv=none; d=zoho.com; s=zohoarc; b=Nu30gG8VRdzNQqODdb6HBfnJAsT7hgMi6l7TOLTeAgUnMaqoKMopSsTn9NvUrdbw6IBDWWzOgF9hAJFGB0VDB2HLKJ+X8iqQawNm5SVRerkTFC5RkgFxd7zIZsYpLmIdtXf7UVc8B4359qGcARoua6IOdXe9qKOXVg6q+5WNshM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1570136260; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To:ARC-Authentication-Results; bh=/h2lvofI5veiQ2GeLJJfwM5Jui+0U5/3wG6sfWPesoQ=; b=dPxy7ZNd0hr1C52bv9hMxyC8twVBJnhdttNo8UF8T0p0vROU+wuCWkq3YErlN5DZgVPie/S5sPJ1BraEZM2VdyXlQbHAWNyj49CunLQLoqRk9pGQFvMWXda9OPuDPawKg3HUAGjiIgYqzH75uBct0Nq8rrQnKJ7J9LMAETFmtrU= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=fail; spf=none (zoho.com: 192.237.175.120 is neither permitted nor denied by domain of lists.xenproject.org) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Return-Path: Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) by mx.zohomail.com with SMTPS id 1570136260473421.61103579884445; Thu, 3 Oct 2019 13:57:40 -0700 (PDT) Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1iG89N-0004zi-9I; Thu, 03 Oct 2019 20:56:37 +0000 Received: from us1-rack-iad1.inumbo.com ([172.99.69.81]) by lists.xenproject.org with esmtp (Exim 4.89) (envelope-from ) id 1iG89L-0004zc-P8 for xen-devel@lists.xenproject.org; Thu, 03 Oct 2019 20:56:35 +0000 Received: from esa6.hc3370-68.iphmx.com (unknown [216.71.155.175]) by us1-rack-iad1.inumbo.com (Halon) with ESMTPS id 45cdd4f8-e620-11e9-8c93-bc764e2007e4; Thu, 03 Oct 2019 20:56:30 +0000 (UTC) X-Inumbo-ID: 45cdd4f8-e620-11e9-8c93-bc764e2007e4 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; d=citrix.com; s=securemail; t=1570136190; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version; bh=uawN6kiy330XSI7invCfsgLcbriGckTH4SPnytCHc28=; b=Tw5HLsUvOBp2LB4VzsqXF3XI7JIHS4/fwbmHwZvi4YXMIDTRG7BAkmQP uFqxwan0eStPrMjRnsDXdCuMMAsxBYRZ7v0lzGrR9RMlJs8kwPFZnP+Bd wPQBRbmCO7ocw75PdqERTQ+ylIZE9h/qW33jfq+jb0gflFqaRXY+vOCE6 w=; Authentication-Results: esa6.hc3370-68.iphmx.com; dkim=none (message not signed) header.i=none; spf=None smtp.pra=andrew.cooper3@citrix.com; spf=Pass smtp.mailfrom=Andrew.Cooper3@citrix.com; spf=None smtp.helo=postmaster@mail.citrix.com Received-SPF: none (zoho.com: 192.237.175.120 is neither permitted nor denied by domain of lists.xenproject.org) client-ip=192.237.175.120; envelope-from=xen-devel-bounces@lists.xenproject.org; helo=lists.xenproject.org; Received-SPF: None (esa6.hc3370-68.iphmx.com: no sender authenticity information available from domain of andrew.cooper3@citrix.com) identity=pra; client-ip=162.221.158.21; receiver=esa6.hc3370-68.iphmx.com; envelope-from="Andrew.Cooper3@citrix.com"; x-sender="andrew.cooper3@citrix.com"; x-conformance=sidf_compatible Received-SPF: Pass (esa6.hc3370-68.iphmx.com: domain of Andrew.Cooper3@citrix.com designates 162.221.158.21 as permitted sender) identity=mailfrom; client-ip=162.221.158.21; receiver=esa6.hc3370-68.iphmx.com; envelope-from="Andrew.Cooper3@citrix.com"; x-sender="Andrew.Cooper3@citrix.com"; x-conformance=sidf_compatible; x-record-type="v=spf1"; x-record-text="v=spf1 ip4:209.167.231.154 ip4:178.63.86.133 ip4:195.66.111.40/30 ip4:85.115.9.32/28 ip4:199.102.83.4 ip4:192.28.146.160 ip4:192.28.146.107 ip4:216.52.6.88 ip4:216.52.6.188 ip4:162.221.158.21 ip4:162.221.156.83 ~all" Received-SPF: None (esa6.hc3370-68.iphmx.com: no sender authenticity information available from domain of postmaster@mail.citrix.com) identity=helo; client-ip=162.221.158.21; receiver=esa6.hc3370-68.iphmx.com; envelope-from="Andrew.Cooper3@citrix.com"; x-sender="postmaster@mail.citrix.com"; x-conformance=sidf_compatible IronPort-SDR: nQcnm77dQ16uRCfwUo9HNV6N3Cz27//0+6xjwvT+RlNdHnjhJas/QebRQO5LeGTO/iLQ8ayeQw 0maraWDbIwz4VGajvUX1bEa5E0FCoheio44Ot0B9kpyvHwEh/GUsLxXAJjhYFaY+GRwS9i0FJk CTAQOjieIji/T8GWus/g+Ybn/Qv3TwLALQapd/E72e1L53LVTfrJPa/KLElvYjxIlr0cMKBF9i YYomIo03eEKIZ5RXfDMHmgd52d2nGO6uLxmuSjxZh01BlZA3YzwZLEe+11X7k3OcvBd3gKrmLj FeA= X-SBRS: 2.7 X-MesageID: 6742543 X-Ironport-Server: esa6.hc3370-68.iphmx.com X-Remote-IP: 162.221.158.21 X-Policy: $RELAYED X-IronPort-AV: E=Sophos;i="5.67,253,1566878400"; d="scan'208";a="6742543" From: Andrew Cooper To: Xen-devel Date: Thu, 3 Oct 2019 21:56:22 +0100 Message-ID: <20191003205623.20839-3-andrew.cooper3@citrix.com> X-Mailer: git-send-email 2.11.0 In-Reply-To: <20191003205623.20839-1-andrew.cooper3@citrix.com> References: <20191003205623.20839-1-andrew.cooper3@citrix.com> MIME-Version: 1.0 Subject: [Xen-devel] [PATCH 2/4] docs/sphinx: Indent cleanup X-BeenThere: xen-devel@lists.xenproject.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Cc: Juergen Gross , Lars Kurth , Stefano Stabellini , Julien Grall , Wei Liu , Konrad Rzeszutek Wilk , George Dunlap , Andrew Cooper , Tim Deegan , Jan Beulich , Ian Jackson Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable Errors-To: xen-devel-bounces@lists.xenproject.org Sender: "Xen-devel" X-ZohoMail-DKIM: fail (Header signature does not verify) 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 Reviewed-by: Lars Kurth --- 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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 .. 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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 .. toctree:: - :maxdepth: 2 + :maxdepth: 2 =20 - 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 gue= st. =20 .. list-table:: - :header-rows: 1 + :header-rows: 1 =20 - * - ABI - - Hypercall Index - - Parameters (1 - 6) - - Result + * - ABI + - Hypercall Index + - Parameters (1 - 6) + - Result =20 - * - 64bit - - RAX - - RDI RSI RDX R10 R8 R9 - - RAX + * - 64bit + - RAX + - RDI RSI RDX R10 R8 R9 + - RAX =20 - * - 32bit - - EAX - - EBX ECX EDX ESI EDI EBP - - EAX + * - 32bit + - EAX + - EBX ECX EDX ESI EDI EBP + - EAX =20 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 n= ot @@ -53,22 +53,22 @@ The exact sequence of instructions required to issue a = hypercall differs between virtualisation mode and hardware vendor. =20 .. list-table:: - :header-rows: 1 + :header-rows: 1 =20 - * - Guest - - Transfer instruction + * - Guest + - Transfer instruction =20 - * - 32bit PV - - INT 0x82 + * - 32bit PV + - INT 0x82 =20 - * - 64bit PV - - SYSCALL + * - 64bit PV + - SYSCALL =20 - * - Intel HVM - - VMCALL + * - Intel HVM + - VMCALL =20 - * - AMD HVM - - VMMCALL + * - AMD HVM + - VMMCALL =20 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 stu= b [3]_: =20 .. code-block:: none =20 - call hypercall_page + index * 32 + call hypercall_page + index * 32 =20 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 =3D=3D=3D =20 .. toctree:: - :maxdepth: 2 + :maxdepth: 2 =20 - hypercall-abi + hypercall-abi diff --git a/docs/hypervisor-guide/code-coverage.rst b/docs/hypervisor-guid= e/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 t= he data. =20 .. warning:: =20 - 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. =20 =20 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 =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D =20 .. toctree:: - :maxdepth: 2 + :maxdepth: 2 =20 - 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 =20 .. note:: =20 - 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/ =20 =20 User documentation @@ -18,9 +18,9 @@ preferred distribution, and is attempting to run virtual = machines and configure the system. =20 .. toctree:: - :maxdepth: 2 + :maxdepth: 2 =20 - admin-guide/index + admin-guide/index =20 =20 Guest documentation @@ -31,9 +31,9 @@ intended for OS developers trying to use a Xen feature, a= nd for Xen developers to avoid breaking things. =20 .. toctree:: - :maxdepth: 3 + :maxdepth: 3 =20 - guest-guide/index + guest-guide/index =20 =20 Hypervisor developer documentation @@ -44,6 +44,6 @@ who is building Xen from source, and is running the new h= ypervisor in some kind of development environment. =20 .. toctree:: - :maxdepth: 2 + :maxdepth: 2 =20 - hypervisor-guide/index + hypervisor-guide/index --=20 2.11.0 _______________________________________________ Xen-devel mailing list Xen-devel@lists.xenproject.org https://lists.xenproject.org/mailman/listinfo/xen-devel