aboutsummaryrefslogtreecommitdiff
path: root/docs/virtio-pmem.rst
diff options
context:
space:
mode:
authorStefan Hajnoczi <stefanha@redhat.com>2019-11-11 09:44:11 +0000
committerStefan Hajnoczi <stefanha@redhat.com>2019-12-19 16:20:21 +0000
commitf21673c35e0a49e66e228825a9ea3e81a9947eed (patch)
tree5af28a22f8f5dd04745cd2f4b994db0182a835ed /docs/virtio-pmem.rst
parent5847c750f3d31959022cc67a03870ba1a229d59b (diff)
downloadqemu-f21673c35e0a49e66e228825a9ea3e81a9947eed.zip
qemu-f21673c35e0a49e66e228825a9ea3e81a9947eed.tar.gz
qemu-f21673c35e0a49e66e228825a9ea3e81a9947eed.tar.bz2
docs: fix rst syntax errors in unbuilt docs
The .rst files outside docs/{devel,interop,specs} aren't built yet and therefore a few syntax errors have slipped through. Fix them. Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> Message-Id: <20191111094411.427174-1-stefanha@redhat.com> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Diffstat (limited to 'docs/virtio-pmem.rst')
-rw-r--r--docs/virtio-pmem.rst19
1 files changed, 10 insertions, 9 deletions
diff --git a/docs/virtio-pmem.rst b/docs/virtio-pmem.rst
index e77881b..4bf5d00 100644
--- a/docs/virtio-pmem.rst
+++ b/docs/virtio-pmem.rst
@@ -27,17 +27,18 @@ 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:
+ 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
+ -object memory-backend-file,id=mem1,share,mem-path=./virtio_pmem.img,size=4G
+ -device virtio-pmem-pci,memdev=mem1,id=nv1
- where:
- - "object memory-backend-file,id=mem1,share,mem-path=<image>, size=<image size>"
- creates a backend file with the specified size.
+ where:
- - "device virtio-pmem-pci,id=nvdimm1,memdev=mem1" creates a virtio pmem
- pci device whose storage is provided by above memory backend device.
+ - "object memory-backend-file,id=mem1,share,mem-path=<image>, size=<image size>"
+ creates a backend file with the specified size.
+
+ - "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.
@@ -50,7 +51,7 @@ memory backing has to be added via 'object_add'; afterwards, the virtio
pmem device can be added via 'device_add'.
For example, the following commands add another 4GB virtio pmem device to
-the guest:
+the guest::
(qemu) object_add memory-backend-file,id=mem2,share=on,mem-path=virtio_pmem2.img,size=4G
(qemu) device_add virtio-pmem-pci,id=virtio_pmem2,memdev=mem2