summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-08-07 17:48:00 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-08-13 13:18:54 +0100
commit4888d1e6a1507430bbb46a38422c833d4a24f579 (patch)
tree76ed7d30b86b71a5ecc1bbd33f2baa07c137ed68 /documentation
parentd22a3907f19562803a25cdfc47634ca311182f19 (diff)
downloadast2050-yocto-poky-4888d1e6a1507430bbb46a38422c833d4a24f579.zip
ast2050-yocto-poky-4888d1e6a1507430bbb46a38422c833d4a24f579.tar.gz
ref-manual, dev-manual: Review edits for Build Directory wording.
Did some word-smithing to work around a false statement that implied externalsrc.bbclass needed to be inherited on a recipe-by-recipe basis. This affected the usage section and the glossary definitions for both EXTERNALSRC and EXTERNALSRC_BUILD. Also updated the "B" variable description to be more accurate in the use of the term "Build Directory." (From yocto-docs rev: 46695817b6e44cfa88161699105b8d03a5828fd2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml4
-rw-r--r--documentation/ref-manual/ref-variables.xml29
2 files changed, 17 insertions, 16 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index 792568c..2d4282e 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -3776,9 +3776,9 @@
<para>
To build from software that comes from an external source, all you
- need to do is change your recipe so that it inherits
+ need to do is inherit
<ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink>
- and then sets the
+ and then set the
<ulink url='&YOCTO_DOCS_REF_URL;#var-EXTERNALSRC'><filename>EXTERNALSRC</filename></ulink>
variable to point to your external source code.
Here are the statements to put in your
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index e95a08e..2402010 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -94,19 +94,22 @@
<glossentry id='var-B'><glossterm>B</glossterm>
<glossdef>
<para>
- The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>.
- The OpenEmbedded build system places generated objects into the Build Directory
- during a recipe's build process.
+ The directory within the
+ <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
+ in which the OpenEmbedded build system places generated
+ objects during a recipe's build process.
By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
directory:
<literallayout class='monospaced'>
B = "${WORKDIR}/${BPN}/{PV}/"
</literallayout>
- You can separate the (<filename>S</filename>) directory and the directory pointed to
- by the <filename>B</filename> variable.
- Most Autotools-based recipes support separating these directories.
- The build system defaults to using separate directories for <filename>gcc</filename>
- and some kernel recipes.
+ You can separate the (<filename>S</filename>) directory
+ and the directory pointed to by the <filename>B</filename>
+ variable.
+ Most Autotools-based recipes support separating these
+ directories.
+ The build system defaults to using separate directories for
+ <filename>gcc</filename> and some kernel recipes.
</para>
</glossdef>
</glossentry>
@@ -1082,9 +1085,8 @@ Core layer for images cannot be removed
<glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm>
<glossdef>
<para>
- When a recipe inherits
- <filename>externalsrc.bbclass</filename>, this
- variable points to the source tree, which is
+ If <filename>externalsrc.bbclass</filename> is inherited,
+ this variable points to the source tree, which is
outside of the OpenEmbedded build system.
When set, this variable sets the
<link linkend='var-S'><filename>S</filename></link>
@@ -1108,9 +1110,8 @@ Core layer for images cannot be removed
<glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm>
<glossdef>
<para>
- When a recipe inherits
- <filename>externalsrc.bbclass</filename>, this
- variable points to the directory in which the recipe's
+ If <filename>externalsrc.bbclass</filename> is inherited,
+ this variable points to the directory in which the recipe's
source code is built,
which is outside of the OpenEmbedded build system.
When set, this variable sets the
OpenPOWER on IntegriCloud