1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-09 05:29:32 +00:00

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>
This commit is contained in:
Scott Rifenbark
2015-05-21 11:12:19 -06:00
committed by Richard Purdie
parent add1f737b8
commit ab23dd967e
14 changed files with 982 additions and 1120 deletions
Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

+15 -1
View File
@@ -110,7 +110,7 @@
<title>System Requirements</title>
<para>
For general Yocto Project system requirements, see the
"<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>What You Need and How You Get It</ulink>" section
"<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>Setting Up to Use the Yocto Project</ulink>" section
in the Yocto Project Quick Start.
The remainder of this section provides details on system requirements
not covered in the Yocto Project Quick Start.
@@ -212,6 +212,20 @@
<para>
The following list shows the required packages by function
given a supported Ubuntu or Debian Linux distribution:
<note>
If your build system has the
<filename>oss4-dev</filename> package installed, you
might experience QEMU build failures due to the package
installing its own custom
<filename>/usr/include/linux/soundcard.h</filename> on
the Debian system.
If you run into this situation, either of the following
solutions exist:
<literallayout class='monospaced'>
$ sudo apt-get build-dep qemu
$ sudo apt-get remove oss4-dev
</literallayout>
</note>
<itemizedlist>
<listitem><para><emphasis>Essentials:</emphasis>
Packages needed to build an image on a headless
+1 -1
View File
@@ -255,7 +255,7 @@
It is worth noting that you can greatly speed up the build time by properly setting
the <filename>BB_NUMBER_THREADS</filename> variable.
See the
"<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
"<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
section in the Yocto Project Quick Start for more information.
</para>
+17 -3
View File
@@ -19,13 +19,27 @@
for less obvious aspects of the build process.
For general information on how to build an image using the OpenEmbedded build
system, see the
"<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>"
"<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
section of the Yocto Project Quick Start.
</para>
<section id='build-overview'>
<title>Build Overview</title>
<para>
In the development environment you will need to build an image whenever you change hardware
support, add or change system libraries, or add or change services that have dependencies.
</para>
<mediaobject>
<imageobject>
<imagedata fileref="figures/building-an-image.png" format="PNG" align='center' scalefit='1'/>
</imageobject>
<caption>
<para>Building an Image</para>
</caption>
</mediaobject>
<para>
The first thing you need to do is set up the OpenEmbedded build
environment by sourcing an environment setup script
@@ -99,8 +113,8 @@
<filename class="directory">tmp/deploy/images</filename>.
For information on how to run pre-built images such as <filename>qemux86</filename>
and <filename>qemuarm</filename>, see the
"<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>"
section in the Yocto Project Quick Start.
"<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Example Using Pre-Built Binaries and QEMU</ulink>"
section in the Yocto Project Application Developer's Guide.
For information about how to install these images, see the documentation for your
particular board or machine.
</para>