summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-qemu.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/dev-manual/dev-manual-qemu.rst')
-rw-r--r--documentation/dev-manual/dev-manual-qemu.rst43
1 files changed, 25 insertions, 18 deletions
diff --git a/documentation/dev-manual/dev-manual-qemu.rst b/documentation/dev-manual/dev-manual-qemu.rst
index 9337a35428..c91e8b5389 100644
--- a/documentation/dev-manual/dev-manual-qemu.rst
+++ b/documentation/dev-manual/dev-manual-qemu.rst
@@ -33,10 +33,10 @@ implementation of QEMU.
33For official information and documentation on QEMU in general, see the 33For official information and documentation on QEMU in general, see the
34following references: 34following references:
35 35
36- `QEMU Website <http://wiki.qemu.org/Main_Page>`__\ *:* The official 36- `QEMU Website <https://wiki.qemu.org/Main_Page>`__\ *:* The official
37 website for the QEMU Open Source project. 37 website for the QEMU Open Source project.
38 38
39- `Documentation <http://wiki.qemu.org/Manual>`__\ *:* The QEMU user 39- `Documentation <https://wiki.qemu.org/Manual>`__\ *:* The QEMU user
40 manual. 40 manual.
41 41
42.. _qemu-running-qemu: 42.. _qemu-running-qemu:
@@ -141,14 +141,14 @@ available. Follow these general steps to run QEMU:
141 141
142 - This example does not provide enough information for QEMU to 142 - This example does not provide enough information for QEMU to
143 launch. While the command does provide a root filesystem type, it 143 launch. While the command does provide a root filesystem type, it
144 must also minimally provide a MACHINE, KERNEL, or VM option. 144 must also minimally provide a `MACHINE`, `KERNEL`, or `VM` option.
145 :: 145 ::
146 146
147 $ runqemu ext4 147 $ runqemu ext4
148 148
149 - This example specifies to boot a virtual machine image 149 - This example specifies to boot a virtual machine image
150 (``.wic.vmdk`` file). From the ``.wic.vmdk``, ``runqemu`` 150 (``.wic.vmdk`` file). From the ``.wic.vmdk``, ``runqemu``
151 determines the QEMU architecture (MACHINE) to be "qemux86-64" and 151 determines the QEMU architecture (`MACHINE`) to be "qemux86-64" and
152 the root filesystem type to be "vmdk". 152 the root filesystem type to be "vmdk".
153 :: 153 ::
154 154
@@ -208,7 +208,8 @@ using an NFS server.
208 extracts it into a location that you specify. Here is an example that 208 extracts it into a location that you specify. Here is an example that
209 takes a file system and extracts it to a directory named 209 takes a file system and extracts it to a directory named
210 ``test-nfs``: 210 ``test-nfs``:
211 :: 211
212 .. code-block:: none
212 213
213 runqemu-extract-sdk ./tmp/deploy/images/qemux86-64/core-image-sato-qemux86-64.tar.bz2 test-nfs 214 runqemu-extract-sdk ./tmp/deploy/images/qemux86-64/core-image-sato-qemux86-64.tar.bz2 test-nfs
214 215
@@ -217,7 +218,8 @@ using an NFS server.
217 You can then also make changes to the files within ``./test-nfs`` and 218 You can then also make changes to the files within ``./test-nfs`` and
218 see those changes appear in the image in real time. Here is an 219 see those changes appear in the image in real time. Here is an
219 example using the ``qemux86`` image: 220 example using the ``qemux86`` image:
220 :: 221
222 .. code-block:: none
221 223
222 runqemu qemux86-64 ./test-nfs 224 runqemu qemux86-64 ./test-nfs
223 225
@@ -226,14 +228,20 @@ using an NFS server.
226 Should you need to start, stop, or restart the NFS share, you can use 228 Should you need to start, stop, or restart the NFS share, you can use
227 the following commands: 229 the following commands:
228 230
229 - The following command starts the NFS share: runqemu-export-rootfs 231 - The following command starts the NFS share:
230 start file-system-location 232 ::
233
234 runqemu-export-rootfs start file-system-location
235
236 - The following command stops the NFS share:
237 ::
231 238
232 - The following command stops the NFS share: runqemu-export-rootfs 239 runqemu-export-rootfs stop file-system-location
233 stop file-system-location
234 240
235 - The following command restarts the NFS share: 241 - The following command restarts the NFS share:
236 runqemu-export-rootfs restart file-system-location 242 ::
243
244 runqemu-export-rootfs restart file-system-location
237 245
238.. _qemu-kvm-cpu-compatibility: 246.. _qemu-kvm-cpu-compatibility:
239 247
@@ -380,30 +388,29 @@ command line:
380.. note:: 388.. note::
381 389
382 If you do provide some "illegal" option combination or perhaps you do 390 If you do provide some "illegal" option combination or perhaps you do
383 not provide enough in the way of options, 391 not provide enough in the way of options, ``runqemu``
384 runqemu
385 provides appropriate error messaging to help you correct the problem. 392 provides appropriate error messaging to help you correct the problem.
386 393
387- QEMUARCH: The QEMU machine architecture, which must be "qemuarm", 394- `QEMUARCH`: The QEMU machine architecture, which must be "qemuarm",
388 "qemuarm64", "qemumips", "qemumips64", "qemuppc", "qemux86", or 395 "qemuarm64", "qemumips", "qemumips64", "qemuppc", "qemux86", or
389 "qemux86-64". 396 "qemux86-64".
390 397
391- ``VM``: The virtual machine image, which must be a ``.wic.vmdk`` 398- `VM`: The virtual machine image, which must be a ``.wic.vmdk``
392 file. Use this option when you want to boot a ``.wic.vmdk`` image. 399 file. Use this option when you want to boot a ``.wic.vmdk`` image.
393 The image filename you provide must contain one of the following 400 The image filename you provide must contain one of the following
394 strings: "qemux86-64", "qemux86", "qemuarm", "qemumips64", 401 strings: "qemux86-64", "qemux86", "qemuarm", "qemumips64",
395 "qemumips", "qemuppc", or "qemush4". 402 "qemumips", "qemuppc", or "qemush4".
396 403
397- ROOTFS: A root filesystem that has one of the following filetype 404- `ROOTFS`: A root filesystem that has one of the following filetype
398 extensions: "ext2", "ext3", "ext4", "jffs2", "nfs", or "btrfs". If 405 extensions: "ext2", "ext3", "ext4", "jffs2", "nfs", or "btrfs". If
399 the filename you provide for this option uses "nfs", it must provide 406 the filename you provide for this option uses "nfs", it must provide
400 an explicit root filesystem path. 407 an explicit root filesystem path.
401 408
402- KERNEL: A kernel image, which is a ``.bin`` file. When you provide a 409- `KERNEL`: A kernel image, which is a ``.bin`` file. When you provide a
403 ``.bin`` file, ``runqemu`` detects it and assumes the file is a 410 ``.bin`` file, ``runqemu`` detects it and assumes the file is a
404 kernel image. 411 kernel image.
405 412
406- MACHINE: The architecture of the QEMU machine, which must be one of 413- `MACHINE`: The architecture of the QEMU machine, which must be one of
407 the following: "qemux86", "qemux86-64", "qemuarm", "qemuarm64", 414 the following: "qemux86", "qemux86-64", "qemuarm", "qemuarm64",
408 "qemumips", "qemumips64", or "qemuppc". The MACHINE and QEMUARCH 415 "qemumips", "qemumips64", or "qemuppc". The MACHINE and QEMUARCH
409 options are basically identical. If you do not provide a MACHINE 416 options are basically identical. If you do not provide a MACHINE