diff options
-rw-r--r-- | documentation/ref-manual/closer-look.xml | 17 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 32 | ||||
-rw-r--r-- | documentation/yocto-project-qs/yocto-project-qs.xml | 11 |
3 files changed, 46 insertions, 14 deletions
diff --git a/documentation/ref-manual/closer-look.xml b/documentation/ref-manual/closer-look.xml index eccf97698a..c8f2fae94e 100644 --- a/documentation/ref-manual/closer-look.xml +++ b/documentation/ref-manual/closer-look.xml | |||
@@ -491,6 +491,14 @@ | |||
491 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> | 491 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> |
492 | variable. | 492 | variable. |
493 | This area is a cache that can hold previously downloaded source. | 493 | This area is a cache that can hold previously downloaded source. |
494 | You can also instruct the OpenEmbedded build system to create | ||
495 | tarballs from Git repositories, which is not the default behavior, | ||
496 | and store them in the <filename>DL_DIR</filename> by using the | ||
497 | <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> | ||
498 | variable. | ||
499 | </para> | ||
500 | |||
501 | <para> | ||
494 | Judicious use of a <filename>DL_DIR</filename> directory can | 502 | Judicious use of a <filename>DL_DIR</filename> directory can |
495 | save the build system a trip across the Internet when looking | 503 | save the build system a trip across the Internet when looking |
496 | for files. | 504 | for files. |
@@ -566,6 +574,15 @@ | |||
566 | fetcher module. | 574 | fetcher module. |
567 | </para> | 575 | </para> |
568 | 576 | ||
577 | <note> | ||
578 | For information on how to have the OpenEmbedded build system | ||
579 | generate tarballs for Git repositories and place them in the | ||
580 | <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link> | ||
581 | directory, see the | ||
582 | <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> | ||
583 | variable. | ||
584 | </note> | ||
585 | |||
569 | <para> | 586 | <para> |
570 | When fetching a repository, BitBake uses the | 587 | When fetching a repository, BitBake uses the |
571 | <link linkend='var-SRCREV'><filename>SRCREV</filename></link> | 588 | <link linkend='var-SRCREV'><filename>SRCREV</filename></link> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index fe1c100794..5d0d257e23 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -502,6 +502,12 @@ | |||
502 | For performance reasons, creating and placing tarballs of | 502 | For performance reasons, creating and placing tarballs of |
503 | the Git repositories is not the default action by the | 503 | the Git repositories is not the default action by the |
504 | OpenEmbedded build system. | 504 | OpenEmbedded build system. |
505 | <literallayout class='monospaced'> | ||
506 | BB_Generate_MIRROR_TARBALLS = "1" | ||
507 | </literallayout> | ||
508 | Set this variable in your <filename>local.conf</filename> | ||
509 | file in the | ||
510 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | ||
505 | </para> | 511 | </para> |
506 | </glossdef> | 512 | </glossdef> |
507 | </glossentry> | 513 | </glossentry> |
@@ -1272,6 +1278,15 @@ Core layer for images cannot be removed | |||
1272 | <para> | 1278 | <para> |
1273 | The central download directory used by the build process to | 1279 | The central download directory used by the build process to |
1274 | store downloads. | 1280 | store downloads. |
1281 | By default, <filename>DL_DIR</filename> gets files | ||
1282 | suitable for mirroring for everything except Git | ||
1283 | repositories. | ||
1284 | If you want tarballs of Git repositories, use the | ||
1285 | <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> | ||
1286 | variable. | ||
1287 | </para> | ||
1288 | |||
1289 | <para> | ||
1275 | You can set this directory by defining the | 1290 | You can set this directory by defining the |
1276 | <filename>DL_DIR</filename> variable in the | 1291 | <filename>DL_DIR</filename> variable in the |
1277 | <filename>/conf/local.conf</filename> file. | 1292 | <filename>/conf/local.conf</filename> file. |
@@ -1296,20 +1311,9 @@ Core layer for images cannot be removed | |||
1296 | <filename>DL_DIR</filename> and the build system looks there | 1311 | <filename>DL_DIR</filename> and the build system looks there |
1297 | first to find source tarballs. | 1312 | first to find source tarballs. |
1298 | <note> | 1313 | <note> |
1299 | <para> | 1314 | When wiping and rebuilding, you can preserve this |
1300 | When wiping and rebuilding, you can preserve this | 1315 | directory to speed up this part of subsequent |
1301 | directory to speed up this part of subsequent | 1316 | builds. |
1302 | builds. | ||
1303 | </para> | ||
1304 | |||
1305 | <para> | ||
1306 | Also, by default, the <filename>DL_DIR</filename> | ||
1307 | does not contain tarballs of Git directories. | ||
1308 | However, you can instruct the build process to save | ||
1309 | these tarballs to the directory by using the | ||
1310 | <link linkend='var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></link> | ||
1311 | variable. | ||
1312 | </para> | ||
1313 | </note> | 1317 | </note> |
1314 | </para> | 1318 | </para> |
1315 | 1319 | ||
diff --git a/documentation/yocto-project-qs/yocto-project-qs.xml b/documentation/yocto-project-qs/yocto-project-qs.xml index f212437f07..e33e4a6e4c 100644 --- a/documentation/yocto-project-qs/yocto-project-qs.xml +++ b/documentation/yocto-project-qs/yocto-project-qs.xml | |||
@@ -911,6 +911,17 @@ | |||
911 | </para> | 911 | </para> |
912 | 912 | ||
913 | <para> | 913 | <para> |
914 | In the previous example, the | ||
915 | <ulink url='&YOCTO_DOCS_REF_URL;#var-BB_GENERATE_MIRROR_TARBALLS'><filename>BB_GENERATE_MIRROR_TARBALLS</filename></ulink> | ||
916 | variable causes the OpenEmbedded build system to generate tarballs | ||
917 | of the Git repositories and store them in the | ||
918 | <ulink url='&YOCTO_DOCS_REF_URL;#var-DL_DIR'><filename>DL_DIR</filename></ulink> | ||
919 | directory. | ||
920 | Due to performance reasons, generating and storing these tarballs | ||
921 | is not the build system's default behavior. | ||
922 | </para> | ||
923 | |||
924 | <para> | ||
914 | You can also use the | 925 | You can also use the |
915 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PREMIRRORS'><filename>PREMIRRORS</filename></ulink> | 926 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PREMIRRORS'><filename>PREMIRRORS</filename></ulink> |
916 | variable. | 927 | variable. |