From: Paolo Bonzini <pbonzini@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org
Subject: [PATCH 4/5] docs/system: move x86 CPU configuration to a separate document
Date: Tue, 7 Sep 2021 17:56:40 +0200 [thread overview]
Message-ID: <20210907155641.197844-5-pbonzini@redhat.com> (raw)
In-Reply-To: <20210907155641.197844-1-pbonzini@redhat.com>
Currently, cpu-models-x86.rst.inc is included in target-i386.rst directly.
To make the toctree more homogeneous when adding more documentation,
include it through a first-class .rst file.
Together with the previous changes to the man page skeletons, this also
frees "===" for the headings, so that cpu-models-x86.rst.inc need not
assume anything about the headings used by target-i386.rst.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
docs/system/cpu-models-x86.rst.inc | 4 ++--
docs/system/i386/cpu.rst | 1 +
docs/system/target-i386.rst | 8 +++++++-
3 files changed, 10 insertions(+), 3 deletions(-)
create mode 100644 docs/system/i386/cpu.rst
diff --git a/docs/system/cpu-models-x86.rst.inc b/docs/system/cpu-models-x86.rst.inc
index 9119f5dff5..6e8be7d79b 100644
--- a/docs/system/cpu-models-x86.rst.inc
+++ b/docs/system/cpu-models-x86.rst.inc
@@ -1,5 +1,5 @@
Recommendations for KVM CPU model configuration on x86 hosts
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+============================================================
The information that follows provides recommendations for configuring
CPU models on x86 hosts. The goals are to maximise performance, while
@@ -368,7 +368,7 @@ featureset, which prevents guests having optimal performance.
Syntax for configuring CPU models
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+=================================
The examples below illustrate the approach to configuring the various
CPU models / features in QEMU and libvirt.
diff --git a/docs/system/i386/cpu.rst b/docs/system/i386/cpu.rst
new file mode 100644
index 0000000000..738719da9a
--- /dev/null
+++ b/docs/system/i386/cpu.rst
@@ -0,0 +1 @@
+.. include:: ../cpu-models-x86.rst.inc
diff --git a/docs/system/target-i386.rst b/docs/system/target-i386.rst
index 22ba5ce2c0..c9720a8cd1 100644
--- a/docs/system/target-i386.rst
+++ b/docs/system/target-i386.rst
@@ -19,7 +19,13 @@ Board-specific documentation
i386/microvm
i386/pc
-.. include:: cpu-models-x86.rst.inc
+Architectural features
+~~~~~~~~~~~~~~~~~~~~~~
+
+.. toctree::
+ :maxdepth: 1
+
+ i386/cpu
.. _pcsys_005freq:
--
2.31.1
next prev parent reply other threads:[~2021-09-07 16:02 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-07 15:56 [PATCH 0/5] docs: reorganize target-i386 to make room for SGX Paolo Bonzini
2021-09-07 15:56 ` [PATCH 1/5] docs: standardize book titles to === with overline Paolo Bonzini
2021-09-07 16:08 ` Peter Maydell
2021-09-07 15:56 ` [PATCH 2/5] docs: standardize directory index to --- " Paolo Bonzini
2021-09-07 16:08 ` Peter Maydell
2021-09-07 15:56 ` [PATCH 3/5] docs/system: standardize docs/system man page sections " Paolo Bonzini
2021-09-07 16:21 ` Peter Maydell
2021-09-07 15:56 ` Paolo Bonzini [this message]
2021-09-07 16:23 ` [PATCH 4/5] docs/system: move x86 CPU configuration to a separate document Peter Maydell
2021-09-07 15:56 ` [PATCH 5/5] docs/system: move SGX documentation within the system docs Paolo Bonzini
2021-09-07 16:28 ` Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210907155641.197844-5-pbonzini@redhat.com \
--to=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).