summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-08-09 11:08:38 +0300
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-08-13 13:18:55 +0100
commit61ce3fd240620da28ba35f5b1461b77e64ae9903 (patch)
treea08538244611f6b11a7cb74a7b38a06ad30eb4bb /documentation/ref-manual
parent505619965eecdb4ac421d7ee3aad2ddd8dffcdb7 (diff)
downloadpoky-61ce3fd240620da28ba35f5b1461b77e64ae9903.tar.gz
ref-manual: Added BINCONFIG_GLOB variable and updated binconfig.bbclass
New variable. Changed the class section to have a reference-like section title. Added a link back to the GLOB variable. (From yocto-docs rev: 42dbafc1b64d8572930501f25a0470038721524f) 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-classes.xml16
-rw-r--r--documentation/ref-manual/ref-variables.xml23
2 files changed, 35 insertions, 4 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index af07b144d6..d230ddd935 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -157,12 +157,17 @@
157</section> 157</section>
158 158
159<section id='ref-classes-binconfig'> 159<section id='ref-classes-binconfig'>
160 <title>Binary Configuration Scripts - <filename>binconfig.bbclass</filename></title> 160 <title><filename>binconfig.bbclass</filename></title>
161 161
162 <para> 162 <para>
163 Before <filename>pkg-config</filename> had become widespread, libraries shipped shell 163 This class helps to correct paths in shell scripts.
164 scripts to give information about the libraries and include paths needed 164 </para>
165 to build software (usually named <filename>LIBNAME-config</filename>). 165
166 <para>
167 Before <filename>pkg-config</filename> had become widespread, libraries
168 shipped shell scripts to give information about the libraries and
169 include paths needed to build software (usually named
170 <filename>LIBNAME-config</filename>).
166 This class assists any recipe using such scripts. 171 This class assists any recipe using such scripts.
167 </para> 172 </para>
168 173
@@ -173,6 +178,9 @@
173 changed to point into the <filename>sysroots/</filename> directory so 178 changed to point into the <filename>sysroots/</filename> directory so
174 that all builds that use the script use the correct directories 179 that all builds that use the script use the correct directories
175 for the cross compiling layout. 180 for the cross compiling layout.
181 See the
182 <link linkend='var-BINCONFIG_GLOB'><filename>BINCONFIG_GLOB</filename></link>
183 variable for more information.
176 </para> 184 </para>
177</section> 185</section>
178 186
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index ded45262c8..a357377032 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -672,6 +672,29 @@ Core layer for images cannot be removed
672 </glossdef> 672 </glossdef>
673 </glossentry> 673 </glossentry>
674 674
675 <glossentry id='var-BINCONFIG_GLOB'><glossterm>BINCONFIG_GLOB</glossterm>
676 <glossdef>
677 <para>
678 When inheriting <filename>binconfig.bbclass</filename>
679 from a recipe, this variable specifies a wildcard for
680 configuration scripts that need editing.
681 The scripts are edited to correct any paths that have been
682 set up during compilation so that they are correct for
683 use when installed into the sysroot and called by the
684 build processes of other recipes.
685 </para>
686
687 <para>
688 For more information on how this variable works, see
689 <filename>meta/classes/binconfig.bbclass</filename> in the
690 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
691 You can also find general information on the class in the
692 "<link linkend='ref-classes-binconfig'><filename>binconfig.bbclass</filename></link>"
693 section.
694 </para>
695 </glossdef>
696 </glossentry>
697
675 <glossentry id='var-BP'><glossterm>BP</glossterm> 698 <glossentry id='var-BP'><glossterm>BP</glossterm>
676 <glossdef> 699 <glossdef>
677 <para>The base recipe name and version but without any special 700 <para>The base recipe name and version but without any special