From 6084246825ea764c689a5c1a04b7d560c897ba50 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Wed, 18 Sep 2013 13:39:18 -0700 Subject: [PATCH] ref-manual, yocto-project-qs: Explanations for Git tarballs Fixes [YOCTO #5035] By default, the DL_DIR does not get files from Git repositories that are suitable for mirroring. There is a work-around by using the BB_GENERATE_MIRROR_TARBALLS variable, which, when set, causes the build system to generate tarballs for the Git repositories and place them in the DL_DIR. To address this, I added a new variable description for the BB_GENERATE_MIRROR_TARBALLS varible, updated the DL_DIR variable to indicate that "out-of-the-box" the YP puts suitable mirror files into the DL_DIR for everthing except Git repositories. Some other sections were updated where discussion revolved around pulling down source files. The QS had a spot where the BB_GENERATE_MIRROR_TARBALLS variable was actually used in an example. And, the expanded discussion on the BitBake process had a couple spots that deserved a mention. (From yocto-docs rev: 1539ff13222449ba60bfaaaac4fe1e8a795b0039) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/closer-look.xml | 17 ++++++++++ documentation/ref-manual/ref-variables.xml | 32 +++++++++++-------- .../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 @@ DL_DIR variable. This area is a cache that can hold previously downloaded source. + You can also instruct the OpenEmbedded build system to create + tarballs from Git repositories, which is not the default behavior, + and store them in the DL_DIR by using the + BB_GENERATE_MIRROR_TARBALLS + variable. + + + Judicious use of a DL_DIR directory can save the build system a trip across the Internet when looking for files. @@ -566,6 +574,15 @@ fetcher module. + + For information on how to have the OpenEmbedded build system + generate tarballs for Git repositories and place them in the + DL_DIR + directory, see the + BB_GENERATE_MIRROR_TARBALLS + variable. + + When fetching a repository, BitBake uses the SRCREV 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 @@ For performance reasons, creating and placing tarballs of the Git repositories is not the default action by the OpenEmbedded build system. + + BB_Generate_MIRROR_TARBALLS = "1" + + Set this variable in your local.conf + file in the + Build Directory. @@ -1272,6 +1278,15 @@ Core layer for images cannot be removed The central download directory used by the build process to store downloads. + By default, DL_DIR gets files + suitable for mirroring for everything except Git + repositories. + If you want tarballs of Git repositories, use the + BB_GENERATE_MIRROR_TARBALLS + variable. + + + You can set this directory by defining the DL_DIR variable in the /conf/local.conf file. @@ -1296,20 +1311,9 @@ Core layer for images cannot be removed 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. - - - - Also, by default, the DL_DIR - does not contain tarballs of Git directories. - However, you can instruct the build process to save - these tarballs to the directory by using the - BB_GENERATE_MIRROR_TARBALLS - variable. - + When wiping and rebuilding, you can preserve this + directory to speed up this part of subsequent + builds. 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 @@ -910,6 +910,17 @@ + + In the previous example, the + BB_GENERATE_MIRROR_TARBALLS + variable causes the OpenEmbedded build system to generate tarballs + of the Git repositories and store them in the + DL_DIR + directory. + Due to performance reasons, generating and storing these tarballs + is not the build system's default behavior. + + You can also use the PREMIRRORS