Ver código fonte

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>
Stefan Hajnoczi 5 anos atrás
pai
commit
f21673c35e
3 arquivos alterados com 15 adições e 14 exclusões
  1. 3 3
      docs/arm-cpu-features.rst
  2. 2 2
      docs/virtio-net-failover.rst
  3. 10 9
      docs/virtio-pmem.rst

+ 3 - 3
docs/arm-cpu-features.rst

@@ -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
 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.
 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"}
       (QEMU) query-cpu-model-expansion type=full model={"name":"max"}
       { "return": {
       { "return": {

+ 2 - 2
docs/virtio-net-failover.rst

@@ -1,6 +1,6 @@
-========================
+======================================
 QEMU virtio-net standby (net_failover)
 QEMU virtio-net standby (net_failover)
-========================
+======================================
 
 
 This document explains the setup and usage of virtio-net standby feature which
 This document explains the setup and usage of virtio-net standby feature which
 is used to create a net_failover pair of devices.
 is used to create a net_failover pair of devices.

+ 10 - 9
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
   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"
   Multiple virtio pmem devices can be created if multiple pairs of "-object"
   and "-device" are provided.
   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'.
 pmem device can be added via 'device_add'.
 
 
 For example, the following commands add another 4GB virtio pmem device to
 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) 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
  (qemu) device_add virtio-pmem-pci,id=virtio_pmem2,memdev=mem2