From: Markus Armbruster <armbru@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: qemu@nongnu.org
Subject: docs/qemu-qmp-ref.7 markup messed up
Date: Fri, 26 Mar 2021 15:19:38 +0100 [thread overview]
Message-ID: <87v99engjp.fsf@dusky.pond.sub.org> (raw)
When I look at docs/qemu-qmp-ref.7 with less -R, I see
ReplicationMode (Enum)
An enumeration of replication modes.
Values
primary
Primary mode, the vm's state will be sent to secondary QEMU.
secondary
Secondary mode, receive the vm's state from primary QEMU.
Since
2.9
If
--> defined(CONFIG_REPLICATION).SS BlockdevOptionsReplication (Object)
Driver specific block device options for replication
Members
mode: ReplicationMode
the replication mode
The line I marked with --> is bad. It should instead look like
If
defined(CONFIG_REPLICATION)
BlockdevOptionsReplication (Object)
Driver specific block device options for replication
Unformatted code:
.SS \fBReplicationMode\fP (Enum)
.sp
An enumeration of replication modes.
.SS Values
.INDENT 0.0
.TP
.B \fBprimary\fP
Primary mode, the vm\(aqs state will be sent to secondary QEMU.
.TP
.B \fBsecondary\fP
Secondary mode, receive the vm\(aqs state from primary QEMU.
.UNINDENT
.SS Since
.sp
2.9
.SS If
--> \fBdefined(CONFIG_REPLICATION)\fP.SS \fBBlockdevOptionsReplication\fP (Object)
.sp
Driver specific block device options for replication
.SS Members
.INDENT 0.0
.TP
.B \fBmode\fP: \fBReplicationMode\fP
the replication mode
.TP
I believe line I marked with --> should be broken before .SS.
I'm using sphinx-build-3 2.2.2.
I checked with the merge commit that switched QAPI doc generation to
Sphinx (commit e344ffe73b), same result.
next reply other threads:[~2021-03-26 15:06 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-26 14:19 Markus Armbruster [this message]
2021-03-26 20:40 ` docs/qemu-qmp-ref.7 markup messed up John Snow
2021-04-06 13:33 ` Markus Armbruster
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=87v99engjp.fsf@dusky.pond.sub.org \
--to=armbru@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=qemu@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.