qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Peter Maydell <peter.maydell@linaro.org>
To: qemu-devel@nongnu.org
Subject: [PULL 19/24] docs/system/virtio-pmem.rst: Fix minor style issues
Date: Mon, 23 Nov 2020 11:43:10 +0000	[thread overview]
Message-ID: <20201123114315.13372-20-peter.maydell@linaro.org> (raw)
In-Reply-To: <20201123114315.13372-1-peter.maydell@linaro.org>

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 section headers 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>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Reviewed-by: Pankaj Gupta <pankaj.gupta@cloud.ionos.com>
---
 docs/system/virtio-pmem.rst | 60 ++++++++++++++++++-------------------
 1 file changed, 30 insertions(+), 30 deletions(-)

diff --git a/docs/system/virtio-pmem.rst b/docs/system/virtio-pmem.rst
index 4bf5d004432..c82ac067315 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
---------
+-------
 
-  Virtio pmem allows to bypass the guest page cache and directly use
-  host page cache. This reduces guest memory footprint as the host can
-  make efficient memory reclaim decisions under memory pressure.
+Virtio pmem allows to bypass the guest page cache and directly use
+host page cache. This reduces guest memory footprint as the host can
+make efficient memory reclaim decisions under memory pressure.
 
-o How does virtio-pmem compare to the nvdimm emulation supported by QEMU?
+How does virtio-pmem compare to the nvdimm emulation?
+-----------------------------------------------------
 
-  NVDIMM emulation on regular (i.e. non-NVDIMM) host storage does not
-  persist the guest writes as there are no defined semantics in the device
-  specification. The virtio pmem device provides guest write persistence
-  on non-NVDIMM host storage.
+NVDIMM emulation on regular (i.e. non-NVDIMM) host storage does not
+persist the guest writes as there are no defined semantics in the device
+specification. The virtio pmem device provides guest write persistence
+on non-NVDIMM host storage.
 
 virtio pmem usage
 -----------------
 
-  A virtio pmem device backed by a memory-backend-file can be created on
-  the QEMU command line as in the following example::
+A virtio pmem device backed by a memory-backend-file can be created on
+the QEMU command line as in the following example::
 
     -object memory-backend-file,id=mem1,share,mem-path=./virtio_pmem.img,size=4G
     -device virtio-pmem-pci,memdev=mem1,id=nv1
 
-  where:
+where:
 
   - "object memory-backend-file,id=mem1,share,mem-path=<image>, size=<image size>"
     creates a backend file with the specified size.
@@ -40,8 +39,8 @@ virtio pmem usage
   - "device virtio-pmem-pci,id=nvdimm1,memdev=mem1" creates a virtio pmem
     pci device whose storage is provided by above memory backend device.
 
-  Multiple virtio pmem devices can be created if multiple pairs of "-object"
-  and "-device" are provided.
+Multiple virtio pmem devices can be created if multiple pairs of "-object"
+and "-device" are provided.
 
 Hotplug
 -------
@@ -59,17 +58,18 @@ the guest::
 Guest Data Persistence
 ----------------------
 
- Guest data persistence on non-NVDIMM requires guest userspace applications
- to perform fsync/msync. This is different from a real nvdimm backend where
- no additional fsync/msync is required. This is to persist guest writes in
- host backing file which otherwise remains in host page cache and there is
- risk of losing the data in case of power failure.
+Guest data persistence on non-NVDIMM requires guest userspace applications
+to perform fsync/msync. This is different from a real nvdimm backend where
+no additional fsync/msync is required. This is to persist guest writes in
+host backing file which otherwise remains in host page cache and there is
+risk of losing the data in case of power failure.
 
- With virtio pmem device, MAP_SYNC mmap flag is not supported. This provides
- a hint to application to perform fsync for write persistence.
+With virtio pmem device, MAP_SYNC mmap flag is not supported. This provides
+a hint to application to perform fsync for write persistence.
 
 Limitations
-------------
+-----------
+
 - Real nvdimm device backend is not supported.
 - virtio pmem hotunplug is not supported.
 - ACPI NVDIMM features like regions/namespaces are not supported.
-- 
2.20.1



  parent reply	other threads:[~2020-11-23 12:04 UTC|newest]

Thread overview: 26+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-11-23 11:42 [PULL 00/24] target-arm queue Peter Maydell
2020-11-23 11:42 ` [PULL 01/24] target/arm: fix stage 2 page-walks in 32-bit emulation Peter Maydell
2020-11-23 11:42 ` [PULL 02/24] hw/arm: Fix bad print format specifiers Peter Maydell
2020-11-23 11:42 ` [PULL 03/24] hw/intc: fix heap-buffer-overflow in rxicu_realize() Peter Maydell
2020-11-23 11:42 ` [PULL 04/24] MAINTAINERS: Cover system/arm/cpu-features.rst with ARM TCG CPUs Peter Maydell
2020-11-23 11:42 ` [PULL 05/24] MAINTAINERS: Cover system/arm/aspeed.rst with ASPEED BMC machines Peter Maydell
2020-11-23 11:42 ` [PULL 06/24] MAINTAINERS: Cover system/arm/nuvoton.rst with Nuvoton NPCM7xx Peter Maydell
2020-11-23 11:42 ` [PULL 07/24] MAINTAINERS: Fix system/arm/orangepi.rst path Peter Maydell
2020-11-23 11:42 ` [PULL 08/24] MAINTAINERS: Cover system/arm/sbsa.rst with SBSA-REF machine Peter Maydell
2020-11-23 11:43 ` [PULL 09/24] MAINTAINERS: Cover system/arm/sx1.rst with OMAP machines Peter Maydell
2020-11-23 11:43 ` [PULL 10/24] docs/system: Deprecate raspi2/raspi3 machine aliases Peter Maydell
2020-11-23 11:43 ` [PULL 11/24] docs/system/arm: Document the various raspi boards Peter Maydell
2020-11-23 11:43 ` [PULL 12/24] docs/system/arm: Document OpenPOWER Witherspoon BMC model Front LEDs Peter Maydell
2020-11-23 11:43 ` [PULL 13/24] docs/system/arm: Document the Sharp Zaurus SL-6000 Peter Maydell
2020-11-23 11:43 ` [PULL 14/24] target/arm: Make SYS_HEAPINFO work with RAM that doesn't start at 0 Peter Maydell
2020-11-23 11:43 ` [PULL 15/24] linux-user/arm: Deliver SIGTRAP for UDF patterns used as breakpoints Peter Maydell
2020-11-23 11:43 ` [PULL 16/24] docs: Move virtio-net-failover.rst into the system manual Peter Maydell
2020-11-23 11:43 ` [PULL 17/24] docs: Move cpu-hotplug.rst " Peter Maydell
2020-11-23 11:43 ` [PULL 18/24] docs: Move virtio-pmem.rst " Peter Maydell
2020-11-23 11:43 ` Peter Maydell [this message]
2020-11-23 11:43 ` [PULL 20/24] docs: Split out 'pc' machine model docs into their own file Peter Maydell
2020-11-23 11:43 ` [PULL 21/24] docs: Move microvm.rst into the system manual Peter Maydell
2020-11-23 11:43 ` [PULL 22/24] docs: Move pr-manager.rst " Peter Maydell
2020-11-23 11:43 ` [PULL 23/24] docs: Split qemu-pr-helper documentation into tools manual Peter Maydell
2020-11-23 11:43 ` [PULL 24/24] docs/system/pr-manager.rst: Fix minor docs nits Peter Maydell
2020-11-23 17:03 ` [PULL 00/24] target-arm queue 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=20201123114315.13372-20-peter.maydell@linaro.org \
    --to=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 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).