diff options
Diffstat (limited to 'documentation/ref-manual/ref-classes.xml')
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 72 |
1 files changed, 48 insertions, 24 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 7331867a02..8730f01a67 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -105,18 +105,18 @@ | |||
105 | It's useful to have some idea of how the tasks defined by this class work | 105 | It's useful to have some idea of how the tasks defined by this class work |
106 | and what they do behind the scenes. | 106 | and what they do behind the scenes. |
107 | <itemizedlist> | 107 | <itemizedlist> |
108 | <listitem><para><filename>do_configure</filename> ‐ Regenerates the | 108 | <listitem><para><link linkend='ref-tasks-configure'><filename>do_configure</filename></link> ‐ Regenerates the |
109 | configure script (using <filename>autoreconf</filename>) and then launches it | 109 | configure script (using <filename>autoreconf</filename>) and then launches it |
110 | with a standard set of arguments used during cross-compilation. | 110 | with a standard set of arguments used during cross-compilation. |
111 | You can pass additional parameters to <filename>configure</filename> through the | 111 | You can pass additional parameters to <filename>configure</filename> through the |
112 | <filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></filename> variable. | 112 | <filename><link linkend='var-EXTRA_OECONF'>EXTRA_OECONF</link></filename> variable. |
113 | </para></listitem> | 113 | </para></listitem> |
114 | <listitem><para><filename>do_compile</filename> ‐ Runs <filename>make</filename> with | 114 | <listitem><para><link linkend='ref-tasks-compile'><filename>do_compile</filename></link> ‐ Runs <filename>make</filename> with |
115 | arguments that specify the compiler and linker. | 115 | arguments that specify the compiler and linker. |
116 | You can pass additional arguments through | 116 | You can pass additional arguments through |
117 | the <filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></filename> variable. | 117 | the <filename><link linkend='var-EXTRA_OEMAKE'>EXTRA_OEMAKE</link></filename> variable. |
118 | </para></listitem> | 118 | </para></listitem> |
119 | <listitem><para><filename>do_install</filename> ‐ Runs <filename>make install</filename> | 119 | <listitem><para><link linkend='ref-tasks-install'><filename>do_install</filename></link> ‐ Runs <filename>make install</filename> |
120 | and passes in | 120 | and passes in |
121 | <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> | 121 | <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}</filename> |
122 | as <filename>DESTDIR</filename>. | 122 | as <filename>DESTDIR</filename>. |
@@ -550,12 +550,14 @@ | |||
550 | The main function of this class is to allow the deploy step to be | 550 | The main function of this class is to allow the deploy step to be |
551 | accelerated by shared state. | 551 | accelerated by shared state. |
552 | Recipes that inherit this class should define their own | 552 | Recipes that inherit this class should define their own |
553 | <filename>do_deploy</filename> function to copy the files to be | 553 | <link linkend='ref-tasks-deploy'><filename>do_deploy</filename></link> |
554 | deployed to | 554 | function to copy the files to be deployed to |
555 | <link linkend='var-DEPLOYDIR'><filename>DEPLOYDIR</filename></link>, | 555 | <link linkend='var-DEPLOYDIR'><filename>DEPLOYDIR</filename></link>, |
556 | and use <filename>addtask</filename> to add the task at the appropriate | 556 | and use <filename>addtask</filename> to add the task at the appropriate |
557 | place, which is usually after <filename>do_compile</filename> or | 557 | place, which is usually after |
558 | <filename>do_install</filename>. | 558 | <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> |
559 | or | ||
560 | <link linkend='ref-tasks-install'><filename>do_install</filename></link>. | ||
559 | The class then takes care of staging the files from | 561 | The class then takes care of staging the files from |
560 | <filename>DEPLOYDIR</filename> to | 562 | <filename>DEPLOYDIR</filename> to |
561 | <filename>DEPLOY_DIR_IMAGE</filename>. | 563 | <filename>DEPLOY_DIR_IMAGE</filename>. |
@@ -1174,7 +1176,8 @@ | |||
1174 | <para> | 1176 | <para> |
1175 | The <filename>image-mklibs</filename> class | 1177 | The <filename>image-mklibs</filename> class |
1176 | enables the use of the <filename>mklibs</filename> utility during the | 1178 | enables the use of the <filename>mklibs</filename> utility during the |
1177 | <filename>do_rootfs</filename> task, which optimizes the size of | 1179 | <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> |
1180 | task, which optimizes the size of | ||
1178 | libraries contained in the image. | 1181 | libraries contained in the image. |
1179 | </para> | 1182 | </para> |
1180 | 1183 | ||
@@ -1195,7 +1198,9 @@ | |||
1195 | <para> | 1198 | <para> |
1196 | The <filename>image-prelink</filename> class | 1199 | The <filename>image-prelink</filename> class |
1197 | enables the use of the <filename>prelink</filename> utility during | 1200 | enables the use of the <filename>prelink</filename> utility during |
1198 | the <filename>do_rootfs</filename> task, which optimizes the dynamic | 1201 | the |
1202 | <link linkend='ref-tasks-rootfs'><filename>do_rootfs</filename></link> | ||
1203 | task, which optimizes the dynamic | ||
1199 | linking of shared libraries to reduce executable startup time. | 1204 | linking of shared libraries to reduce executable startup time. |
1200 | </para> | 1205 | </para> |
1201 | 1206 | ||
@@ -1310,7 +1315,9 @@ | |||
1310 | thus is not normally enabled. | 1315 | thus is not normally enabled. |
1311 | </para></listitem> | 1316 | </para></listitem> |
1312 | <listitem><para><emphasis><filename>compile-host-path:</filename></emphasis> | 1317 | <listitem><para><emphasis><filename>compile-host-path:</filename></emphasis> |
1313 | Checks the <filename>do_compile</filename> log for indications | 1318 | Checks the |
1319 | <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> | ||
1320 | log for indications | ||
1314 | that paths to locations on the build host were used. | 1321 | that paths to locations on the build host were used. |
1315 | Using such paths might result in host contamination of the | 1322 | Using such paths might result in host contamination of the |
1316 | build output. | 1323 | build output. |
@@ -1367,7 +1374,9 @@ | |||
1367 | <link linkend='var-INCOMPATIBLE_LICENSE'><filename>INCOMPATIBLE_LICENSE</filename></link>. | 1374 | <link linkend='var-INCOMPATIBLE_LICENSE'><filename>INCOMPATIBLE_LICENSE</filename></link>. |
1368 | </para></listitem> | 1375 | </para></listitem> |
1369 | <listitem><para><emphasis><filename>install-host-path:</filename></emphasis> | 1376 | <listitem><para><emphasis><filename>install-host-path:</filename></emphasis> |
1370 | Checks the <filename>do_install</filename> log for indications | 1377 | Checks the |
1378 | <link linkend='ref-tasks-install'><filename>do_install</filename></link> | ||
1379 | log for indications | ||
1371 | that paths to locations on the build host were used. | 1380 | that paths to locations on the build host were used. |
1372 | Using such paths might result in host contamination of the | 1381 | Using such paths might result in host contamination of the |
1373 | build output. | 1382 | build output. |
@@ -1451,7 +1460,8 @@ | |||
1451 | </para></listitem> | 1460 | </para></listitem> |
1452 | <listitem><para><emphasis><filename>pkgv-undefined:</filename></emphasis> | 1461 | <listitem><para><emphasis><filename>pkgv-undefined:</filename></emphasis> |
1453 | Checks to see if the <filename>PKGV</filename> variable | 1462 | Checks to see if the <filename>PKGV</filename> variable |
1454 | is undefined during <filename>do_package</filename>. | 1463 | is undefined during |
1464 | <link linkend='ref-tasks-package'><filename>do_package</filename></link>. | ||
1455 | </para></listitem> | 1465 | </para></listitem> |
1456 | <listitem><para><emphasis><filename>pkgvarcheck:</filename></emphasis> | 1466 | <listitem><para><emphasis><filename>pkgvarcheck:</filename></emphasis> |
1457 | Checks through the variables | 1467 | Checks through the variables |
@@ -1569,7 +1579,8 @@ | |||
1569 | <link linkend='var-D'><filename>D</filename></link>, | 1579 | <link linkend='var-D'><filename>D</filename></link>, |
1570 | <link linkend='var-PN'><filename>PN</filename></link>, and | 1580 | <link linkend='var-PN'><filename>PN</filename></link>, and |
1571 | <link linkend='var-PKGD'><filename>PKGD</filename></link>) are | 1581 | <link linkend='var-PKGD'><filename>PKGD</filename></link>) are |
1572 | undefined during <filename>do_package</filename>. | 1582 | undefined during |
1583 | <link linkend='ref-tasks-package'><filename>do_package</filename></link>. | ||
1573 | </para></listitem> | 1584 | </para></listitem> |
1574 | <listitem><para><emphasis><filename>version-going-backwards:</filename></emphasis> | 1585 | <listitem><para><emphasis><filename>version-going-backwards:</filename></emphasis> |
1575 | If Build History is enabled, reports when a package | 1586 | If Build History is enabled, reports when a package |
@@ -1803,8 +1814,11 @@ | |||
1803 | <link linkend='ref-classes-module-base'><filename>module-base</filename></link> | 1814 | <link linkend='ref-classes-module-base'><filename>module-base</filename></link> |
1804 | and | 1815 | and |
1805 | <link linkend='ref-classes-kernel-module-split'><filename>kernel-module-split</filename></link> | 1816 | <link linkend='ref-classes-kernel-module-split'><filename>kernel-module-split</filename></link> |
1806 | classes, and implements <filename>do_compile</filename> and | 1817 | classes, and implements the |
1807 | <filename>do_install</filename> functions. | 1818 | <link linkend='ref-tasks-compile'><filename>do_compile</filename></link> |
1819 | and | ||
1820 | <link linkend='ref-tasks-install'><filename>do_install</filename></link> | ||
1821 | tasks. | ||
1808 | The class provides everything needed to build and package a kernel | 1822 | The class provides everything needed to build and package a kernel |
1809 | module. | 1823 | module. |
1810 | </para> | 1824 | </para> |
@@ -2216,7 +2230,9 @@ | |||
2216 | 2230 | ||
2217 | <para> | 2231 | <para> |
2218 | The <filename>patch</filename> class provides all functionality for | 2232 | The <filename>patch</filename> class provides all functionality for |
2219 | applying patches during the <filename>do_patch</filename> task. | 2233 | applying patches during the |
2234 | <link linkend='ref-tasks-patch'><filename>do_patch</filename></link> | ||
2235 | task. | ||
2220 | </para> | 2236 | </para> |
2221 | 2237 | ||
2222 | <para> | 2238 | <para> |
@@ -2285,7 +2301,9 @@ | |||
2285 | The <filename>populate_sdk</filename> class provides support for | 2301 | The <filename>populate_sdk</filename> class provides support for |
2286 | SDK-only recipes. | 2302 | SDK-only recipes. |
2287 | For information on advantages gained when building a cross-development | 2303 | For information on advantages gained when building a cross-development |
2288 | toolchain using the <filename>do_populate_sdk</filename> task, see the | 2304 | toolchain using the |
2305 | <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link> | ||
2306 | task, see the | ||
2289 | "<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>" | 2307 | "<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>" |
2290 | section in the Yocto Project Application Developer's Guide. | 2308 | section in the Yocto Project Application Developer's Guide. |
2291 | </para> | 2309 | </para> |
@@ -2360,7 +2378,8 @@ | |||
2360 | section. | 2378 | section. |
2361 | For information on advantages gained when building a | 2379 | For information on advantages gained when building a |
2362 | cross-development toolchain using the | 2380 | cross-development toolchain using the |
2363 | <filename>do_populate_sdk</filename> task, see the | 2381 | <link linkend='ref-tasks-populate_sdk'><filename>do_populate_sdk</filename></link> |
2382 | task, see the | ||
2364 | "<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>" | 2383 | "<ulink url='&YOCTO_DOCS_ADT_URL;#optionally-building-a-toolchain-installer'>Optionally Building a Toolchain Installer</ulink>" |
2365 | section in the Yocto Project Application Developer's Guide. | 2384 | section in the Yocto Project Application Developer's Guide. |
2366 | </para> | 2385 | </para> |
@@ -2722,7 +2741,9 @@ | |||
2722 | provides functionality for handling site configuration. | 2741 | provides functionality for handling site configuration. |
2723 | The class is used by the | 2742 | The class is used by the |
2724 | <link linkend='ref-classes-autotools'><filename>autotools</filename></link> | 2743 | <link linkend='ref-classes-autotools'><filename>autotools</filename></link> |
2725 | class to accelerate the <filename>do_configure</filename> task. | 2744 | class to accelerate the |
2745 | <link linkend='ref-tasks-configure'><filename>do_configure</filename></link> | ||
2746 | task. | ||
2726 | </para> | 2747 | </para> |
2727 | </section> | 2748 | </section> |
2728 | 2749 | ||
@@ -2802,7 +2823,8 @@ | |||
2802 | <para> | 2823 | <para> |
2803 | The <filename>staging</filename> class provides support for staging | 2824 | The <filename>staging</filename> class provides support for staging |
2804 | files into the sysroot during the | 2825 | files into the sysroot during the |
2805 | <filename>do_populate_sysroot</filename> task. | 2826 | <link linkend='ref-tasks-populate_sysroot'><filename>do_populate_sysroot</filename></link> |
2827 | task. | ||
2806 | The class is enabled by default because it is inherited by the | 2828 | The class is enabled by default because it is inherited by the |
2807 | <link linkend='ref-classes-base'><filename>base</filename></link> | 2829 | <link linkend='ref-classes-base'><filename>base</filename></link> |
2808 | class. | 2830 | class. |
@@ -2873,8 +2895,9 @@ | |||
2873 | 2895 | ||
2874 | <para> | 2896 | <para> |
2875 | Under this class, the recipe or Makefile (i.e. whatever the recipe is | 2897 | Under this class, the recipe or Makefile (i.e. whatever the recipe is |
2876 | calling during the <filename>do_install</filename> task) installs unit | 2898 | calling during the |
2877 | files into | 2899 | <link linkend='ref-tasks-install'><filename>do_install</filename></link> |
2900 | task) installs unit files into | ||
2878 | <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}${systemd_unitdir}/system</filename>. | 2901 | <filename>${</filename><link linkend='var-D'><filename>D</filename></link><filename>}${systemd_unitdir}/system</filename>. |
2879 | If the unit files being installed go into packages other than the | 2902 | If the unit files being installed go into packages other than the |
2880 | main package, you need to set | 2903 | main package, you need to set |
@@ -3192,8 +3215,9 @@ | |||
3192 | <para> | 3215 | <para> |
3193 | The <filename>utility-tasks</filename> class provides support for | 3216 | The <filename>utility-tasks</filename> class provides support for |
3194 | various "utility" type tasks that are applicable to all recipes, | 3217 | various "utility" type tasks that are applicable to all recipes, |
3195 | such as <filename>do_clean</filename> and | 3218 | such as |
3196 | <filename>do_listtasks</filename>. | 3219 | <link linkend='ref-tasks-clean'><filename>do_clean</filename></link> and |
3220 | <link linkend='ref-tasks-listtasks'><filename>do_listtasks</filename></link>. | ||
3197 | </para> | 3221 | </para> |
3198 | 3222 | ||
3199 | <para> | 3223 | <para> |