Xen project Mailing List

[PATCH v6 8/9] docs: hypercalls sphinx skeleton for generated html

Create a skeleton for the documentation about hypercalls Signed-off-by: Luca Fancellu <luca.fancellu@xxxxxxx> --- 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=$(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 .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

©2013 Xen Project, A Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation.
Xen Project is a trademark of The Linux Foundation.