Skip to content

Commit

Permalink
docs: fix rst syntax errors in unbuilt docs
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
stefanhaRH committed Dec 19, 2019
1 parent 5847c75 commit f21673c
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 14 deletions.
6 changes: 3 additions & 3 deletions docs/arm-cpu-features.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ CPU type is possible with the `query-cpu-model-expansion` QMP command.
Below are some examples where `scripts/qmp/qmp-shell` (see the top comment
block in the script for usage) is used to issue the QMP commands.

(1) Determine which CPU features are available for the `max` CPU type
(Note, we started QEMU with qemu-system-aarch64, so `max` is
implementing the ARMv8-A reference manual in this case)::
1. Determine which CPU features are available for the `max` CPU type
(Note, we started QEMU with qemu-system-aarch64, so `max` is
implementing the ARMv8-A reference manual in this case)::

(QEMU) query-cpu-model-expansion type=full model={"name":"max"}
{ "return": {
Expand Down
4 changes: 2 additions & 2 deletions docs/virtio-net-failover.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
========================
======================================
QEMU virtio-net standby (net_failover)
========================
======================================

This document explains the setup and usage of virtio-net standby feature which
is used to create a net_failover pair of devices.
Expand Down
19 changes: 10 additions & 9 deletions docs/virtio-pmem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
Expand Down

0 comments on commit f21673c

Please sign in to comment.