summaryrefslogtreecommitdiffstats
path: root/documentation/poky-ref-manual/ref-classes.xml
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-07-02 14:34:39 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-07-03 14:55:03 +0100
commit5966b44893a39847d3d590566dd488323a11ff73 (patch)
tree4cc4c8a6fd8403ea0d9708eb9c449d1e0b8eded2 /documentation/poky-ref-manual/ref-classes.xml
parent7064538309121c23323d442db6c9f0b11c8d6431 (diff)
downloadpoky-5966b44893a39847d3d590566dd488323a11ff73.tar.gz
documentation/poky-ref-manual: Yocto Project scrub
I have changed as many "Yocto Project" terms as possible so that better reflect reality. (From yocto-docs rev: 5f729e53b0cb653c97621e4e6598d9295d60ada5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/poky-ref-manual/ref-classes.xml')
-rw-r--r--documentation/poky-ref-manual/ref-classes.xml33
1 files changed, 18 insertions, 15 deletions
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml
index 35c713434c..67f2454145 100644
--- a/documentation/poky-ref-manual/ref-classes.xml
+++ b/documentation/poky-ref-manual/ref-classes.xml
@@ -12,10 +12,11 @@
12 file. 12 file.
13 Class files are identified by the extension <filename>.bbclass</filename> and are usually placed 13 Class files are identified by the extension <filename>.bbclass</filename> and are usually placed
14 in a <filename>classes/</filename> directory beneath the 14 in a <filename>classes/</filename> directory beneath the
15 <filename>meta*/</filename> directory found in the Yocto Project file's area 15 <filename>meta*/</filename> directory found in the
16 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
16 Class files can also be pointed to by BUILDDIR (e.g. <filename>build/</filename>)in the same way as 17 Class files can also be pointed to by BUILDDIR (e.g. <filename>build/</filename>)in the same way as
17 <filename>.conf</filename> files in the <filename>conf</filename> directory. 18 <filename>.conf</filename> files in the <filename>conf</filename> directory.
18 Class files are searched for in <filename>BBPATH</filename> 19 Class files are searched for in <link linkend='var-BBPATH'><filename>BBPATH</filename></link>
19 using the same method by which <filename>.conf</filename> files are searched. 20 using the same method by which <filename>.conf</filename> files are searched.
20</para> 21</para>
21 22
@@ -111,7 +112,7 @@
111 </para> 112 </para>
112 113
113 <para> 114 <para>
114 Currently, the Yocto Project supports only one binary per package. 115 Currently, the OpenEmbedded build system supports only one binary per package.
115 </para> 116 </para>
116</section> 117</section>
117 118
@@ -121,7 +122,7 @@
121 <para> 122 <para>
122 This class uses <filename>update-rc.d</filename> to safely install an 123 This class uses <filename>update-rc.d</filename> to safely install an
123 initialization script on behalf of the package. 124 initialization script on behalf of the package.
124 The Yocto Project takes care of details such as making sure the script is stopped before 125 The OpenEmbedded build system takes care of details such as making sure the script is stopped before
125 a package is removed and started when the package is installed. 126 a package is removed and started when the package is installed.
126 Three variables control this class: 127 Three variables control this class:
127 <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>, 128 <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>,
@@ -254,7 +255,7 @@
254 255
255 <para> 256 <para>
256 This class adds the <filename>devshell</filename> task. 257 This class adds the <filename>devshell</filename> task.
257 Distribution policy dictates whether to include this class as the Yocto Project does. 258 Distribution policy dictates whether to include this class.
258 See the 259 See the
259 "<link linkend='platdev-appdev-devshell'>Development Within a Development Shell</link>" section 260 "<link linkend='platdev-appdev-devshell'>Development Within a Development Shell</link>" section
260 for more information about using devshell. 261 for more information about using devshell.
@@ -277,8 +278,9 @@
277 <para> 278 <para>
278 You can control the list of resulting package formats by using the 279 You can control the list of resulting package formats by using the
279 <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> 280 <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename>
280 variable defined in the <filename>local.conf</filename> configuration file 281 variable defined in the <filename>local.conf</filename> configuration file,
281 found in the Yocto Project file's <filename>conf</filename> directory. 282 which is located in the <filename>conf</filename> folder of the
283 <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
282 When defining the variable, you can specify one or more package types. 284 When defining the variable, you can specify one or more package types.
283 Since images are generated from packages, a packaging class is 285 Since images are generated from packages, a packaging class is
284 needed to enable image generation. 286 needed to enable image generation.
@@ -380,7 +382,7 @@
380 The class also performs basic user configuration checks from 382 The class also performs basic user configuration checks from
381 the <filename>local.conf</filename> configuration file to 383 the <filename>local.conf</filename> configuration file to
382 prevent common mistakes that cause build failures. 384 prevent common mistakes that cause build failures.
383 Distribution policy usually whether to include this class as the Yocto Project does. 385 Distribution policy usually determines whether to include this class.
384 </para> 386 </para>
385</section> 387</section>
386 388
@@ -389,10 +391,10 @@
389 391
390 <para> 392 <para>
391 This class adds a step to the package generation process that sanity checks the 393 This class adds a step to the package generation process that sanity checks the
392 packages generated by the Yocto Project. 394 packages generated by the OpenEmbedded build system.
393 A range of checks are performed that check the build's output 395 A range of checks are performed that check the build's output
394 for common problems that show up during runtime. 396 for common problems that show up during runtime.
395 Distribution policy usually dictates whether to include this class as the Yocto Project does. 397 Distribution policy usually dictates whether to include this class.
396 </para> 398 </para>
397 399
398 <para> 400 <para>
@@ -514,7 +516,8 @@
514 you can use this class to specify those packages and associate the users and groups 516 you can use this class to specify those packages and associate the users and groups
515 with those packages. 517 with those packages.
516 The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename> 518 The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename>
517 recipe in the Yocto Project Files provides a simple exmample that shows how to add three 519 recipe in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>
520 provides a simple exmample that shows how to add three
518 users and groups to two packages. 521 users and groups to two packages.
519 See the <filename>useradd-example.bb</filename> for more information on how to 522 See the <filename>useradd-example.bb</filename> for more information on how to
520 use this class. 523 use this class.
@@ -526,7 +529,7 @@
526 529
527 <para> 530 <para>
528 You can use this class to build software from source code that is external to the 531 You can use this class to build software from source code that is external to the
529 Yocto Project build system. 532 OpenEmbedded build system.
530 In other words, your source code resides in an external tree outside of the Yocto Project. 533 In other words, your source code resides in an external tree outside of the Yocto Project.
531 Building software from an external source tree means that the normal fetch, unpack, and 534 Building software from an external source tree means that the normal fetch, unpack, and
532 patch process is not used. 535 patch process is not used.
@@ -541,7 +544,7 @@
541 <para> 544 <para>
542 This class expects the source code to support recipe builds that use the 545 This class expects the source code to support recipe builds that use the
543 <link linkend='var-B'><filename>B</filename></link> variable to point to the directory in 546 <link linkend='var-B'><filename>B</filename></link> variable to point to the directory in
544 which the Yocto Project build system places the generated objects built from the recipes. 547 which the OpenEmbedded build system places the generated objects built from the recipes.
545 By default, the <filename>B</filename> directory is set to the following, which is separate from the 548 By default, the <filename>B</filename> directory is set to the following, which is separate from the
546 source directory (<filename>S</filename>): 549 source directory (<filename>S</filename>):
547 <literallayout class='monospaced'> 550 <literallayout class='monospaced'>
@@ -570,7 +573,7 @@
570 When you do, the <link linkend='var-B'><filename>B</filename></link> variable must support the 573 When you do, the <link linkend='var-B'><filename>B</filename></link> variable must support the
571 recipe's ability to build variants in different working directories. 574 recipe's ability to build variants in different working directories.
572 Most autotools-based recipes support separating these directories. 575 Most autotools-based recipes support separating these directories.
573 The Yocto Project defaults to using separate directories for <filename>gcc</filename> 576 The OpenEmbedded build system defaults to using separate directories for <filename>gcc</filename>
574 and some kernel recipes. 577 and some kernel recipes.
575 Alternatively, you can make sure that separate recipes exist that each 578 Alternatively, you can make sure that separate recipes exist that each
576 use the <filename>BBCLASSEXTEND</filename> variable to build each variant. 579 use the <filename>BBCLASSEXTEND</filename> variable to build each variant.
@@ -591,7 +594,7 @@
591 Thus far, this appendix has discussed only the most useful and important 594 Thus far, this appendix has discussed only the most useful and important
592 classes. 595 classes.
593 However, other classes exist within the <filename>meta/classes</filename> directory 596 However, other classes exist within the <filename>meta/classes</filename> directory
594 in the Yocto Project file's directory structure. 597 in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>.
595 You can examine the <filename>.bbclass</filename> files directly for more 598 You can examine the <filename>.bbclass</filename> files directly for more
596 information. 599 information.
597 </para> 600 </para>