From: Luca Fancellu <luca.fancellu@arm.com>
To: xen-devel@lists.xenproject.org
Cc: bertrand.marquis@arm.com, wei.chen@arm.com,
Andrew Cooper <andrew.cooper3@citrix.com>,
George Dunlap <george.dunlap@citrix.com>,
Ian Jackson <iwj@xenproject.org>, Jan Beulich <jbeulich@suse.com>,
Julien Grall <julien@xen.org>,
Stefano Stabellini <sstabellini@kernel.org>, Wei Liu <wl@xen.org>
Subject: [PATCH v7 8/9] docs: hypercalls sphinx skeleton for generated html
Date: Mon, 5 Jul 2021 11:51:02 +0100 [thread overview]
Message-ID: <20210705105103.14509-9-luca.fancellu@arm.com> (raw)
In-Reply-To: <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 <luca.fancellu@arm.com>
---
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
-----------
--
2.17.1
next prev parent reply other threads:[~2021-07-05 10:55 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-05 10:50 [PATCH v7 0/9] Use Doxygen and sphinx for html documentation Luca Fancellu
2021-07-05 10:50 ` [PATCH v7 1/9] docs: add doxygen configuration file Luca Fancellu
2021-07-05 10:50 ` [PATCH v7 2/9] docs: add Xen png logo for the doxygen documentation Luca Fancellu
2021-07-05 10:50 ` [PATCH v7 3/9] docs: add doxygen templates Luca Fancellu
2021-07-05 10:50 ` [PATCH v7 4/9] m4/python: add function to docs_tool.m4 and new m4 module Luca Fancellu
2021-07-05 10:50 ` [PATCH v7 5/9] docs: add checks to configure for sphinx and doxygen Luca Fancellu
2021-07-05 10:51 ` [PATCH v7 6/9] docs: add doxygen preprocessor and related files Luca Fancellu
2021-07-05 10:51 ` [PATCH v7 7/9] docs: Change Makefile and sphinx configuration for doxygen Luca Fancellu
2021-07-05 10:51 ` Luca Fancellu [this message]
2021-07-05 10:51 ` [PATCH v7 9/9] docs/doxygen: doxygen documentation for grant_table.h Luca Fancellu
2021-07-05 13:03 ` Jan Beulich
2021-07-05 13:23 ` Luca Fancellu
2021-07-05 13:27 ` Jan Beulich
2021-07-06 8:38 ` Luca Fancellu
2021-07-05 14:20 ` Julien Grall
2021-07-06 8:44 ` Luca Fancellu
2021-07-07 13:24 ` Julien Grall
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210705105103.14509-9-luca.fancellu@arm.com \
--to=luca.fancellu@arm.com \
--cc=andrew.cooper3@citrix.com \
--cc=bertrand.marquis@arm.com \
--cc=george.dunlap@citrix.com \
--cc=iwj@xenproject.org \
--cc=jbeulich@suse.com \
--cc=julien@xen.org \
--cc=sstabellini@kernel.org \
--cc=wei.chen@arm.com \
--cc=wl@xen.org \
--cc=xen-devel@lists.xenproject.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).