Peter Maydell d95f260aee 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		2024-01-15 17:12:22 +00:00
..
acpi-bits.rst	Revert "tests: Use separate virtual environment for avocado"	2023-08-28 09:55:48 +02:00
atomics.rst	atomics: eliminate mb_read/mb_set	2023-06-06 09:42:14 +02:00
bitops.rst
blkdebug.txt
blkverify.txt
block-coroutine-wrapper.rst	block-coroutine-wrapper.py: introduce co_wrapper	2022-12-15 16:07:43 +01:00
build-system.rst	meson: remove CONFIG_ALL	2023-12-31 09:11:28 +01:00
ci-definitions.rst.inc
ci-jobs.rst.inc	gitlab: enable ccache for many build jobs	2023-08-30 14:57:33 +01:00
ci-runners.rst.inc
ci.rst	docs/devel: clean-up the CI links in the docs	2022-06-01 18:55:04 +01:00
clocks.rst	docs: Constify VMstate in examples	2023-12-30 07:38:06 +11:00
code-of-conduct.rst	docs/devel: add a maintainers section to development process	2022-11-22 09:49:07 +00:00
conflict-resolution.rst
control-flow-integrity.rst
decodetree.rst	docs: Document decodetree named field syntax	2023-05-30 10:55:39 -07:00
docs.rst	docs/devel/docs: Document .hx file syntax	2024-01-15 17:12:22 +00:00
ebpf_rss.rst
fuzzing.rst	docs/fuzz: remove mentions of fork-based fuzzing	2023-02-16 23:02:46 -05:00
index-api.rst	hw/pci: modify pci_setup_iommu() to set PCIIOMMUOps	2023-11-03 09:20:31 +01:00
index-build.rst	docs/devel/docs: Document .hx file syntax	2024-01-15 17:12:22 +00:00
index-internals.rst	docs/devel: Add VFIO iommufd backend documentation	2023-12-19 19:03:38 +01:00
index-process.rst	docs/devel: add some front matter to the devel index	2023-07-03 12:52:08 +01:00
index-tcg.rst	docs/devel: add some front matter to the devel index	2023-07-03 12:52:08 +01:00
index.rst	docs/devel: add some front matter to the devel index	2023-07-03 12:52:08 +01:00
kconfig.rst	configure, meson: rename targetos to host_os	2023-12-31 09:11:29 +01:00
loads-stores.rst	docs/devel/loads-stores: Fix git grep regexes	2023-09-21 14:45:57 +01:00
lockcnt.txt
maintainers.rst	docs/devel: add a maintainers section to development process	2022-11-22 09:49:07 +00:00
memory.rst
migration.rst	docs: Constify VMstate in examples	2023-12-30 07:38:06 +11:00
modules.rst
multi-process.rst	docs: Don't mention "-mem-path" in multi-process.rst	2023-09-19 10:23:21 +02:00
multi-thread-tcg.rst	Rename "QEMU global mutex" to "BQL" in comments and docs	2024-01-08 10:45:43 -05:00
multiple-iothreads.txt	Rename "QEMU global mutex" to "BQL" in comments and docs	2024-01-08 10:45:43 -05:00
pci.rst	hw/pci: modify pci_setup_iommu() to set PCIIOMMUOps	2023-11-03 09:20:31 +01:00
qapi-code-gen.rst	Rename "QEMU global mutex" to "BQL" in comments and docs	2024-01-08 10:45:43 -05:00
qdev-api.rst	docs/devel: split qom-api reference into new file	2023-07-03 12:52:22 +01:00
qgraph.rst
qom-api.rst	docs/devel: split qom-api reference into new file	2023-07-03 12:52:22 +01:00
qom.rst	misc: Fix some typos in documentation and comments	2023-08-01 23:52:23 +02:00
qtest.rst	system: Rename softmmu/ directory as system/	2023-10-08 21:08:08 +02:00
rcu.txt
replay.rst	Rename "QEMU global mutex" to "BQL" in comments and docs	2024-01-08 10:45:43 -05:00
reset.rst	Replace "iothread lock" with "BQL" in comments	2024-01-08 10:45:43 -05:00
s390-cpu-topology.rst	docs/s390: Fix wrong command example in s390-cpu-topology.rst	2023-11-28 14:27:18 +01:00
s390-dasd-ipl.rst
secure-coding-practices.rst
stable-process.rst
style.rst	docs/style: permit inline loop variables	2023-08-30 14:57:44 +01:00
submitting-a-patch.rst	docs/devel: try and improve the language around patch review	2022-11-22 09:52:23 +00:00
submitting-a-pull-request.rst	docs/devel: add a maintainers section to development process	2022-11-22 09:49:07 +00:00
tcg-icount.rst	accel/tcg: Remove CF_LAST_IO	2023-11-14 10:40:54 -08:00
tcg-ops.rst	docs/devel/tcg-ops: fix missing newlines in "Host vector operations"	2023-08-24 11:22:42 -07:00
tcg-plugins.rst	docs: add a new section to outline emulation support	2023-02-02 10:44:23 +00:00
tcg.rst	docs/devel: add some front matter to the devel index	2023-07-03 12:52:08 +01:00
testing.rst	gitlab: add optional job to run flaky avocado tests	2023-12-01 17:47:20 +00:00
tracing.rst
trivial-patches.rst
ui.rst
vfio-iommufd.rst	docs/devel: Add VFIO iommufd backend documentation	2023-12-19 19:03:38 +01:00
vfio-migration.rst	vfio/migration: Add P2P support for VFIO migration	2023-09-11 08:34:05 +02:00
virtio-backends.rst
virtio-migration.txt
writing-monitor-commands.rst	qapi: Start to elide redundant has_FOO in generated C	2022-12-13 18:31:37 +01:00
zoned-storage.rst	docs/zoned-storage:add zoned emulation use case	2023-05-15 08:19:04 -04:00