diff options
| -rw-r--r-- | bitbake/doc/user-manual/user-manual-ref-variables.xml | 95 |
1 files changed, 92 insertions, 3 deletions
diff --git a/bitbake/doc/user-manual/user-manual-ref-variables.xml b/bitbake/doc/user-manual/user-manual-ref-variables.xml index 9cf42fd0a4..05fbd5df87 100644 --- a/bitbake/doc/user-manual/user-manual-ref-variables.xml +++ b/bitbake/doc/user-manual/user-manual-ref-variables.xml | |||
| @@ -17,7 +17,7 @@ | |||
| 17 | <para> | 17 | <para> |
| 18 | <link linkend='var-ASSUME_PROVIDED'>A</link> | 18 | <link linkend='var-ASSUME_PROVIDED'>A</link> |
| 19 | <link linkend='var-B'>B</link> | 19 | <link linkend='var-B'>B</link> |
| 20 | <!-- <link linkend='var-CFLAGS'>C</link> --> | 20 | <link linkend='var-CACHE'>C</link> |
| 21 | <link linkend='var-DEFAULT_PREFERENCE'>D</link> | 21 | <link linkend='var-DEFAULT_PREFERENCE'>D</link> |
| 22 | <link linkend='var-EXCLUDE_FROM_WORLD'>E</link> | 22 | <link linkend='var-EXCLUDE_FROM_WORLD'>E</link> |
| 23 | <link linkend='var-FAKEROOT'>F</link> | 23 | <link linkend='var-FAKEROOT'>F</link> |
| @@ -930,10 +930,19 @@ | |||
| 930 | 930 | ||
| 931 | </glossdiv> | 931 | </glossdiv> |
| 932 | 932 | ||
| 933 | <!-- | ||
| 934 | <glossdiv id='var-glossary-c'><title>C</title> | 933 | <glossdiv id='var-glossary-c'><title>C</title> |
| 934 | |||
| 935 | <glossentry id='var-CACHE'><glossterm>CACHE</glossterm> | ||
| 936 | <glossdef> | ||
| 937 | <para> | ||
| 938 | Specifies the directory BitBake uses to store a cache | ||
| 939 | of the metadata so it does not need to be parsed every | ||
| 940 | time BitBake is started. | ||
| 941 | </para> | ||
| 942 | </glossdef> | ||
| 943 | </glossentry> | ||
| 944 | |||
| 935 | </glossdiv> | 945 | </glossdiv> |
| 936 | --> | ||
| 937 | 946 | ||
| 938 | <glossdiv id='var-glossary-d'><title>D</title> | 947 | <glossdiv id='var-glossary-d'><title>D</title> |
| 939 | 948 | ||
| @@ -1118,6 +1127,48 @@ | |||
| 1118 | </glossdef> | 1127 | </glossdef> |
| 1119 | </glossentry> | 1128 | </glossentry> |
| 1120 | 1129 | ||
| 1130 | <glossentry id='var-FETCHCMD'><glossterm>FETCHCMD</glossterm> | ||
| 1131 | <glossdef> | ||
| 1132 | <para> | ||
| 1133 | Defines the command the BitBake fetcher module | ||
| 1134 | executes when running fetch operations. | ||
| 1135 | You need to use an override suffix when you use the | ||
| 1136 | variable (e.g. <filename>FETCHCMD_git</filename> | ||
| 1137 | or <filename>FETCHCMD_svn</filename>). | ||
| 1138 | </para> | ||
| 1139 | </glossdef> | ||
| 1140 | </glossentry> | ||
| 1141 | |||
| 1142 | <glossentry id='var-FILE'><glossterm>FILE</glossterm> | ||
| 1143 | <glossdef> | ||
| 1144 | <para> | ||
| 1145 | Points at the current file. | ||
| 1146 | BitBake sets this variable during the parsing process | ||
| 1147 | to identify the file being parsed. | ||
| 1148 | BitBake also sets this variable when a recipe is being | ||
| 1149 | executed to identify the recipe file. | ||
| 1150 | </para> | ||
| 1151 | </glossdef> | ||
| 1152 | </glossentry> | ||
| 1153 | |||
| 1154 | <glossentry id='var-FILESDIR'><glossterm>FILESDIR</glossterm> | ||
| 1155 | <glossdef> | ||
| 1156 | <para> | ||
| 1157 | Specifies directories BitBake uses when searching for | ||
| 1158 | patches and files. | ||
| 1159 | The "local" fetcher module uses these directories when | ||
| 1160 | handling <filename>file://</filename> URLs if the file | ||
| 1161 | was not found using | ||
| 1162 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link>. | ||
| 1163 | <note> | ||
| 1164 | The <filename>FILESDIR</filename> variable is | ||
| 1165 | deprecated and you should use | ||
| 1166 | <filename>FILESPATH</filename> in all new code. | ||
| 1167 | </note> | ||
| 1168 | </para> | ||
| 1169 | </glossdef> | ||
| 1170 | </glossentry> | ||
| 1171 | |||
| 1121 | <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm> | 1172 | <glossentry id='var-FILESPATH'><glossterm>FILESPATH</glossterm> |
| 1122 | <glossdef> | 1173 | <glossdef> |
| 1123 | <para> | 1174 | <para> |
| @@ -1248,6 +1299,32 @@ | |||
| 1248 | </glossdef> | 1299 | </glossdef> |
| 1249 | </glossentry> | 1300 | </glossentry> |
| 1250 | 1301 | ||
| 1302 | <glossentry id='var-MULTI_PROVIDER_WHITELIST'><glossterm>MULTI_PROVIDER_WHITELIST</glossterm> | ||
| 1303 | <glossdef> | ||
| 1304 | <para> | ||
| 1305 | Allows you to suppress BitBake warnings caused when | ||
| 1306 | building two separate recipes that provide the same | ||
| 1307 | output. | ||
| 1308 | </para> | ||
| 1309 | |||
| 1310 | <para> | ||
| 1311 | Bitbake normally issues a warning when building two | ||
| 1312 | different recipes where each provides the same output. | ||
| 1313 | This scenario is usually something the user does not | ||
| 1314 | want. | ||
| 1315 | However, cases do exist where it makes sense, particularly | ||
| 1316 | in the <filename>virtual/*</filename> namespace. | ||
| 1317 | You can use this variable to suppress BitBake's warnings. | ||
| 1318 | </para> | ||
| 1319 | |||
| 1320 | <para> | ||
| 1321 | To use the variable, list provider names (e.g. | ||
| 1322 | recipe names, <filename>virtual/kernel</filename>, | ||
| 1323 | and so forth). | ||
| 1324 | </para> | ||
| 1325 | </glossdef> | ||
| 1326 | </glossentry> | ||
| 1327 | |||
| 1251 | </glossdiv> | 1328 | </glossdiv> |
| 1252 | 1329 | ||
| 1253 | <!-- | 1330 | <!-- |
| @@ -1314,6 +1391,18 @@ | |||
| 1314 | </glossdef> | 1391 | </glossdef> |
| 1315 | </glossentry> | 1392 | </glossentry> |
| 1316 | 1393 | ||
| 1394 | <glossentry id='var-PERSISTENT_DIR'><glossterm>PERSISTENT_DIR</glossterm> | ||
| 1395 | <glossdef> | ||
| 1396 | <para> | ||
| 1397 | Specifies the directory BitBake uses to store data that | ||
| 1398 | should be preserved between builds. | ||
| 1399 | In particular, the data stored is the data that uses | ||
| 1400 | BitBake's persistent data API and the data used by the | ||
| 1401 | PR Server and PR Service. | ||
| 1402 | </para> | ||
| 1403 | </glossdef> | ||
| 1404 | </glossentry> | ||
| 1405 | |||
| 1317 | <glossentry id='var-PF'><glossterm>PF</glossterm> | 1406 | <glossentry id='var-PF'><glossterm>PF</glossterm> |
| 1318 | <glossdef> | 1407 | <glossdef> |
| 1319 | <para> | 1408 | <para> |
