summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-classes.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-20 17:52:28 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-03-25 12:29:44 +0000
commit32890f29afd9bd93e22c325cdc24466982fb80a6 (patch)
treee6e5318d5028db92ede8aaeee17e8b49d349a8fd /documentation/ref-manual/ref-classes.xml
parentc441f5f005f306a3dfc203237aab42b4a37336b5 (diff)
downloadpoky-32890f29afd9bd93e22c325cdc24466982fb80a6.tar.gz
adt-manual, ref-manual: Cross-toolchain details added. New class also.
In the adt-manual in the "Optionally Building a Toolchain Installer" setion, I added some basic advantage information for building a toolchain installer using bitbake image -c populate_sdk. In the ref-manual, I added cross-referencing to this basic information in several strategic areas: "SDK Generation", the populate_sdk class reference section, the populate_sdk_* class reference section, and the "Cross-Development Toolchain Generation" sections. Finally, I also put in documentation for a new class called autotools-brokensep. (From yocto-docs rev: cde7dd2fbd7bdc0d71dc678ee7a5422459654287) 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/ref-classes.xml')
-rw-r--r--documentation/ref-manual/ref-classes.xml46
1 files changed, 46 insertions, 0 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index de8448febf..58004cbee1 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -130,6 +130,36 @@
130 </para></listitem> 130 </para></listitem>
131 </itemizedlist> 131 </itemizedlist>
132 </para> 132 </para>
133
134 <note>
135 It is planned for future Yocto Project releases that by default, the
136 <filename>autotools</filename> class supports out-of-tree builds
137 (<link linkend='var-B'><filename>B</filename></link> !=
138 <link linkend='var-S'><filename>S</filename></link>).
139 If your recipes do not support out-of-tree builds, you should
140 have them inherit the
141 <link linkend='ref-classes-autotools-brokensep'><filename>autotools-brokensep</filename></link>
142 class.
143 </note>
144</section>
145
146<section id='ref-classes-autotools-brokensep'>
147 <title><filename>autotools-brokensep.bbclass</filename></title>
148
149 <para>
150 The <filename>autotools-brokensep</filename> class behaves the same
151 as the
152 <link linkend='ref-classes-autotools'><filename>autotools</filename></link>
153 class but builds with
154 <link linkend='var-B'><filename>B</filename></link> ==
155 <link linkend='var-S'><filename>S</filename></link>.
156 This method is useful when out-of-tree build support is either not
157 present or is broken.
158 <note>
159 It is recommended that out-of-tree support be fixed and used
160 if at all possible.
161 </note>
162 </para>
133</section> 163</section>
134 164
135<section id='ref-classes-base'> 165<section id='ref-classes-base'>
@@ -2220,6 +2250,10 @@
2220 <para> 2250 <para>
2221 The <filename>populate_sdk</filename> class provides support for 2251 The <filename>populate_sdk</filename> class provides support for
2222 SDK-only recipes. 2252 SDK-only recipes.
2253 For information on advantages gained when building a cross-development
2254 toolchain using the <filename>do_populate_sdk</filename> task, see the
2255 "<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
2256 section in the Yocto Project Application Developer's Guide.
2223 </para> 2257 </para>
2224</section> 2258</section>
2225 2259
@@ -2284,6 +2318,18 @@
2284 These classes are inherited by and used with the 2318 These classes are inherited by and used with the
2285 <filename>populate_sdk_base</filename> class. 2319 <filename>populate_sdk_base</filename> class.
2286 </para> 2320 </para>
2321
2322 <para>
2323 For more information on the cross-development toolchain
2324 generation, see the
2325 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
2326 section.
2327 For information on advantages gained when building a
2328 cross-development toolchain using the
2329 <filename>do_populate_sdk</filename> task, see the
2330 "<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>"
2331 section in the Yocto Project Application Developer's Guide.
2332 </para>
2287</section> 2333</section>
2288 2334
2289<section id='ref-classes-prexport'> 2335<section id='ref-classes-prexport'>