sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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>
This commit is contained in:
Scott Rifenbark 2013-08-07 17:48:00 +03:00 committed by Richard Purdie
parent d22a3907f1
commit 4888d1e6a1
2 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
documentation/dev-manual/dev-manual-common-tasks.xml
View File

@ -3776,9 +3776,9 @@
<para> <para>
To build from software that comes from an external source, all you 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> <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> <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTERNALSRC'><filename>EXTERNALSRC</filename></ulink>
variable to point to your external source code. variable to point to your external source code.
Here are the statements to put in your Here are the statements to put in your

29
documentation/ref-manual/ref-variables.xml
View File

@ -94,19 +94,22 @@
<glossentry id='var-B'><glossterm>B</glossterm> <glossentry id='var-B'><glossterm>B</glossterm>
<glossdef> <glossdef>
<para> <para>
The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. The directory within the
The OpenEmbedded build system places generated objects into the Build Directory <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
during a recipe's build process. 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> By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
directory: directory:
<literallayout class='monospaced'> <literallayout class='monospaced'>
B = "${WORKDIR}/${BPN}/{PV}/" B = "${WORKDIR}/${BPN}/{PV}/"
</literallayout> </literallayout>
You can separate the (<filename>S</filename>) directory and the directory pointed to You can separate the (<filename>S</filename>) directory
by the <filename>B</filename> variable. and the directory pointed to by the <filename>B</filename>
Most Autotools-based recipes support separating these directories. variable.
The build system defaults to using separate directories for <filename>gcc</filename> Most Autotools-based recipes support separating these
and some kernel recipes. directories.
The build system defaults to using separate directories for
<filename>gcc</filename> and some kernel recipes.
</para> </para>
</glossdef> </glossdef>
</glossentry> </glossentry>
@ -1082,9 +1085,8 @@ Core layer for images cannot be removed
<glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm> <glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm>
<glossdef> <glossdef>
<para> <para>
When a recipe inherits If <filename>externalsrc.bbclass</filename> is inherited,
<filename>externalsrc.bbclass</filename>, this this variable points to the source tree, which is
variable points to the source tree, which is
outside of the OpenEmbedded build system. outside of the OpenEmbedded build system.
When set, this variable sets the When set, this variable sets the
<link linkend='var-S'><filename>S</filename></link> <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> <glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm>
<glossdef> <glossdef>
<para> <para>
When a recipe inherits If <filename>externalsrc.bbclass</filename> is inherited,
<filename>externalsrc.bbclass</filename>, this this variable points to the directory in which the recipe's
variable points to the directory in which the recipe's
source code is built, source code is built,
which is outside of the OpenEmbedded build system. which is outside of the OpenEmbedded build system.
When set, this variable sets the When set, this variable sets the