diff options
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 118 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 2 |
2 files changed, 62 insertions, 58 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index f24f5946b4..b5d53cd70b 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -2262,6 +2262,67 @@ | |||
2262 | </para> | 2262 | </para> |
2263 | </section> | 2263 | </section> |
2264 | 2264 | ||
2265 | <section id='ref-classes-rm-work'> | ||
2266 | <title><filename>rm_work.bbclass</filename></title> | ||
2267 | |||
2268 | <para> | ||
2269 | The <filename>rm_work</filename> class supports deletion of temporary | ||
2270 | workspace, which can ease your hard drive demands during builds. | ||
2271 | </para> | ||
2272 | |||
2273 | <para> | ||
2274 | The OpenEmbedded build system can use a substantial amount of disk | ||
2275 | space during the build process. | ||
2276 | A portion of this space is the work files under the | ||
2277 | <filename>${TMPDIR}/work</filename> directory for each recipe. | ||
2278 | Once the build system generates the packages for a recipe, the work | ||
2279 | files for that recipe are no longer needed. | ||
2280 | However, by default, the build system preserves these files | ||
2281 | for inspection and possible debugging purposes. | ||
2282 | If you would rather have these files deleted to save disk space | ||
2283 | as the build progresses, you can enable <filename>rm_work</filename> | ||
2284 | by adding the following to your <filename>local.conf</filename> file, | ||
2285 | which is found in the | ||
2286 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | ||
2287 | <literallayout class='monospaced'> | ||
2288 | INHERIT += "rm_work" | ||
2289 | </literallayout> | ||
2290 | If you are modifying and building source code out of the work directory | ||
2291 | for a recipe, enabling <filename>rm_work</filename> will potentially | ||
2292 | result in your changes to the source being lost. | ||
2293 | To exclude some recipes from having their work directories deleted by | ||
2294 | <filename>rm_work</filename>, you can add the names of the recipe or | ||
2295 | recipes you are working on to the <filename>RM_WORK_EXCLUDE</filename> | ||
2296 | variable, which can also be set in your <filename>local.conf</filename> | ||
2297 | file. | ||
2298 | Here is an example: | ||
2299 | <literallayout class='monospaced'> | ||
2300 | RM_WORK_EXCLUDE += "busybox eglibc" | ||
2301 | </literallayout> | ||
2302 | </para> | ||
2303 | </section> | ||
2304 | |||
2305 | <section id='ref-classes-rootfs*'> | ||
2306 | <title><filename>rootfs*.bbclass</filename></title> | ||
2307 | |||
2308 | <para> | ||
2309 | These classes add support for creating images in several formats. | ||
2310 | First, the root filesystem is created from packages using | ||
2311 | one of the <filename>rootfs_*.bbclass</filename> | ||
2312 | files (depending on the package format used) and then the image is created. | ||
2313 | <itemizedlist> | ||
2314 | <listitem><para>The | ||
2315 | <filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></filename> | ||
2316 | variable controls the types of images to generate. | ||
2317 | </para></listitem> | ||
2318 | <listitem><para>The | ||
2319 | <filename><link linkend='var-IMAGE_INSTALL'>IMAGE_INSTALL</link></filename> | ||
2320 | variable controls the list of packages to install into the | ||
2321 | image.</para></listitem> | ||
2322 | </itemizedlist> | ||
2323 | </para> | ||
2324 | </section> | ||
2325 | |||
2265 | <section id='ref-classes-scons'> | 2326 | <section id='ref-classes-scons'> |
2266 | <title><filename>scons.bbclass</filename></title> | 2327 | <title><filename>scons.bbclass</filename></title> |
2267 | 2328 | ||
@@ -2459,27 +2520,6 @@ | |||
2459 | </para> | 2520 | </para> |
2460 | </section> | 2521 | </section> |
2461 | 2522 | ||
2462 | <section id='ref-classes-rootfs*'> | ||
2463 | <title><filename>rootfs*.bbclass</filename></title> | ||
2464 | |||
2465 | <para> | ||
2466 | These classes add support for creating images in several formats. | ||
2467 | First, the root filesystem is created from packages using | ||
2468 | one of the <filename>rootfs_*.bbclass</filename> | ||
2469 | files (depending on the package format used) and then the image is created. | ||
2470 | <itemizedlist> | ||
2471 | <listitem><para>The | ||
2472 | <filename><link linkend='var-IMAGE_FSTYPES'>IMAGE_FSTYPES</link></filename> | ||
2473 | variable controls the types of images to generate. | ||
2474 | </para></listitem> | ||
2475 | <listitem><para>The | ||
2476 | <filename><link linkend='var-IMAGE_INSTALL'>IMAGE_INSTALL</link></filename> | ||
2477 | variable controls the list of packages to install into the | ||
2478 | image.</para></listitem> | ||
2479 | </itemizedlist> | ||
2480 | </para> | ||
2481 | </section> | ||
2482 | |||
2483 | <section id='ref-classes-sanity'> | 2523 | <section id='ref-classes-sanity'> |
2484 | <title>Host System Sanity Checks - <filename>sanity.bbclass</filename></title> | 2524 | <title>Host System Sanity Checks - <filename>sanity.bbclass</filename></title> |
2485 | 2525 | ||
@@ -2493,42 +2533,6 @@ | |||
2493 | </para> | 2533 | </para> |
2494 | </section> | 2534 | </section> |
2495 | 2535 | ||
2496 | <section id='ref-classes-rm-work'> | ||
2497 | <title>Removing Work Files During the Build - <filename>rm_work.bbclass</filename></title> | ||
2498 | |||
2499 | <para> | ||
2500 | The OpenEmbedded build system can use a substantial amount of disk | ||
2501 | space during the build process. | ||
2502 | A portion of this space is the work files under the | ||
2503 | <filename>${TMPDIR}/work</filename> directory for each recipe. | ||
2504 | Once the build system generates the packages for a recipe, the work | ||
2505 | files for that recipe are no longer needed. | ||
2506 | However, by default, the build system preserves these files | ||
2507 | for inspection and possible debugging purposes. | ||
2508 | If you would rather have these files deleted to save disk space | ||
2509 | as the build progresses, you can enable <filename>rm_work</filename> | ||
2510 | by adding the following to your <filename>local.conf</filename> file, | ||
2511 | which is found in the | ||
2512 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | ||
2513 | <literallayout class='monospaced'> | ||
2514 | INHERIT += "rm_work" | ||
2515 | </literallayout> | ||
2516 | If you are modifying and building source code out of the work directory | ||
2517 | for a recipe, enabling <filename>rm_work</filename> will potentially | ||
2518 | result in your changes to the source being lost. | ||
2519 | To exclude some recipes from having their work directories deleted by | ||
2520 | <filename>rm_work</filename>, you can add the names of the recipe or | ||
2521 | recipes you are working on to the <filename>RM_WORK_EXCLUDE</filename> | ||
2522 | variable, which can also be set in your <filename>local.conf</filename> | ||
2523 | file. | ||
2524 | Here is an example: | ||
2525 | <literallayout class='monospaced'> | ||
2526 | RM_WORK_EXCLUDE += "busybox eglibc" | ||
2527 | </literallayout> | ||
2528 | </para> | ||
2529 | </section> | ||
2530 | |||
2531 | |||
2532 | <section id='ref-classes-siteinfo'> | 2536 | <section id='ref-classes-siteinfo'> |
2533 | <title>Autotools Configuration Data Cache - <filename>siteinfo.bbclass</filename></title> | 2537 | <title>Autotools Configuration Data Cache - <filename>siteinfo.bbclass</filename></title> |
2534 | 2538 | ||
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 60e24ef565..7ece12cc2c 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -5274,7 +5274,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
5274 | With <filename>rm_work</filename> enabled, this | 5274 | With <filename>rm_work</filename> enabled, this |
5275 | variable specifies a list of recipes whose work directories | 5275 | variable specifies a list of recipes whose work directories |
5276 | should not be removed. | 5276 | should not be removed. |
5277 | See the "<link linkend='ref-classes-rm-work'>Removing Work Files During the Build - <filename>rm_work.bbclass</filename></link>" | 5277 | See the "<link linkend='ref-classes-rm-work'><filename>rm_work.bbclass</filename></link>" |
5278 | section for more details. | 5278 | section for more details. |
5279 | </para> | 5279 | </para> |
5280 | </glossdef> | 5280 | </glossdef> |