From cff864901861f80e0c3ed030499ae88d5f01befc Mon Sep 17 00:00:00 2001 From: Mark Asselstine Date: Tue, 18 Feb 2020 16:33:28 -0500 Subject: [PATCH] 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 Signed-off-by: Richard Purdie --- .../brief-yoctoprojectqs.xml | 4 ++-- documentation/dev-manual/dev-manual-qemu.xml | 22 ++++++++--------- .../kernel-dev/kernel-dev-common.xml | 24 +++++++++++-------- .../profile-manual/profile-manual-usage.xml | 2 +- documentation/ref-manual/ref-structure.xml | 2 +- 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 @@ meta-toolchain meta-ide-support - You can also run generated qemu images with a command like 'runqemu qemux86' + You can also run generated qemu images with a command like 'runqemu qemux86-64' Among other things, the script creates the Build Directory, @@ -332,7 +332,7 @@ QEMU, which is a Quick EMUlator that ships with the Yocto Project: - $ runqemu qemux86 + $ runqemu qemux86-64 If you want to learn more about running QEMU, see the "Using the Quick EMUlator (QEMU)" 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 @@ This example starts QEMU with - MACHINE set to "qemux86". + MACHINE set to "qemux86-64". Assuming a standard Build Directory, runqemu automatically finds the - bzImage-qemux86.bin image file and + bzImage-qemux86-64.bin image file and the - core-image-minimal-qemux86-20140707074611.rootfs.ext3 + core-image-minimal-qemux86-64-20200218002850.rootfs.ext4 (assuming the current build created a core-image-minimal image). @@ -166,7 +166,7 @@ timestamp. - $ runqemu qemux86 + $ runqemu qemux86-64 @@ -175,7 +175,7 @@ This command, however, specifically provides the image and root filesystem type. - $ runqemu qemux86 core-image-minimal ext3 + $ runqemu qemux86-64 core-image-minimal ext4 @@ -188,7 +188,7 @@ be installed (see the previous description for the audio option for more information). - $ runqemu qemux86 ramfs audio + $ runqemu qemux86-64 ramfs audio @@ -200,7 +200,7 @@ KERNEL, or VM option. - $ runqemu ext3 + $ runqemu ext4 @@ -209,9 +209,9 @@ From the .wic.vmdk, runqemu determines the QEMU architecture (MACHINE) to be - "qemux86" and the root filesystem type to be "vmdk". + "qemux86-64" and the root filesystem type to be "vmdk". - $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86.wic.vmdk + $ runqemu /home/scott-lenovo/vm/core-image-minimal-qemux86-64.wic.vmdk @@ -296,7 +296,7 @@ extracts it to a directory named test-nfs: - runqemu-extract-sdk ./tmp/deploy/images/qemux86/core-image-sato-qemux86.tar.bz2 test-nfs + runqemu-extract-sdk ./tmp/deploy/images/qemux86-64/core-image-sato-qemux86-64.tar.bz2 test-nfs @@ -310,7 +310,7 @@ Here is an example using the qemux86 image: - runqemu qemux86 ./test-nfs + runqemu qemux86-64 ./test-nfs 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 @@ Prepare Your local.conf File: By default, the MACHINE - variable is set to "qemux86", which is fine if you are - building for the QEMU emulator in 32-bit mode. + variable is set to "qemux86-64", which is fine if you are + building for the QEMU emulator in 64-bit mode. However, if you are not, you need to set the MACHINE variable appropriately in your conf/local.conf file found in @@ -104,10 +104,12 @@ MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS variable to include kernel modules. - This example uses the default "qemux86" for the - MACHINE variable but needs to - add the "kernel-modules": + In this example we wish to build for qemux86 so + we must set the MACHINE variable + to "qemux86" and also add the "kernel-modules". As described + we do this by appending to conf/local.conf: + MACHINE = "qemux86" MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-modules" @@ -314,8 +316,8 @@ File: By default, the MACHINE - variable is set to "qemux86", which is fine if you are - building for the QEMU emulator in 32-bit mode. + variable is set to "qemux86-64", which is fine if you are + building for the QEMU emulator in 64-bit mode. However, if you are not, you need to set the MACHINE variable appropriately in your conf/local.conf file found @@ -329,10 +331,12 @@ MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS variable to include kernel modules. - This example uses the default "qemux86" for the - MACHINE variable but needs to - add the "kernel-modules": + In this example we wish to build for qemux86 so + we must set the MACHINE variable + to "qemux86" and also add the "kernel-modules". As described + we do this by appending to conf/local.conf: + MACHINE = "qemux86" MACHINE_ESSENTIAL_EXTRA_RRECOMMENDS += "kernel-modules" 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 @@ meta-toolchain meta-ide-support - You can also run generated qemu images with a command like 'runqemu qemux86' + You can also run generated qemu images with a command like 'runqemu qemux86-64' 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 @@ meta-toolchain meta-ide-support - You can also run generated qemu images with a command like 'runqemu qemux86' + You can also run generated qemu images with a command like 'runqemu qemux86-64' The script gets its default list of common targets from the conf-notes.txt file, which is found in the