diff options
| -rw-r--r-- | documentation/ref-manual/ref-classes.xml | 46 |
1 files changed, 24 insertions, 22 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index eaceb13b8e..90aa377521 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
| @@ -21,7 +21,7 @@ | |||
| 21 | Class files are identified by the extension <filename>.bbclass</filename> | 21 | Class files are identified by the extension <filename>.bbclass</filename> |
| 22 | and are usually placed in a <filename>classes/</filename> directory beneath | 22 | and are usually placed in a <filename>classes/</filename> directory beneath |
| 23 | the <filename>meta*/</filename> directory found in the | 23 | the <filename>meta*/</filename> directory found in the |
| 24 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 24 | <link linkend='source-directory'>Source Directory</link>. |
| 25 | Class files can also be pointed to by | 25 | Class files can also be pointed to by |
| 26 | <link linkend='var-BUILDDIR'><filename>BUILDDIR</filename></link> | 26 | <link linkend='var-BUILDDIR'><filename>BUILDDIR</filename></link> |
| 27 | (e.g. <filename>build/</filename>) in the same way as | 27 | (e.g. <filename>build/</filename>) in the same way as |
| @@ -36,7 +36,7 @@ | |||
| 36 | This chapter discusses only the most useful and important classes. | 36 | This chapter discusses only the most useful and important classes. |
| 37 | Other classes do exist within the <filename>meta/classes</filename> | 37 | Other classes do exist within the <filename>meta/classes</filename> |
| 38 | directory in the | 38 | directory in the |
| 39 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 39 | <link linkend='source-directory'>Source Directory</link>. |
| 40 | You can reference the <filename>.bbclass</filename> files directly | 40 | You can reference the <filename>.bbclass</filename> files directly |
| 41 | for more information. | 41 | for more information. |
| 42 | </para> | 42 | </para> |
| @@ -94,7 +94,7 @@ | |||
| 94 | <para> | 94 | <para> |
| 95 | For more details on the source archiver, see the | 95 | For more details on the source archiver, see the |
| 96 | "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" | 96 | "<ulink url='&YOCTO_DOCS_DEV_URL;#maintaining-open-source-license-compliance-during-your-products-lifecycle'>Maintaining Open Source License Compliance During Your Product's Lifecycle</ulink>" |
| 97 | section in the Yocto Project Development Manual. | 97 | section in the Yocto Project Development Tasks Manual. |
| 98 | You can also see the | 98 | You can also see the |
| 99 | <link linkend='var-ARCHIVER_MODE'><filename>ARCHIVER_MODE</filename></link> | 99 | <link linkend='var-ARCHIVER_MODE'><filename>ARCHIVER_MODE</filename></link> |
| 100 | variable for information about the variable flags (varflags) | 100 | variable for information about the variable flags (varflags) |
| @@ -122,7 +122,7 @@ | |||
| 122 | These classes can also work with software that emulates Autotools. | 122 | These classes can also work with software that emulates Autotools. |
| 123 | For more information, see the | 123 | For more information, see the |
| 124 | "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-autotooled-package'>Autotooled Package</ulink>" | 124 | "<ulink url='&YOCTO_DOCS_DEV_URL;#new-recipe-autotooled-package'>Autotooled Package</ulink>" |
| 125 | section in the Yocto Project Development Manual. | 125 | section in the Yocto Project Development Tasks Manual. |
| 126 | </para> | 126 | </para> |
| 127 | 127 | ||
| 128 | <para> | 128 | <para> |
| @@ -333,7 +333,7 @@ | |||
| 333 | For details on how the class works, see the | 333 | For details on how the class works, see the |
| 334 | <filename>meta/classes/bluetooth.bbclass</filename> file in the Yocto | 334 | <filename>meta/classes/bluetooth.bbclass</filename> file in the Yocto |
| 335 | Project | 335 | Project |
| 336 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 336 | <link linkend='source-directory'>Source Directory</link>. |
| 337 | </para> | 337 | </para> |
| 338 | </section> | 338 | </section> |
| 339 | 339 | ||
| @@ -641,7 +641,7 @@ | |||
| 641 | Distribution policy dictates whether to include this class. | 641 | Distribution policy dictates whether to include this class. |
| 642 | See the | 642 | See the |
| 643 | "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section | 643 | "<ulink url='&YOCTO_DOCS_DEV_URL;#platdev-appdev-devshell'>Using a Development Shell</ulink>" section |
| 644 | in the Yocto Project Development Manual for more information about | 644 | in the Yocto Project Development Tasks Manual for more information about |
| 645 | using <filename>devshell</filename>. | 645 | using <filename>devshell</filename>. |
| 646 | </para> | 646 | </para> |
| 647 | </section> | 647 | </section> |
| @@ -816,11 +816,11 @@ | |||
| 816 | For more information on the | 816 | For more information on the |
| 817 | <filename>externalsrc</filename> class, see the comments in | 817 | <filename>externalsrc</filename> class, see the comments in |
| 818 | <filename>meta/classes/externalsrc.bbclass</filename> in the | 818 | <filename>meta/classes/externalsrc.bbclass</filename> in the |
| 819 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 819 | <link linkend='source-directory'>Source Directory</link>. |
| 820 | For information on how to use the <filename>externalsrc</filename> | 820 | For information on how to use the <filename>externalsrc</filename> |
| 821 | class, see the | 821 | class, see the |
| 822 | "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>" | 822 | "<ulink url='&YOCTO_DOCS_DEV_URL;#building-software-from-an-external-source'>Building Software from an External Source</ulink>" |
| 823 | section in the Yocto Project Development Manual. | 823 | section in the Yocto Project Development Tasks Manual. |
| 824 | </para> | 824 | </para> |
| 825 | </section> | 825 | </section> |
| 826 | 826 | ||
| @@ -1247,7 +1247,7 @@ | |||
| 1247 | </itemizedlist> | 1247 | </itemizedlist> |
| 1248 | For information on customizing images, see the | 1248 | For information on customizing images, see the |
| 1249 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage'>Customizing Images</ulink>" | 1249 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage'>Customizing Images</ulink>" |
| 1250 | section in the Yocto Project Development Manual. | 1250 | section in the Yocto Project Development Tasks Manual. |
| 1251 | For information on how images are created, see the | 1251 | For information on how images are created, see the |
| 1252 | "<link linkend='images-dev-environment'>Images</link>" section elsewhere | 1252 | "<link linkend='images-dev-environment'>Images</link>" section elsewhere |
| 1253 | in this manual. | 1253 | in this manual. |
| @@ -1880,7 +1880,7 @@ This check was removed for YP 2.3 release | |||
| 1880 | you build the kernel image. | 1880 | you build the kernel image. |
| 1881 | For information on how to build an initramfs, see the | 1881 | For information on how to build an initramfs, see the |
| 1882 | "<ulink url='&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image'>Building an Initial RAM Filesystem (initramfs) Image</ulink>" | 1882 | "<ulink url='&YOCTO_DOCS_DEV_URL;#building-an-initramfs-image'>Building an Initial RAM Filesystem (initramfs) Image</ulink>" |
| 1883 | section in the Yocto Project Development Manual. | 1883 | section in the Yocto Project Development Tasks Manual. |
| 1884 | </para> | 1884 | </para> |
| 1885 | 1885 | ||
| 1886 | <para> | 1886 | <para> |
| @@ -2174,7 +2174,7 @@ This check was removed for YP 2.3 release | |||
| 2174 | <para> | 2174 | <para> |
| 2175 | For more information on using the Multilib feature, see the | 2175 | For more information on using the Multilib feature, see the |
| 2176 | "<ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Combining Multiple Versions of Library Files into One Image</ulink>" | 2176 | "<ulink url='&YOCTO_DOCS_DEV_URL;#combining-multiple-versions-library-files-into-one-image'>Combining Multiple Versions of Library Files into One Image</ulink>" |
| 2177 | section in the Yocto Project Development Manual. | 2177 | section in the Yocto Project Development Tasks Manual. |
| 2178 | </para> | 2178 | </para> |
| 2179 | </section> | 2179 | </section> |
| 2180 | 2180 | ||
| @@ -2308,7 +2308,7 @@ This check was removed for YP 2.3 release | |||
| 2308 | The <filename>oelint</filename> class is an | 2308 | The <filename>oelint</filename> class is an |
| 2309 | obsolete lint checking tool that exists in | 2309 | obsolete lint checking tool that exists in |
| 2310 | <filename>meta/classes</filename> in the | 2310 | <filename>meta/classes</filename> in the |
| 2311 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 2311 | <link linkend='source-directory'>Source Directory</link>. |
| 2312 | </para> | 2312 | </para> |
| 2313 | 2313 | ||
| 2314 | <para> | 2314 | <para> |
| @@ -2387,7 +2387,7 @@ This check was removed for YP 2.3 release | |||
| 2387 | on the target (i.e. runtime installation of packages). | 2387 | on the target (i.e. runtime installation of packages). |
| 2388 | For more information, see the | 2388 | For more information, see the |
| 2389 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-runtime-package-management'>Using Runtime Package Management</ulink>" | 2389 | "<ulink url='&YOCTO_DOCS_DEV_URL;#using-runtime-package-management'>Using Runtime Package Management</ulink>" |
| 2390 | section in the Yocto Project Development Manual. | 2390 | section in the Yocto Project Development Tasks Manual. |
| 2391 | </para> | 2391 | </para> |
| 2392 | 2392 | ||
| 2393 | <para> | 2393 | <para> |
| @@ -2567,7 +2567,7 @@ This check was removed for YP 2.3 release | |||
| 2567 | <para> | 2567 | <para> |
| 2568 | For information on how to use this class, see the | 2568 | For information on how to use this class, see the |
| 2569 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-customtasks'>Customizing Images Using Custom Package Groups</ulink>" | 2569 | "<ulink url='&YOCTO_DOCS_DEV_URL;#usingpoky-extend-customimage-customtasks'>Customizing Images Using Custom Package Groups</ulink>" |
| 2570 | section in the Yocto Project Development Manual. | 2570 | section in the Yocto Project Development Tasks Manual. |
| 2571 | </para> | 2571 | </para> |
| 2572 | 2572 | ||
| 2573 | <para> | 2573 | <para> |
| @@ -2810,8 +2810,8 @@ This check was removed for YP 2.3 release | |||
| 2810 | <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. | 2810 | <link linkend='var-DISTRO_FEATURES'><filename>DISTRO_FEATURES</filename></link>. |
| 2811 | See the | 2811 | See the |
| 2812 | "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages With ptest</ulink>" | 2812 | "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages With ptest</ulink>" |
| 2813 | section in the Yocto Project Development Manual for more information | 2813 | section in the Yocto Project Development Tasks Manual for more |
| 2814 | on ptest. | 2814 | information on ptest. |
| 2815 | </para> | 2815 | </para> |
| 2816 | </section> | 2816 | </section> |
| 2817 | 2817 | ||
| @@ -2827,7 +2827,7 @@ This check was removed for YP 2.3 release | |||
| 2827 | <para> | 2827 | <para> |
| 2828 | For information on setting up and running ptests, see the | 2828 | For information on setting up and running ptests, see the |
| 2829 | "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages With ptest</ulink>" | 2829 | "<ulink url='&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest'>Testing Packages With ptest</ulink>" |
| 2830 | section in the Yocto Project Development Manual. | 2830 | section in the Yocto Project Development Tasks Manual. |
| 2831 | </para> | 2831 | </para> |
| 2832 | </section> | 2832 | </section> |
| 2833 | 2833 | ||
| @@ -3435,7 +3435,7 @@ This check was removed for YP 2.3 release | |||
| 3435 | <para> | 3435 | <para> |
| 3436 | For more information on <filename>systemd</filename>, see the | 3436 | For more information on <filename>systemd</filename>, see the |
| 3437 | "<ulink url='&YOCTO_DOCS_DEV_URL;#selecting-an-initialization-manager'>Selecting an Initialization Manager</ulink>" | 3437 | "<ulink url='&YOCTO_DOCS_DEV_URL;#selecting-an-initialization-manager'>Selecting an Initialization Manager</ulink>" |
| 3438 | section in the Yocto Project Development Manual. | 3438 | section in the Yocto Project Development Tasks Manual. |
| 3439 | </para> | 3439 | </para> |
| 3440 | </section> | 3440 | </section> |
| 3441 | 3441 | ||
| @@ -3535,7 +3535,7 @@ This check was removed for YP 2.3 release | |||
| 3535 | <para> | 3535 | <para> |
| 3536 | For information on how to enable, run, and create new tests, see the | 3536 | For information on how to enable, run, and create new tests, see the |
| 3537 | "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" | 3537 | "<ulink url='&YOCTO_DOCS_DEV_URL;#performing-automated-runtime-testing'>Performing Automated Runtime Testing</ulink>" |
| 3538 | section in the Yocto Project Development Manual. | 3538 | section in the Yocto Project Development Tasks Manual. |
| 3539 | </para> | 3539 | </para> |
| 3540 | </section> | 3540 | </section> |
| 3541 | 3541 | ||
| @@ -3717,7 +3717,8 @@ This check was removed for YP 2.3 release | |||
| 3717 | provide pathnames for links, default links for targets, and | 3717 | provide pathnames for links, default links for targets, and |
| 3718 | so forth. | 3718 | so forth. |
| 3719 | For details on how to use this class, see the comments in the | 3719 | For details on how to use this class, see the comments in the |
| 3720 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass'><filename>update-alternatives.bbclass</filename></ulink>. | 3720 | <ulink url='&YOCTO_GIT_URL;/cgit/cgit.cgi/poky/tree/meta/classes/update-alternatives.bbclass'><filename>update-alternatives.bbclass</filename></ulink> |
| 3721 | file. | ||
| 3721 | </para> | 3722 | </para> |
| 3722 | 3723 | ||
| 3723 | <note> | 3724 | <note> |
| @@ -3757,8 +3758,9 @@ This check was removed for YP 2.3 release | |||
| 3757 | For example, if you have packages that contain system services that | 3758 | For example, if you have packages that contain system services that |
| 3758 | should be run under their own user or group, you can use these classes | 3759 | should be run under their own user or group, you can use these classes |
| 3759 | to enable creation of the user or group. | 3760 | to enable creation of the user or group. |
| 3760 | The <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename> | 3761 | The |
| 3761 | recipe in the <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink> | 3762 | <filename>meta-skeleton/recipes-skeleton/useradd/useradd-example.bb</filename> |
| 3763 | recipe in the <link linkend='source-directory'>Source Directory</link> | ||
| 3762 | provides a simple example that shows how to add three | 3764 | provides a simple example that shows how to add three |
| 3763 | users and groups to two packages. | 3765 | users and groups to two packages. |
| 3764 | See the <filename>useradd-example.bb</filename> recipe for more | 3766 | See the <filename>useradd-example.bb</filename> recipe for more |
