From 4f7fea8ccb5bb12adb7609eba8f840bc009b95e6 Mon Sep 17 00:00:00 2001 From: Scott Rifenbark Date: Tue, 26 Nov 2013 07:11:49 -0800 Subject: [PATCH] ref-manual: Updated the introduction text for Classes chapter. (From yocto-docs rev: fbaae0f02856d58592be1b54117463245e527897) Signed-off-by: Scott Rifenbark Signed-off-by: Richard Purdie --- documentation/ref-manual/ref-classes.xml | 43 +++++++++++++----------- 1 file changed, 23 insertions(+), 20 deletions(-) diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 27edfde33d..e65004f8ff 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -6,36 +6,39 @@ Classes - Class files are used to abstract common functionality and share it amongst multiple - .bb files. + Class files are used to abstract common functionality and share it amongst + multiple recipe (.bb) files. + To use a class file, you simply make sure the recipe inherits the class. + In most cases, when a recipe inherits a class it is enough to enable its + features. + There are cases, however, where in the recipe you might need to set + variables or override some default behavior. + + + 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 found in the + found in a recipe 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 found in the Source Directory. Class files can also be pointed to by BUILDDIR (e.g. build/) in the same way as .conf files in the conf directory. - Class files are searched for in BBPATH - using the same method by which .conf files are searched. - - - - In most cases inheriting the class is enough to enable its features, although - for some classes you might need to set variables or override some of the - default behavior. + Class files are searched for in + BBPATH + using the same method by which .conf files are + searched. This chapter discusses only the most useful and important classes. - Other classes do exist within the meta/classes - directory in the - Source Directory. - You can reference the .bbclass files directly - for more information. + Other classes do exist within the meta/classes + directory in the + Source Directory. + You can reference the .bbclass files directly + for more information.