summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2013-12-06 12:41:17 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2013-12-11 14:19:28 +0000
commit55a505805993a2d37a4a448bacf2d90d3fc03169 (patch)
tree0858b34ef578f524a47c12cbe50be85885e8ebfa /documentation
parentbc6b005b0c2ba001d061acc585589b6e5642f8f8 (diff)
downloadpoky-55a505805993a2d37a4a448bacf2d90d3fc03169.tar.gz
ref-manual: Review edits to the "C" and "D" classes.
Modifications to ccache, chrpath, clutter, cross, cross-canadian, crosssdk, and debian classes. Added a new variable to the glossary for LEAD_SONAME. (From yocto-docs rev: f27b6315f839a731017866106578e664c6c86982) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-classes.xml42
-rw-r--r--documentation/ref-manual/ref-variables.xml17
2 files changed, 50 insertions, 9 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 5e7fad3ea2..a5a906d5ac 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -345,7 +345,9 @@
345 <title><filename>ccache.bbclass</filename></title> 345 <title><filename>ccache.bbclass</filename></title>
346 346
347 <para> 347 <para>
348 The <filename>ccache</filename> class enables this cache for the build. 348 The <filename>ccache</filename> class enables the
349 <ulink url='http://ccache.samba.org/'>C/C++ Compiler Cache</ulink>
350 for the build.
349 This class is used to give a minor performance boost during the build. 351 This class is used to give a minor performance boost during the build.
350 However, using the class can lead to unexpected side-effects. 352 However, using the class can lead to unexpected side-effects.
351 Thus, it is recommended that you do not use this class. 353 Thus, it is recommended that you do not use this class.
@@ -360,7 +362,9 @@
360 <para> 362 <para>
361 The <filename>chrpath</filename> class 363 The <filename>chrpath</filename> class
362 is a wrapper around the "chrpath" utility, which is used during the 364 is a wrapper around the "chrpath" utility, which is used during the
363 build process for <filename>nativesdk</filename> recipes to change 365 build process for <filename>nativesdk</filename>,
366 <filename>cross</filename>, and
367 <filename>cross-canadian</filename> recipes to change
364 <filename>RPATH</filename> records within binaries in order to make 368 <filename>RPATH</filename> records within binaries in order to make
365 them relocatable. 369 them relocatable.
366 </para> 370 </para>
@@ -373,6 +377,12 @@
373 The <filename>clutter</filename> class consolidates the 377 The <filename>clutter</filename> class consolidates the
374 major and minor version naming and other common items used by Clutter 378 major and minor version naming and other common items used by Clutter
375 and related recipes. 379 and related recipes.
380 <note>
381 Unlike some other classes related to specific libraries, recipes
382 building other software that uses Clutter do not need to
383 inherit this class unless they use the same recipe versioning
384 scheme that the Clutter and related recipes do.
385 </note>
376 </para> 386 </para>
377</section> 387</section>
378 388
@@ -454,8 +464,8 @@
454 <title><filename>cross.bbclass</filename></title> 464 <title><filename>cross.bbclass</filename></title>
455 465
456 <para> 466 <para>
457 The <filename>cross</filename>)class provides support for 467 The <filename>cross</filename> class provides support for the recipes
458 cross-compilation tools. 468 that build the cross-compilation tools.
459 </para> 469 </para>
460</section> 470</section>
461 471
@@ -464,7 +474,8 @@
464 474
465 <para> 475 <para>
466 The <filename>cross-canadian</filename> class 476 The <filename>cross-canadian</filename> class
467 provides support for Canadian Cross compilation tools for SDKs. 477 provides support for the recipes that build the Canadian
478 Cross-compilation tools for SDKs.
468 See the 479 See the
469 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" 480 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
470 section for more discussion on these cross-compilation tools. 481 section for more discussion on these cross-compilation tools.
@@ -476,8 +487,8 @@
476 487
477 <para> 488 <para>
478 The <filename>crosssdk</filename> class 489 The <filename>crosssdk</filename> class
479 provides support for cross-compilation tools used for building 490 provides support for the recipes that build the cross-compilation
480 SDKs. 491 tools used for building SDKs.
481 See the 492 See the
482 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" 493 "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>"
483 section for more discussion on these cross-compilation tools. 494 section for more discussion on these cross-compilation tools.
@@ -488,10 +499,20 @@
488 <title><filename>debian.bbclass</filename></title> 499 <title><filename>debian.bbclass</filename></title>
489 500
490 <para> 501 <para>
491 The <filename>debian</filename> class renames packages so that they 502 The <filename>debian</filename> class renames output packages so that
492 follow the Debian naming policy (i.e. <filename>eglibc</filename> 503 they follow the Debian naming policy (i.e. <filename>eglibc</filename>
493 becomes <filename>libc6</filename> and <filename>eglibc-devel</filename> 504 becomes <filename>libc6</filename> and <filename>eglibc-devel</filename>
494 becomes <filename>libc6-dev</filename>.) 505 becomes <filename>libc6-dev</filename>.)
506 Renaming includes the library name and version as part of the package
507 name.
508 </para>
509
510 <para>
511 If a recipe creates packages for multiple libraries
512 (shared object files of <filename>.so</filename> type), use the
513 <link linkend='var-LEAD_SONAME'><filename>LEAD_SONAME</filename></link>
514 variable in the recipe to specify the library on which to apply the
515 naming scheme.
495 </para> 516 </para>
496</section> 517</section>
497 518
@@ -512,6 +533,9 @@
512 and use <filename>addtask</filename> to add the task at the appropriate 533 and use <filename>addtask</filename> to add the task at the appropriate
513 place, which is usually after <filename>do_compile</filename> or 534 place, which is usually after <filename>do_compile</filename> or
514 <filename>do_install</filename>. 535 <filename>do_install</filename>.
536 The class then takes care of staging the files from
537 <filename>DEPLOYDIR</filename> to
538 <filename>DEPLOY_DIR_IMAGE</filename>.
515 </para> 539 </para>
516</section> 540</section>
517 541
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 4a0e4d1047..2f3aafacc6 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -3514,6 +3514,23 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
3514 </glossdef> 3514 </glossdef>
3515 </glossentry> 3515 </glossentry>
3516 3516
3517 <glossentry id='var-LEAD_SONAME'><glossterm>LEAD_SONAME</glossterm>
3518 <glossdef>
3519 <para>
3520 Specifies the lead (or primary) compiled library file
3521 (<filename>.so</filename>) that the
3522 <link linkend='ref-classes-debian'><filename>debian</filename></link>
3523 class applies its naming policy to given a recipe that
3524 packages multiple libraries.
3525 </para>
3526
3527 <para>
3528 This variable works in conjunction with the
3529 <filename>debian</filename> class.
3530 </para>
3531 </glossdef>
3532 </glossentry>
3533
3517 <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm> 3534 <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm>
3518 <glossdef> 3535 <glossdef>
3519 <para>Checksums of the license text in the recipe source code.</para> 3536 <para>Checksums of the license text in the recipe source code.</para>