summaryrefslogtreecommitdiffstats
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
parentd22a3907f19562803a25cdfc47634ca311182f19 (diff)
downloadpoky-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>
-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 792568cd25..2d4282e1ce 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -3776,9 +3776,9 @@
3776 3776
3777 <para> 3777 <para>
3778 To build from software that comes from an external source, all you 3778 To build from software that comes from an external source, all you
3779 need to do is change your recipe so that it inherits 3779 need to do is inherit
3780 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink> 3780 <ulink url='&YOCTO_DOCS_REF_URL;#ref-classes-externalsrc'><filename>externalsrc.bbclass</filename></ulink>
3781 and then sets the 3781 and then set the
3782 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTERNALSRC'><filename>EXTERNALSRC</filename></ulink> 3782 <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTERNALSRC'><filename>EXTERNALSRC</filename></ulink>
3783 variable to point to your external source code. 3783 variable to point to your external source code.
3784 Here are the statements to put in your 3784 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 e95a08e5b1..240201068d 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -94,19 +94,22 @@
94 <glossentry id='var-B'><glossterm>B</glossterm> 94 <glossentry id='var-B'><glossterm>B</glossterm>
95 <glossdef> 95 <glossdef>
96 <para> 96 <para>
97 The <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. 97 The directory within the
98 The OpenEmbedded build system places generated objects into the Build Directory 98 <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>
99 during a recipe's build process. 99 in which the OpenEmbedded build system places generated
100 objects during a recipe's build process.
100 By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link> 101 By default, this directory is the same as the <link linkend='var-S'><filename>S</filename></link>
101 directory: 102 directory:
102 <literallayout class='monospaced'> 103 <literallayout class='monospaced'>
103 B = "${WORKDIR}/${BPN}/{PV}/" 104 B = "${WORKDIR}/${BPN}/{PV}/"
104 </literallayout> 105 </literallayout>
105 You can separate the (<filename>S</filename>) directory and the directory pointed to 106 You can separate the (<filename>S</filename>) directory
106 by the <filename>B</filename> variable. 107 and the directory pointed to by the <filename>B</filename>
107 Most Autotools-based recipes support separating these directories. 108 variable.
108 The build system defaults to using separate directories for <filename>gcc</filename> 109 Most Autotools-based recipes support separating these
109 and some kernel recipes. 110 directories.
111 The build system defaults to using separate directories for
112 <filename>gcc</filename> and some kernel recipes.
110 </para> 113 </para>
111 </glossdef> 114 </glossdef>
112 </glossentry> 115 </glossentry>
@@ -1082,9 +1085,8 @@ Core layer for images cannot be removed
1082 <glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm> 1085 <glossentry id='var-EXTERNALSRC'><glossterm>EXTERNALSRC</glossterm>
1083 <glossdef> 1086 <glossdef>
1084 <para> 1087 <para>
1085 When a recipe inherits 1088 If <filename>externalsrc.bbclass</filename> is inherited,
1086 <filename>externalsrc.bbclass</filename>, this 1089 this variable points to the source tree, which is
1087 variable points to the source tree, which is
1088 outside of the OpenEmbedded build system. 1090 outside of the OpenEmbedded build system.
1089 When set, this variable sets the 1091 When set, this variable sets the
1090 <link linkend='var-S'><filename>S</filename></link> 1092 <link linkend='var-S'><filename>S</filename></link>
@@ -1108,9 +1110,8 @@ Core layer for images cannot be removed
1108 <glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm> 1110 <glossentry id='var-EXTERNALSRC_BUILD'><glossterm>EXTERNALSRC_BUILD</glossterm>
1109 <glossdef> 1111 <glossdef>
1110 <para> 1112 <para>
1111 When a recipe inherits 1113 If <filename>externalsrc.bbclass</filename> is inherited,
1112 <filename>externalsrc.bbclass</filename>, this 1114 this variable points to the directory in which the recipe's
1113 variable points to the directory in which the recipe's
1114 source code is built, 1115 source code is built,
1115 which is outside of the OpenEmbedded build system. 1116 which is outside of the OpenEmbedded build system.
1116 When set, this variable sets the 1117 When set, this variable sets the