diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2013-12-06 12:41:17 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2013-12-11 14:19:28 +0000 |
commit | 55a505805993a2d37a4a448bacf2d90d3fc03169 (patch) | |
tree | 0858b34ef578f524a47c12cbe50be85885e8ebfa /documentation | |
parent | bc6b005b0c2ba001d061acc585589b6e5642f8f8 (diff) | |
download | ast2050-yocto-poky-55a505805993a2d37a4a448bacf2d90d3fc03169.zip ast2050-yocto-poky-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.xml | 42 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 17 |
2 files changed, 50 insertions, 9 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 5e7fad3..a5a906d 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -345,7 +345,9 @@ <title><filename>ccache.bbclass</filename></title> <para> - The <filename>ccache</filename> class enables this cache for the build. + The <filename>ccache</filename> class enables the + <ulink url='http://ccache.samba.org/'>C/C++ Compiler Cache</ulink> + for the build. This class is used to give a minor performance boost during the build. However, using the class can lead to unexpected side-effects. Thus, it is recommended that you do not use this class. @@ -360,7 +362,9 @@ <para> The <filename>chrpath</filename> class is a wrapper around the "chrpath" utility, which is used during the - build process for <filename>nativesdk</filename> recipes to change + build process for <filename>nativesdk</filename>, + <filename>cross</filename>, and + <filename>cross-canadian</filename> recipes to change <filename>RPATH</filename> records within binaries in order to make them relocatable. </para> @@ -373,6 +377,12 @@ The <filename>clutter</filename> class consolidates the major and minor version naming and other common items used by Clutter and related recipes. + <note> + Unlike some other classes related to specific libraries, recipes + building other software that uses Clutter do not need to + inherit this class unless they use the same recipe versioning + scheme that the Clutter and related recipes do. + </note> </para> </section> @@ -454,8 +464,8 @@ <title><filename>cross.bbclass</filename></title> <para> - The <filename>cross</filename>)class provides support for - cross-compilation tools. + The <filename>cross</filename> class provides support for the recipes + that build the cross-compilation tools. </para> </section> @@ -464,7 +474,8 @@ <para> The <filename>cross-canadian</filename> class - provides support for Canadian Cross compilation tools for SDKs. + provides support for the recipes that build the Canadian + Cross-compilation tools for SDKs. See the "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" section for more discussion on these cross-compilation tools. @@ -476,8 +487,8 @@ <para> The <filename>crosssdk</filename> class - provides support for cross-compilation tools used for building - SDKs. + provides support for the recipes that build the cross-compilation + tools used for building SDKs. See the "<link linkend='cross-development-toolchain-generation'>Cross-Development Toolchain Generation</link>" section for more discussion on these cross-compilation tools. @@ -488,10 +499,20 @@ <title><filename>debian.bbclass</filename></title> <para> - The <filename>debian</filename> class renames packages so that they - follow the Debian naming policy (i.e. <filename>eglibc</filename> + The <filename>debian</filename> class renames output packages so that + they follow the Debian naming policy (i.e. <filename>eglibc</filename> becomes <filename>libc6</filename> and <filename>eglibc-devel</filename> becomes <filename>libc6-dev</filename>.) + Renaming includes the library name and version as part of the package + name. + </para> + + <para> + If a recipe creates packages for multiple libraries + (shared object files of <filename>.so</filename> type), use the + <link linkend='var-LEAD_SONAME'><filename>LEAD_SONAME</filename></link> + variable in the recipe to specify the library on which to apply the + naming scheme. </para> </section> @@ -512,6 +533,9 @@ and use <filename>addtask</filename> to add the task at the appropriate place, which is usually after <filename>do_compile</filename> or <filename>do_install</filename>. + The class then takes care of staging the files from + <filename>DEPLOYDIR</filename> to + <filename>DEPLOY_DIR_IMAGE</filename>. </para> </section> diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 4a0e4d1..2f3aafa 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" </glossdef> </glossentry> + <glossentry id='var-LEAD_SONAME'><glossterm>LEAD_SONAME</glossterm> + <glossdef> + <para> + Specifies the lead (or primary) compiled library file + (<filename>.so</filename>) that the + <link linkend='ref-classes-debian'><filename>debian</filename></link> + class applies its naming policy to given a recipe that + packages multiple libraries. + </para> + + <para> + This variable works in conjunction with the + <filename>debian</filename> class. + </para> + </glossdef> + </glossentry> + <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm> <glossdef> <para>Checksums of the license text in the recipe source code.</para> |