ref-manual: Updated the introduction text for Classes chapter.
(From yocto-docs rev: 3544d290668cc0e65d6c586f25083924253d41a3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
0922d3c603
commit
9a6d7e0d24
|
@ -6,36 +6,39 @@
|
|||
<title>Classes</title>
|
||||
|
||||
<para>
|
||||
Class files are used to abstract common functionality and share it amongst multiple
|
||||
<filename>.bb</filename> files.
|
||||
Class files are used to abstract common functionality and share it amongst
|
||||
multiple recipe (<filename>.bb</filename>) 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.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
Any <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink> usually
|
||||
found in a <filename>.bb</filename> file can also be placed in a class
|
||||
file.
|
||||
Class files are identified by the extension <filename>.bbclass</filename> and are usually placed
|
||||
in a <filename>classes/</filename> directory beneath the
|
||||
<filename>meta*/</filename> directory found in the
|
||||
found in a recipe can also be placed in a class file.
|
||||
Class files are identified by the extension <filename>.bbclass</filename>
|
||||
and are usually placed in a <filename>classes/</filename> directory beneath
|
||||
the <filename>meta*/</filename> directory found in the
|
||||
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
|
||||
Class files can also be pointed to by
|
||||
<link linkend='var-BUILDDIR'><filename>BUILDDIR</filename></link>
|
||||
(e.g. <filename>build/</filename>) in the same way as
|
||||
<filename>.conf</filename> files in the <filename>conf</filename> directory.
|
||||
Class files are searched for in <link linkend='var-BBPATH'><filename>BBPATH</filename></link>
|
||||
using the same method by which <filename>.conf</filename> files are searched.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
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
|
||||
<link linkend='var-BBPATH'><filename>BBPATH</filename></link>
|
||||
using the same method by which <filename>.conf</filename> files are
|
||||
searched.
|
||||
</para>
|
||||
|
||||
<para>
|
||||
This chapter discusses only the most useful and important classes.
|
||||
Other classes do exist within the <filename>meta/classes</filename>
|
||||
directory in the
|
||||
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
|
||||
You can reference the <filename>.bbclass</filename> files directly
|
||||
for more information.
|
||||
Other classes do exist within the <filename>meta/classes</filename>
|
||||
directory in the
|
||||
<ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>.
|
||||
You can reference the <filename>.bbclass</filename> files directly
|
||||
for more information.
|
||||
</para>
|
||||
|
||||
<section id='ref-classes-base'>
|
||||
|
|
Loading…
Reference in New Issue