Re: [PATCH 4/5] docs/system: move x86 CPU configuration to a separate document

[Peter Maydell]

On Tue, 7 Sept 2021 at 16:56, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> 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

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>

>  .. _pcsys_005freq:

This reminds me that we probably ought to clean up these weirdly
named labels that we inherited from the texinfo-to-rst conversion
unless we're actually using them.

thanks
-- PMM