From ab23dd967e5a59de3cffe48762b4956edba5d478 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Thu, 21 May 2015 11:12:19 -0600 Subject: 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 Signed-off-by: Richard Purdie --- .../ref-manual/figures/building-an-image.png | Bin 0 -> 14891 bytes documentation/ref-manual/introduction.xml | 16 +++++++++++++++- documentation/ref-manual/ref-bitbake.xml | 2 +- documentation/ref-manual/usingpoky.xml | 20 +++++++++++++++++--- 4 files changed, 33 insertions(+), 5 deletions(-) create mode 100755 documentation/ref-manual/figures/building-an-image.png (limited to 'documentation/ref-manual') 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 Binary files /dev/null and b/documentation/ref-manual/figures/building-an-image.png 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 @@ System Requirements For general Yocto Project system requirements, see the - "What You Need and How You Get It" section + "Setting Up to Use the Yocto Project" 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 @@ The following list shows the required packages by function given a supported Ubuntu or Debian Linux distribution: + + If your build system has the + oss4-dev package installed, you + might experience QEMU build failures due to the package + installing its own custom + /usr/include/linux/soundcard.h on + the Debian system. + If you run into this situation, either of the following + solutions exist: + + $ sudo apt-get build-dep qemu + $ sudo apt-get remove oss4-dev + + Essentials: 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 @@ It is worth noting that you can greatly speed up the build time by properly setting the BB_NUMBER_THREADS variable. See the - "Building an Image" + "Building Images" section in the Yocto Project Quick Start for more information. 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,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 - "Building an Image" + "Building Images" section of the Yocto Project Quick Start.
Build Overview + + 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. + + + + + + + + Building an Image + + + The first thing you need to do is set up the OpenEmbedded build environment by sourcing an environment setup script @@ -99,8 +113,8 @@ tmp/deploy/images. For information on how to run pre-built images such as qemux86 and qemuarm, see the - "Using Pre-Built Binaries and QEMU" - section in the Yocto Project Quick Start. + "Example Using Pre-Built Binaries and QEMU" + 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. -- cgit v1.2.3-54-g00ecf