summaryrefslogtreecommitdiffstats
path: root/documentation/dev-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/dev-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/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml3
-rw-r--r--documentation/dev-manual/dev-manual-model.xml18
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml2
-rw-r--r--documentation/dev-manual/dev-manual-start.xml22
4 files changed, 28 insertions, 17 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index a929481633..e927a89bee 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -5021,9 +5021,6 @@
5021 Furthermore, the <link linkend='build-directory'>Build Directory</link> is 5021 Furthermore, the <link linkend='build-directory'>Build Directory</link> is
5022 <filename>build</filename> and is located in <filename>poky</filename> and 5022 <filename>build</filename> and is located in <filename>poky</filename> and
5023 the kernel is based on the Linux 3.4 kernel. 5023 the kernel is based on the Linux 3.4 kernel.
5024 For general information on how to configure the most efficient build, see the
5025 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section
5026 in the Yocto Project Quick Start.
5027 </para> 5024 </para>
5028 5025
5029 <para> 5026 <para>
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 03eb5f1176..9c549d7464 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -124,7 +124,7 @@
124 development using the Yocto Project</emphasis>: See the 124 development using the Yocto Project</emphasis>: See the
125 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distribution</ulink>" 125 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distribution</ulink>"
126 and the 126 and the
127 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both 127 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>" sections both
128 in the Yocto Project Quick Start for requirements.</para></listitem> 128 in the Yocto Project Quick Start for requirements.</para></listitem>
129 <listitem><para><emphasis>Establish a local copy of the project files on your 129 <listitem><para><emphasis>Establish a local copy of the project files on your
130 system</emphasis>: You need this <link linkend='source-directory'>Source 130 system</emphasis>: You need this <link linkend='source-directory'>Source
@@ -223,7 +223,7 @@
223 "<link linkend='enabling-your-layer'>Enabling Your Layer</link>" section 223 "<link linkend='enabling-your-layer'>Enabling Your Layer</link>" section
224 for information on how to let the build system know about your new layer.</para> 224 for information on how to let the build system know about your new layer.</para>
225 <para>The entire process for building an image is overviewed in the section 225 <para>The entire process for building an image is overviewed in the section
226 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" section 226 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" section
227 of the Yocto Project Quick Start. 227 of the Yocto Project Quick Start.
228 You might want to reference this information.</para></listitem> 228 You might want to reference this information.</para></listitem>
229 <listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded build system 229 <listitem><para><emphasis>Build the image</emphasis>: The OpenEmbedded build system
@@ -451,7 +451,7 @@
451 <listitem><para><emphasis>Set up your host development system to support 451 <listitem><para><emphasis>Set up your host development system to support
452 development using the Yocto Project</emphasis>: See 452 development using the Yocto Project</emphasis>: See
453 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distribution</ulink>" and 453 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distribution</ulink>" and
454 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" sections both 454 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>" sections both
455 in the Yocto Project Quick Start for requirements.</para></listitem> 455 in the Yocto Project Quick Start for requirements.</para></listitem>
456 <listitem><para><emphasis>Establish a local copy of project files on your 456 <listitem><para><emphasis>Establish a local copy of project files on your
457 system</emphasis>: Having the <link linkend='source-directory'>Source 457 system</emphasis>: Having the <link linkend='source-directory'>Source
@@ -476,7 +476,7 @@
476 (<filename>local.conf</filename> and <filename>bblayers.conf</filename>) 476 (<filename>local.conf</filename> and <filename>bblayers.conf</filename>)
477 are configured appropriately.</para> 477 are configured appropriately.</para>
478 <para>The entire process for building an image is overviewed in the 478 <para>The entire process for building an image is overviewed in the
479 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" 479 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
480 section of the Yocto Project Quick Start. 480 section of the Yocto Project Quick Start.
481 You might want to reference this information. 481 You might want to reference this information.
482 You can find more information on BitBake in the 482 You can find more information on BitBake in the
@@ -617,7 +617,7 @@
617 <para>For information on pre-built kernel image naming schemes for images 617 <para>For information on pre-built kernel image naming schemes for images
618 that can run on the QEMU emulator, see the 618 that can run on the QEMU emulator, see the
619 "<ulink url='&YOCTO_DOCS_QS_URL;#downloading-the-pre-built-linux-kernel'>Downloading the Pre-Built Linux Kernel</ulink>" 619 "<ulink url='&YOCTO_DOCS_QS_URL;#downloading-the-pre-built-linux-kernel'>Downloading the Pre-Built Linux Kernel</ulink>"
620 section in the Yocto Project Quick Start.</para></listitem> 620 section in the Yocto Project Application Developer's Guide.</para></listitem>
621 <listitem><para><emphasis>Install the ADT</emphasis>: 621 <listitem><para><emphasis>Install the ADT</emphasis>:
622 The ADT provides a target-specific cross-development toolchain, the root filesystem, 622 The ADT provides a target-specific cross-development toolchain, the root filesystem,
623 the QEMU emulator, and other tools that can help you develop your application. 623 the QEMU emulator, and other tools that can help you develop your application.
@@ -646,7 +646,7 @@
646 section in the Yocto Project Application Developer's Guide for information 646 section in the Yocto Project Application Developer's Guide for information
647 and the 647 and the
648 "<ulink url='&YOCTO_DOCS_QS_URL;#installing-the-toolchain'>Installing the Toolchain</ulink>" 648 "<ulink url='&YOCTO_DOCS_QS_URL;#installing-the-toolchain'>Installing the Toolchain</ulink>"
649 in the Yocto Project Quick Start for information on finding and installing 649 in the Yocto Project Application Developer's Guide for information on finding and installing
650 the correct toolchain based on your host development system and your target 650 the correct toolchain based on your host development system and your target
651 architecture. 651 architecture.
652 </para></listitem> 652 </para></listitem>
@@ -1163,7 +1163,7 @@
1163 If the architecture you need is not listed in 1163 If the architecture you need is not listed in
1164 the menu, you will need to build the image. 1164 the menu, you will need to build the image.
1165 See the 1165 See the
1166 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" 1166 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
1167 section of the Yocto Project Quick Start for 1167 section of the Yocto Project Quick Start for
1168 more information.</para></listitem> 1168 more information.</para></listitem>
1169 </itemizedlist> 1169 </itemizedlist>
@@ -1740,7 +1740,7 @@
1740 For information on how to set up a local copy of the 1740 For information on how to set up a local copy of the
1741 <filename>poky</filename> repository and on how to 1741 <filename>poky</filename> repository and on how to
1742 build a Yocto Project image, see the 1742 build a Yocto Project image, see the
1743 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" 1743 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
1744 section in the Yocto Project Quick Start. 1744 section in the Yocto Project Quick Start.
1745 </para></listitem> 1745 </para></listitem>
1746 <listitem><para> 1746 <listitem><para>
@@ -2375,7 +2375,7 @@
2375 <filename>bitbake -c cleanall <replaceable>package</replaceable></filename>). 2375 <filename>bitbake -c cleanall <replaceable>package</replaceable></filename>).
2376 Modifications will also disappear if you use the <filename>rm_work</filename> 2376 Modifications will also disappear if you use the <filename>rm_work</filename>
2377 feature as described in the 2377 feature as described in the
2378 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" 2378 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
2379 section of the Yocto Project Quick Start. 2379 section of the Yocto Project Quick Start.
2380 </note></para></listitem> 2380 </note></para></listitem>
2381 <listitem><para><emphasis>Generate the Patch:</emphasis> 2381 <listitem><para><emphasis>Generate the Patch:</emphasis>
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index 2c5fa683e0..70fa96975d 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -709,7 +709,7 @@
709 You "bake" something by running it through BitBake.</para> 709 You "bake" something by running it through BitBake.</para>
710 <para>It is worth noting that the term "package" can, in general, have subtle 710 <para>It is worth noting that the term "package" can, in general, have subtle
711 meanings. For example, the packages referred to in the 711 meanings. For example, the packages referred to in the
712 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" section are 712 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>" section are
713 compiled binaries that, when installed, add functionality to your Linux 713 compiled binaries that, when installed, add functionality to your Linux
714 distribution.</para> 714 distribution.</para>
715 <para>Another point worth noting is that historically within the Yocto Project, 715 <para>Another point worth noting is that historically within the Yocto Project,
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 36a3593c19..db989b7bfa 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -73,7 +73,7 @@
73 </para></listitem> 73 </para></listitem>
74 <listitem><para><emphasis>Packages:</emphasis> The OpenEmbedded build system 74 <listitem><para><emphasis>Packages:</emphasis> The OpenEmbedded build system
75 requires that certain packages exist on your development system (e.g. Python 2.7). 75 requires that certain packages exist on your development system (e.g. Python 2.7).
76 See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Packages</ulink>" 76 See "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>"
77 section in the Yocto Project Quick Start and the 77 section in the Yocto Project Quick Start and the
78 "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>" 78 "<ulink url='&YOCTO_DOCS_REF_URL;#required-packages-for-the-host-development-system'>Required Packages for the Host Development System</ulink>"
79 section in the Yocto Project Reference Manual for the exact 79 section in the Yocto Project Reference Manual for the exact
@@ -125,6 +125,20 @@
125 wiki page</ulink>, which describes how to create local 125 wiki page</ulink>, which describes how to create local
126 Git repositories for both 126 Git repositories for both
127 <filename>poky</filename> and <filename>meta-intel</filename>. 127 <filename>poky</filename> and <filename>meta-intel</filename>.
128 </para>
129 <para>
130 You can also get the Yocto Project Files by downloading
131 Yocto Project releases from the
132 <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>.
133 From the website, you just click "Downloads" in the navigation
134 pane to the left to display all Yocto Project downloads.
135 Current and archived releases are available for download.
136 Nightly and developmental builds are also maintained at
137 <ulink url="&YOCTO_AB_NIGHTLY_URL;"></ulink>.
138 One final site you can visit for information on Yocto Project
139 releases is the
140 <ulink url='&YOCTO_WIKI_URL;/wiki/Releases'>Releases</ulink>
141 wiki.
128 </para></listitem> 142 </para></listitem>
129 <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis> 143 <listitem id='local-kernel-files'><para><emphasis>Yocto Project Kernel:</emphasis>
130 If you are going to be making modifications to a supported Yocto Project kernel, you 144 If you are going to be making modifications to a supported Yocto Project kernel, you
@@ -277,7 +291,7 @@
277 <para> 291 <para>
278 The build process creates an entire Linux distribution, including the toolchain, from source. 292 The build process creates an entire Linux distribution, including the toolchain, from source.
279 For more information on this topic, see the 293 For more information on this topic, see the
280 "<ulink url='&YOCTO_DOCS_QS_URL;#building-image'>Building an Image</ulink>" 294 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
281 section in the Yocto Project Quick Start. 295 section in the Yocto Project Quick Start.
282 </para> 296 </para>
283 297
@@ -349,8 +363,8 @@
349 by sourcing an environment setup script. 363 by sourcing an environment setup script.
350 Finally, you start the QEMU emulator. 364 Finally, you start the QEMU emulator.
351 You can find details on all these steps in the 365 You can find details on all these steps in the
352 "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Using Pre-Built Binaries and QEMU</ulink>" 366 "<ulink url='&YOCTO_DOCS_QS_URL;#using-pre-built'>Example Using Pre-Built Binaries and QEMU</ulink>"
353 section of the Yocto Project Quick Start. 367 section of the Yocto Project Application Developer's Guide.
354 You can learn more about using QEMU with the Yocto Project in the 368 You can learn more about using QEMU with the Yocto Project in the
355 "<link linkend='dev-manual-qemu'>Using the Quick EMUlator (QEMU)</link>" 369 "<link linkend='dev-manual-qemu'>Using the Quick EMUlator (QEMU)</link>"
356 section. 370 section.