diff options
| author | Peter Maydell <peter.maydell@linaro.org> | 2023-12-12 16:23:13 +0000 |
|---|---|---|
| committer | Peter Maydell <peter.maydell@linaro.org> | 2024-01-15 17:12:22 +0000 |
| commit | d95f260aee3ea1b12779cdede7456480ea9ea3d1 (patch) | |
| tree | d731d8c81085899f24155f1de2c867fb3eeb488d /qemu-img-cmds.hx | |
| parent | 977542ded7e6b28d2bc077bcda24568c716e393c (diff) | |
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 'qemu-img-cmds.hx')
| -rw-r--r-- | qemu-img-cmds.hx | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/qemu-img-cmds.hx b/qemu-img-cmds.hx index 068692d13e..c9dd70a892 100644 --- a/qemu-img-cmds.hx +++ b/qemu-img-cmds.hx @@ -1,3 +1,5 @@ +HXCOMM See docs/devel/docs.rst for the format of this file. +HXCOMM HXCOMM Keep the list of subcommands sorted by name. HXCOMM Use DEFHEADING() to define headings in both help text and rST HXCOMM Text between SRST and ERST are copied to rST version and |