aboutsummaryrefslogtreecommitdiff
path: root/MAINTAINERS
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2023-12-12 16:23:13 +0000
committerPeter Maydell <peter.maydell@linaro.org>2024-01-15 17:12:22 +0000
commitd95f260aee3ea1b12779cdede7456480ea9ea3d1 (patch)
treed731d8c81085899f24155f1de2c867fb3eeb488d /MAINTAINERS
parent977542ded7e6b28d2bc077bcda24568c716e393c (diff)
downloadqemu-d95f260aee3ea1b12779cdede7456480ea9ea3d1.zip
qemu-d95f260aee3ea1b12779cdede7456480ea9ea3d1.tar.gz
qemu-d95f260aee3ea1b12779cdede7456480ea9ea3d1.tar.bz2
docs/devel/docs: Document .hx file syntax
We don't currently document the syntax of .hx files anywhere except in a few comments at the top of individual .hx files. We don't even have somewhere in the developer docs where we could do this. Add a new files docs/devel/docs.rst which can be a place to document how our docs build process works. For the moment, put in only a brief introductory paragraph and the documentation of the .hx files. We could later add to this file by for example describing how the QAPI-schema-to-docs process works, or anything else that developers might need to know about how to add documentation. Make the .hx files refer to this doc file, and clean up their header comments to be more accurate for the usage in each file and less cut-n-pasted. Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Luc Michel <luc.michel@amd.com> Reviewed-by: David Woodhouse <dwmw@amazon.co.uk> Message-id: 20231212162313.1742462-1-peter.maydell@linaro.org
Diffstat (limited to 'MAINTAINERS')
-rw-r--r--MAINTAINERS1
1 files changed, 1 insertions, 0 deletions
diff --git a/MAINTAINERS b/MAINTAINERS
index b406fb2..8e8ca27 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -4175,6 +4175,7 @@ F: docs/conf.py
F: docs/*/conf.py
F: docs/sphinx/
F: docs/_templates/
+F: docs/devel/docs.rst
Miscellaneous
-------------