qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: Guoyi Tu <tugy@chinatelecom.cn>
Cc: Elena Ufimtseva <elena.ufimtseva@oracle.com>,
	Jagannathan Raman <jag.raman@oracle.com>,
	qemu-devel@nongnu.org
Subject: Re: [PATCH] docs: Fix title format errors in the multi-process.rst
Date: Fri, 21 Jun 2024 13:28:14 +0100	[thread overview]
Message-ID: <CAFEAcA8ix+iy1mzUFYAq4X69ZqQvH96ULN1bLeJkKjW5GL4Zmg@mail.gmail.com> (raw)
In-Reply-To: <4485ad60-45b9-4499-8f89-830c6e67decb@chinatelecom.cn>

On Wed, 19 Jun 2024 at 08:46, Guoyi Tu <tugy@chinatelecom.cn> wrote:
>
>
> Signed-off-by: Guoyi Tu <tugy@chinatelecom.cn>
> ---
>   docs/devel/multi-process.rst | 8 ++++++--
>   1 file changed, 6 insertions(+), 2 deletions(-)

I have a couple of questions about whether these are
the right heading levels. But this document uses quite
a lot of heading/subheading levels, and I'm not very
familiar with the contents, so my suggestions below might
not be right.

> diff --git a/docs/devel/multi-process.rst b/docs/devel/multi-process.rst
> index 4ef539c0b0..223f878139 100644
> --- a/docs/devel/multi-process.rst
> +++ b/docs/devel/multi-process.rst
> @@ -185,7 +185,9 @@ Another difference is that in the vhost user model,
> a single daemon can
>   support multiple QEMU instances. This is contrary to the security regime
>   desired, in which the emulation application should only be allowed to
>   access the files or devices the VM it's running on behalf of can access.
> -#### qemu-io model
> +
> +qemu-io model
> +'''''''''''''

Should this be ^^^^^^, i.e. same heading level as "vhost user model"
earlier in this subsection?

>   ``qemu-io`` is a test harness used to test changes to the QEMU block
> backend
>   object code (e.g., the code that implements disk images for disk driver
> @@ -587,7 +589,9 @@ described below attempt to ameliorate this effect by
> allowing the
>   emulation process to communicate directly with the kernel KVM driver.
>   The KVM file descriptors created would be passed to the emulation process
>   via initialization messages, much like the guest memory table is done.
> -#### MMIO acceleration
> +
> +MMIO acceleration
> +^^^^^^^^^^^^^^^^^

This seems like the right heading level, but should the
following headings ("data structures", "master descriptor",
"slave descriptor", "kvm_io_device ops") drop down a heading
level from ^^^ to ''', on the basis that they're sub-headings
under "MMIO acceleration" ?

thanks
-- PMM


      reply	other threads:[~2024-06-21 12:28 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-06-19  7:38 [PATCH] docs: Fix title format errors in the multi-process.rst Guoyi Tu
2024-06-21 12:28 ` Peter Maydell [this message]

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=CAFEAcA8ix+iy1mzUFYAq4X69ZqQvH96ULN1bLeJkKjW5GL4Zmg@mail.gmail.com \
    --to=peter.maydell@linaro.org \
    --cc=elena.ufimtseva@oracle.com \
    --cc=jag.raman@oracle.com \
    --cc=qemu-devel@nongnu.org \
    --cc=tugy@chinatelecom.cn \
    /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).