diff options
Diffstat (limited to 'bitbake')
-rw-r--r-- | bitbake/doc/user-manual/user-manual-ref-variables.xml | 93 |
1 files changed, 47 insertions, 46 deletions
diff --git a/bitbake/doc/user-manual/user-manual-ref-variables.xml b/bitbake/doc/user-manual/user-manual-ref-variables.xml index 0f62a8d1b7..4a3080f841 100644 --- a/bitbake/doc/user-manual/user-manual-ref-variables.xml +++ b/bitbake/doc/user-manual/user-manual-ref-variables.xml | |||
@@ -55,7 +55,7 @@ | |||
55 | <glossentry id='var-B'><glossterm>B</glossterm> | 55 | <glossentry id='var-B'><glossterm>B</glossterm> |
56 | <glossdef> | 56 | <glossdef> |
57 | <para> | 57 | <para> |
58 | The directory in which BitBake will execute functions | 58 | The directory in which BitBake executes functions |
59 | during a recipe's build process. | 59 | during a recipe's build process. |
60 | </para> | 60 | </para> |
61 | </glossdef> | 61 | </glossdef> |
@@ -146,7 +146,7 @@ | |||
146 | below 1 Gbyte or the available free inodes drops below | 146 | below 1 Gbyte or the available free inodes drops below |
147 | 100 Kbytes. | 147 | 100 Kbytes. |
148 | Because two directories are provided with the variable, the | 148 | Because two directories are provided with the variable, the |
149 | build system also issue a | 149 | build system also issues a |
150 | warning when the disk space in the | 150 | warning when the disk space in the |
151 | <filename>${SSTATE_DIR}</filename> directory drops | 151 | <filename>${SSTATE_DIR}</filename> directory drops |
152 | below 1 Gbyte or the number of free inodes drops | 152 | below 1 Gbyte or the number of free inodes drops |
@@ -295,7 +295,7 @@ | |||
295 | <para>Lists the names of configured layers. | 295 | <para>Lists the names of configured layers. |
296 | These names are used to find the other <filename>BBFILE_*</filename> | 296 | These names are used to find the other <filename>BBFILE_*</filename> |
297 | variables. | 297 | variables. |
298 | Typically, each layer will append its name to this variable in its | 298 | Typically, each layer appends its name to this variable in its |
299 | <filename>conf/layer.conf</filename> file. | 299 | <filename>conf/layer.conf</filename> file. |
300 | </para> | 300 | </para> |
301 | </glossdef> | 301 | </glossdef> |
@@ -345,7 +345,7 @@ | |||
345 | 345 | ||
346 | <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm> | 346 | <glossentry id='var-BBFILES'><glossterm>BBFILES</glossterm> |
347 | <glossdef> | 347 | <glossdef> |
348 | <para>List of recipe files used by BitBake to build software.</para> | 348 | <para>List of recipe files BitBake uses to build software.</para> |
349 | </glossdef> | 349 | </glossdef> |
350 | </glossentry> | 350 | </glossentry> |
351 | 351 | ||
@@ -435,8 +435,9 @@ | |||
435 | <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm> | 435 | <glossentry id='var-BBPATH'><glossterm>BBPATH</glossterm> |
436 | <glossdef> | 436 | <glossdef> |
437 | <para> | 437 | <para> |
438 | Used by BitBake to locate | 438 | Used by BitBake to locate class |
439 | <filename>.bbclass</filename> and configuration files. | 439 | (<filename>.bbclass</filename>) and configuration |
440 | (<filename>.conf</filename>) files. | ||
440 | This variable is analogous to the | 441 | This variable is analogous to the |
441 | <filename>PATH</filename> variable. | 442 | <filename>PATH</filename> variable. |
442 | <note> | 443 | <note> |
@@ -645,17 +646,18 @@ | |||
645 | 646 | ||
646 | <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> | 647 | <glossentry id='var-LAYERDEPENDS'><glossterm>LAYERDEPENDS</glossterm> |
647 | <glossdef> | 648 | <glossdef> |
648 | <para>Lists the layers that this recipe depends upon, separated by spaces. | 649 | <para>Lists the layers, separated by spaces, upon which this recipe depends. |
649 | Optionally, you can specify a specific layer version for a dependency | 650 | Optionally, you can specify a specific layer version for a dependency |
650 | by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3" | 651 | by adding it to the end of the layer name with a colon, (e.g. "anotherlayer:3" |
651 | to be compared against | 652 | to be compared against |
652 | <link linkend='var-LAYERVERSION'><filename>LAYERVERSION</filename></link><filename>_anotherlayer</filename> | 653 | <link linkend='var-LAYERVERSION'><filename>LAYERVERSION</filename></link><filename>_anotherlayer</filename> |
653 | in this case). | 654 | in this case). |
654 | An error will be produced if any dependency is missing or | 655 | BitBake produces an error if any dependency is missing or |
655 | the version numbers do not match exactly (if specified). | 656 | the version numbers do not match exactly (if specified).</para> |
656 | This variable is used in the <filename>conf/layer.conf</filename> file | 657 | <para> |
657 | and must be suffixed with the name of the specific layer (e.g. | 658 | You use this variable in the <filename>conf/layer.conf</filename> file. |
658 | <filename>LAYERDEPENDS_mylayer</filename>).</para> | 659 | You must also use the specific layer name as a suffix |
660 | to the variable (e.g. <filename>LAYERDEPENDS_mylayer</filename>).</para> | ||
659 | </glossdef> | 661 | </glossdef> |
660 | </glossentry> | 662 | </glossentry> |
661 | 663 | ||
@@ -671,13 +673,14 @@ | |||
671 | <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm> | 673 | <glossentry id='var-LAYERVERSION'><glossterm>LAYERVERSION</glossterm> |
672 | <glossdef> | 674 | <glossdef> |
673 | <para>Optionally specifies the version of a layer as a single number. | 675 | <para>Optionally specifies the version of a layer as a single number. |
674 | You can use this within | 676 | You can use this variable within |
675 | <link linkend='var-LAYERDEPENDS'><filename>LAYERDEPENDS</filename></link> | 677 | <link linkend='var-LAYERDEPENDS'><filename>LAYERDEPENDS</filename></link> |
676 | for another layer in order to depend on a specific version | 678 | for another layer in order to depend on a specific version |
677 | of the layer. | 679 | of the layer.</para> |
678 | This variable is used in the <filename>conf/layer.conf</filename> file | 680 | <para> |
679 | and must be suffixed with the name of the specific layer (e.g. | 681 | You use this variable in the <filename>conf/layer.conf</filename> file. |
680 | <filename>LAYERVERSION_mylayer</filename>).</para> | 682 | You must also use the specific layer name as a suffix |
683 | to the variable (e.g. <filename>LAYERDEPENDS_mylayer</filename>).</para> | ||
681 | </glossdef> | 684 | </glossdef> |
682 | </glossentry> | 685 | </glossentry> |
683 | 686 | ||
@@ -696,7 +699,7 @@ | |||
696 | <glossentry id='var-MIRRORS'><glossterm>MIRRORS</glossterm> | 699 | <glossentry id='var-MIRRORS'><glossterm>MIRRORS</glossterm> |
697 | <glossdef> | 700 | <glossdef> |
698 | <para> | 701 | <para> |
699 | Specifies additional paths from which the BitBake gets source code. | 702 | Specifies additional paths from which BitBake gets source code. |
700 | When the build system searches for source code, it first | 703 | When the build system searches for source code, it first |
701 | tries the local download directory. | 704 | tries the local download directory. |
702 | If that location fails, the build system tries locations | 705 | If that location fails, the build system tries locations |
@@ -732,9 +735,9 @@ | |||
732 | what variables are overridden after BitBake parses | 735 | what variables are overridden after BitBake parses |
733 | recipes and configuration files. | 736 | recipes and configuration files. |
734 | You can find more information on how overrides are handled | 737 | You can find more information on how overrides are handled |
735 | in the BitBake Manual that is located at | 738 | in the |
736 | <filename>bitbake/doc/manual</filename> in the | 739 | "<link linkend='conditional-syntax-overrides'>Conditional Syntax (Overrides)</link>" |
737 | <ulink url='&YOCTO_DOCS_DEV_URL;#source-directory'>Source Directory</ulink>. | 740 | section. |
738 | </para> | 741 | </para> |
739 | </glossdef> | 742 | </glossdef> |
740 | </glossentry> | 743 | </glossentry> |
@@ -744,7 +747,7 @@ | |||
744 | 747 | ||
745 | <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> | 748 | <glossentry id='var-PACKAGES'><glossterm>PACKAGES</glossterm> |
746 | <glossdef> | 749 | <glossdef> |
747 | <para>The list of packages to be created from the recipe. | 750 | <para>The list of packages the recipe creates. |
748 | </para> | 751 | </para> |
749 | </glossdef> | 752 | </glossdef> |
750 | </glossentry> | 753 | </glossentry> |
@@ -759,8 +762,8 @@ | |||
759 | they should be satisfied. | 762 | they should be satisfied. |
760 | For example, if a hard, runtime dependency | 763 | For example, if a hard, runtime dependency |
761 | (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>) | 764 | (<link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link>) |
762 | of another package is satisfied | 765 | of another package is satisfied during the build |
763 | at build time through the <filename>PACKAGES_DYNAMIC</filename> | 766 | through the <filename>PACKAGES_DYNAMIC</filename> |
764 | variable, but a package with the module name is never actually | 767 | variable, but a package with the module name is never actually |
765 | produced, then the other package will be broken. | 768 | produced, then the other package will be broken. |
766 | Thus, if you attempt to include that package in an image, | 769 | Thus, if you attempt to include that package in an image, |
@@ -775,7 +778,7 @@ | |||
775 | <para> | 778 | <para> |
776 | The epoch of the recipe. | 779 | The epoch of the recipe. |
777 | By default, this variable is unset. | 780 | By default, this variable is unset. |
778 | The field is used to make upgrades possible when the | 781 | The variable is used to make upgrades possible when the |
779 | versioning scheme changes in some backwards incompatible | 782 | versioning scheme changes in some backwards incompatible |
780 | way. | 783 | way. |
781 | </para> | 784 | </para> |
@@ -831,7 +834,7 @@ | |||
831 | variable determines which recipe should be given preference. | 834 | variable determines which recipe should be given preference. |
832 | You must always suffix the variable with the | 835 | You must always suffix the variable with the |
833 | <link linkend='var-PN'><filename>PN</filename></link> | 836 | <link linkend='var-PN'><filename>PN</filename></link> |
834 | you want to select, and you should set the | 837 | you want to select, and you should set |
835 | <link linkend='var-PV'><filename>PV</filename></link> | 838 | <link linkend='var-PV'><filename>PV</filename></link> |
836 | accordingly for precedence. | 839 | accordingly for precedence. |
837 | You can use the "<filename>%</filename>" character as a | 840 | You can use the "<filename>%</filename>" character as a |
@@ -870,7 +873,7 @@ | |||
870 | </para> | 873 | </para> |
871 | 874 | ||
872 | <para> | 875 | <para> |
873 | Typically, you could add a specific server for the | 876 | Typically, you would add a specific server for the |
874 | build system to attempt before any others by adding | 877 | build system to attempt before any others by adding |
875 | something like the following to your configuration: | 878 | something like the following to your configuration: |
876 | <literallayout class='monospaced'> | 879 | <literallayout class='monospaced'> |
@@ -915,14 +918,13 @@ | |||
915 | </para> | 918 | </para> |
916 | 919 | ||
917 | <para> | 920 | <para> |
918 | An example of how the <filename>PRSERV_HOST</filename> variable is | 921 | Following is an example of how the <filename>PRSERV_HOST</filename> variable is |
919 | set: | 922 | set: |
920 | <literallayout class='monospaced'> | 923 | <literallayout class='monospaced'> |
921 | PRSERV_HOST = "localhost:0" | 924 | PRSERV_HOST = "localhost:0" |
922 | </literallayout> | 925 | </literallayout> |
923 | You must set the variable if you want to automatically | 926 | You must set the variable if you want to automatically |
924 | start a local | 927 | start a local PR service. |
925 | <ulink url='&YOCTO_DOCS_DEV_URL;#working-with-a-pr-service'>PR service</ulink>. | ||
926 | You can set <filename>PRSERV_HOST</filename> to other | 928 | You can set <filename>PRSERV_HOST</filename> to other |
927 | values to use a remote PR service. | 929 | values to use a remote PR service. |
928 | </para> | 930 | </para> |
@@ -1083,18 +1085,18 @@ | |||
1083 | to pull in for the build and how to pull them in. | 1085 | to pull in for the build and how to pull them in. |
1084 | For example, if the recipe or append file only needs to | 1086 | For example, if the recipe or append file only needs to |
1085 | fetch a tarball from the Internet, the recipe or | 1087 | fetch a tarball from the Internet, the recipe or |
1086 | append file uses a single <filename>SRC_URI</filename> | 1088 | append file uses a <filename>SRC_URI</filename> |
1087 | entry. | 1089 | entry that specifies just the tarball. |
1088 | On the other hand, if the recipe or append file needs to | 1090 | On the other hand, if the recipe or append file needs to |
1089 | fetch a tarball, apply two patches, and include a custom | 1091 | fetch a tarball, apply two patches, and include a custom |
1090 | file, the recipe or append file would include four | 1092 | file, the recipe or append file needs an |
1091 | instances of the variable.</para> | 1093 | <filename>SRC_URI</filename> variable that specifies all |
1094 | those sources.</para> | ||
1092 | <para>The following list explains the available URI protocols: | 1095 | <para>The following list explains the available URI protocols: |
1093 | <itemizedlist> | 1096 | <itemizedlist> |
1094 | <listitem><para><emphasis><filename>file://</filename> -</emphasis> | 1097 | <listitem><para><emphasis><filename>file://</filename> -</emphasis> |
1095 | Fetches files, which are usually files shipped with | 1098 | Fetches files, which are usually files shipped with |
1096 | the | 1099 | the metadata, |
1097 | <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>, | ||
1098 | from the local machine. | 1100 | from the local machine. |
1099 | The path is relative to the | 1101 | The path is relative to the |
1100 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> | 1102 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> |
@@ -1116,7 +1118,7 @@ | |||
1116 | any special package name suffix. | 1118 | any special package name suffix. |
1117 | </para></listitem> | 1119 | </para></listitem> |
1118 | <listitem><para><emphasis>files -</emphasis> | 1120 | <listitem><para><emphasis>files -</emphasis> |
1119 | Files within a directory, which is named | 1121 | Files within a directory that is named |
1120 | <filename>files</filename> and is also | 1122 | <filename>files</filename> and is also |
1121 | alongside the recipe or append file. | 1123 | alongside the recipe or append file. |
1122 | </para></listitem> | 1124 | </para></listitem> |
@@ -1144,11 +1146,11 @@ | |||
1144 | <listitem><para><emphasis><filename>svk://</filename> -</emphasis> Fetches files from | 1146 | <listitem><para><emphasis><filename>svk://</filename> -</emphasis> Fetches files from |
1145 | an SVK revision control repository.</para></listitem> | 1147 | an SVK revision control repository.</para></listitem> |
1146 | <listitem><para><emphasis><filename>http://</filename> -</emphasis> Fetches files from | 1148 | <listitem><para><emphasis><filename>http://</filename> -</emphasis> Fetches files from |
1147 | the Internet using <filename>http</filename>.</para></listitem> | 1149 | the Internet using HTTP.</para></listitem> |
1148 | <listitem><para><emphasis><filename>https://</filename> -</emphasis> Fetches files | 1150 | <listitem><para><emphasis><filename>https://</filename> -</emphasis> Fetches files |
1149 | from the Internet using <filename>https</filename>.</para></listitem> | 1151 | from the Internet using HTTPS.</para></listitem> |
1150 | <listitem><para><emphasis><filename>ftp://</filename> -</emphasis> Fetches files | 1152 | <listitem><para><emphasis><filename>ftp://</filename> -</emphasis> Fetches files |
1151 | from the Internet using <filename>ftp</filename>.</para></listitem> | 1153 | from the Internet using FTP.</para></listitem> |
1152 | <listitem><para><emphasis><filename>cvs://</filename> -</emphasis> Fetches files from | 1154 | <listitem><para><emphasis><filename>cvs://</filename> -</emphasis> Fetches files from |
1153 | a CVS revision control repository.</para></listitem> | 1155 | a CVS revision control repository.</para></listitem> |
1154 | <listitem><para><emphasis><filename>hg://</filename> -</emphasis> Fetches files from | 1156 | <listitem><para><emphasis><filename>hg://</filename> -</emphasis> Fetches files from |
@@ -1240,9 +1242,8 @@ | |||
1240 | <glossdef> | 1242 | <glossdef> |
1241 | <para> | 1243 | <para> |
1242 | The revision of the source code used to build the package. | 1244 | The revision of the source code used to build the package. |
1243 | This variable applies to Subversion, Git, Mercurial and Bazaar | 1245 | This variable applies only when using Subversion, Git, Mercurial and Bazaar. |
1244 | only. | 1246 | If you want to build a fixed revision and you want |
1245 | Note that if you wish to build a fixed revision and you wish | ||
1246 | to avoid performing a query on the remote repository every time | 1247 | to avoid performing a query on the remote repository every time |
1247 | BitBake parses your recipe, you should specify a <filename>SRCREV</filename> that is a | 1248 | BitBake parses your recipe, you should specify a <filename>SRCREV</filename> that is a |
1248 | full revision identifier and not just a tag. | 1249 | full revision identifier and not just a tag. |
@@ -1263,7 +1264,7 @@ | |||
1263 | <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm> | 1264 | <glossentry id='var-SUMMARY'><glossterm>SUMMARY</glossterm> |
1264 | <glossdef> | 1265 | <glossdef> |
1265 | <para> | 1266 | <para> |
1266 | A short (72 characters or less) summary for the recipe. | 1267 | A short summary for the recipe, which is 72 characters or less. |
1267 | </para> | 1268 | </para> |
1268 | </glossdef> | 1269 | </glossdef> |
1269 | </glossentry> | 1270 | </glossentry> |
@@ -1274,7 +1275,7 @@ | |||
1274 | 1275 | ||
1275 | <glossentry id='var-T'><glossterm>T</glossterm> | 1276 | <glossentry id='var-T'><glossterm>T</glossterm> |
1276 | <glossdef> | 1277 | <glossdef> |
1277 | <para>This variable points to a directory were BitBake places | 1278 | <para>Points to a directory were BitBake places |
1278 | temporary files, which consist mostly of task logs and | 1279 | temporary files, which consist mostly of task logs and |
1279 | scripts, when building a particular recipe. | 1280 | scripts, when building a particular recipe. |
1280 | </para> | 1281 | </para> |
@@ -1284,7 +1285,7 @@ | |||
1284 | <glossentry id='var-TOPDIR'><glossterm>TOPDIR</glossterm> | 1285 | <glossentry id='var-TOPDIR'><glossterm>TOPDIR</glossterm> |
1285 | <glossdef> | 1286 | <glossdef> |
1286 | <para> | 1287 | <para> |
1287 | This variable points to the | 1288 | Points to the |
1288 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. | 1289 | <ulink url='&YOCTO_DOCS_DEV_URL;#build-directory'>Build Directory</ulink>. |
1289 | BitBake automatically sets this variable. | 1290 | BitBake automatically sets this variable. |
1290 | </para> | 1291 | </para> |