summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-07-18 10:44:37 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-07-22 09:19:25 +0100
commit15901164ee71dec0906dadaff08f3365a66feb05 (patch)
treea5604781e057606afd6d7b0451826a0118d965b1 /documentation
parent2217d97ba9f48ded4f229981ed4ad7e846b87db0 (diff)
downloadpoky-15901164ee71dec0906dadaff08f3365a66feb05.tar.gz
dev-manual, ref-manual: Eliminated pre-built section
Fixes [YOCTO #11630] I took the section that described how to use a pre-built kernel and run it through QEMU out. This is basically a QEMU usage section and is not in that area. There were some QEMU speed up items suitable for the QEMU concepts section in the ref-manual. I put those in that area. (From yocto-docs rev: b081013aa10b42e4eb88ed54940112c5ae106911) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-start.xml59
-rw-r--r--documentation/ref-manual/usingpoky.xml78
2 files changed, 80 insertions, 57 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 0835650bd3..e70d79e424 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -858,6 +858,7 @@
858 </para> 858 </para>
859</section> 859</section>
860 860
861<!--
861<section id='using-pre-built-binaries-and-qemu'> 862<section id='using-pre-built-binaries-and-qemu'>
862 <title>Using Pre-Built Binaries and QEMU</title> 863 <title>Using Pre-Built Binaries and QEMU</title>
863 864
@@ -906,64 +907,8 @@
906 "<link linkend='dev-manual-qemu'>Using the Quick EMUlator (QEMU)</link>" 907 "<link linkend='dev-manual-qemu'>Using the Quick EMUlator (QEMU)</link>"
907 section. 908 section.
908 </para> 909 </para>
909
910 <para>
911 Using QEMU to emulate your hardware can result in speed issues
912 depending on the target and host architecture mix.
913 For example, using the <filename>qemux86</filename> image in the emulator
914 on an Intel-based 32-bit (x86) host machine is fast because the target and
915 host architectures match.
916 On the other hand, using the <filename>qemuarm</filename> image on the same Intel-based
917 host can be slower.
918 But, you still achieve faithful emulation of ARM-specific issues.
919 </para>
920
921 <para>
922 To speed things up, the QEMU images support using <filename>distcc</filename>
923 to call a cross-compiler outside the emulated system.
924 If you used <filename>runqemu</filename> to start QEMU, and the
925 <filename>distccd</filename> application is present on the host system, any
926 BitBake cross-compiling toolchain available from the build system is automatically
927 used from within QEMU simply by calling <filename>distcc</filename>.
928 You can accomplish this by defining the cross-compiler variable
929 (e.g. <filename>export CC="distcc"</filename>).
930 Alternatively, if you are using a suitable SDK image or the appropriate
931 stand-alone toolchain is present,
932 the toolchain is also automatically used.
933 </para>
934
935 <note>
936 Several mechanisms exist that let you connect to the system running on the
937 QEMU emulator:
938 <itemizedlist>
939 <listitem><para>QEMU provides a framebuffer interface that makes standard
940 consoles available.</para></listitem>
941 <listitem><para>Generally, headless embedded devices have a serial port.
942 If so, you can configure the operating system of the running image
943 to use that port to run a console.
944 The connection uses standard IP networking.</para></listitem>
945 <listitem><para>
946 SSH servers exist in some QEMU images.
947 The <filename>core-image-sato</filename> QEMU image has a
948 Dropbear secure shell (SSH) server that runs with the root
949 password disabled.
950 The <filename>core-image-full-cmdline</filename> and
951 <filename>core-image-lsb</filename> QEMU images
952 have OpenSSH instead of Dropbear.
953 Including these SSH servers allow you to use standard
954 <filename>ssh</filename> and <filename>scp</filename> commands.
955 The <filename>core-image-minimal</filename> QEMU image,
956 however, contains no SSH server.
957 </para></listitem>
958 <listitem><para>You can use a provided, user-space NFS server to boot the QEMU session
959 using a local copy of the root filesystem on the host.
960 In order to make this connection, you must extract a root filesystem tarball by using the
961 <filename>runqemu-extract-sdk</filename> command.
962 After running the command, you must then point the <filename>runqemu</filename>
963 script to the extracted directory instead of a root filesystem image file.</para></listitem>
964 </itemizedlist>
965 </note>
966</section> 910</section>
911-->
967</chapter> 912</chapter>
968<!-- 913<!--
969vim: expandtab tw=80 ts=4 914vim: expandtab tw=80 ts=4
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index 2f5316d54b..c323d38318 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -1111,6 +1111,84 @@
1111 </para> 1111 </para>
1112 </section> 1112 </section>
1113 1113
1114 <section id='qemu-performance'>
1115 <title>QEMU Performance</title>
1116
1117 <para>
1118 Using QEMU to emulate your hardware can result in speed issues
1119 depending on the target and host architecture mix.
1120 For example, using the <filename>qemux86</filename> image in the
1121 emulator on an Intel-based 32-bit (x86) host machine is fast
1122 because the target and host architectures match.
1123 On the other hand, using the <filename>qemuarm</filename> image
1124 on the same Intel-based host can be slower.
1125 But, you still achieve faithful emulation of ARM-specific issues.
1126 </para>
1127
1128 <para>
1129 To speed things up, the QEMU images support using
1130 <filename>distcc</filename> to call a cross-compiler outside the
1131 emulated system.
1132 If you used <filename>runqemu</filename> to start QEMU, and the
1133 <filename>distccd</filename> application is present on the host
1134 system, any BitBake cross-compiling toolchain available from the
1135 build system is automatically used from within QEMU simply by
1136 calling <filename>distcc</filename>.
1137 You can accomplish this by defining the cross-compiler variable
1138 (e.g. <filename>export CC="distcc"</filename>).
1139 Alternatively, if you are using a suitable SDK image or the
1140 appropriate stand-alone toolchain is present, the toolchain is
1141 also automatically used.
1142 </para>
1143
1144 <note>
1145 Several mechanisms exist that let you connect to the system
1146 running on the QEMU emulator:
1147 <itemizedlist>
1148 <listitem><para>
1149 QEMU provides a framebuffer interface that makes standard
1150 consoles available.
1151 </para></listitem>
1152 <listitem><para>
1153 Generally, headless embedded devices have a serial port.
1154 If so, you can configure the operating system of the
1155 running image to use that port to run a console.
1156 The connection uses standard IP networking.
1157 </para></listitem>
1158 <listitem><para>
1159 SSH servers exist in some QEMU images.
1160 The <filename>core-image-sato</filename> QEMU image has a
1161 Dropbear secure shell (SSH) server that runs with the root
1162 password disabled.
1163 The <filename>core-image-full-cmdline</filename> and
1164 <filename>core-image-lsb</filename> QEMU images
1165 have OpenSSH instead of Dropbear.
1166 Including these SSH servers allow you to use standard
1167 <filename>ssh</filename> and <filename>scp</filename>
1168 commands.
1169 The <filename>core-image-minimal</filename> QEMU image,
1170 however, contains no SSH server.
1171 </para></listitem>
1172 <listitem><para>
1173 You can use a provided, user-space NFS server to boot
1174 the QEMU session using a local copy of the root
1175 filesystem on the host.
1176 In order to make this connection, you must extract a
1177 root filesystem tarball by using the
1178 <filename>runqemu-extract-sdk</filename> command.
1179 After running the command, you must then point the
1180 <filename>runqemu</filename>
1181 script to the extracted directory instead of a root
1182 filesystem image file.
1183 See the
1184 "<ulink url='&YOCTO_DOCS_DEV_URL;#qemu-running-under-a-network-file-system-nfs-server'>Running Under a Network File System (NFS) Server</ulink>"
1185 section in the Yocto Project Development Manual for more
1186 information.
1187 </para></listitem>
1188 </itemizedlist>
1189 </note>
1190 </section>
1191
1114 <section id='qemu-command-line-syntax'> 1192 <section id='qemu-command-line-syntax'>
1115 <title>QEMU Command-Line Syntax</title> 1193 <title>QEMU Command-Line Syntax</title>
1116 1194