diff options
Diffstat (limited to 'documentation/ref-manual/introduction.xml')
| -rw-r--r-- | documentation/ref-manual/introduction.xml | 560 |
1 files changed, 560 insertions, 0 deletions
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml new file mode 100644 index 0000000..a61740d --- /dev/null +++ b/documentation/ref-manual/introduction.xml | |||
| @@ -0,0 +1,560 @@ | |||
| 1 | <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" | ||
| 2 | "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" | ||
| 3 | [<!ENTITY % poky SYSTEM "../poky.ent"> %poky; ] > | ||
| 4 | |||
| 5 | <chapter id='intro'> | ||
| 6 | <title>Introduction</title> | ||
| 7 | |||
| 8 | <section id='intro-welcome'> | ||
| 9 | <title>Introduction</title> | ||
| 10 | |||
| 11 | <para> | ||
| 12 | This manual provides reference information for the current release of the Yocto Project. | ||
| 13 | The Yocto Project is an open-source collaboration project focused on embedded Linux | ||
| 14 | developers. | ||
| 15 | Amongst other things, the Yocto Project uses the OpenEmbedded build system, which | ||
| 16 | is based on the Poky project, to construct complete Linux images. | ||
| 17 | You can find complete introductory and getting started information on the Yocto Project | ||
| 18 | by reading the | ||
| 19 | <ulink url='&YOCTO_DOCS_QS_URL;'>Yocto Project Quick Start</ulink>. | ||
| 20 | For task-based information using the Yocto Project, see the | ||
| 21 | <ulink url='&YOCTO_DOCS_DEV_URL;'>Yocto Project Development Manual</ulink> | ||
| 22 | and the <ulink url='&YOCTO_DOCS_KERNEL_DEV_URL;'>Yocto Project Linux Kernel Development Manual</ulink>. | ||
| 23 | For Board Support Package (BSP) structure information, see the | ||
| 24 | <ulink url='&YOCTO_DOCS_BSP_URL;'>Yocto Project Board Support Package (BSP) Developer's Guide</ulink>. | ||
| 25 | You can find information on tracing and profiling in the | ||
| 26 | <ulink url='&YOCTO_DOCS_PROF_URL;#profile-manual'>Yocto Project Profiling and Tracing Manual</ulink>. | ||
| 27 | For information on BitBake, which is the task execution tool the | ||
| 28 | OpenEmbedded build system is based on, see the | ||
| 29 | <ulink url='&YOCTO_DOCS_BB_URL;#bitbake-user-manual'>BitBake User Manual</ulink>. | ||
| 30 | Finally, you can also find lots of Yocto Project information on the | ||
| 31 | <ulink url="&YOCTO_HOME_URL;">Yocto Project website</ulink>. | ||
| 32 | </para> | ||
| 33 | </section> | ||
| 34 | |||
| 35 | <section id='intro-manualoverview'> | ||
| 36 | <title>Documentation Overview</title> | ||
| 37 | <para> | ||
| 38 | This reference manual consists of the following: | ||
| 39 | <itemizedlist> | ||
| 40 | <listitem><para><emphasis> | ||
| 41 | <link linkend='usingpoky'>Using the Yocto Project</link>:</emphasis> | ||
| 42 | Provides an overview of the components that make up the Yocto Project | ||
| 43 | followed by information about debugging images created in the Yocto Project. | ||
| 44 | </para></listitem> | ||
| 45 | <listitem><para><emphasis> | ||
| 46 | <link linkend='closer-look'>A Closer Look at the Yocto Project Development Environment</link>:</emphasis> | ||
| 47 | Provides a more detailed look at the Yocto Project development | ||
| 48 | environment within the context of development. | ||
| 49 | </para></listitem> | ||
| 50 | <listitem><para><emphasis> | ||
| 51 | <link linkend='technical-details'>Technical Details</link>:</emphasis> | ||
| 52 | Describes fundamental Yocto Project components as well as an explanation | ||
| 53 | behind how the Yocto Project uses shared state (sstate) cache to speed build time. | ||
| 54 | </para></listitem> | ||
| 55 | <listitem><para><emphasis> | ||
| 56 | <link linkend='migration'>Migrating to a Newer Yocto Project Release</link>:</emphasis> | ||
| 57 | Describes release-specific information that helps you move from | ||
| 58 | one Yocto Project Release to another. | ||
| 59 | </para></listitem> | ||
| 60 | <listitem><para><emphasis> | ||
| 61 | <link linkend='ref-structure'>Directory Structure</link>:</emphasis> | ||
| 62 | Describes the | ||
| 63 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> created | ||
| 64 | either by unpacking a released Yocto Project tarball on your host development system, | ||
| 65 | or by cloning the upstream | ||
| 66 | <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>Poky</ulink> Git repository. | ||
| 67 | </para></listitem> | ||
| 68 | <listitem><para><emphasis> | ||
| 69 | <link linkend='ref-classes'>Classes</link>:</emphasis> | ||
| 70 | Describes the classes used in the Yocto Project.</para></listitem> | ||
| 71 | <listitem><para><emphasis> | ||
| 72 | <link linkend='ref-tasks'>Tasks</link>:</emphasis> | ||
| 73 | Describes the tasks defined by the OpenEmbedded build system. | ||
| 74 | </para></listitem> | ||
| 75 | <listitem><para><emphasis> | ||
| 76 | <link linkend='ref-images'>Images</link>:</emphasis> | ||
| 77 | Describes the standard images that the Yocto Project supports. | ||
| 78 | </para></listitem> | ||
| 79 | <listitem><para><emphasis> | ||
| 80 | <link linkend='ref-features'>Features</link>:</emphasis> | ||
| 81 | Describes mechanisms for creating distribution, machine, and image | ||
| 82 | features during the build process using the OpenEmbedded build system.</para></listitem> | ||
| 83 | <listitem><para><emphasis> | ||
| 84 | <link linkend='ref-variables-glos'>Variables Glossary</link>:</emphasis> | ||
| 85 | Presents most variables used by the OpenEmbedded build system, which | ||
| 86 | uses BitBake. | ||
| 87 | Entries describe the function of the variable and how to apply them. | ||
| 88 | </para></listitem> | ||
| 89 | <listitem><para><emphasis> | ||
| 90 | <link linkend='ref-varlocality'>Variable Context</link>:</emphasis> | ||
| 91 | Provides variable locality or context.</para></listitem> | ||
| 92 | <listitem><para><emphasis> | ||
| 93 | <link linkend='faq'>FAQ</link>:</emphasis> | ||
| 94 | Provides answers for commonly asked questions in the Yocto Project | ||
| 95 | development environment.</para></listitem> | ||
| 96 | <listitem><para><emphasis> | ||
| 97 | <link linkend='resources'>Contributing to the Yocto Project</link>:</emphasis> | ||
| 98 | Provides guidance on how you can contribute back to the Yocto | ||
| 99 | Project.</para></listitem> | ||
| 100 | </itemizedlist> | ||
| 101 | </para> | ||
| 102 | </section> | ||
| 103 | |||
| 104 | |||
| 105 | <section id='intro-requirements'> | ||
| 106 | <title>System Requirements</title> | ||
| 107 | <para> | ||
| 108 | For general Yocto Project system requirements, see the | ||
| 109 | "<ulink url='&YOCTO_DOCS_QS_URL;#yp-resources'>What You Need and How You Get It</ulink>" section | ||
| 110 | in the Yocto Project Quick Start. | ||
| 111 | The remainder of this section provides details on system requirements | ||
| 112 | not covered in the Yocto Project Quick Start. | ||
| 113 | </para> | ||
| 114 | |||
| 115 | <section id='detailed-supported-distros'> | ||
| 116 | <title>Supported Linux Distributions</title> | ||
| 117 | |||
| 118 | <para> | ||
| 119 | Currently, the Yocto Project is supported on the following | ||
| 120 | distributions: | ||
| 121 | <note> | ||
| 122 | <para> | ||
| 123 | Yocto Project releases are tested against the stable Linux | ||
| 124 | distributions in the following list. | ||
| 125 | The Yocto Project should work on other distributions but | ||
| 126 | validation is not performed against them. | ||
| 127 | </para> | ||
| 128 | |||
| 129 | <para> | ||
| 130 | In particular, the Yocto Project does not support | ||
| 131 | and currently has no plans to support | ||
| 132 | rolling-releases or development distributions due to their | ||
| 133 | constantly changing nature. | ||
| 134 | We welcome patches and bug reports, but keep in mind that | ||
| 135 | our priority is on the supported platforms listed below. | ||
| 136 | </para> | ||
| 137 | |||
| 138 | <para> | ||
| 139 | If you encounter problems, please go to | ||
| 140 | <ulink url='&YOCTO_BUGZILLA_URL;'>Yocto Project Bugzilla</ulink> | ||
| 141 | and submit a bug. | ||
| 142 | We are interested in hearing about your experience. | ||
| 143 | </para> | ||
| 144 | </note> | ||
| 145 | <itemizedlist> | ||
| 146 | <!-- <listitem><para>Ubuntu 10.04</para></listitem> | ||
| 147 | <listitem><para>Ubuntu 11.10</para></listitem> --> | ||
| 148 | <listitem><para>Ubuntu 12.04 (LTS)</para></listitem> | ||
| 149 | <listitem><para>Ubuntu 13.10</para></listitem> | ||
| 150 | <listitem><para>Ubuntu 14.04 (LTS)</para></listitem> | ||
| 151 | <!-- <listitem><para>Fedora 16 (Verne)</para></listitem> | ||
| 152 | <listitem><para>Fedora 17 (Spherical)</para></listitem> --> | ||
| 153 | <listitem><para>Fedora release 19 (Schrödinger's Cat)</para></listitem> | ||
| 154 | <listitem><para>Fedora release 20 (Heisenbug)</para></listitem> | ||
| 155 | <!-- <listitem><para>CentOS release 5.6 (Final)</para></listitem> | ||
| 156 | <listitem><para>CentOS release 5.7 (Final)</para></listitem> | ||
| 157 | <listitem><para>CentOS release 5.8 (Final)</para></listitem> | ||
| 158 | <listitem><para>CentOS release 6.3 (Final)</para></listitem> --> | ||
| 159 | <listitem><para>CentOS release 6.4</para></listitem> | ||
| 160 | <listitem><para>CentOS release 6.5</para></listitem> | ||
| 161 | <!-- <listitem><para>Debian GNU/Linux 6.0 (Squeeze)</para></listitem> --> | ||
| 162 | <listitem><para>Debian GNU/Linux 7.0 (Wheezy)</para></listitem> | ||
| 163 | <listitem><para>Debian GNU/Linux 7.1 (Wheezy)</para></listitem> | ||
| 164 | <listitem><para>Debian GNU/Linux 7.2 (Wheezy)</para></listitem> | ||
| 165 | <listitem><para>Debian GNU/Linux 7.3 (Wheezy)</para></listitem> | ||
| 166 | <listitem><para>Debian GNU/Linux 7.4 (Wheezy)</para></listitem> | ||
| 167 | <!-- <listitem><para>openSUSE 11.4</para></listitem> | ||
| 168 | <listitem><para>openSUSE 12.1</para></listitem> --> | ||
| 169 | <listitem><para>openSUSE 12.2</para></listitem> | ||
| 170 | <listitem><para>openSUSE 12.3</para></listitem> | ||
| 171 | <listitem><para>openSUSE 13.1</para></listitem> | ||
| 172 | </itemizedlist> | ||
| 173 | </para> | ||
| 174 | |||
| 175 | <note> | ||
| 176 | While the Yocto Project Team attempts to ensure all Yocto Project | ||
| 177 | releases are one hundred percent compatible with each officially | ||
| 178 | supported Linux distribution, instances might exist where you | ||
| 179 | encounter a problem while using the Yocto Project on a specific | ||
| 180 | distribution. | ||
| 181 | For example, the CentOS 6.4 distribution does not include the | ||
| 182 | Gtk+ 2.20.0 and PyGtk 2.21.0 (or higher) packages, which are | ||
| 183 | required to run | ||
| 184 | <ulink url='&YOCTO_HOME_URL;/tools-resources/projects/hob'>Hob</ulink>. | ||
| 185 | </note> | ||
| 186 | </section> | ||
| 187 | |||
| 188 | <section id='required-packages-for-the-host-development-system'> | ||
| 189 | <title>Required Packages for the Host Development System</title> | ||
| 190 | |||
| 191 | <para> | ||
| 192 | The list of packages you need on the host development system can | ||
| 193 | be large when covering all build scenarios using the Yocto Project. | ||
| 194 | This section provides required packages according to | ||
| 195 | Linux distribution and function. | ||
| 196 | </para> | ||
| 197 | |||
| 198 | <section id='ubuntu-packages'> | ||
| 199 | <title>Ubuntu and Debian</title> | ||
| 200 | |||
| 201 | <para> | ||
| 202 | The following list shows the required packages by function | ||
| 203 | given a supported Ubuntu or Debian Linux distribution: | ||
| 204 | <itemizedlist> | ||
| 205 | <listitem><para><emphasis>Essentials:</emphasis> | ||
| 206 | Packages needed to build an image on a headless | ||
| 207 | system: | ||
| 208 | <literallayout class='monospaced'> | ||
| 209 | $ sudo apt-get install &UBUNTU_HOST_PACKAGES_ESSENTIAL; | ||
| 210 | </literallayout></para></listitem> | ||
| 211 | <listitem><para><emphasis>Graphical and Eclipse Plug-In Extras:</emphasis> | ||
| 212 | Packages recommended if the host system has graphics | ||
| 213 | support or if you are going to use the Eclipse | ||
| 214 | IDE: | ||
| 215 | <literallayout class='monospaced'> | ||
| 216 | $ sudo apt-get install libsdl1.2-dev xterm | ||
| 217 | </literallayout></para></listitem> | ||
| 218 | <listitem><para><emphasis>Documentation:</emphasis> | ||
| 219 | Packages needed if you are going to build out the | ||
| 220 | Yocto Project documentation manuals: | ||
| 221 | <literallayout class='monospaced'> | ||
| 222 | $ sudo apt-get install make xsltproc docbook-utils fop dblatex xmlto | ||
| 223 | </literallayout></para></listitem> | ||
| 224 | <listitem><para><emphasis>ADT Installer Extras:</emphasis> | ||
| 225 | Packages needed if you are going to be using the | ||
| 226 | <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>: | ||
| 227 | <literallayout class='monospaced'> | ||
| 228 | $ sudo apt-get install autoconf automake libtool libglib2.0-dev | ||
| 229 | </literallayout></para></listitem> | ||
| 230 | </itemizedlist> | ||
| 231 | </para> | ||
| 232 | </section> | ||
| 233 | |||
| 234 | <section id='fedora-packages'> | ||
| 235 | <title>Fedora Packages</title> | ||
| 236 | |||
| 237 | <para> | ||
| 238 | The following list shows the required packages by function | ||
| 239 | given a supported Fedora Linux distribution: | ||
| 240 | <itemizedlist> | ||
| 241 | <listitem><para><emphasis>Essentials:</emphasis> | ||
| 242 | Packages needed to build an image for a headless | ||
| 243 | system: | ||
| 244 | <literallayout class='monospaced'> | ||
| 245 | $ sudo yum install &FEDORA_HOST_PACKAGES_ESSENTIAL; | ||
| 246 | </literallayout></para></listitem> | ||
| 247 | <listitem><para><emphasis>Graphical and Eclipse Plug-In Extras:</emphasis> | ||
| 248 | Packages recommended if the host system has graphics | ||
| 249 | support or if you are going to use the Eclipse | ||
| 250 | IDE: | ||
| 251 | <literallayout class='monospaced'> | ||
| 252 | $ sudo yum install SDL-devel xterm perl-Thread-Queue | ||
| 253 | </literallayout></para></listitem> | ||
| 254 | <listitem><para><emphasis>Documentation:</emphasis> | ||
| 255 | Packages needed if you are going to build out the | ||
| 256 | Yocto Project documentation manuals: | ||
| 257 | <literallayout class='monospaced'> | ||
| 258 | $ sudo yum install make docbook-style-dsssl docbook-style-xsl \ | ||
| 259 | docbook-dtds docbook-utils fop libxslt dblatex xmlto | ||
| 260 | </literallayout></para></listitem> | ||
| 261 | <listitem><para><emphasis>ADT Installer Extras:</emphasis> | ||
| 262 | Packages needed if you are going to be using the | ||
| 263 | <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>: | ||
| 264 | <literallayout class='monospaced'> | ||
| 265 | $ sudo yum install autoconf automake libtool glib2-devel | ||
| 266 | </literallayout></para></listitem> | ||
| 267 | </itemizedlist> | ||
| 268 | </para> | ||
| 269 | </section> | ||
| 270 | |||
| 271 | <section id='opensuse-packages'> | ||
| 272 | <title>openSUSE Packages</title> | ||
| 273 | |||
| 274 | <para> | ||
| 275 | The following list shows the required packages by function | ||
| 276 | given a supported openSUSE Linux distribution: | ||
| 277 | <itemizedlist> | ||
| 278 | <listitem><para><emphasis>Essentials:</emphasis> | ||
| 279 | Packages needed to build an image for a headless | ||
| 280 | system: | ||
| 281 | <literallayout class='monospaced'> | ||
| 282 | $ sudo zypper install &OPENSUSE_HOST_PACKAGES_ESSENTIAL; | ||
| 283 | </literallayout></para></listitem> | ||
| 284 | <listitem><para><emphasis>Graphical and Eclipse Plug-In Extras:</emphasis> | ||
| 285 | Packages recommended if the host system has graphics | ||
| 286 | support or if you are going to use the Eclipse | ||
| 287 | IDE: | ||
| 288 | <literallayout class='monospaced'> | ||
| 289 | $ sudo zypper install libSDL-devel xterm | ||
| 290 | </literallayout></para></listitem> | ||
| 291 | <listitem><para><emphasis>Documentation:</emphasis> | ||
| 292 | Packages needed if you are going to build out the | ||
| 293 | Yocto Project documentation manuals: | ||
| 294 | <literallayout class='monospaced'> | ||
| 295 | $ sudo zypper install make fop xsltproc dblatex xmlto | ||
| 296 | </literallayout></para></listitem> | ||
| 297 | <listitem><para><emphasis>ADT Installer Extras:</emphasis> | ||
| 298 | Packages needed if you are going to be using the | ||
| 299 | <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>: | ||
| 300 | <literallayout class='monospaced'> | ||
| 301 | $ sudo zypper install autoconf automake libtool glib2-devel | ||
| 302 | </literallayout></para></listitem> | ||
| 303 | </itemizedlist> | ||
| 304 | </para> | ||
| 305 | </section> | ||
| 306 | |||
| 307 | <section id='centos-packages'> | ||
| 308 | <title>CentOS Packages</title> | ||
| 309 | |||
| 310 | <para> | ||
| 311 | The following list shows the required packages by function | ||
| 312 | given a supported CentOS Linux distribution: | ||
| 313 | <note>Depending on the CentOS version you are using, other requirements | ||
| 314 | and dependencies might exist. | ||
| 315 | For details, you should look at the CentOS sections on the | ||
| 316 | <ulink url='https://wiki.yoctoproject.org/wiki/Poky/GettingStarted/Dependencies'>Poky/GettingStarted/Dependencies</ulink> | ||
| 317 | wiki page. | ||
| 318 | </note> | ||
| 319 | <itemizedlist> | ||
| 320 | <listitem><para><emphasis>Essentials:</emphasis> | ||
| 321 | Packages needed to build an image for a headless | ||
| 322 | system: | ||
| 323 | <literallayout class='monospaced'> | ||
| 324 | $ sudo yum install &CENTOS_HOST_PACKAGES_ESSENTIAL; | ||
| 325 | </literallayout></para></listitem> | ||
| 326 | <listitem><para><emphasis>Graphical and Eclipse Plug-In Extras:</emphasis> | ||
| 327 | Packages recommended if the host system has graphics | ||
| 328 | support or if you are going to use the Eclipse | ||
| 329 | IDE: | ||
| 330 | <literallayout class='monospaced'> | ||
| 331 | $ sudo yum install SDL-devel xterm | ||
| 332 | </literallayout></para></listitem> | ||
| 333 | <listitem><para><emphasis>Documentation:</emphasis> | ||
| 334 | Packages needed if you are going to build out the | ||
| 335 | Yocto Project documentation manuals: | ||
| 336 | <literallayout class='monospaced'> | ||
| 337 | $ sudo yum install make docbook-style-dsssl docbook-style-xsl \ | ||
| 338 | docbook-dtds docbook-utils fop libxslt dblatex xmlto | ||
| 339 | </literallayout></para></listitem> | ||
| 340 | <listitem><para><emphasis>ADT Installer Extras:</emphasis> | ||
| 341 | Packages needed if you are going to be using the | ||
| 342 | <ulink url='&YOCTO_DOCS_ADT_URL;#using-the-adt-installer'>Application Development Toolkit (ADT) Installer</ulink>: | ||
| 343 | <literallayout class='monospaced'> | ||
| 344 | $ sudo yum install autoconf automake libtool glib2-devel | ||
| 345 | </literallayout></para></listitem> | ||
| 346 | </itemizedlist> | ||
| 347 | </para> | ||
| 348 | </section> | ||
| 349 | </section> | ||
| 350 | |||
| 351 | <section id='required-git-tar-and-python-versions'> | ||
| 352 | <title>Required Git, tar, and Python Versions</title> | ||
| 353 | |||
| 354 | <para> | ||
| 355 | In order to use the build system, your host development system | ||
| 356 | must meet the following version requirements for Git, tar, and | ||
| 357 | Python: | ||
| 358 | <itemizedlist> | ||
| 359 | <listitem><para>Git 1.7.5 or greater</para></listitem> | ||
| 360 | <listitem><para>tar 1.24 or greater</para></listitem> | ||
| 361 | <listitem><para>Python 2.7.3 or greater not including | ||
| 362 | Python 3.x, which is not supported.</para></listitem> | ||
| 363 | </itemizedlist> | ||
| 364 | </para> | ||
| 365 | |||
| 366 | <para> | ||
| 367 | If your host development system does not meet all these requirements, | ||
| 368 | you can resolve this by installing a <filename>buildtools</filename> | ||
| 369 | tarball that contains these tools. | ||
| 370 | You can get the tarball one of two ways: download a pre-built | ||
| 371 | tarball or use BitBake to build the tarball. | ||
| 372 | </para> | ||
| 373 | |||
| 374 | <section id='downloading-a-pre-built-buildtools-tarball'> | ||
| 375 | <title>Downloading a Pre-Built <filename>buildtools</filename> Tarball</title> | ||
| 376 | |||
| 377 | <para> | ||
| 378 | Downloading and running a pre-built buildtools installer is | ||
| 379 | the easiest of the two methods by which you can get these tools: | ||
| 380 | <orderedlist> | ||
| 381 | <listitem><para> | ||
| 382 | Locate and download the <filename>*.sh</filename> at | ||
| 383 | <ulink url='&YOCTO_DL_URL;/releases/yocto/yocto-&DISTRO;/buildtools/'></ulink>. | ||
| 384 | </para></listitem> | ||
| 385 | <listitem><para> | ||
| 386 | Execute the installation script. | ||
| 387 | Here is an example: | ||
| 388 | <literallayout class='monospaced'> | ||
| 389 | $ sh poky-eglibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh | ||
| 390 | </literallayout> | ||
| 391 | During execution, a prompt appears that allows you to | ||
| 392 | choose the installation directory. | ||
| 393 | For example, you could choose the following: | ||
| 394 | <literallayout class='monospaced'> | ||
| 395 | /home/your-username/buildtools | ||
| 396 | </literallayout> | ||
| 397 | </para></listitem> | ||
| 398 | <listitem><para> | ||
| 399 | Source the tools environment setup script by using a | ||
| 400 | command like the following: | ||
| 401 | <literallayout class='monospaced'> | ||
| 402 | $ source /home/your-username/buildtools/environment-setup-i586-poky-linux | ||
| 403 | </literallayout> | ||
| 404 | Of course, you need to supply your installation directory and be | ||
| 405 | sure to use the right file (i.e. i585 or x86-64). | ||
| 406 | </para> | ||
| 407 | <para> | ||
| 408 | After you have sourced the setup script, | ||
| 409 | the tools are added to <filename>PATH</filename> | ||
| 410 | and any other environment variables required to run the | ||
| 411 | tools are initialized. | ||
| 412 | The results are working versions versions of Git, tar, | ||
| 413 | Python and <filename>chrpath</filename>. | ||
| 414 | </para></listitem> | ||
| 415 | </orderedlist> | ||
| 416 | </para> | ||
| 417 | </section> | ||
| 418 | |||
| 419 | <section id='building-your-own-buildtools-tarball'> | ||
| 420 | <title>Building Your Own <filename>buildtools</filename> Tarball</title> | ||
| 421 | |||
| 422 | <para> | ||
| 423 | Building and running your own buildtools installer applies | ||
| 424 | only when you have a build host that can already run BitBake. | ||
| 425 | In this case, you use that machine to build the | ||
| 426 | <filename>.sh</filename> file and then | ||
| 427 | take steps to transfer and run it on a | ||
| 428 | machine that does not meet the minimal Git, tar, and Python | ||
| 429 | requirements. | ||
| 430 | </para> | ||
| 431 | |||
| 432 | <para> | ||
| 433 | Here are the steps to take to build and run your own | ||
| 434 | buildtools installer: | ||
| 435 | <orderedlist> | ||
| 436 | <listitem><para> | ||
| 437 | On the machine that is able to run BitBake, | ||
| 438 | be sure you have set up your build environment with | ||
| 439 | the setup script | ||
| 440 | (<link linkend='structure-core-script'><filename>&OE_INIT_FILE;</filename></link> | ||
| 441 | or | ||
| 442 | <link linkend='structure-memres-core-script'><filename>oe-init-build-env-memres</filename></link>). | ||
| 443 | </para></listitem> | ||
| 444 | <listitem><para> | ||
| 445 | Run the BitBake command to build the tarball: | ||
| 446 | <literallayout class='monospaced'> | ||
| 447 | $ bitbake buildtools-tarball | ||
| 448 | </literallayout> | ||
| 449 | <note> | ||
| 450 | The | ||
| 451 | <link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link> | ||
| 452 | variable in your <filename>local.conf</filename> file | ||
| 453 | determines whether you build tools for a 32-bit | ||
| 454 | or 64-bit system. | ||
| 455 | </note> | ||
| 456 | Once the build completes, you can find the | ||
| 457 | <filename>.sh</filename> file that installs | ||
| 458 | the tools in the <filename>tmp/deploy/sdk</filename> | ||
| 459 | subdirectory of the | ||
| 460 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | ||
| 461 | The installer file has the string "buildtools" | ||
| 462 | in the name. | ||
| 463 | </para></listitem> | ||
| 464 | <listitem><para> | ||
| 465 | Transfer the <filename>.sh</filename> file from the | ||
| 466 | build host to the machine that does not meet the | ||
| 467 | Git, tar, or Python requirements. | ||
| 468 | </para></listitem> | ||
| 469 | <listitem><para> | ||
| 470 | On the machine that does not meet the requirements, | ||
| 471 | run the <filename>.sh</filename> file | ||
| 472 | to install the tools. | ||
| 473 | Here is an example: | ||
| 474 | <literallayout class='monospaced'> | ||
| 475 | $ sh poky-eglibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh | ||
| 476 | </literallayout> | ||
| 477 | During execution, a prompt appears that allows you to | ||
| 478 | choose the installation directory. | ||
| 479 | For example, you could choose the following: | ||
| 480 | <literallayout class='monospaced'> | ||
| 481 | /home/your-username/buildtools | ||
| 482 | </literallayout> | ||
| 483 | </para></listitem> | ||
| 484 | <listitem><para> | ||
| 485 | Source the tools environment setup script by using a | ||
| 486 | command like the following: | ||
| 487 | <literallayout class='monospaced'> | ||
| 488 | $ source /home/your-username/buildtools/environment-setup-i586-poky-linux | ||
| 489 | </literallayout> | ||
| 490 | Of course, you need to supply your installation directory and be | ||
| 491 | sure to use the right file (i.e. i585 or x86-64). | ||
| 492 | </para> | ||
| 493 | <para> | ||
| 494 | After you have sourced the setup script, | ||
| 495 | the tools are added to <filename>PATH</filename> | ||
| 496 | and any other environment variables required to run the | ||
| 497 | tools are initialized. | ||
| 498 | The results are working versions versions of Git, tar, | ||
| 499 | Python and <filename>chrpath</filename>. | ||
| 500 | </para></listitem> | ||
| 501 | </orderedlist> | ||
| 502 | </para> | ||
| 503 | </section> | ||
| 504 | </section> | ||
| 505 | </section> | ||
| 506 | |||
| 507 | <section id='intro-getit'> | ||
| 508 | <title>Obtaining the Yocto Project</title> | ||
| 509 | <para> | ||
| 510 | The Yocto Project development team makes the Yocto Project available through a number | ||
| 511 | of methods: | ||
| 512 | <itemizedlist> | ||
| 513 | <listitem><para><emphasis>Source Repositories:</emphasis> | ||
| 514 | Working from a copy of the upstream | ||
| 515 | <filename>poky</filename> repository is the | ||
| 516 | preferred method for obtaining and using a Yocto Project | ||
| 517 | release. | ||
| 518 | You can view the Yocto Project Source Repositories at | ||
| 519 | <ulink url='&YOCTO_GIT_URL;/cgit.cgi'></ulink>. | ||
| 520 | In particular, you can find the | ||
| 521 | <filename>poky</filename> repository at | ||
| 522 | <ulink url='http://git.yoctoproject.org/cgit/cgit.cgi/poky/'></ulink>. | ||
| 523 | </para></listitem> | ||
| 524 | <listitem><para><emphasis>Releases:</emphasis> Stable, tested | ||
| 525 | releases are available as tarballs through | ||
| 526 | <ulink url='&YOCTO_DL_URL;/releases/yocto/'/>.</para></listitem> | ||
| 527 | <listitem><para><emphasis>Nightly Builds:</emphasis> These | ||
| 528 | tarball releases are available at | ||
| 529 | <ulink url='http://autobuilder.yoctoproject.org/nightly'/>. | ||
| 530 | These builds include Yocto Project releases, meta-toolchain | ||
| 531 | tarball installation scripts, and experimental builds. | ||
| 532 | </para></listitem> | ||
| 533 | <listitem><para><emphasis>Yocto Project Website:</emphasis> You can | ||
| 534 | find tarball releases of the Yocto Project and supported BSPs | ||
| 535 | at the | ||
| 536 | <ulink url='&YOCTO_HOME_URL;'>Yocto Project website</ulink>. | ||
| 537 | Along with these downloads, you can find lots of other | ||
| 538 | information at this site. | ||
| 539 | </para></listitem> | ||
| 540 | </itemizedlist> | ||
| 541 | </para> | ||
| 542 | </section> | ||
| 543 | |||
| 544 | <section id='intro-getit-dev'> | ||
| 545 | <title>Development Checkouts</title> | ||
| 546 | <para> | ||
| 547 | Development using the Yocto Project requires a local | ||
| 548 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | ||
| 549 | You can set up the Source Directory by cloning a copy of the upstream | ||
| 550 | <ulink url='&YOCTO_DOCS_DEV_URL;#poky'>poky</ulink> Git repository. | ||
| 551 | For information on how to do this, see the | ||
| 552 | "<ulink url='&YOCTO_DOCS_DEV_URL;#getting-setup'>Getting Set Up</ulink>" | ||
| 553 | section in the Yocto Project Development Manual. | ||
| 554 | </para> | ||
| 555 | </section> | ||
| 556 | |||
| 557 | </chapter> | ||
| 558 | <!-- | ||
| 559 | vim: expandtab tw=80 ts=4 | ||
| 560 | --> | ||
