summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-10-01 09:17:16 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-10-01 22:52:55 +0100
commit1cd0b1ea1ce0291efa5e5288d33da60271d00fa1 (patch)
treeae9c0cf8d5a82f504bb17d21fa6541ac5870b837 /documentation/ref-manual
parenta81bfcb91fe2cd21b7aa1bd1385e6d75428009dc (diff)
downloadast2050-yocto-poky-1cd0b1ea1ce0291efa5e5288d33da60271d00fa1.zip
ast2050-yocto-poky-1cd0b1ea1ce0291efa5e5288d33da60271d00fa1.tar.gz
ref-manual: Updated the BBPATH glossary term
Fixes [YOCTO #5063] Provided a brief note that tells the user how to set BBPATH if they are going to run BitBake from any directory outside of the build directory. (From yocto-docs rev: 89b31f252237113638acea4634a65ea9ff241b5e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/ref-variables.xml22
1 files changed, 20 insertions, 2 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 8133b9d..da04d03 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -724,8 +724,26 @@ Core layer for images cannot be removed
<glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm>
<glossdef>
- <para>Used by BitBake to locate <filename>.bbclass</filename> and configuration files.
- This variable is analogous to the <filename>PATH</filename> variable.</para>
+ <para>
+ Used by BitBake to locate
+ <filename>.bbclass</filename> and configuration files.
+ This variable is analogous to the
+ <filename>PATH</filename> variable.
+ <note>
+ If you run BitBake from a directory outside of the
+ <ulink url='&YOCTO_DOCS_DEV_URL;build-directory'>Build Directory</ulink>,
+ you must be sure to set
+ <filename>BBPATH</filename> to point to the
+ Build Directory.
+ Set the variable as you would any environment variable
+ and then run BitBake:
+ <literallayout class='monospaced'>
+ $ BBPATH = "&lt;build_directory&gt;"
+ $ export BBPATH
+ $ bitbake &lt;target&gt;
+ </literallayout>
+ </note>
+ </para>
</glossdef>
</glossentry>
OpenPOWER on IntegriCloud