diff options
| -rw-r--r-- | bitbake/doc/user-manual/user-manual-ref-variables.xml | 146 |
1 files changed, 39 insertions, 107 deletions
diff --git a/bitbake/doc/user-manual/user-manual-ref-variables.xml b/bitbake/doc/user-manual/user-manual-ref-variables.xml index 7d821ed267..b9db594131 100644 --- a/bitbake/doc/user-manual/user-manual-ref-variables.xml +++ b/bitbake/doc/user-manual/user-manual-ref-variables.xml | |||
| @@ -48,7 +48,7 @@ | |||
| 48 | <glossentry id='var-ASSUME_PROVIDED'><glossterm>ASSUME_PROVIDED</glossterm> | 48 | <glossentry id='var-ASSUME_PROVIDED'><glossterm>ASSUME_PROVIDED</glossterm> |
| 49 | <glossdef> | 49 | <glossdef> |
| 50 | <para> | 50 | <para> |
| 51 | Recipe names | 51 | Lists recipe names |
| 52 | (<link linkend='var-PN'><filename>PN</filename></link> | 52 | (<link linkend='var-PN'><filename>PN</filename></link> |
| 53 | values) BitBake does not attempt to build. | 53 | values) BitBake does not attempt to build. |
| 54 | Instead, BitBake assumes these recipes have already been | 54 | Instead, BitBake assumes these recipes have already been |
| @@ -56,11 +56,12 @@ | |||
| 56 | </para> | 56 | </para> |
| 57 | 57 | ||
| 58 | <para> | 58 | <para> |
| 59 | <filename>ASSUMED_PROVIDED</filename> often specifies | 59 | In OpenEmbedded Core, <filename>ASSUME_PROVIDED</filename> |
| 60 | native tools. | 60 | mostly specifies native tools that should not be built. |
| 61 | A good example is <filename>git-native</filename>, which | 61 | An example is <filename>git-native</filename>, which |
| 62 | allows for the the Git binary from the host to be used | 62 | when specified allows for the Git binary from the host to |
| 63 | rather than building <filename>git-native</filename>. | 63 | be used rather than building |
| 64 | <filename>git-native</filename>. | ||
| 64 | </para> | 65 | </para> |
| 65 | </glossdef> | 66 | </glossdef> |
| 66 | </glossentry> | 67 | </glossentry> |
| @@ -108,7 +109,6 @@ | |||
| 108 | It is important to realize when your changes are no longer | 109 | It is important to realize when your changes are no longer |
| 109 | being applied. | 110 | being applied. |
| 110 | </para> | 111 | </para> |
| 111 | |||
| 112 | </glossdef> | 112 | </glossdef> |
| 113 | </glossentry> | 113 | </glossentry> |
| 114 | 114 | ||
| @@ -490,6 +490,18 @@ | |||
| 490 | </glossdef> | 490 | </glossdef> |
| 491 | </glossentry> | 491 | </glossentry> |
| 492 | 492 | ||
| 493 | <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm> | ||
| 494 | <glossdef> | ||
| 495 | <para> | ||
| 496 | The maximum number of tasks BitBake should run in parallel | ||
| 497 | at any one time. | ||
| 498 | If your host development system supports multiple cores, | ||
| 499 | a good rule of thumb is to set this variable to twice the | ||
| 500 | number of cores. | ||
| 501 | </para> | ||
| 502 | </glossdef> | ||
| 503 | </glossentry> | ||
| 504 | |||
| 493 | <glossentry id='var-BB_NUMBER_PARSE_THREADS'><glossterm>BB_NUMBER_PARSE_THREADS</glossterm> | 505 | <glossentry id='var-BB_NUMBER_PARSE_THREADS'><glossterm>BB_NUMBER_PARSE_THREADS</glossterm> |
| 494 | <glossdef> | 506 | <glossdef> |
| 495 | <para> | 507 | <para> |
| @@ -530,14 +542,6 @@ | |||
| 530 | </glossdef> | 542 | </glossdef> |
| 531 | </glossentry> | 543 | </glossentry> |
| 532 | 544 | ||
| 533 | <glossentry id='var-BB_NUMBER_THREADS'><glossterm>BB_NUMBER_THREADS</glossterm> | ||
| 534 | <glossdef> | ||
| 535 | <para>The maximum number of tasks BitBake should run in parallel at any one time. | ||
| 536 | If your host development system supports multiple cores, a good rule of thumb | ||
| 537 | is to set this variable to twice the number of cores.</para> | ||
| 538 | </glossdef> | ||
| 539 | </glossentry> | ||
| 540 | |||
| 541 | <glossentry id='var-BB_RUNFMT'><glossterm>BB_RUNFMT</glossterm> | 545 | <glossentry id='var-BB_RUNFMT'><glossterm>BB_RUNFMT</glossterm> |
| 542 | <glossdef> | 546 | <glossdef> |
| 543 | <para> | 547 | <para> |
| @@ -818,19 +822,27 @@ | |||
| 818 | <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm> | 822 | <glossentry id='var-BBCLASSEXTEND'><glossterm>BBCLASSEXTEND</glossterm> |
| 819 | <glossdef> | 823 | <glossdef> |
| 820 | <para> | 824 | <para> |
| 821 | Allows you to extend a recipe so that it builds variants of the software. | 825 | Allows you to extend a recipe so that it builds variants |
| 822 | Common variants for recipes exist such as "natives" like <filename>quilt-native</filename>, | 826 | of the software. |
| 827 | Common variants for recipes exist such as "natives" | ||
| 828 | like <filename>quilt-native</filename>, | ||
| 823 | which is a copy of Quilt built to run on the build system; | 829 | which is a copy of Quilt built to run on the build system; |
| 824 | "crosses" such as <filename>gcc-cross</filename>, | 830 | "crosses" such as <filename>gcc-cross</filename>, |
| 825 | which is a compiler built to run on the build machine but produces binaries | 831 | which is a compiler built to run on the build machine |
| 826 | that run on the target <filename>MACHINE</filename>; | 832 | but produces binaries that run on the target |
| 827 | "nativesdk", which targets the SDK machine instead of <filename>MACHINE</filename>; | 833 | <filename>MACHINE</filename>; "nativesdk", which targets |
| 828 | and "mulitlibs" in the form "<filename>multilib:<multilib_name></filename>". | 834 | the SDK machine instead of <filename>MACHINE</filename>; |
| 835 | and "mulitlibs" in the form | ||
| 836 | "<filename>multilib:<multilib_name></filename>". | ||
| 829 | </para> | 837 | </para> |
| 830 | 838 | ||
| 831 | <para> | 839 | <para> |
| 832 | To build a different variant of the recipe with a minimal amount of code, it usually | 840 | To build a different variant of the recipe with a minimal |
| 833 | is as simple as adding the following to your recipe: | 841 | amount of code, it usually is as simple as adding the |
| 842 | variable to your recipe. | ||
| 843 | Here are two examples. | ||
| 844 | The "native" variants are from the OpenEmbedded Core | ||
| 845 | metadata: | ||
| 834 | <literallayout class='monospaced'> | 846 | <literallayout class='monospaced'> |
| 835 | BBCLASSEXTEND =+ "native nativesdk" | 847 | BBCLASSEXTEND =+ "native nativesdk" |
| 836 | BBCLASSEXTEND =+ "multilib:<multilib_name>" | 848 | BBCLASSEXTEND =+ "multilib:<multilib_name>" |
| @@ -1511,9 +1523,6 @@ | |||
| 1511 | through the <filename>PACKAGES_DYNAMIC</filename> | 1523 | through the <filename>PACKAGES_DYNAMIC</filename> |
| 1512 | variable, but a package with the module name is never actually | 1524 | variable, but a package with the module name is never actually |
| 1513 | produced, then the other package will be broken. | 1525 | produced, then the other package will be broken. |
| 1514 | Thus, if you attempt to include that package in an image, | ||
| 1515 | you will get a dependency failure from the packaging system | ||
| 1516 | during <filename>do_rootfs</filename>. | ||
| 1517 | </para> | 1526 | </para> |
| 1518 | </glossdef> | 1527 | </glossdef> |
| 1519 | </glossentry> | 1528 | </glossentry> |
| @@ -1860,7 +1869,8 @@ | |||
| 1860 | 1869 | ||
| 1861 | <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm> | 1870 | <glossentry id='var-SRC_URI'><glossterm>SRC_URI</glossterm> |
| 1862 | <glossdef> | 1871 | <glossdef> |
| 1863 | <para>The list of source files - local or remote. | 1872 | <para> |
| 1873 | The list of source files - local or remote. | ||
| 1864 | This variable tells BitBake which bits | 1874 | This variable tells BitBake which bits |
| 1865 | to pull in for the build and how to pull them in. | 1875 | to pull in for the build and how to pull them in. |
| 1866 | For example, if the recipe or append file only needs to | 1876 | For example, if the recipe or append file only needs to |
| @@ -1880,41 +1890,7 @@ | |||
| 1880 | from the local machine. | 1890 | from the local machine. |
| 1881 | The path is relative to the | 1891 | The path is relative to the |
| 1882 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> | 1892 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> |
| 1883 | variable. | 1893 | variable.</para></listitem> |
| 1884 | Thus, the build system searches, in order, from the | ||
| 1885 | following directories, which are assumed to be a | ||
| 1886 | subdirectories of the directory in which the | ||
| 1887 | recipe file (<filename>.bb</filename>) or | ||
| 1888 | append file (<filename>.bbappend</filename>) | ||
| 1889 | resides: | ||
| 1890 | <itemizedlist> | ||
| 1891 | <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> | ||
| 1892 | The base recipe name without any special | ||
| 1893 | suffix or version numbers. | ||
| 1894 | </para></listitem> | ||
| 1895 | <listitem><para><emphasis><filename>${BP}</filename> -</emphasis> | ||
| 1896 | <filename>${BPN}-${PV}</filename>. | ||
| 1897 | The base recipe name and version but without | ||
| 1898 | any special package name suffix. | ||
| 1899 | </para></listitem> | ||
| 1900 | <listitem><para><emphasis>files -</emphasis> | ||
| 1901 | Files within a directory that is named | ||
| 1902 | <filename>files</filename> and is also | ||
| 1903 | alongside the recipe or append file. | ||
| 1904 | </para></listitem> | ||
| 1905 | </itemizedlist> | ||
| 1906 | <note> | ||
| 1907 | If you want the build system to pick up files | ||
| 1908 | specified through a | ||
| 1909 | <filename>SRC_URI</filename> | ||
| 1910 | statement from your append file, you need to be | ||
| 1911 | sure to extend the | ||
| 1912 | <filename>FILESPATH</filename> | ||
| 1913 | variable by also using the | ||
| 1914 | <filename>FILESEXTRAPATHS</filename> | ||
| 1915 | variable from within your append file. | ||
| 1916 | </note> | ||
| 1917 | </para></listitem> | ||
| 1918 | <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a | 1894 | <listitem><para><emphasis><filename>bzr://</filename> -</emphasis> Fetches files from a |
| 1919 | Bazaar revision control repository.</para></listitem> | 1895 | Bazaar revision control repository.</para></listitem> |
| 1920 | <listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a | 1896 | <listitem><para><emphasis><filename>git://</filename> -</emphasis> Fetches files from a |
| @@ -1943,50 +1919,6 @@ | |||
| 1943 | a Subversion (<filename>svn</filename>) revision control repository.</para></listitem> | 1919 | a Subversion (<filename>svn</filename>) revision control repository.</para></listitem> |
| 1944 | </itemizedlist> | 1920 | </itemizedlist> |
| 1945 | </para> | 1921 | </para> |
| 1946 | <para>Standard and recipe-specific options for <filename>SRC_URI</filename> exist. | ||
| 1947 | Here are standard options: | ||
| 1948 | <itemizedlist> | ||
| 1949 | <listitem><para><emphasis><filename>apply</filename> -</emphasis> Whether to apply | ||
| 1950 | the patch or not. | ||
| 1951 | The default action is to apply the patch.</para></listitem> | ||
| 1952 | <listitem><para><emphasis><filename>striplevel</filename> -</emphasis> Which | ||
| 1953 | striplevel to use when applying the patch. | ||
| 1954 | The default level is 1.</para></listitem> | ||
| 1955 | <listitem><para><emphasis><filename>patchdir</filename> -</emphasis> Specifies | ||
| 1956 | the directory in which the patch should be applied. | ||
| 1957 | The default is <filename>${S}</filename>. | ||
| 1958 | </para></listitem> | ||
| 1959 | </itemizedlist> | ||
| 1960 | </para> | ||
| 1961 | <para>Here are options specific to recipes building code from a revision control system: | ||
| 1962 | <itemizedlist> | ||
| 1963 | <listitem><para><emphasis><filename>mindate</filename> -</emphasis> | ||
| 1964 | Apply the patch only if | ||
| 1965 | <link linkend='var-SRCDATE'><filename>SRCDATE</filename></link> | ||
| 1966 | is equal to or greater than <filename>mindate</filename>. | ||
| 1967 | </para></listitem> | ||
| 1968 | <listitem><para><emphasis><filename>maxdate</filename> -</emphasis> | ||
| 1969 | Apply the patch only if <filename>SRCDATE</filename> | ||
| 1970 | is not later than <filename>mindate</filename>. | ||
| 1971 | </para></listitem> | ||
| 1972 | <listitem><para><emphasis><filename>minrev</filename> -</emphasis> | ||
| 1973 | Apply the patch only if <filename>SRCREV</filename> | ||
| 1974 | is equal to or greater than <filename>minrev</filename>. | ||
| 1975 | </para></listitem> | ||
| 1976 | <listitem><para><emphasis><filename>maxrev</filename> -</emphasis> | ||
| 1977 | Apply the patch only if <filename>SRCREV</filename> | ||
| 1978 | is not later than <filename>maxrev</filename>. | ||
| 1979 | </para></listitem> | ||
| 1980 | <listitem><para><emphasis><filename>rev</filename> -</emphasis> | ||
| 1981 | Apply the patch only if <filename>SRCREV</filename> | ||
| 1982 | is equal to <filename>rev</filename>. | ||
| 1983 | </para></listitem> | ||
| 1984 | <listitem><para><emphasis><filename>notrev</filename> -</emphasis> | ||
| 1985 | Apply the patch only if <filename>SRCREV</filename> | ||
| 1986 | is not equal to <filename>rev</filename>. | ||
| 1987 | </para></listitem> | ||
| 1988 | </itemizedlist> | ||
| 1989 | </para> | ||
| 1990 | <para>Here are some additional options worth mentioning: | 1922 | <para>Here are some additional options worth mentioning: |
| 1991 | <itemizedlist> | 1923 | <itemizedlist> |
| 1992 | <listitem><para><emphasis><filename>unpack</filename> -</emphasis> Controls | 1924 | <listitem><para><emphasis><filename>unpack</filename> -</emphasis> Controls |
| @@ -1994,7 +1926,7 @@ | |||
| 1994 | The default action is to unpack the file.</para></listitem> | 1926 | The default action is to unpack the file.</para></listitem> |
| 1995 | <listitem><para><emphasis><filename>subdir</filename> -</emphasis> Places the file | 1927 | <listitem><para><emphasis><filename>subdir</filename> -</emphasis> Places the file |
| 1996 | (or extracts its contents) into the specified | 1928 | (or extracts its contents) into the specified |
| 1997 | subdirectory of <filename>WORKDIR</filename>. | 1929 | subdirectory. |
| 1998 | This option is useful for unusual tarballs or other archives that | 1930 | This option is useful for unusual tarballs or other archives that |
| 1999 | do not have their files already in a subdirectory within the archive. | 1931 | do not have their files already in a subdirectory within the archive. |
| 2000 | </para></listitem> | 1932 | </para></listitem> |
