All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: qemu-devel@nongnu.org
Subject: Re: [for-5.2 4/9] docs/system/virtio-pmem.rst: Fix minor style issues
Date: Thu, 12 Nov 2020 18:23:08 +0000	[thread overview]
Message-ID: <87y2j65t9v.fsf@linaro.org> (raw)
In-Reply-To: <20201112144041.32278-5-peter.maydell@linaro.org>


Peter Maydell <peter.maydell@linaro.org> writes:

> The virtio-pmem documentation has some minor style issues we hadn't
> noticed since we weren't rendering it in our docs:
>
>  * Sphinx doesn't complain about overlong title-underlining the
>    way it complains about too-short underlining, but it looks odd;
>    make the underlines of the top level title the right length
>
>  * Indent of paragraphs makes them render as blockquotes;
>    remove the indent so they just render as normal text
>
>  * Leading 'o' isn't rst markup, so it just renders as a literal
>    "o"; reformat as a subsection heading instead
>
>  * "QEMU" in the document title and section headings are a bit
>    odd and unnecessary since this is the QEMU manual; delete
>    or rephrase them
>
>  * There's no need to specify what QEMU version the device first
>    appeared in.
>
> Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
> ---
>  docs/system/virtio-pmem.rst | 55 ++++++++++++++++++-------------------
>  1 file changed, 27 insertions(+), 28 deletions(-)
>
> diff --git a/docs/system/virtio-pmem.rst b/docs/system/virtio-pmem.rst
> index 4bf5d004432..e5f91eff1c2 100644
> --- a/docs/system/virtio-pmem.rst
> +++ b/docs/system/virtio-pmem.rst
> @@ -1,38 +1,37 @@
>  
> -========================
> -QEMU virtio pmem
> -========================
> +===========
> +virtio pmem
> +===========
>  
> - This document explains the setup and usage of the virtio pmem device
> - which is available since QEMU v4.1.0.
> -
> - The virtio pmem device is a paravirtualized persistent memory device
> - on regular (i.e non-NVDIMM) storage.
> +This document explains the setup and usage of the virtio pmem device.
> +The virtio pmem device is a paravirtualized persistent memory device
> +on regular (i.e non-NVDIMM) storage.
>  
>  Usecase
>  --------

nit: but we didn't fix this while we were at it?

Anyway:

Reviewed-by: Alex Bennée <alex.bennee@linaro.org>

-- 
Alex Bennée


  reply	other threads:[~2020-11-12 18:24 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-12 14:40 [for-5.2 0/9] docs: Move orphan top-level .rst files into manuals Peter Maydell
2020-11-12 14:40 ` [for-5.2 1/9] docs: Move virtio-net-failover.rst into the system manual Peter Maydell
2020-11-12 18:08   ` Alex Bennée
2020-11-12 14:40 ` [for-5.2 2/9] docs: Move cpu-hotplug.rst " Peter Maydell
2020-11-12 18:10   ` Alex Bennée
2020-11-12 14:40 ` [for-5.2 3/9] docs: Move virtio-pmem.rst " Peter Maydell
2020-11-12 18:17   ` Alex Bennée
2020-11-12 14:40 ` [for-5.2 4/9] docs/system/virtio-pmem.rst: Fix minor style issues Peter Maydell
2020-11-12 18:23   ` Alex Bennée [this message]
2020-11-19 14:17   ` Pankaj Gupta
2020-11-12 14:40 ` [for-5.2 5/9] docs: Split out 'pc' machine model docs into their own file Peter Maydell
2020-11-12 18:26   ` Alex Bennée
2020-11-12 14:40 ` [for-5.2 6/9] docs: Move microvm.rst into the system manual Peter Maydell
2020-11-12 18:30   ` Alex Bennée
2020-11-12 14:40 ` [for-5.2 7/9] docs: Move pr-manager.rst " Peter Maydell
2020-11-12 18:31   ` Alex Bennée
2020-11-12 14:40 ` [for-5.2 8/9] docs: Split qemu-pr-helper documentation into tools manual Peter Maydell
2020-11-12 18:32   ` Alex Bennée
2020-11-12 14:40 ` [for-5.2 9/9] docs/system/pr-manager.rst: Fix minor docs nits Peter Maydell
2020-11-12 18:32   ` Alex Bennée
2020-11-12 18:33 ` [for-5.2 0/9] docs: Move orphan top-level .rst files into manuals Alex Bennée

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=87y2j65t9v.fsf@linaro.org \
    --to=alex.bennee@linaro.org \
    --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 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.