summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2015-05-21 11:12:19 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-07-28 18:02:32 +0100
commitab23dd967e5a59de3cffe48762b4956edba5d478 (patch)
treed170bb0b1418a309fb12419ccd310c2f1634abf7 /documentation/ref-manual
parentadd1f737b8baa5aa258d967cb29810dbd636ad1a (diff)
downloadpoky-ab23dd967e5a59de3cffe48762b4956edba5d478.tar.gz
yocto-project-qs and others: Rewrite of the QS
This was a complete re-write of the YP Quick Start in an attempt to streamline it, remove unecessary detail, and make it flow better with the examples. In doing so, many manuals were affected due to section headings being renamed, information being moved, etc. Here is a list of the changes by manual: Makefile - Removed two figures from TARFILE list for the yocto-project-qs. Added building-an-image.png to the ref-manual TARFILE list. Added using-a-pre-build-image.png to the adt-manual TARFILE list. Repositioned 'eclipse' in the adt-manual TARFILE list. adt-manual: Fixed a cross-reference so that it goes to the new 'Building Images' section that is within the YP QS. Added new section 'Example Using Pre-Build Binaries and QEMU' to hold the information that was formerly in YP QS. dev-manual: Removed a cross-reference into the YP QS that promised how to configure the most efficent build. Changed a cross-reference into the YP QS from 'The Packages' to 'The Build System Packages'. Changed a cross-reference into the YP QS from 'Building an Image' to 'Building Images'. Changed a text reference from the YP QS to the adt-manual. Moved the bit about getting YP files by using the YP website from the YP QS to the dev-manual. Changed a cross-reference into the YP QS from 'Using Pre-Built Binaries and QEMU' to 'Example Using Pre-built Binaries and QEMU', which was moved to the adt-manual. ref-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. Moved the note about if your system has oss4-dev in the packages area in the YP QS to the appropriate area in the ref-manual. Moved the introduction information regarding building an image along with the figure from YP QS to the ref-manual's section on building images. toaster-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. yocto-project-qs: Complete rewrite that changed many section headings and removed much detail, which was placed in other manuals. (From yocto-docs rev: da4ed8147b04963a700caa784bda709c57b4eb6e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rwxr-xr-xdocumentation/ref-manual/figures/building-an-image.pngbin0 -> 14891 bytes
-rw-r--r--documentation/ref-manual/introduction.xml16
-rw-r--r--documentation/ref-manual/ref-bitbake.xml2
-rw-r--r--documentation/ref-manual/usingpoky.xml20
4 files changed, 33 insertions, 5 deletions
diff --git a/documentation/ref-manual/figures/building-an-image.png b/documentation/ref-manual/figures/building-an-image.png
new file mode 100755
index 0000000000..1fbea5ab00
--- /dev/null
+++ b/documentation/ref-manual/figures/building-an-image.png
Binary files differ
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml
index cc3f6b075c..5250e26be7 100644
--- a/documentation/ref-manual/introduction.xml
+++ b/documentation/ref-manual/introduction.xml
@@ -110,7 +110,7 @@
110<title>System Requirements</title> 110<title>System Requirements</title>
111 <para> 111 <para>
112 For general Yocto Project system requirements, see the 112 For general Yocto Project system requirements, see the
113 "<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>What You Need and How You Get It</ulink>" section 113 "<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>Setting Up to Use the Yocto Project</ulink>" section
114 in the Yocto Project Quick Start. 114 in the Yocto Project Quick Start.
115 The remainder of this section provides details on system requirements 115 The remainder of this section provides details on system requirements
116 not covered in the Yocto Project Quick Start. 116 not covered in the Yocto Project Quick Start.
@@ -212,6 +212,20 @@
212 <para> 212 <para>
213 The following list shows the required packages by function 213 The following list shows the required packages by function
214 given a supported Ubuntu or Debian Linux distribution: 214 given a supported Ubuntu or Debian Linux distribution:
215 <note>
216 If your build system has the
217 <filename>oss4-dev</filename> package installed, you
218 might experience QEMU build failures due to the package
219 installing its own custom
220 <filename>/usr/include/linux/soundcard.h</filename> on
221 the Debian system.
222 If you run into this situation, either of the following
223 solutions exist:
224 <literallayout class='monospaced'>
225 $ sudo apt-get build-dep qemu
226 $ sudo apt-get remove oss4-dev
227 </literallayout>
228 </note>
215 <itemizedlist> 229 <itemizedlist>
216 <listitem><para><emphasis>Essentials:</emphasis> 230 <listitem><para><emphasis>Essentials:</emphasis>
217 Packages needed to build an image on a headless 231 Packages needed to build an image on a headless
diff --git a/documentation/ref-manual/ref-bitbake.xml b/documentation/ref-manual/ref-bitbake.xml
index 30aff6431f..dc402dbffc 100644
--- a/documentation/ref-manual/ref-bitbake.xml
+++ b/documentation/ref-manual/ref-bitbake.xml
@@ -255,7 +255,7 @@
255 It is worth noting that you can greatly speed up the build time by properly setting 255 It is worth noting that you can greatly speed up the build time by properly setting
256 the <filename>BB_NUMBER_THREADS</filename> variable. 256 the <filename>BB_NUMBER_THREADS</filename> variable.
257 See the 257 See the
258 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" 258 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
259 section in the Yocto Project Quick Start for more information. 259 section in the Yocto Project Quick Start for more information.
260 </para> 260 </para>
261 261
diff --git a/documentation/ref-manual/usingpoky.xml b/documentation/ref-manual/usingpoky.xml
index e2e05b2514..ca87962e24 100644
--- a/documentation/ref-manual/usingpoky.xml
+++ b/documentation/ref-manual/usingpoky.xml
@@ -19,7 +19,7 @@
19 for less obvious aspects of the build process. 19 for less obvious aspects of the build process.
20 For general information on how to build an image using the OpenEmbedded build 20 For general information on how to build an image using the OpenEmbedded build
21 system, see the 21 system, see the
22 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" 22 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
23 section of the Yocto Project Quick Start. 23 section of the Yocto Project Quick Start.
24 </para> 24 </para>
25 25
@@ -27,6 +27,20 @@
27 <title>Build Overview</title> 27 <title>Build Overview</title>
28 28
29 <para> 29 <para>
30 In the development environment you will need to build an image whenever you change hardware
31 support, add or change system libraries, or add or change services that have dependencies.
32 </para>
33
34 <mediaobject>
35 <imageobject>
36 <imagedata fileref="figures/building-an-image.png" format="PNG" align='center' scalefit='1'/>
37 </imageobject>
38 <caption>
39 <para>Building an Image</para>
40 </caption>
41 </mediaobject>
42
43 <para>
30 The first thing you need to do is set up the OpenEmbedded build 44 The first thing you need to do is set up the OpenEmbedded build
31 environment by sourcing an environment setup script 45 environment by sourcing an environment setup script
32 (i.e. 46 (i.e.
@@ -99,8 +113,8 @@
99 <filename class="directory">tmp/deploy/images</filename>. 113 <filename class="directory">tmp/deploy/images</filename>.
100 For information on how to run pre-built images such as <filename>qemux86</filename> 114 For information on how to run pre-built images such as <filename>qemux86</filename>
101 and <filename>qemuarm</filename>, see the 115 and <filename>qemuarm</filename>, see the
102 "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" 116 "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Example Using Pre-Built Binaries and QEMU</ulink>"
103 section in the Yocto Project Quick Start. 117 section in the Yocto Project Application Developer's Guide.
104 For information about how to install these images, see the documentation for your 118 For information about how to install these images, see the documentation for your
105 particular board or machine. 119 particular board or machine.
106 </para> 120 </para>