From 1e10a0cf03dd5d8ba0a2cb634fdc039a000b6d88 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Mon, 4 Apr 2011 16:49:31 -0500 Subject: documentation/poky-ref-manual/ref-classes.xml: tag updates Removed the various styles for commands and such and replaced with simple / pairs. (From OE-Core rev: c5a0cc3e6a2f1e7eb1a90c67d2a038d3dc18b1ba) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/poky-ref-manual/ref-classes.xml | 87 ++++++++++----------------- 1 file changed, 32 insertions(+), 55 deletions(-) (limited to 'documentation') diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml index 64cff65426..f4a509c62b 100644 --- a/documentation/poky-ref-manual/ref-classes.xml +++ b/documentation/poky-ref-manual/ref-classes.xml @@ -6,14 +6,14 @@ Class files are used to abstract common functionality and share it amongst multiple - .bb files. Any metadata usually found in a - .bb file can also be placed in a class + .bb files. Any metadata usually found in a + .bb file can also be placed in a class file. Class files are identified by the extension - .bbclass and are usually placed - in a classes/ directory beneath the - meta*/ directory or the directory pointed - by BUILDDIR (e.g. build/)in the same way as - .conf files in the .bbclass and are usually placed + in a classes/ directory beneath the + meta*/ directory or the directory pointed + by BUILDDIR (e.g. build/)in the same way as + .conf files in the conf directory. Class files are searched for in BBPATH in the same was as .conf files too. @@ -28,7 +28,7 @@ The base class - <filename>base.bbclass</filename> - The base class is special in that every .bb + The base class is special in that every .bb file inherits it automatically. It contains definitions of standard basic tasks such as fetching, unpacking, configuring (empty by default), compiling (runs any Makefile present), installing (empty by default) and packaging @@ -95,54 +95,31 @@ Several programs can fulfill the same or similar function and - they can be installed with the same name. For example the ar + be installed with the same name. + For example, the ar command is available from the "busybox", "binutils" and "elfutils" packages. - This class handles the renaming of the binaries so multiple packages - can be installed which would otherwise conflict and yet the - ar command still works regardless of which are installed - or subsequently removed. It renames the conflicting binary in each package + The update-alternatives.bbclass class handles renaming the + binaries so that multiple packages can be installed without conflicts. + The ar command still works regardless of which packages are installed + or subsequently removed. + The class renames the conflicting binary in each package and symlinks the highest priority binary during installation or removal of packages. - + + Four variables control this class: - - - - - ALTERNATIVE_NAME - - - Name of binary which will be replaced (ar in this example) - - - - - ALTERNATIVE_LINK - - - Path to resulting binary ("/bin/ar" in this example) - - - - - ALTERNATIVE_PATH - - - Path to real binary ("/usr/bin/ar.binutils" in this example) - - - - - ALTERNATIVE_PRIORITY - - - Priority of binary, the version with the most features should have the highest priority - - - - - + + ALTERNATIVE_NAME ‐ The name of the + binary that is replaced (ar in this example). + ALTERNATIVE_LINK ‐ The path to + the resulting binary (/bin/ar in this example). + ALTERNATIVE_PATH ‐ The path to the + real binary (/usr/bin/ar.binutils in this example). + ALTERNATIVE_PRIORITY ‐ The priority of + the binary. + The version with the most features should have the highest priority. + Currently, only one binary per package is supported. @@ -176,7 +153,7 @@ During staging Bitbake installs such scripts into the sysroots/ directory. It also changes all - paths to point into the sysroots/ + paths to point into the sysroots/ directory so all builds which use the script will use the correct directories for the cross compiling layout. @@ -219,7 +196,7 @@ - Result of their work are tmp/deploy/source/ + Result of their work are tmp/deploy/source/ subdirs with sources sorted by LICENSE field. If recipe lists few licenses (or has entries like "Bitstream Vera") source archive is put in each license dir. @@ -323,7 +300,7 @@ This means that each kernel module built is packaged separately and inter-module dependencies are - created by parsing the modinfo output. If all modules are + created by parsing the modinfo output. If all modules are required then installing the "kernel-modules" package will install all packages with modules and various other kernel packages such as "kernel-vmlinux". @@ -407,7 +384,7 @@ Only the most useful/important classes are covered here but there are - others, see the meta/classes directory for the rest. + others, see the meta/classes directory for the rest. -- cgit v1.2.3-54-g00ecf