summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2017-07-04 11:25:36 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2017-07-12 00:28:15 +0100
commite4f288d519da5d98bae0ba1c4d1841c3f9a8b531 (patch)
tree7c9470ccfdb2a1287b19de6a7422bac446612793 /documentation/dev-manual
parent3f65f662ba456156cd6a7a94bfc841e1e7172a31 (diff)
downloadpoky-e4f288d519da5d98bae0ba1c4d1841c3f9a8b531.tar.gz
dev-manual: Updated "Performing a Simple Build" section.
I added a figure for this simple build workflow that uses BitBake from a Linux host. Also did a bit of re-writing. A new figure was introduced so the Makefile had to be adjusted to include that figure. The figure resides in the figures directory of both the dev-manual and the mega-manual. (From yocto-docs rev: c3b0b1d53f551c02202cef80a8a48dd24576b975) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r--documentation/dev-manual/dev-manual-start.xml49
-rw-r--r--documentation/dev-manual/figures/bitbake-build-flow.pngbin0 -> 49242 bytes
2 files changed, 44 insertions, 5 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml
index 09b13c7783..0835650bd3 100644
--- a/documentation/dev-manual/dev-manual-start.xml
+++ b/documentation/dev-manual/dev-manual-start.xml
@@ -764,18 +764,57 @@
764 <title>Performing a Simple Build</title> 764 <title>Performing a Simple Build</title>
765 765
766 <para> 766 <para>
767 The build process creates an entire Linux distribution, 767 Several methods exist that allow you to build an image within the
768 including the toolchain, from source. 768 Yocto Project.
769 For more information on this topic, see the 769 This procedure shows how to build an image using BitBake from a
770 Linux host.
771 <note><title>Notes</title>
772 <itemizedlist>
773 <listitem><para>
774 For information on how to build an image using
775 <ulink url='&YOCTO_DOCS_REF_URL;#toaster-term'>Toaster</ulink>,
776 see the
777 <ulink url='&YOCTO_DOCS_TOAST_URL;'>Yocto Project Toaster Manual</ulink>.
778 </para></listitem>
779 <listitem><para>
780 For information on how to use
781 <filename>devtool</filename> to build images, see the
782 "<ulink url='&YOCTO_DOCS_SDK_URL;#using-devtool-in-your-sdk-workflow'>Using <filename>devtool</filename> in Your SDK Workflow</ulink>"
783 section in the Yocto Project Software Development Kit
784 (SDK) Developer's Guide.
785 </para></listitem>
786 </itemizedlist>
787 </note>
788 </para>
789
790 <para>
791 The build process creates an entire Linux distribution from source
792 and places it in your
793 <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>
794 under <filename>tmp/deploy/images</filename>.
795 For detailed information on the build process using BitBake, see the
796 "<ulink url='&YOCTO_DOCS_REF_URL;#images-dev-environment'>Images</ulink>"
797 section in the Yocto Project Reference Manual.
798 You can also reference the
770 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" 799 "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>"
771 section in the Yocto Project Quick Start. 800 section in the Yocto Project Quick Start.
772 </para> 801 </para>
773 802
774 <para> 803 <para>
775 Following are the high-level steps for performing a simple build 804 The following figure and list overviews the build process:
776 using the Yocto Project: 805 <imagedata fileref="figures/bitbake-build-flow.png" width="7in" depth="6in" align="center" scalefit="1" />
777 <orderedlist> 806 <orderedlist>
778 <listitem><para> 807 <listitem><para>
808 <emphasis>Set Up Your Host Development System to Support
809 Development Using the Yocto Project:</emphasis>
810 See the
811 "<ulink url='&YOCTO_DOCS_QS_URL;#the-linux-distro'>The Linux Distribution</ulink>"
812 and the
813 "<ulink url='&YOCTO_DOCS_QS_URL;#packages'>The Build Host Packages</ulink>"
814 sections both in the Yocto Project Quick Start for
815 build host requirements.
816 </para></listitem>
817 <listitem><para>
779 <emphasis>Set Up Your Source Directories:</emphasis> 818 <emphasis>Set Up Your Source Directories:</emphasis>
780 Make sure you have set up the Source Directory described in the 819 Make sure you have set up the Source Directory described in the
781 "<link linkend='cloning-the-poky-repository'>Cloning the <filename>poky</filename> Repository</link>" 820 "<link linkend='cloning-the-poky-repository'>Cloning the <filename>poky</filename> Repository</link>"
diff --git a/documentation/dev-manual/figures/bitbake-build-flow.png b/documentation/dev-manual/figures/bitbake-build-flow.png
new file mode 100644
index 0000000000..eb95eb3da0
--- /dev/null
+++ b/documentation/dev-manual/figures/bitbake-build-flow.png
Binary files differ