diff options
Diffstat (limited to 'documentation/poky-ref-manual/ref-classes.xml')
| -rw-r--r-- | documentation/poky-ref-manual/ref-classes.xml | 33 |
1 files changed, 18 insertions, 15 deletions
diff --git a/documentation/poky-ref-manual/ref-classes.xml b/documentation/poky-ref-manual/ref-classes.xml index 35c713434c..67f2454145 100644 --- a/documentation/poky-ref-manual/ref-classes.xml +++ b/documentation/poky-ref-manual/ref-classes.xml @@ -12,10 +12,11 @@ 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 Yocto Project file's area + <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 BUILDDIR (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 <filename>BBPATH</filename> + 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> @@ -111,7 +112,7 @@ </para> <para> - Currently, the Yocto Project supports only one binary per package. + Currently, the OpenEmbedded build system supports only one binary per package. </para> </section> @@ -121,7 +122,7 @@ <para> This class uses <filename>update-rc.d</filename> to safely install an initialization script on behalf of the package. - The Yocto Project takes care of details such as making sure the script is stopped before + The OpenEmbedded build system takes care of details such as making sure the script is stopped before a package is removed and started when the package is installed. Three variables control this class: <filename><link linkend='var-INITSCRIPT_PACKAGES'>INITSCRIPT_PACKAGES</link></filename>, @@ -254,7 +255,7 @@ <para> This class adds the <filename>devshell</filename> task. - Distribution policy dictates whether to include this class as the Yocto Project does. + Distribution policy dictates whether to include this class. See the "<link linkend='platdev-appdev-devshell'>Development Within a Development Shell</link>" section for more information about using devshell. @@ -277,8 +278,9 @@ <para> You can control the list of resulting package formats by using the <filename><link linkend='var-PACKAGE_CLASSES'>PACKAGE_CLASSES</link></filename> - variable defined in the <filename>local.conf</filename> configuration file - found in the Yocto Project file's <filename>conf</filename> directory. + variable defined in the <filename>local.conf</filename> configuration file, + which is located in the <filename>conf</filename> folder of the + <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. When defining the variable, you can specify one or more package types. Since images are generated from packages, a packaging class is needed to enable image generation. @@ -380,7 +382,7 @@ The class also performs basic user configuration checks from the <filename>local.conf</filename> configuration file to prevent common mistakes that cause build failures. - Distribution policy usually whether to include this class as the Yocto Project does. + Distribution policy usually determines whether to include this class. </para> </section> @@ -389,10 +391,10 @@ <para> This class adds a step to the package generation process that sanity checks the - packages generated by the Yocto Project. + packages generated by the OpenEmbedded build system. A range of checks are performed that check the build's output for common problems that show up during runtime. - Distribution policy usually dictates whether to include this class as the Yocto Project does. + Distribution policy usually dictates whether to include this class. </para> <para> @@ -514,7 +516,8 @@ you can use this class to specify those packages and associate the users and groups with those packages. The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename> - recipe in the Yocto Project Files provides a simple exmample that shows how to add three + recipe in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink> + provides a simple exmample that shows how to add three users and groups to two packages. See the <filename>useradd-example.bb</filename> for more information on how to use this class. @@ -526,7 +529,7 @@ <para> You can use this class to build software from source code that is external to the - Yocto Project build system. + OpenEmbedded build system. In other words, your source code resides in an external tree outside of the Yocto Project. Building software from an external source tree means that the normal fetch, unpack, and patch process is not used. @@ -541,7 +544,7 @@ <para> This class expects the source code to support recipe builds that use the <link linkend='var-B'><filename>B</filename></link> variable to point to the directory in - which the Yocto Project build system places the generated objects built from the recipes. + which the OpenEmbedded build system places the generated objects built from the recipes. By default, the <filename>B</filename> directory is set to the following, which is separate from the source directory (<filename>S</filename>): <literallayout class='monospaced'> @@ -570,7 +573,7 @@ When you do, the <link linkend='var-B'><filename>B</filename></link> variable must support the recipe's ability to build variants in different working directories. Most autotools-based recipes support separating these directories. - The Yocto Project defaults to using separate directories for <filename>gcc</filename> + The OpenEmbedded build system defaults to using separate directories for <filename>gcc</filename> and some kernel recipes. Alternatively, you can make sure that separate recipes exist that each use the <filename>BBCLASSEXTEND</filename> variable to build each variant. @@ -591,7 +594,7 @@ Thus far, this appendix has discussed only the most useful and important classes. However, other classes exist within the <filename>meta/classes</filename> directory - in the Yocto Project file's directory structure. + in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>source directory</ulink>. You can examine the <filename>.bbclass</filename> files directly for more information. </para> |