From 62907f76bcd0cb8b255dedb8182be7ada2779c24 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 31 Jan 2012 14:21:35 -0600 Subject: 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 (From yocto-docs rev: 4d7835a3bff5bd054301fa9ab6954c11c88dad58) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/dev-manual/dev-manual-start.xml | 13 +++++++-- documentation/poky-ref-manual/faq.xml | 2 +- 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 @@ previous section. Initialize the build environment by sourcing a build environment script. - Optionally ensure the conf/local.conf configuration file is set - up how you want it. - This file defines the target machine architecture and other build options. + Optionally ensure the /conf/local.conf configuration file, + which is found in the Yocto Project build directory, is set up how you want it. + This file defines many aspects of the build environment including + the target machine architecture through the + MACHINE variable, + the development machine's processor use through the + BB_NUMBER_THREADS and + PARALLEL_MAKE variables, and + a centralized tarball download directory through the + DL_DIR variable. Build the image using the bitbake command. If you want information on BitBake, see the user manual at . 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 @@ - + How does the Yocto Project obtain source code and will it work behind my firewall or proxy server? 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 @@ DL_DIR - The directory where all fetched sources will be stored. + + The central download directory used by the build process to store downloads. + You can set this directory by defining the DL_DIR + variable in the /conf/local.conf file. + This directory is self-maintaining and you should not have + to touch it. + By default, the directory is downloads in the + Yocto Project build directory. + + #DL_DIR ?= "${TOPDIR}/downloads" + + To specify a different download directory, simply uncomment the line + and provide your directory. + + + + During a first build, the system downloads many different source code + tarballs from various upstream projects. + Downloading can take a while, particularly if your network + connection is slow. + Tarballs are all stored in the directory defined by + DL_DIR and the build system looks there first + to find source tarballs. + + When wiping and rebuilding, you can preserve this directory to speed + up this part of subsequent builds. + + + + + You can safely share this directory between multiple builds on the + same development machine. + For additional information on how the build process gets source files, see + this entry in + The FAQ appendix of this manual. + -- cgit v1.2.3-54-g00ecf