diff options
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 46 |
1 files changed, 31 insertions, 15 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index e1b2e5d4c7..459254c078 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
| @@ -730,45 +730,61 @@ | |||
| 730 | </section> | 730 | </section> |
| 731 | </section> | 731 | </section> |
| 732 | 732 | ||
| 733 | <section id='building-images'> | 733 | <section id='performing-a-simple-build'> |
| 734 | <title>Building Images</title> | 734 | <title>Performing a Simple Build</title> |
| 735 | 735 | ||
| 736 | <para> | 736 | <para> |
| 737 | The build process creates an entire Linux distribution, including the toolchain, from source. | 737 | The build process creates an entire Linux distribution, |
| 738 | including the toolchain, from source. | ||
| 738 | For more information on this topic, see the | 739 | For more information on this topic, see the |
| 739 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" | 740 | "<ulink url='&YOCTO_DOCS_QS_URL;#qs-building-images'>Building Images</ulink>" |
| 740 | section in the Yocto Project Quick Start. | 741 | section in the Yocto Project Quick Start. |
| 741 | </para> | 742 | </para> |
| 742 | 743 | ||
| 743 | <para> | 744 | <para> |
| 744 | The build process is as follows: | 745 | Following are the high-level steps for performing a simple build |
| 746 | using the Yocto Project: | ||
| 745 | <orderedlist> | 747 | <orderedlist> |
| 746 | <listitem><para>Make sure you have set up the Source Directory described in the | 748 | <listitem><para> |
| 747 | previous section.</para></listitem> | 749 | <emphasis>Set Up Your Source Directories:</emphasis> |
| 748 | <listitem><para>Initialize the build environment by sourcing a build | 750 | Make sure you have set up the Source Directory described in the |
| 751 | "<link linkend='cloning-the-poky-repository'>Cloning the <filename>poky</filename> Repository</link>" | ||
| 752 | section. | ||
| 753 | </para></listitem> | ||
| 754 | <listitem><para> | ||
| 755 | <emphasis>Initialize the Build Environment:</emphasis> | ||
| 756 | Initialize the build environment by sourcing a build | ||
| 749 | environment script (i.e. | 757 | environment script (i.e. |
| 750 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> | 758 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> |
| 751 | or | 759 | or |
| 752 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>). | 760 | <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>). |
| 753 | </para></listitem> | 761 | </para></listitem> |
| 754 | <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file, | 762 | <listitem><para> |
| 755 | which is found in the | 763 | <emphasis>Make Sure Your <filename>local.conf</filename> |
| 764 | File is Correct:</emphasis> | ||
| 765 | Ensure the <filename>conf/local.conf</filename> configuration | ||
| 766 | file, which is found in the | ||
| 756 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, | 767 | <ulink url='&YOCTO_DOCS_REF_URL;#build-directory'>Build Directory</ulink>, |
| 757 | is set up how you want it. | 768 | is set up how you want it. |
| 758 | This file defines many aspects of the build environment including | 769 | This file defines many aspects of the build environment |
| 759 | the target machine architecture through the | 770 | including the target machine architecture through the |
| 760 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'>MACHINE</ulink></filename> variable, | 771 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-MACHINE'>MACHINE</ulink></filename> variable, |
| 761 | the packaging format used during the build | 772 | the packaging format used during the build |
| 762 | (<ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>), | 773 | (<ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_CLASSES'><filename>PACKAGE_CLASSES</filename></ulink>), |
| 763 | and a centralized tarball download directory through the | 774 | and a centralized tarball download directory through the |
| 764 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> | 775 | <filename><ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'>DL_DIR</ulink></filename> variable. |
| 776 | </para></listitem> | ||
| 765 | <listitem><para> | 777 | <listitem><para> |
| 778 | <emphasis>Build the Image:</emphasis> | ||
| 766 | Build the image using the <filename>bitbake</filename> command. | 779 | Build the image using the <filename>bitbake</filename> command. |
| 767 | If you want information on BitBake, see the | 780 | For example, the following command builds the |
| 781 | <filename>core-image-minimal</filename> image: | ||
| 782 | <literallayout class='monospaced'> | ||
| 783 | $ bitbake core-image-minimal | ||
| 784 | </literallayout> | ||
| 785 | For information on BitBake, see the | ||
| 768 | <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>. | 786 | <ulink url='&YOCTO_DOCS_BB_URL;'>BitBake User Manual</ulink>. |
| 769 | </para></listitem> | 787 | </para></listitem> |
| 770 | <listitem><para>Run the image either on the actual hardware or using the QEMU | ||
| 771 | emulator.</para></listitem> | ||
| 772 | </orderedlist> | 788 | </orderedlist> |
| 773 | </para> | 789 | </para> |
| 774 | </section> | 790 | </section> |
