From 41e74881b013cdab5ad503f8c08f521c9414c627 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <srifenbark@gmail.com>
Date: Wed, 19 Oct 2016 07:54:57 -0700
Subject: ref-manual: Updated 2.2 migration for runqemu porting to python

Indicated that the configuration file is not mandatory.  Also,
documented the supported qemu* machines should you run the
script without a configuration file.

(From yocto-docs rev: c01e8ff8e3233e56a220be042616d5810f181a58)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/ref-manual/migration.xml | 47 +++++++++++++++++++++++++++++-----
 1 file changed, 40 insertions(+), 7 deletions(-)

(limited to 'documentation')

diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index bd70ca7910..64f6da876b 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -3493,16 +3493,21 @@
 
         <para>
             The new <filename>runqemu</filename> is a Python script.
-            The script requires a configuration file in the following
-            form in order to boot the BSP:
+            Machine knowledge is no longer hardcoded into
+            <filename>runqemu</filename>.
+            You can choose to use the <filename>qemuboot</filename>
+            configuration file to define the BSP's own arguments and to make
+            it bootable with <filename>runqemu</filename>.
+            If you use a configuration file, use the following form:
             <literallayout class='monospaced'>
      <replaceable>image-name</replaceable>-<replaceable>machine</replaceable>.qemuboot.conf
             </literallayout>
-            Machine knowledge is no longer hardcoded into
-            <filename>runqemu</filename>.
-            You can use the <filename>qemuboot</filename> configuration file
-            to define the BSP's own arguments and to make it bootable
-            with <filename>runqemu</filename>.
+            The configuration file enables fine-grained tuning of options
+            passed to QEMU without the <filename>runqemu</filename> script
+            hard-coding any knowledge about different machines.
+            Using a configuration file is particularly convenient when trying
+            to use QEMU with machines other than the
+            <filename>qemu*</filename> machines in OE-Core.
             <note>
                 Previous usage patterns are continued to be supported.
             </note>
@@ -3515,6 +3520,34 @@
             <filename>qemuboot.conf</filename>.
         </para>
 
+
+        <para>
+            If you want to use <filename>runqemu</filename> without a
+            configuration file, use the following command form:
+            <literallayout class='monospaced'>
+     $ runqemu <replaceable>machine</replaceable> <replaceable>rootfs</replaceable> <replaceable>kernel</replaceable> [<replaceable>options</replaceable>]
+            </literallayout>
+            Supported <replaceable>machines</replaceable> are as follows:
+            <literallayout class='monospaced'>
+     qemuarm
+     qemuarm64
+     qemux86
+     qemux86-64
+     qemuppc
+     qemumips
+     qemumips64
+     qemumipsel
+     qemumips64el
+            </literallayout>
+            Consider the following example, which uses the
+            <filename>qemux86-64</filename> machine,
+            provides a root filesystem, provides an image, and uses
+            the <filename>nographic</filename> option:
+            <literallayout class='monospaced'>
+$ runqemu qemux86-64 tmp/deploy/images/qemux86-64/core-image-minimal-qemux86-64.ext4 tmp/deploy/images/qemux86-64/bzImage nographic
+            </literallayout>
+        </para>
+
         <para>
             Following is a list of variables that can be set in configuration
             files such as <filename>bsp.conf</filename> to enable the BSP
-- 
cgit v1.2.3-54-g00ecf