summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNeil Williams <codehelp@debian.org>2016-01-12 19:28:16 +0000
committerNeil Williams <codehelp@debian.org>2016-01-12 19:28:16 +0000
commitb4c07e7da920ac46f640dd8555d187762c401263 (patch)
tree118b74e2b68b171ec0c717c5676704861e80ac94 /doc
parent513a847a24a62a1ee26776802c787694f3843b8e (diff)
downloadvmdebootstrap-b4c07e7da920ac46f640dd8555d187762c401263.tar.gz
Fix rst syntax
Martin Michlmayr <tbm@hpe.com> http://lists.alioth.debian.org/pipermail/vmdebootstrap-devel/Week-of-Mon-20160111/000390.html
Diffstat (limited to 'doc')
-rw-r--r--doc/overview.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/overview.rst b/doc/overview.rst
index 68f0491..8f33a14 100644
--- a/doc/overview.rst
+++ b/doc/overview.rst
@@ -15,8 +15,8 @@ sent to the command line. If the ``--log`` option is not used, no
output will be sent to any log files either.
To use the image, you probably want to create a virtual machine using
-your preferred virtualization technology, such as file:`kvm` or
-file:`qemu`. Configure the virtual machine to use the image you've
+your preferred virtualization technology, such as :file:`kvm` or
+:file:`qemu`. Configure the virtual machine to use the image you've
created. Then start the virtual machine and log into it via its console
to configure it. The image has an empty root password and will not have
networking configured by default. Set the root password before you
@@ -335,14 +335,14 @@ image file or directory, not a physical block device / removable media.
the command line to launch a new virtual machine. Not all devices have
virtualisation support in hardware.
-This has implications for file:`u-boot` support in some cases. If the
+This has implications for :file:`u-boot` support in some cases. If the
device can support reading the bootloader from a known partition, like
the beaglebone-black, then :file:`vmdebootstrap` can provide space for
the bootloader and the image will work as a prebuilt installation image.
If the device expects that the bootloader exists at a specific offset
and therefore requires that the bootloader is written as an image not
as a binary which can be copied into an existing partition,
-:file:vmdebootstrap` is unable to include that bootloader image into
+:file:`vmdebootstrap` is unable to include that bootloader image into
the virtual machine image.
The beagleboneblack.sh script in the examples/ directory provides a worked
@@ -519,7 +519,7 @@ will be used.
LAVA tests
----------
-There is an example file:`lava-submit.py` script which can be edited
+There is an example :file:`lava-submit.py` script which can be edited
to automatically submit QEMU tests to a specified LAVA instance. The
images themselves will use local ``file://`` URLs and therefore the
``lava-dispatcher`` needs to be installed locally. Configuring LAVA