qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: John Snow <jsnow@redhat.com>
Cc: Michael Roth <michael.roth@amd.com>,
	QEMU Developers <qemu-devel@nongnu.org>,
	Markus Armbruster <armbru@redhat.com>
Subject: Re: [PATCH 1/1] sphinx: qapidoc: Wrap "If" section body in a paragraph node
Date: Tue, 6 Apr 2021 15:08:33 +0000	[thread overview]
Message-ID: <CAFEAcA-qh9GQSs=JFcoN74gKF-6+DDL39T1kUbAmmcA+AS7Xzw@mail.gmail.com> (raw)
In-Reply-To: <20210406141909.1992225-2-jsnow@redhat.com>

On Tue, 6 Apr 2021 at 15:19, John Snow <jsnow@redhat.com> wrote:
>
> These sections need to be wrapped in a block-level element, such as
> Paragraph in order for them to be rendered into Texinfo correctly.
>
> Before (e.g.):
>
> <section ids="qapidoc-713">
>   <title>If</title>
>   <literal>defined(CONFIG_REPLICATION)</literal>
> </section>
>
> became:
>
>   .SS If
>   \fBdefined(CONFIG_REPLICATION)\fP.SS \fBBlockdevOptionsReplication\fP (Object)
>   ...
>
>
> After:
>
> <section ids="qapidoc-713">
>   <title>If</title>
>   <paragraph>
>     <literal>defined(CONFIG_REPLICATION)</literal>
>   </paragraph>
> </section>
>
> becomes:
>
>   .SS If
>   .sp
>   \fBdefined(CONFIG_REPLICATION)\fP
>   .SS \fBBlockdevOptionsReplication\fP (Object)
>   ...
>
>
> Reported-by: Markus Armbruster <armbru@redhat.com>
> Tested-by: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: John Snow <jsnow@redhat.com>

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

It's a shame Sphinx doesn't diagnose this kind of mis-constructed
document tree.

thanks
-- PMM


  reply	other threads:[~2021-04-06 15:11 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-04-06 14:19 [PATCH 0/1] " John Snow
2021-04-06 14:19 ` [PATCH 1/1] " John Snow
2021-04-06 15:08   ` Peter Maydell [this message]
2021-04-13  4:34   ` Markus Armbruster
2021-04-07  9:41 ` [PATCH 0/1] " Markus Armbruster
2021-04-13  9:16   ` 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='CAFEAcA-qh9GQSs=JFcoN74gKF-6+DDL39T1kUbAmmcA+AS7Xzw@mail.gmail.com' \
    --to=peter.maydell@linaro.org \
    --cc=armbru@redhat.com \
    --cc=jsnow@redhat.com \
    --cc=michael.roth@amd.com \
    --cc=qemu-devel@nongnu.org \
    --subject='Re: [PATCH 1/1] sphinx: qapidoc: Wrap "If" section body in a paragraph node' \
    /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

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).