qemu/docs/devel/index-build.rst

QEMU Build System
-----------------

Details about how QEMU's build system works. You will need to understand
some of the basics if you are adding new files and targets to the build.

.. toctree::
   :maxdepth: 3

   build-system
   kconfig
   docs
   qapi-code-gen
   control-flow-integrity
docs/devel: Split testing docs from the build docs and move to separate folder Building and testing are two separate topics, so let's split the testing into a separate category and move the related files into a separate folder. Message-ID: <20240830133841.142644-42-thuth@redhat.com> Signed-off-by: Thomas Huth <thuth@redhat.com> 2024-08-30 16:38:35 +03:00			`QEMU Build System`
			`-----------------`
docs/devel: try and impose some organisation We have a growing set of developer docs but the index is currently in order of when stuff was added. Try and make things a bit easier to find my adding sub indexes and organising into themes. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com> Message-Id: <20220315121251.2280317-7-alex.bennee@linaro.org> 2022-03-09 16:52:15 +03:00
docs/devel: Split testing docs from the build docs and move to separate folder Building and testing are two separate topics, so let's split the testing into a separate category and move the related files into a separate folder. Message-ID: <20240830133841.142644-42-thuth@redhat.com> Signed-off-by: Thomas Huth <thuth@redhat.com> 2024-08-30 16:38:35 +03:00			`Details about how QEMU's build system works. You will need to understand`
			`some of the basics if you are adding new files and targets to the build.`
docs/devel: try and impose some organisation We have a growing set of developer docs but the index is currently in order of when stuff was added. Try and make things a bit easier to find my adding sub indexes and organising into themes. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com> Message-Id: <20220315121251.2280317-7-alex.bennee@linaro.org> 2022-03-09 16:52:15 +03:00
			`.. toctree::`
docs/devel: drop :hidden: and :includehidden: tags This was confusing and in the case of qtest was hiding the details of the qgraph sub-document in the qtest pages. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Acked-by: Richard Henderson <richard.henderson@linaro.org> Message-Id: <20220419091020.3008144-4-alex.bennee@linaro.org> 2022-04-19 12:09:58 +03:00			`:maxdepth: 3`
docs/devel: try and impose some organisation We have a growing set of developer docs but the index is currently in order of when stuff was added. Try and make things a bit easier to find my adding sub indexes and organising into themes. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com> Message-Id: <20220315121251.2280317-7-alex.bennee@linaro.org> 2022-03-09 16:52:15 +03:00
			`build-system`
			`kconfig`
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 2023-12-12 19:23:13 +03:00			`docs`
docs/devel: try and impose some organisation We have a growing set of developer docs but the index is currently in order of when stuff was added. Try and make things a bit easier to find my adding sub indexes and organising into themes. Signed-off-by: Alex Bennée <alex.bennee@linaro.org> Reviewed-by: Kashyap Chamarthy <kchamart@redhat.com> Message-Id: <20220315121251.2280317-7-alex.bennee@linaro.org> 2022-03-09 16:52:15 +03:00			`qapi-code-gen`
			`control-flow-integrity`