From patchwork Mon Jul 5 10:51:02 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Luca Fancellu X-Patchwork-Id: 12358843 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-16.8 required=3.0 tests=BAYES_00, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER,INCLUDES_PATCH, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id DF279C07E9E for ; Mon, 5 Jul 2021 10:55:46 +0000 (UTC) Received: from lists.xenproject.org (lists.xenproject.org [192.237.175.120]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mail.kernel.org (Postfix) with ESMTPS id B09D761159 for ; Mon, 5 Jul 2021 10:55:46 +0000 (UTC) DMARC-Filter: OpenDMARC Filter v1.3.2 mail.kernel.org B09D761159 Authentication-Results: mail.kernel.org; dmarc=fail (p=none dis=none) header.from=arm.com Authentication-Results: mail.kernel.org; spf=pass smtp.mailfrom=xen-devel-bounces@lists.xenproject.org Received: from list by lists.xenproject.org with outflank-mailman.150102.277632 (Exim 4.92) (envelope-from ) id 1m0MGK-0005j5-Eq; Mon, 05 Jul 2021 10:55:40 +0000 X-Outflank-Mailman: Message body and most headers restored to incoming version Received: by outflank-mailman (output) from mailman id 150102.277632; Mon, 05 Jul 2021 10:55:40 +0000 Received: from localhost ([127.0.0.1] helo=lists.xenproject.org) by lists.xenproject.org with esmtp (Exim 4.92) (envelope-from ) id 1m0MGK-0005ip-BE; Mon, 05 Jul 2021 10:55:40 +0000 Received: by outflank-mailman (input) for mailman id 150102; Mon, 05 Jul 2021 10:55:38 +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 1m0MGI-0004Tv-BN for xen-devel@lists.xenproject.org; Mon, 05 Jul 2021 10:55:38 +0000 Received: from foss.arm.com (unknown [217.140.110.172]) by us1-amaz-eas2.inumbo.com (Halon) with ESMTP id 84a67786-dd7f-11eb-8443-12813bfff9fa; Mon, 05 Jul 2021 10:55:32 +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 DFDDA1042; Mon, 5 Jul 2021 03:55:31 -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 2729F3F5A1; Mon, 5 Jul 2021 03:55:29 -0700 (PDT) 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: 84a67786-dd7f-11eb-8443-12813bfff9fa 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 v7 8/9] docs: hypercalls sphinx skeleton for generated html Date: Mon, 5 Jul 2021 11:51:02 +0100 Message-Id: <20210705105103.14509-9-luca.fancellu@arm.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20210705105103.14509-1-luca.fancellu@arm.com> References: <20210705105103.14509-1-luca.fancellu@arm.com> Create a skeleton for the documentation about hypercalls. At this stage the documentation can be created only for one architecture at a time. Signed-off-by: Luca Fancellu --- v7 changes: - modify the commit message 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 ef0b0ed101..7543452b66 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 c0699a2f1b..870d8f6c9b 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=$(realpath $(XEN_ROOT)) DOXYGEN_OUTPUT=$(DOXYGEN_OUTPUT) \ $(SPHINXBUILD) -b html . sphinx/html else @@ -109,6 +112,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 .PHONY: distclean distclean: clean diff --git a/docs/hypercall-interfaces/arm32.rst b/docs/hypercall-interfaces/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 +============================ + +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-interfaces/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 +============================ + +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-interfaces/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 +==================== + +.. toctree:: + @XEN_TARGET_ARCH@ diff --git a/docs/hypercall-interfaces/x86_64.rst b/docs/hypercall-interfaces/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 +============================= + +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 +Hypercall Interfaces documentation +---------------------------------- + +.. toctree:: + :maxdepth: 2 + + hypercall-interfaces/index + Miscellanea -----------