summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-01-31 14:21:35 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-03-08 12:07:46 -0800
commit62907f76bcd0cb8b255dedb8182be7ada2779c24 (patch)
treefa53034eb08c70b296a8b314d3347ad5ba58d652 /documentation/poky-ref-manual
parentddaf79d4d435c22e6dad14f9d61e561ccacab86e (diff)
downloadpoky-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>
Diffstat (limited to 'documentation/poky-ref-manual')
-rw-r--r--documentation/poky-ref-manual/faq.xml2
-rw-r--r--documentation/poky-ref-manual/ref-variables.xml37
2 files changed, 37 insertions, 2 deletions
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>