From: Scott Rifenbark <srifenbark@gmail.com>
Date: Thu, 28 Mar 2019 17:15:25 +0000 (-0700)
Subject: ref-manual: Updated BB_GENERATE_MIRROR_TARBALLS
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=5555841e5ecf4c45b6bc87e2a9534b7309fc7805;p=thirdparty%2Fopenembedded%2Fopenembedded-core-contrib.git

ref-manual: Updated BB_GENERATE_MIRROR_TARBALLS

Updated the description to tell the user they can safely
clean up the DL_DIR after creating tarballs of the source
files from downloaded repos.

(From yocto-docs rev: 6aff69632ea3102b6389ea510e1e3fa5bf1c2123)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 6470c739c28..536bd15eaa0 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -931,20 +931,21 @@
 
         <glossentry id='var-BB_GENERATE_MIRROR_TARBALLS'><glossterm>BB_GENERATE_MIRROR_TARBALLS</glossterm>
             <info>
-                BB_GENERATE_MIRROR_TARBALLS[doc] = "Causes tarballs of the Git repositories to be placed in the DL_DIR directory."
+                BB_GENERATE_MIRROR_TARBALLS[doc] = "Causes tarballs of the source control repositories to be placed in the DL_DIR directory."
             </info>
             <glossdef>
                 <para role="glossdeffirst">
 <!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
-                    Causes tarballs of the Git repositories, including the
-                    Git metadata, to be placed in the
+                    Causes tarballs of the source control repositories
+                    (e.g. Git repositories), including metadata, to be placed
+                    in the
                     <link linkend='var-DL_DIR'><filename>DL_DIR</filename></link>
                     directory.
                 </para>
 
                 <para>
                     For performance reasons, creating and placing tarballs of
-                    the Git repositories is not the default action by the
+                    these repositories is not the default action by the
                     OpenEmbedded build system.
                     <literallayout class='monospaced'>
      BB_GENERATE_MIRROR_TARBALLS = "1"
@@ -953,6 +954,13 @@
                     file in the
                     <link linkend='build-directory'>Build Directory</link>.
                 </para>
+
+                <para>
+                    Once you have the tarballs containing your source files,
+                    you can clean up your <filename>DL_DIR</filename>
+                    directory by deleting any Git or other source control
+                    work directories.
+                </para>
             </glossdef>
         </glossentry>