diff options
Diffstat (limited to 'bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml')
-rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml | 78 |
1 files changed, 39 insertions, 39 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml index 2490f6e4ba..d00f8a545f 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml | |||
@@ -595,7 +595,7 @@ | |||
595 | 595 | ||
596 | <para> | 596 | <para> |
597 | BitBake uses | 597 | BitBake uses |
598 | <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> | 598 | <link linkend='var-bb-OVERRIDES'><filename>OVERRIDES</filename></link> |
599 | to control what variables are overridden after BitBake | 599 | to control what variables are overridden after BitBake |
600 | parses recipes and configuration files. | 600 | parses recipes and configuration files. |
601 | This section describes how you can use | 601 | This section describes how you can use |
@@ -705,7 +705,7 @@ | |||
705 | 705 | ||
706 | <para>Internally, this is implemented by prepending | 706 | <para>Internally, this is implemented by prepending |
707 | the task (e.g. "task-compile:") to the value of | 707 | the task (e.g. "task-compile:") to the value of |
708 | <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> | 708 | <link linkend='var-bb-OVERRIDES'><filename>OVERRIDES</filename></link> |
709 | for the local datastore of the <filename>do_compile</filename> | 709 | for the local datastore of the <filename>do_compile</filename> |
710 | task.</para> | 710 | task.</para> |
711 | 711 | ||
@@ -868,7 +868,7 @@ | |||
868 | 868 | ||
869 | <para> | 869 | <para> |
870 | BitBake uses the | 870 | BitBake uses the |
871 | <link linkend='var-BBPATH'><filename>BBPATH</filename></link> | 871 | <link linkend='var-bb-BBPATH'><filename>BBPATH</filename></link> |
872 | variable to locate needed include and class files. | 872 | variable to locate needed include and class files. |
873 | Additionally, BitBake searches the current directory for | 873 | Additionally, BitBake searches the current directory for |
874 | <filename>include</filename> and <filename>require</filename> | 874 | <filename>include</filename> and <filename>require</filename> |
@@ -1086,7 +1086,7 @@ | |||
1086 | <para> | 1086 | <para> |
1087 | When creating a configuration file (<filename>.conf</filename>), | 1087 | When creating a configuration file (<filename>.conf</filename>), |
1088 | you can use the | 1088 | you can use the |
1089 | <link linkend='var-INHERIT'><filename>INHERIT</filename></link> | 1089 | <link linkend='var-bb-INHERIT'><filename>INHERIT</filename></link> |
1090 | configuration directive to inherit a class. | 1090 | configuration directive to inherit a class. |
1091 | BitBake only supports this directive when used within | 1091 | BitBake only supports this directive when used within |
1092 | a configuration file. | 1092 | a configuration file. |
@@ -1370,7 +1370,7 @@ | |||
1370 | </para></listitem> | 1370 | </para></listitem> |
1371 | <listitem><para> | 1371 | <listitem><para> |
1372 | BitBake-style Python functions generate a separate | 1372 | BitBake-style Python functions generate a separate |
1373 | <filename>${</filename><link linkend='var-T'><filename>T</filename></link><filename>}/run.</filename><replaceable>function-name</replaceable><filename>.</filename><replaceable>pid</replaceable> | 1373 | <filename>${</filename><link linkend='var-bb-T'><filename>T</filename></link><filename>}/run.</filename><replaceable>function-name</replaceable><filename>.</filename><replaceable>pid</replaceable> |
1374 | script that is executed to run the function, and also | 1374 | script that is executed to run the function, and also |
1375 | generate a log file in | 1375 | generate a log file in |
1376 | <filename>${T}/log.</filename><replaceable>function-name</replaceable><filename>.</filename><replaceable>pid</replaceable> | 1376 | <filename>${T}/log.</filename><replaceable>function-name</replaceable><filename>.</filename><replaceable>pid</replaceable> |
@@ -1773,7 +1773,7 @@ | |||
1773 | things exported or listed in its whitelist to ensure that the build | 1773 | things exported or listed in its whitelist to ensure that the build |
1774 | environment is reproducible and consistent. | 1774 | environment is reproducible and consistent. |
1775 | You can prevent this "cleaning" by setting the | 1775 | You can prevent this "cleaning" by setting the |
1776 | <link linkend='var-BB_PRESERVE_ENV'><filename>BB_PRESERVE_ENV</filename></link> | 1776 | <link linkend='var-bb-BB_PRESERVE_ENV'><filename>BB_PRESERVE_ENV</filename></link> |
1777 | variable. | 1777 | variable. |
1778 | </note> | 1778 | </note> |
1779 | Consequently, if you do want something to get passed into the | 1779 | Consequently, if you do want something to get passed into the |
@@ -1783,9 +1783,9 @@ | |||
1783 | Tell BitBake to load what you want from the environment | 1783 | Tell BitBake to load what you want from the environment |
1784 | into the datastore. | 1784 | into the datastore. |
1785 | You can do so through the | 1785 | You can do so through the |
1786 | <link linkend='var-BB_ENV_WHITELIST'><filename>BB_ENV_WHITELIST</filename></link> | 1786 | <link linkend='var-bb-BB_ENV_WHITELIST'><filename>BB_ENV_WHITELIST</filename></link> |
1787 | and | 1787 | and |
1788 | <link linkend='var-BB_ENV_EXTRAWHITE'><filename>BB_ENV_EXTRAWHITE</filename></link> | 1788 | <link linkend='var-bb-BB_ENV_EXTRAWHITE'><filename>BB_ENV_EXTRAWHITE</filename></link> |
1789 | variables. | 1789 | variables. |
1790 | For example, assume you want to prevent the build system from | 1790 | For example, assume you want to prevent the build system from |
1791 | accessing your <filename>$HOME/.ccache</filename> | 1791 | accessing your <filename>$HOME/.ccache</filename> |
@@ -1824,7 +1824,7 @@ | |||
1824 | from the original execution environment. | 1824 | from the original execution environment. |
1825 | Bitbake saves a copy of the original environment into | 1825 | Bitbake saves a copy of the original environment into |
1826 | a special variable named | 1826 | a special variable named |
1827 | <link linkend='var-BB_ORIGENV'><filename>BB_ORIGENV</filename></link>. | 1827 | <link linkend='var-bb-BB_ORIGENV'><filename>BB_ORIGENV</filename></link>. |
1828 | </para> | 1828 | </para> |
1829 | 1829 | ||
1830 | <para> | 1830 | <para> |
@@ -1883,7 +1883,7 @@ | |||
1883 | <listitem><para><emphasis><filename>[depends]</filename>:</emphasis> | 1883 | <listitem><para><emphasis><filename>[depends]</filename>:</emphasis> |
1884 | Controls inter-task dependencies. | 1884 | Controls inter-task dependencies. |
1885 | See the | 1885 | See the |
1886 | <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> | 1886 | <link linkend='var-bb-DEPENDS'><filename>DEPENDS</filename></link> |
1887 | variable and the | 1887 | variable and the |
1888 | "<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>" | 1888 | "<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>" |
1889 | section for more information. | 1889 | section for more information. |
@@ -1891,7 +1891,7 @@ | |||
1891 | <listitem><para><emphasis><filename>[deptask]</filename>:</emphasis> | 1891 | <listitem><para><emphasis><filename>[deptask]</filename>:</emphasis> |
1892 | Controls task build-time dependencies. | 1892 | Controls task build-time dependencies. |
1893 | See the | 1893 | See the |
1894 | <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> | 1894 | <link linkend='var-bb-DEPENDS'><filename>DEPENDS</filename></link> |
1895 | variable and the | 1895 | variable and the |
1896 | "<link linkend='build-dependencies'>Build Dependencies</link>" | 1896 | "<link linkend='build-dependencies'>Build Dependencies</link>" |
1897 | section for more information. | 1897 | section for more information. |
@@ -1937,7 +1937,7 @@ | |||
1937 | of cores but certain tasks need to be rate-limited due to various | 1937 | of cores but certain tasks need to be rate-limited due to various |
1938 | kinds of resource constraints (e.g. to avoid network throttling). | 1938 | kinds of resource constraints (e.g. to avoid network throttling). |
1939 | <filename>number_threads</filename> works similarly to the | 1939 | <filename>number_threads</filename> works similarly to the |
1940 | <link linkend='var-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> | 1940 | <link linkend='var-bb-BB_NUMBER_THREADS'><filename>BB_NUMBER_THREADS</filename></link> |
1941 | variable but is task-specific.</para> | 1941 | variable but is task-specific.</para> |
1942 | 1942 | ||
1943 | <para>Set the value globally. | 1943 | <para>Set the value globally. |
@@ -1971,9 +1971,9 @@ | |||
1971 | <listitem><para><emphasis><filename>[rdepends]</filename>:</emphasis> | 1971 | <listitem><para><emphasis><filename>[rdepends]</filename>:</emphasis> |
1972 | Controls inter-task runtime dependencies. | 1972 | Controls inter-task runtime dependencies. |
1973 | See the | 1973 | See the |
1974 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> | 1974 | <link linkend='var-bb-RDEPENDS'><filename>RDEPENDS</filename></link> |
1975 | variable, the | 1975 | variable, the |
1976 | <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> | 1976 | <link linkend='var-bb-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> |
1977 | variable, and the | 1977 | variable, and the |
1978 | "<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>" | 1978 | "<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>" |
1979 | section for more information. | 1979 | section for more information. |
@@ -1981,9 +1981,9 @@ | |||
1981 | <listitem><para><emphasis><filename>[rdeptask]</filename>:</emphasis> | 1981 | <listitem><para><emphasis><filename>[rdeptask]</filename>:</emphasis> |
1982 | Controls task runtime dependencies. | 1982 | Controls task runtime dependencies. |
1983 | See the | 1983 | See the |
1984 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> | 1984 | <link linkend='var-bb-RDEPENDS'><filename>RDEPENDS</filename></link> |
1985 | variable, the | 1985 | variable, the |
1986 | <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> | 1986 | <link linkend='var-bb-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> |
1987 | variable, and the | 1987 | variable, and the |
1988 | "<link linkend='runtime-dependencies'>Runtime Dependencies</link>" | 1988 | "<link linkend='runtime-dependencies'>Runtime Dependencies</link>" |
1989 | section for more information. | 1989 | section for more information. |
@@ -1996,9 +1996,9 @@ | |||
1996 | <listitem><para><emphasis><filename>[recrdeptask]</filename>:</emphasis> | 1996 | <listitem><para><emphasis><filename>[recrdeptask]</filename>:</emphasis> |
1997 | Controls task recursive runtime dependencies. | 1997 | Controls task recursive runtime dependencies. |
1998 | See the | 1998 | See the |
1999 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> | 1999 | <link linkend='var-bb-RDEPENDS'><filename>RDEPENDS</filename></link> |
2000 | variable, the | 2000 | variable, the |
2001 | <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> | 2001 | <link linkend='var-bb-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> |
2002 | variable, and the | 2002 | variable, and the |
2003 | "<link linkend='recursive-dependencies'>Recursive Dependencies</link>" | 2003 | "<link linkend='recursive-dependencies'>Recursive Dependencies</link>" |
2004 | section for more information. | 2004 | section for more information. |
@@ -2127,7 +2127,7 @@ | |||
2127 | Any given datastore only has one such event executed | 2127 | Any given datastore only has one such event executed |
2128 | against it, however. | 2128 | against it, however. |
2129 | If | 2129 | If |
2130 | <link linkende='var-BB_INVALIDCONF'><filename>BB_INVALIDCONF</filename></link> | 2130 | <link linkende='var-bb-BB_INVALIDCONF'><filename>BB_INVALIDCONF</filename></link> |
2131 | is set in the datastore by the event handler, the | 2131 | is set in the datastore by the event handler, the |
2132 | configuration is reparsed and a new event triggered, | 2132 | configuration is reparsed and a new event triggered, |
2133 | allowing the metadata to update configuration. | 2133 | allowing the metadata to update configuration. |
@@ -2256,17 +2256,17 @@ | |||
2256 | from a single recipe file multiple incarnations of that | 2256 | from a single recipe file multiple incarnations of that |
2257 | recipe file where all incarnations are buildable. | 2257 | recipe file where all incarnations are buildable. |
2258 | These features are enabled through the | 2258 | These features are enabled through the |
2259 | <link linkend='var-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> | 2259 | <link linkend='var-bb-BBCLASSEXTEND'><filename>BBCLASSEXTEND</filename></link> |
2260 | and | 2260 | and |
2261 | <link linkend='var-BBVERSIONS'><filename>BBVERSIONS</filename></link> | 2261 | <link linkend='var-bb-BBVERSIONS'><filename>BBVERSIONS</filename></link> |
2262 | variables. | 2262 | variables. |
2263 | <note> | 2263 | <note> |
2264 | The mechanism for this class extension is extremely | 2264 | The mechanism for this class extension is extremely |
2265 | specific to the implementation. | 2265 | specific to the implementation. |
2266 | Usually, the recipe's | 2266 | Usually, the recipe's |
2267 | <link linkend='var-PROVIDES'><filename>PROVIDES</filename></link>, | 2267 | <link linkend='var-bb-PROVIDES'><filename>PROVIDES</filename></link>, |
2268 | <link linkend='var-PN'><filename>PN</filename></link>, and | 2268 | <link linkend='var-bb-PN'><filename>PN</filename></link>, and |
2269 | <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> | 2269 | <link linkend='var-bb-DEPENDS'><filename>DEPENDS</filename></link> |
2270 | variables would need to be modified by the extension class. | 2270 | variables would need to be modified by the extension class. |
2271 | For specific examples, see the OE-Core | 2271 | For specific examples, see the OE-Core |
2272 | <filename>native</filename>, <filename>nativesdk</filename>, | 2272 | <filename>native</filename>, <filename>nativesdk</filename>, |
@@ -2287,7 +2287,7 @@ | |||
2287 | project from a single recipe file. | 2287 | project from a single recipe file. |
2288 | You can also specify conditional metadata | 2288 | You can also specify conditional metadata |
2289 | (using the | 2289 | (using the |
2290 | <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> | 2290 | <link linkend='var-bb-OVERRIDES'><filename>OVERRIDES</filename></link> |
2291 | mechanism) for a single version, or an optionally named range of versions. | 2291 | mechanism) for a single version, or an optionally named range of versions. |
2292 | Here is an example: | 2292 | Here is an example: |
2293 | <literallayout class='monospaced'> | 2293 | <literallayout class='monospaced'> |
@@ -2306,7 +2306,7 @@ | |||
2306 | into overrides, but it is also made available for the metadata to use | 2306 | into overrides, but it is also made available for the metadata to use |
2307 | in the variable that defines the base recipe versions for use in | 2307 | in the variable that defines the base recipe versions for use in |
2308 | <filename>file://</filename> search paths | 2308 | <filename>file://</filename> search paths |
2309 | (<link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>). | 2309 | (<link linkend='var-bb-FILESPATH'><filename>FILESPATH</filename></link>). |
2310 | </para></listitem> | 2310 | </para></listitem> |
2311 | </itemizedlist> | 2311 | </itemizedlist> |
2312 | </para> | 2312 | </para> |
@@ -2408,7 +2408,7 @@ | |||
2408 | 2408 | ||
2409 | <para> | 2409 | <para> |
2410 | BitBake uses the | 2410 | BitBake uses the |
2411 | <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> | 2411 | <link linkend='var-bb-DEPENDS'><filename>DEPENDS</filename></link> |
2412 | variable to manage build time dependencies. | 2412 | variable to manage build time dependencies. |
2413 | The <filename>[deptask]</filename> varflag for tasks | 2413 | The <filename>[deptask]</filename> varflag for tasks |
2414 | signifies the task of each | 2414 | signifies the task of each |
@@ -2429,9 +2429,9 @@ | |||
2429 | 2429 | ||
2430 | <para> | 2430 | <para> |
2431 | BitBake uses the | 2431 | BitBake uses the |
2432 | <link linkend='var-PACKAGES'><filename>PACKAGES</filename></link>, | 2432 | <link linkend='var-bb-PACKAGES'><filename>PACKAGES</filename></link>, |
2433 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>, and | 2433 | <link linkend='var-bb-RDEPENDS'><filename>RDEPENDS</filename></link>, and |
2434 | <link linkend='var-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> | 2434 | <link linkend='var-bb-RRECOMMENDS'><filename>RRECOMMENDS</filename></link> |
2435 | variables to manage runtime dependencies. | 2435 | variables to manage runtime dependencies. |
2436 | </para> | 2436 | </para> |
2437 | 2437 | ||
@@ -2686,7 +2686,7 @@ | |||
2686 | 2686 | ||
2687 | <para> | 2687 | <para> |
2688 | These checksums are stored in | 2688 | These checksums are stored in |
2689 | <link linkend='var-STAMP'><filename>STAMP</filename></link>. | 2689 | <link linkend='var-bb-STAMP'><filename>STAMP</filename></link>. |
2690 | You can examine the checksums using the following BitBake command: | 2690 | You can examine the checksums using the following BitBake command: |
2691 | <literallayout class='monospaced'> | 2691 | <literallayout class='monospaced'> |
2692 | $ bitbake-dumpsigs | 2692 | $ bitbake-dumpsigs |
@@ -2708,44 +2708,44 @@ | |||
2708 | The following list describes related variables: | 2708 | The following list describes related variables: |
2709 | <itemizedlist> | 2709 | <itemizedlist> |
2710 | <listitem><para> | 2710 | <listitem><para> |
2711 | <link linkend='var-BB_HASHCHECK_FUNCTION'><filename>BB_HASHCHECK_FUNCTION</filename></link>: | 2711 | <link linkend='var-bb-BB_HASHCHECK_FUNCTION'><filename>BB_HASHCHECK_FUNCTION</filename></link>: |
2712 | Specifies the name of the function to call during | 2712 | Specifies the name of the function to call during |
2713 | the "setscene" part of the task's execution in order | 2713 | the "setscene" part of the task's execution in order |
2714 | to validate the list of task hashes. | 2714 | to validate the list of task hashes. |
2715 | </para></listitem> | 2715 | </para></listitem> |
2716 | <listitem><para> | 2716 | <listitem><para> |
2717 | <link linkend='var-BB_SETSCENE_DEPVALID'><filename>BB_SETSCENE_DEPVALID</filename></link>: | 2717 | <link linkend='var-bb-BB_SETSCENE_DEPVALID'><filename>BB_SETSCENE_DEPVALID</filename></link>: |
2718 | Specifies a function BitBake calls that determines | 2718 | Specifies a function BitBake calls that determines |
2719 | whether BitBake requires a setscene dependency to | 2719 | whether BitBake requires a setscene dependency to |
2720 | be met. | 2720 | be met. |
2721 | </para></listitem> | 2721 | </para></listitem> |
2722 | <listitem><para> | 2722 | <listitem><para> |
2723 | <link linkend='var-BB_SETSCENE_VERIFY_FUNCTION2'><filename>BB_SETSCENE_VERIFY_FUNCTION2</filename></link>: | 2723 | <link linkend='var-bb-BB_SETSCENE_VERIFY_FUNCTION2'><filename>BB_SETSCENE_VERIFY_FUNCTION2</filename></link>: |
2724 | Specifies a function to call that verifies the list of | 2724 | Specifies a function to call that verifies the list of |
2725 | planned task execution before the main task execution | 2725 | planned task execution before the main task execution |
2726 | happens. | 2726 | happens. |
2727 | </para></listitem> | 2727 | </para></listitem> |
2728 | <listitem><para> | 2728 | <listitem><para> |
2729 | <link linkend='var-BB_STAMP_POLICY'><filename>BB_STAMP_POLICY</filename></link>: | 2729 | <link linkend='var-bb-BB_STAMP_POLICY'><filename>BB_STAMP_POLICY</filename></link>: |
2730 | Defines the mode for comparing timestamps of stamp files. | 2730 | Defines the mode for comparing timestamps of stamp files. |
2731 | </para></listitem> | 2731 | </para></listitem> |
2732 | <listitem><para> | 2732 | <listitem><para> |
2733 | <link linkend='var-BB_STAMP_WHITELIST'><filename>BB_STAMP_WHITELIST</filename></link>: | 2733 | <link linkend='var-bb-BB_STAMP_WHITELIST'><filename>BB_STAMP_WHITELIST</filename></link>: |
2734 | Lists stamp files that are looked at when the stamp policy | 2734 | Lists stamp files that are looked at when the stamp policy |
2735 | is "whitelist". | 2735 | is "whitelist". |
2736 | </para></listitem> | 2736 | </para></listitem> |
2737 | <listitem><para> | 2737 | <listitem><para> |
2738 | <link linkend='var-BB_TASKHASH'><filename>BB_TASKHASH</filename></link>: | 2738 | <link linkend='var-bb-BB_TASKHASH'><filename>BB_TASKHASH</filename></link>: |
2739 | Within an executing task, this variable holds the hash | 2739 | Within an executing task, this variable holds the hash |
2740 | of the task as returned by the currently enabled | 2740 | of the task as returned by the currently enabled |
2741 | signature generator. | 2741 | signature generator. |
2742 | </para></listitem> | 2742 | </para></listitem> |
2743 | <listitem><para> | 2743 | <listitem><para> |
2744 | <link linkend='var-STAMP'><filename>STAMP</filename></link>: | 2744 | <link linkend='var-bb-STAMP'><filename>STAMP</filename></link>: |
2745 | The base path to create stamp files. | 2745 | The base path to create stamp files. |
2746 | </para></listitem> | 2746 | </para></listitem> |
2747 | <listitem><para> | 2747 | <listitem><para> |
2748 | <link linkend='var-STAMPCLEAN'><filename>STAMPCLEAN</filename></link>: | 2748 | <link linkend='var-bb-STAMPCLEAN'><filename>STAMPCLEAN</filename></link>: |
2749 | Again, the base path to create stamp files but can use wildcards | 2749 | Again, the base path to create stamp files but can use wildcards |
2750 | for matching a range of files for clean operations. | 2750 | for matching a range of files for clean operations. |
2751 | </para></listitem> | 2751 | </para></listitem> |