summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMark Asselstine <mark.asselstine@windriver.com>2020-02-18 16:33:28 -0500
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-03-11 14:41:44 +0000
commitcff864901861f80e0c3ed030499ae88d5f01befc (patch)
treef85cd59aaf8615f1f836fb18e98d4c0660c96317 /documentation
parent0daf901b5be2c1e3ac7e4c274b293e4679ecc10d (diff)
downloadpoky-cff864901861f80e0c3ed030499ae88d5f01befc.tar.gz
manuals: Updates to reflect that MACHINE defaults to qemux86-64
meta-yocto commit 69ddecdb1516 [local.conf.sample: change default MACHINE to qemux86-64] switched the default MACHINE from 'qemux86' to 'qemux86-64' but some documents which either explicitly mentioned the default, or where this was implicit didn't receive an equivalent update. Where it made sense we continue this change in default to the docs. In other places, such as the kernel-dev manual, we note the new default and instruct the user how to switch back to 'qemux86'. Eventually we should probably update the kernel-dev manual to use the default, but for now the intention was to limit the impact of these changes. Note that ext3 has also been replaced with ext4 for image generation, so while we are modifying runqemu lines to qemux86-64 we also make the change to reference ext4 such that the runqemu commands will function properly. (From yocto-docs rev: 8c1d8ab1170f47a2c2692beb903ab0b7c6835b7b) Signed-off-by: Mark Asselstine <mark.asselstine@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml4
-rw-r--r--documentation/dev-manual/dev-manual-qemu.xml22
-rw-r--r--documentation/kernel-dev/kernel-dev-common.xml24
-rw-r--r--documentation/profile-manual/profile-manual-usage.xml2
-rw-r--r--documentation/ref-manual/ref-structure.xml2
5 files changed, 29 insertions, 25 deletions
diff --git a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
index 1daeb2547f..15dd1af42d 100644
--- a/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
+++ b/documentation/brief-yoctoprojectqs/brief-yoctoprojectqs.xml
@@ -266,7 +266,7 @@
266 meta-toolchain 266 meta-toolchain
267 meta-ide-support 267 meta-ide-support
268 268
269 You can also run generated qemu images with a command like 'runqemu qemux86' 269 You can also run generated qemu images with a command like 'runqemu qemux86-64'
270 </literallayout> 270 </literallayout>
271 Among other things, the script creates the 271 Among other things, the script creates the
272 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, 272 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
@@ -332,7 +332,7 @@
332 QEMU, which is a Quick EMUlator that ships with 332 QEMU, which is a Quick EMUlator that ships with
333 the Yocto Project: 333 the Yocto Project:
334 <literallayout class='monospaced'> 334 <literallayout class='monospaced'>
335 $ runqemu qemux86 335 $ runqemu qemux86-64
336 </literallayout> 336 </literallayout>
337 If you want to learn more about running QEMU, see the 337 If you want to learn more about running QEMU, see the
338 "<ulink url="&YOCTO_DOCS_DEV_URL;#dev-manual-qemu">Using the Quick EMUlator (QEMU)</ulink>" 338 "<ulink url="&YOCTO_DOCS_DEV_URL;#dev-manual-qemu">Using the Quick EMUlator (QEMU)</ulink>"
diff --git a/documentation/dev-manual/dev-manual-qemu.xml b/documentation/dev-manual/dev-manual-qemu.xml
index f5a0d64afe..5ccc0dfe83 100644
--- a/documentation/dev-manual/dev-manual-qemu.xml
+++ b/documentation/dev-manual/dev-manual-qemu.xml
@@ -151,13 +151,13 @@
151 <itemizedlist> 151 <itemizedlist>
152 <listitem><para> 152 <listitem><para>
153 This example starts QEMU with 153 This example starts QEMU with
154 <replaceable>MACHINE</replaceable> set to "qemux86". 154 <replaceable>MACHINE</replaceable> set to "qemux86-64".
155 Assuming a standard 155 Assuming a standard
156 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, 156 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>,
157 <filename>runqemu</filename> automatically finds the 157 <filename>runqemu</filename> automatically finds the
158 <filename>bzImage-qemux86.bin</filename> image file and 158 <filename>bzImage-qemux86-64.bin</filename> image file and
159 the 159 the
160 <filename>core-image-minimal-qemux86-20140707074611.rootfs.ext3</filename> 160 <filename>core-image-minimal-qemux86-64-20200218002850.rootfs.ext4</filename>
161 (assuming the current build created a 161 (assuming the current build created a
162 <filename>core-image-minimal</filename> image). 162 <filename>core-image-minimal</filename> image).
163 <note> 163 <note>
@@ -166,7 +166,7 @@
166 timestamp. 166 timestamp.
167 </note> 167 </note>
168 <literallayout class='monospaced'> 168 <literallayout class='monospaced'>
169 $ runqemu qemux86 169 $ runqemu qemux86-64
170 </literallayout> 170 </literallayout>
171 </para></listitem> 171 </para></listitem>
172 <listitem><para> 172 <listitem><para>
@@ -175,7 +175,7 @@
175 This command, however, specifically provides the image 175 This command, however, specifically provides the image
176 and root filesystem type. 176 and root filesystem type.
177 <literallayout class='monospaced'> 177 <literallayout class='monospaced'>
178 $ runqemu qemux86 core-image-minimal ext3 178 $ runqemu qemux86-64 core-image-minimal ext4
179 </literallayout> 179 </literallayout>
180 </para></listitem> 180 </para></listitem>
181 <listitem><para> 181 <listitem><para>
@@ -188,7 +188,7 @@
188 be installed (see the previous description for the 188 be installed (see the previous description for the
189 <filename>audio</filename> option for more information). 189 <filename>audio</filename> option for more information).
190 <literallayout class='monospaced'> 190 <literallayout class='monospaced'>
191 $ runqemu qemux86 ramfs audio 191 $ runqemu qemux86-64 ramfs audio
192 </literallayout> 192 </literallayout>
193 </para></listitem> 193 </para></listitem>
194 <listitem><para> 194 <listitem><para>
@@ -200,7 +200,7 @@
200 <replaceable>KERNEL</replaceable>, or 200 <replaceable>KERNEL</replaceable>, or
201 <replaceable>VM</replaceable> option. 201 <replaceable>VM</replaceable> option.
202 <literallayout class='monospaced'> 202 <literallayout class='monospaced'>
203 $ runqemu ext3 203 $ runqemu ext4
204 </literallayout> 204 </literallayout>
205 </para></listitem> 205 </para></listitem>
206 <listitem><para> 206 <listitem><para>
@@ -209,9 +209,9 @@
209 From the <filename>.wic.vmdk</filename>, 209 From the <filename>.wic.vmdk</filename>,
210 <filename>runqemu</filename> determines the QEMU 210 <filename>runqemu</filename> determines the QEMU
211 architecture (<replaceable>MACHINE</replaceable>) to be 211 architecture (<replaceable>MACHINE</replaceable>) to be
212 "qemux86" and the root filesystem type to be "vmdk". 212 "qemux86-64" and the root filesystem type to be "vmdk".
213 <literallayout class='monospaced'> 213 <literallayout class='monospaced'>
214 $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86.wic.vmdk 214 $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86-64.wic.vmdk
215 </literallayout> 215 </literallayout>
216 </para></listitem> 216 </para></listitem>
217 </itemizedlist> 217 </itemizedlist>
@@ -296,7 +296,7 @@
296 extracts it to a directory named 296 extracts it to a directory named
297 <filename>test-nfs</filename>: 297 <filename>test-nfs</filename>:
298 <literallayout class='monospaced'> 298 <literallayout class='monospaced'>
299 runqemu-extract-sdk ./tmp/deploy/images/qemux86/core-image-sato-qemux86.tar.bz2 test-nfs 299 runqemu-extract-sdk ./tmp/deploy/images/qemux86-64/core-image-sato-qemux86-64.tar.bz2 test-nfs
300 </literallayout> 300 </literallayout>
301 </para></listitem> 301 </para></listitem>
302 <listitem><para> 302 <listitem><para>
@@ -310,7 +310,7 @@
310 Here is an example using the <filename>qemux86</filename> 310 Here is an example using the <filename>qemux86</filename>
311 image: 311 image:
312 <literallayout class='monospaced'> 312 <literallayout class='monospaced'>
313 runqemu qemux86 ./test-nfs 313 runqemu qemux86-64 ./test-nfs
314 </literallayout> 314 </literallayout>
315 </para></listitem> 315 </para></listitem>
316 </orderedlist> 316 </orderedlist>
diff --git a/documentation/kernel-dev/kernel-dev-common.xml b/documentation/kernel-dev/kernel-dev-common.xml
index 2ea5d3f38e..d94ed1942d 100644
--- a/documentation/kernel-dev/kernel-dev-common.xml
+++ b/documentation/kernel-dev/kernel-dev-common.xml
@@ -89,8 +89,8 @@
89 <emphasis>Prepare Your <filename>local.conf</filename> File:</emphasis> 89 <emphasis>Prepare Your <filename>local.conf</filename> File:</emphasis>
90 By default, the 90 By default, the
91 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> 91 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
92 variable is set to "qemux86", which is fine if you are 92 variable is set to "qemux86-64", which is fine if you are
93 building for the QEMU emulator in 32-bit mode. 93 building for the QEMU emulator in 64-bit mode.
94 However, if you are not, you need to set the 94 However, if you are not, you need to set the
95 <filename>MACHINE</filename> variable appropriately in 95 <filename>MACHINE</filename> variable appropriately in
96 your <filename>conf/local.conf</filename> file found in 96 your <filename>conf/local.conf</filename> file found in
@@ -104,10 +104,12 @@
104 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><filename>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</filename></ulink> 104 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><filename>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</filename></ulink>
105 variable to include kernel modules.</para> 105 variable to include kernel modules.</para>
106 106
107 <para>This example uses the default "qemux86" for the 107 <para>In this example we wish to build for qemux86 so
108 <filename>MACHINE</filename> variable but needs to 108 we must set the <filename>MACHINE</filename> variable
109 add the "kernel-modules": 109 to "qemux86" and also add the "kernel-modules". As described
110 we do this by appending to <filename>conf/local.conf</filename>:
110 <literallayout class='monospaced'> 111 <literallayout class='monospaced'>
112 MACHINE = "qemux86"
111 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-modules" 113 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-modules"
112 </literallayout> 114 </literallayout>
113 </para></listitem> 115 </para></listitem>
@@ -314,8 +316,8 @@
314 File:</emphasis> 316 File:</emphasis>
315 By default, the 317 By default, the
316 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink> 318 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'><filename>MACHINE</filename></ulink>
317 variable is set to "qemux86", which is fine if you are 319 variable is set to "qemux86-64", which is fine if you are
318 building for the QEMU emulator in 32-bit mode. 320 building for the QEMU emulator in 64-bit mode.
319 However, if you are not, you need to set the 321 However, if you are not, you need to set the
320 <filename>MACHINE</filename> variable appropriately in 322 <filename>MACHINE</filename> variable appropriately in
321 your <filename>conf/local.conf</filename> file found 323 your <filename>conf/local.conf</filename> file found
@@ -329,10 +331,12 @@
329 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><filename>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</filename></ulink> 331 <ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS'><filename>MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS</filename></ulink>
330 variable to include kernel modules.</para> 332 variable to include kernel modules.</para>
331 333
332 <para>This example uses the default "qemux86" for the 334 <para>In this example we wish to build for qemux86 so
333 <filename>MACHINE</filename> variable but needs to 335 we must set the <filename>MACHINE</filename> variable
334 add the "kernel-modules": 336 to "qemux86" and also add the "kernel-modules". As described
337 we do this by appending to <filename>conf/local.conf</filename>:
335 <literallayout class='monospaced'> 338 <literallayout class='monospaced'>
339 MACHINE = "qemux86"
336 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-modules" 340 MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-modules"
337 </literallayout> 341 </literallayout>
338 </para></listitem> 342 </para></listitem>
diff --git a/documentation/profile-manual/profile-manual-usage.xml b/documentation/profile-manual/profile-manual-usage.xml
index 5999b29603..9a4273a0fe 100644
--- a/documentation/profile-manual/profile-manual-usage.xml
+++ b/documentation/profile-manual/profile-manual-usage.xml
@@ -2182,7 +2182,7 @@
2182 meta-toolchain 2182 meta-toolchain
2183 meta-ide-support 2183 meta-ide-support
2184 2184
2185 You can also run generated qemu images with a command like 'runqemu qemux86' 2185 You can also run generated qemu images with a command like 'runqemu qemux86-64'
2186 2186
2187 </literallayout> 2187 </literallayout>
2188 Once you've done that, you can cd to whatever directory 2188 Once you've done that, you can cd to whatever directory
diff --git a/documentation/ref-manual/ref-structure.xml b/documentation/ref-manual/ref-structure.xml
index 937a4322fd..08699d8ec4 100644
--- a/documentation/ref-manual/ref-structure.xml
+++ b/documentation/ref-manual/ref-structure.xml
@@ -217,7 +217,7 @@
217 meta-toolchain 217 meta-toolchain
218 meta-ide-support 218 meta-ide-support
219 219
220 You can also run generated qemu images with a command like 'runqemu qemux86' 220 You can also run generated qemu images with a command like 'runqemu qemux86-64'
221 </literallayout> 221 </literallayout>
222 The script gets its default list of common targets from the 222 The script gets its default list of common targets from the
223 <filename>conf-notes.txt</filename> file, which is found in the 223 <filename>conf-notes.txt</filename> file, which is found in the