summaryrefslogtreecommitdiffstats
path: root/docs/user
diff options
context:
space:
mode:
authorPaolo Bonzini2021-09-07 16:01:28 +0200
committerPaolo Bonzini2021-09-13 13:56:26 +0200
commit06905f640242c927f07e8c4b45fd4061ffa235ef (patch)
treecf592817e57952f6bd910b8d54937f58bcc3acea /docs/user
parentdocs: standardize book titles to === with overline (diff)
downloadqemu-06905f640242c927f07e8c4b45fd4061ffa235ef.tar.gz
qemu-06905f640242c927f07e8c4b45fd4061ffa235ef.tar.xz
qemu-06905f640242c927f07e8c4b45fd4061ffa235ef.zip
docs: standardize directory index to --- with overline
Use a standard heading format for the index.rst file in a directory. Using overlines makes it clear that individual documents can use e.g. === for chapter titles and --- for section titles, as suggested in the Linux kernel guidelines[1]. They could do it anyway, because documents included in a toctree are parsed separately and therefore are not tied to the same conventions for headings. However, keeping some consistency is useful since sometimes files are included from multiple places. [1] https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html Reviewed-by: Peter Maydell <peter.maydell@linaro.org> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'docs/user')
-rw-r--r--docs/user/index.rst3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/user/index.rst b/docs/user/index.rst
index 9faa4badd7..2c4e29f3db 100644
--- a/docs/user/index.rst
+++ b/docs/user/index.rst
@@ -1,5 +1,6 @@
+-------------------
User Mode Emulation
-===================
+-------------------
This section of the manual is the overall guide for users using QEMU
for user-mode emulation. In this mode, QEMU can launch