From nobody Sat Nov 30 01:36:40 2024 Delivered-To: importer@patchew.org Received-SPF: pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) client-ip=192.237.175.120; envelope-from=xen-devel-bounces@lists.xenproject.org; helo=lists.xenproject.org; Authentication-Results: mx.zohomail.com; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=fail(p=none dis=none) header.from=arm.com ARC-Seal: i=1; a=rsa-sha256; t=1620636121; cv=none; d=zohomail.com; s=zohoarc; b=YSo7FlN2TuT3vYEzHVbY0TPV3HfCn7F9DhPSvQPNm817y4DC65ddUuhSnwGj/VZXXseVmdmbdawe1hUTXaeoY98pe6YYje+ZAYzzyAASQ7XH6d3D0F+0XAAGBzC14lWXUxFE6yWX7EYGlJDbYTQnVb8DcFVtkllULOKpL7MN238= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1620636121; h=Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Help:List-Unsubscribe:Message-ID:References:Sender:Subject:To; bh=8pYo1c0AsEfHYj+wUQ94hhnHK/TjwZTST6GaWsklY0c=; b=NRwkONdOLzfcSbqbROe2m3h28ZGQqyu8UUYAoqVRuWc4AU2Zjx0drId+/jzCsotQ/ZHUV+cz1RNvVytt4gqtehwKO+krLQIppYwgDL3Ll+77Y/4CucVUGubqIaqwx5rWBfBuANw3q32efkehdgfehmE24erWIG7O0XYpaXY3rW0= ARC-Authentication-Results: i=1; mx.zohomail.com; spf=pass (zohomail.com: domain of lists.xenproject.org designates 192.237.175.120 as permitted sender) smtp.mailfrom=xen-devel-bounces@lists.xenproject.org; dmarc=fail header.from= (p=none dis=none) header.from= Return-Path: Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) by mx.zohomail.com with SMTPS id 1620636121135286.6585637852362; Mon, 10 May 2021 01:42:01 -0700 (PDT) Received: from list by lists.xenproject.org with outflank-mailman.124970.235330 (Exim 4.92) (envelope-from ) id 1lg1U2-000384-QA; Mon, 10 May 2021 08:41:46 +0000 Received: by outflank-mailman (output) from mailman id 124970.235330; Mon, 10 May 2021 08:41:46 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lg1U2-00037q-M9; Mon, 10 May 2021 08:41:46 +0000 Received: by outflank-mailman (input) for mailman id 124970; Mon, 10 May 2021 08:41:44 +0000 Received: from all-amaz-eas1.inumbo.com ([34.197.232.57] helo=us1-amaz-eas2.inumbo.com) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1lg1U0-0000ei-Ru for xen-devel@lists.xenproject.org; Mon, 10 May 2021 08:41:44 +0000 Received: from foss.arm.com (unknown [217.140.110.172]) by us1-amaz-eas2.inumbo.com (Halon) with ESMTP id b9f5daf7-e91c-428e-b8f9-d4ac3c66e3e2; Mon, 10 May 2021 08:41:27 +0000 (UTC) Received: from usa-sjc-imap-foss1.foss.arm.com (unknown [10.121.207.14]) by usa-sjc-mx-foss1.foss.arm.com (Postfix) with ESMTP id C498411D4; Mon, 10 May 2021 01:41:26 -0700 (PDT) Received: from e125770.cambridge.arm.com (e125770.cambridge.arm.com [10.1.197.16]) by usa-sjc-imap-foss1.foss.arm.com (Postfix) with ESMTPSA id 6049E3F719; Mon, 10 May 2021 01:41:25 -0700 (PDT) X-Outflank-Mailman: Message body and most headers restored to incoming version X-BeenThere: xen-devel@lists.xenproject.org List-Id: Xen developer discussion List-Unsubscribe: , List-Post: List-Help: List-Subscribe: , Errors-To: xen-devel-bounces@lists.xenproject.org Precedence: list Sender: "Xen-devel" X-Inumbo-ID: b9f5daf7-e91c-428e-b8f9-d4ac3c66e3e2 From: Luca Fancellu To: xen-devel@lists.xenproject.org Cc: bertrand.marquis@arm.com, wei.chen@arm.com, Andrew Cooper , George Dunlap , Ian Jackson , Jan Beulich , Julien Grall , Stefano Stabellini , Wei Liu Subject: [PATCH v6 8/9] docs: hypercalls sphinx skeleton for generated html Date: Mon, 10 May 2021 09:41:04 +0100 Message-Id: <20210510084105.17108-9-luca.fancellu@arm.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210510084105.17108-1-luca.fancellu@arm.com> References: <20210510084105.17108-1-luca.fancellu@arm.com> Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Create a skeleton for the documentation about hypercalls Signed-off-by: Luca Fancellu --- v6 changes: - Now every platform has the same sections in .rst files --- .gitignore | 1 + docs/Makefile | 4 ++++ docs/hypercall-interfaces/arm32.rst | 32 ++++++++++++++++++++++++++ docs/hypercall-interfaces/arm64.rst | 32 ++++++++++++++++++++++++++ docs/hypercall-interfaces/index.rst.in | 7 ++++++ docs/hypercall-interfaces/x86_64.rst | 32 ++++++++++++++++++++++++++ docs/index.rst | 8 +++++++ 7 files changed, 116 insertions(+) create mode 100644 docs/hypercall-interfaces/arm32.rst create mode 100644 docs/hypercall-interfaces/arm64.rst create mode 100644 docs/hypercall-interfaces/index.rst.in create mode 100644 docs/hypercall-interfaces/x86_64.rst diff --git a/.gitignore b/.gitignore index d271e0ce6a..a9aab120ae 100644 --- a/.gitignore +++ b/.gitignore @@ -64,6 +64,7 @@ docs/xen.doxyfile docs/xen.doxyfile.tmp docs/xen-doxygen/doxygen_include.h docs/xen-doxygen/doxygen_include.h.tmp +docs/hypercall-interfaces/index.rst extras/mini-os* install/* stubdom/*-minios-config.mk diff --git a/docs/Makefile b/docs/Makefile index 2f784c36ce..b02c3dfb79 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -61,6 +61,9 @@ build: html txt pdf man-pages figs sphinx-html: $(DOXY_DEPS) $(DOXY_LIST_SOURCES) ifneq ($(SPHINXBUILD),no) $(DOXYGEN) xen.doxyfile + @echo "Generating hypercall-interfaces/index.rst" + @sed -e "s,@XEN_TARGET_ARCH@,$(XEN_TARGET_ARCH),g" \ + hypercall-interfaces/index.rst.in > hypercall-interfaces/index.rst XEN_ROOT=3D$(realpath $(XEN_ROOT)) $(SPHINXBUILD) -b html . sphinx/html else @echo "Sphinx is not installed; skipping sphinx-html documentation." @@ -108,6 +111,7 @@ clean: clean-man-pages rm -f xen.doxyfile.tmp rm -f xen-doxygen/doxygen_include.h rm -f xen-doxygen/doxygen_include.h.tmp + rm -f hypercall-interfaces/index.rst =20 .PHONY: distclean distclean: clean diff --git a/docs/hypercall-interfaces/arm32.rst b/docs/hypercall-interface= s/arm32.rst new file mode 100644 index 0000000000..6762d9fc7c --- /dev/null +++ b/docs/hypercall-interfaces/arm32.rst @@ -0,0 +1,32 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Hypercall Interfaces - arm32 +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D + +Starting points +--------------- +.. toctree:: + :maxdepth: 2 + + + +Functions +--------- + + +Structs +------- + + +Enums and sets of #defines +-------------------------- + + +Typedefs +-------- + + +Enum values and individual #defines +----------------------------------- + + diff --git a/docs/hypercall-interfaces/arm64.rst b/docs/hypercall-interface= s/arm64.rst new file mode 100644 index 0000000000..5e701a2adc --- /dev/null +++ b/docs/hypercall-interfaces/arm64.rst @@ -0,0 +1,32 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Hypercall Interfaces - arm64 +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D + +Starting points +--------------- +.. toctree:: + :maxdepth: 2 + + + +Functions +--------- + + +Structs +------- + + +Enums and sets of #defines +-------------------------- + + +Typedefs +-------- + + +Enum values and individual #defines +----------------------------------- + + diff --git a/docs/hypercall-interfaces/index.rst.in b/docs/hypercall-interf= aces/index.rst.in new file mode 100644 index 0000000000..e4dcc5db8d --- /dev/null +++ b/docs/hypercall-interfaces/index.rst.in @@ -0,0 +1,7 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Hypercall Interfaces +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +.. toctree:: + @XEN_TARGET_ARCH@ diff --git a/docs/hypercall-interfaces/x86_64.rst b/docs/hypercall-interfac= es/x86_64.rst new file mode 100644 index 0000000000..59e948900c --- /dev/null +++ b/docs/hypercall-interfaces/x86_64.rst @@ -0,0 +1,32 @@ +.. SPDX-License-Identifier: CC-BY-4.0 + +Hypercall Interfaces - x86_64 +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D + +Starting points +--------------- +.. toctree:: + :maxdepth: 2 + + + +Functions +--------- + + +Structs +------- + + +Enums and sets of #defines +-------------------------- + + +Typedefs +-------- + + +Enum values and individual #defines +----------------------------------- + + diff --git a/docs/index.rst b/docs/index.rst index b75487a05d..52226a42d8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -53,6 +53,14 @@ kind of development environment. hypervisor-guide/index =20 =20 +Hypercall Interfaces documentation +---------------------------------- + +.. toctree:: + :maxdepth: 2 + + hypercall-interfaces/index + Miscellanea ----------- =20 --=20 2.17.1