diff options
| author | Paolo Bonzini | 2021-09-07 16:01:28 +0200 |
|---|---|---|
| committer | Paolo Bonzini | 2021-09-13 13:56:26 +0200 |
| commit | 06905f640242c927f07e8c4b45fd4061ffa235ef (patch) | |
| tree | cf592817e57952f6bd910b8d54937f58bcc3acea /docs/system | |
| parent | docs: standardize book titles to === with overline (diff) | |
| download | qemu-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/system')
| -rw-r--r-- | docs/system/index.rst | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/system/index.rst b/docs/system/index.rst index 7b9276c05f..73bbedbc22 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -1,5 +1,6 @@ +---------------- System Emulation -================ +---------------- This section of the manual is the overall guide for users using QEMU for full system emulation (as opposed to user-mode emulation). |