diff options
| author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2012-01-31 14:21:35 -0600 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2012-03-08 12:07:46 -0800 |
| commit | 62907f76bcd0cb8b255dedb8182be7ada2779c24 (patch) | |
| tree | fa53034eb08c70b296a8b314d3347ad5ba58d652 | |
| parent | ddaf79d4d435c22e6dad14f9d61e561ccacab86e (diff) | |
| download | poky-62907f76bcd0cb8b255dedb8182be7ada2779c24.tar.gz | |
documentation: More information about DL_DIR added.
The information surrounding the central download directory was
pretty scant. Jim Abernathy pointed this out in an email sent to
me. As a start, I have added quite a bit more information to
the glossary description for DL_DIR. Part of that added information
is a pointer to the FAQ entry that describes exactly how the
build system gets source files. Then, in the YP Development Manual
in the section that introduces the build process, I added several
references to various variables that are set in the local.conf
file prior to kicking off the build.
Reported-by: Jim Abernathy <jim.abernathy@intel.com>
(From yocto-docs rev: 4d7835a3bff5bd054301fa9ab6954c11c88dad58)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
| -rw-r--r-- | documentation/dev-manual/dev-manual-start.xml | 13 | ||||
| -rw-r--r-- | documentation/poky-ref-manual/faq.xml | 2 | ||||
| -rw-r--r-- | documentation/poky-ref-manual/ref-variables.xml | 37 |
3 files changed, 47 insertions, 5 deletions
diff --git a/documentation/dev-manual/dev-manual-start.xml b/documentation/dev-manual/dev-manual-start.xml index 0ed69cf501..6d68a088d0 100644 --- a/documentation/dev-manual/dev-manual-start.xml +++ b/documentation/dev-manual/dev-manual-start.xml | |||
| @@ -240,9 +240,16 @@ | |||
| 240 | previous section.</para></listitem> | 240 | previous section.</para></listitem> |
| 241 | <listitem><para>Initialize the build environment by sourcing a build environment | 241 | <listitem><para>Initialize the build environment by sourcing a build environment |
| 242 | script.</para></listitem> | 242 | script.</para></listitem> |
| 243 | <listitem><para>Optionally ensure the <filename>conf/local.conf</filename> configuration file is set | 243 | <listitem><para>Optionally ensure the <filename>/conf/local.conf</filename> configuration file, |
| 244 | up how you want it. | 244 | which is found in the Yocto Project build directory, is set up how you want it. |
| 245 | This file defines the target machine architecture and other build options.</para></listitem> | 245 | This file defines many aspects of the build environment including |
| 246 | the target machine architecture through the | ||
| 247 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-MACHINE'>MACHINE</ulink></filename> variable, | ||
| 248 | the development machine's processor use through the | ||
| 249 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-BB_NUMBER_THREADS'>BB_NUMBER_THREADS</ulink></filename> and | ||
| 250 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-PARALLEL_MAKE'>PARALLEL_MAKE</ulink></filename> variables, and | ||
| 251 | a centralized tarball download directory through the | ||
| 252 | <filename><ulink url='http://www.yoctoproject.org/docs/latest/poky-ref-manual/poky-ref-manual.html#var-DL_DIR'>DL_DIR</ulink></filename> variable.</para></listitem> | ||
| 246 | <listitem><para>Build the image using the <command>bitbake</command> command. | 253 | <listitem><para>Build the image using the <command>bitbake</command> command. |
| 247 | If you want information on BitBake, see the user manual at | 254 | If you want information on BitBake, see the user manual at |
| 248 | <ulink url='http://docs.openembedded.org/bitbake/html'></ulink>.</para></listitem> | 255 | <ulink url='http://docs.openembedded.org/bitbake/html'></ulink>.</para></listitem> |
diff --git a/documentation/poky-ref-manual/faq.xml b/documentation/poky-ref-manual/faq.xml index 669b2d5aa5..1f4448d463 100644 --- a/documentation/poky-ref-manual/faq.xml +++ b/documentation/poky-ref-manual/faq.xml | |||
| @@ -493,7 +493,7 @@ | |||
| 493 | 493 | ||
| 494 | <qandaentry> | 494 | <qandaentry> |
| 495 | <question> | 495 | <question> |
| 496 | <para> | 496 | <para id='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'> |
| 497 | How does the Yocto Project obtain source code and will it work behind my | 497 | How does the Yocto Project obtain source code and will it work behind my |
| 498 | firewall or proxy server? | 498 | firewall or proxy server? |
| 499 | </para> | 499 | </para> |
diff --git a/documentation/poky-ref-manual/ref-variables.xml b/documentation/poky-ref-manual/ref-variables.xml index 711a8a97ca..60bf034d19 100644 --- a/documentation/poky-ref-manual/ref-variables.xml +++ b/documentation/poky-ref-manual/ref-variables.xml | |||
| @@ -344,7 +344,42 @@ | |||
| 344 | 344 | ||
| 345 | <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> | 345 | <glossentry id='var-DL_DIR'><glossterm>DL_DIR</glossterm> |
| 346 | <glossdef> | 346 | <glossdef> |
| 347 | <para>The directory where all fetched sources will be stored.</para> | 347 | <para> |
| 348 | The central download directory used by the build process to store downloads. | ||
| 349 | You can set this directory by defining the <filename>DL_DIR</filename> | ||
| 350 | variable in the <filename>/conf/local.conf</filename> file. | ||
| 351 | This directory is self-maintaining and you should not have | ||
| 352 | to touch it. | ||
| 353 | By default, the directory is <filename>downloads</filename> in the | ||
| 354 | Yocto Project build directory. | ||
| 355 | <literallayout class='monospaced'> | ||
| 356 | #DL_DIR ?= "${TOPDIR}/downloads" | ||
| 357 | </literallayout> | ||
| 358 | To specify a different download directory, simply uncomment the line | ||
| 359 | and provide your directory. | ||
| 360 | </para> | ||
| 361 | |||
| 362 | <para> | ||
| 363 | During a first build, the system downloads many different source code | ||
| 364 | tarballs from various upstream projects. | ||
| 365 | Downloading can take a while, particularly if your network | ||
| 366 | connection is slow. | ||
| 367 | Tarballs are all stored in the directory defined by | ||
| 368 | <filename>DL_DIR</filename> and the build system looks there first | ||
| 369 | to find source tarballs. | ||
| 370 | <note> | ||
| 371 | When wiping and rebuilding, you can preserve this directory to speed | ||
| 372 | up this part of subsequent builds. | ||
| 373 | </note> | ||
| 374 | </para> | ||
| 375 | |||
| 376 | <para> | ||
| 377 | You can safely share this directory between multiple builds on the | ||
| 378 | same development machine. | ||
| 379 | For additional information on how the build process gets source files, see | ||
| 380 | <link linkend='how-does-the-yocto-project-obtain-source-code-and-will-it-work-behind-my-firewall-or-proxy-server'>this entry</link> in | ||
| 381 | The FAQ appendix of this manual. | ||
| 382 | </para> | ||
| 348 | </glossdef> | 383 | </glossdef> |
| 349 | 384 | ||
| 350 | </glossentry> | 385 | </glossentry> |
