diff options
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 84 |
1 files changed, 42 insertions, 42 deletions
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index 57b448a351..a28053cd85 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -2325,6 +2325,19 @@ | |||
2325 | </para> | 2325 | </para> |
2326 | </section> | 2326 | </section> |
2327 | 2327 | ||
2328 | <section id='ref-classes-sanity'> | ||
2329 | <title>Host System Sanity Checks - <filename>sanity.bbclass</filename></title> | ||
2330 | |||
2331 | <para> | ||
2332 | This class checks to see if prerequisite software is present on the host system | ||
2333 | so that users can be notified of potential problems that might affect their build. | ||
2334 | The class also performs basic user configuration checks from | ||
2335 | the <filename>local.conf</filename> configuration file to | ||
2336 | prevent common mistakes that cause build failures. | ||
2337 | Distribution policy usually determines whether to include this class. | ||
2338 | </para> | ||
2339 | </section> | ||
2340 | |||
2328 | <section id='ref-classes-scons'> | 2341 | <section id='ref-classes-scons'> |
2329 | <title><filename>scons.bbclass</filename></title> | 2342 | <title><filename>scons.bbclass</filename></title> |
2330 | 2343 | ||
@@ -2379,6 +2392,35 @@ | |||
2379 | </para> | 2392 | </para> |
2380 | </section> | 2393 | </section> |
2381 | 2394 | ||
2395 | <section id='ref-classes-siteinfo'> | ||
2396 | <title>Autotools Configuration Data Cache - <filename>siteinfo.bbclass</filename></title> | ||
2397 | |||
2398 | <para> | ||
2399 | Autotools can require tests that must execute on the target hardware. | ||
2400 | Since this is not possible in general when cross compiling, site information is | ||
2401 | used to provide cached test results so these tests can be skipped over but | ||
2402 | still make the correct values available. | ||
2403 | The <filename><link linkend='structure-meta-site'>meta/site directory</link></filename> | ||
2404 | contains test results sorted into different categories such as architecture, endianness, and | ||
2405 | the <filename>libc</filename> used. | ||
2406 | Site information provides a list of files containing data relevant to | ||
2407 | the current build in the | ||
2408 | <filename><link linkend='var-CONFIG_SITE'>CONFIG_SITE</link></filename> variable | ||
2409 | that Autotools automatically picks up. | ||
2410 | </para> | ||
2411 | |||
2412 | <para> | ||
2413 | The class also provides variables like | ||
2414 | <filename><link linkend='var-SITEINFO_ENDIANNESS'>SITEINFO_ENDIANNESS</link></filename> | ||
2415 | and <filename><link linkend='var-SITEINFO_BITS'>SITEINFO_BITS</link></filename> | ||
2416 | that can be used elsewhere in the metadata. | ||
2417 | </para> | ||
2418 | |||
2419 | <para> | ||
2420 | Because this class is included from <filename>base.bbclass</filename>, it is always active. | ||
2421 | </para> | ||
2422 | </section> | ||
2423 | |||
2382 | <section id='ref-classes-spdx'> | 2424 | <section id='ref-classes-spdx'> |
2383 | <title><filename>spdx.bbclass</filename></title> | 2425 | <title><filename>spdx.bbclass</filename></title> |
2384 | 2426 | ||
@@ -2522,48 +2564,6 @@ | |||
2522 | </para> | 2564 | </para> |
2523 | </section> | 2565 | </section> |
2524 | 2566 | ||
2525 | <section id='ref-classes-sanity'> | ||
2526 | <title>Host System Sanity Checks - <filename>sanity.bbclass</filename></title> | ||
2527 | |||
2528 | <para> | ||
2529 | This class checks to see if prerequisite software is present on the host system | ||
2530 | so that users can be notified of potential problems that might affect their build. | ||
2531 | The class also performs basic user configuration checks from | ||
2532 | the <filename>local.conf</filename> configuration file to | ||
2533 | prevent common mistakes that cause build failures. | ||
2534 | Distribution policy usually determines whether to include this class. | ||
2535 | </para> | ||
2536 | </section> | ||
2537 | |||
2538 | <section id='ref-classes-siteinfo'> | ||
2539 | <title>Autotools Configuration Data Cache - <filename>siteinfo.bbclass</filename></title> | ||
2540 | |||
2541 | <para> | ||
2542 | Autotools can require tests that must execute on the target hardware. | ||
2543 | Since this is not possible in general when cross compiling, site information is | ||
2544 | used to provide cached test results so these tests can be skipped over but | ||
2545 | still make the correct values available. | ||
2546 | The <filename><link linkend='structure-meta-site'>meta/site directory</link></filename> | ||
2547 | contains test results sorted into different categories such as architecture, endianness, and | ||
2548 | the <filename>libc</filename> used. | ||
2549 | Site information provides a list of files containing data relevant to | ||
2550 | the current build in the | ||
2551 | <filename><link linkend='var-CONFIG_SITE'>CONFIG_SITE</link></filename> variable | ||
2552 | that Autotools automatically picks up. | ||
2553 | </para> | ||
2554 | |||
2555 | <para> | ||
2556 | The class also provides variables like | ||
2557 | <filename><link linkend='var-SITEINFO_ENDIANNESS'>SITEINFO_ENDIANNESS</link></filename> | ||
2558 | and <filename><link linkend='var-SITEINFO_BITS'>SITEINFO_BITS</link></filename> | ||
2559 | that can be used elsewhere in the metadata. | ||
2560 | </para> | ||
2561 | |||
2562 | <para> | ||
2563 | Because this class is included from <filename>base.bbclass</filename>, it is always active. | ||
2564 | </para> | ||
2565 | </section> | ||
2566 | |||
2567 | <section id='ref-classes-terminal'> | 2567 | <section id='ref-classes-terminal'> |
2568 | <title><filename>terminal.bbclass</filename></title> | 2568 | <title><filename>terminal.bbclass</filename></title> |
2569 | 2569 | ||