diff options
-rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml | 5 | ||||
-rw-r--r-- | bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml | 63 |
2 files changed, 37 insertions, 31 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml index b1b72e0aae..7b4459c95b 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.xml | |||
@@ -596,7 +596,7 @@ | |||
596 | "<link linkend='checksums'>Checksums (Signatures)</link>" | 596 | "<link linkend='checksums'>Checksums (Signatures)</link>" |
597 | section for information). | 597 | section for information). |
598 | It is also possible to append extra metadata to the stamp using | 598 | It is also possible to append extra metadata to the stamp using |
599 | the "stamp-extra-info" task flag. | 599 | the <filename>[stamp-extra-info]</filename> task flag. |
600 | For example, OpenEmbedded uses this flag to make some tasks machine-specific. | 600 | For example, OpenEmbedded uses this flag to make some tasks machine-specific. |
601 | </para> | 601 | </para> |
602 | 602 | ||
@@ -653,7 +653,8 @@ | |||
653 | </itemizedlist> | 653 | </itemizedlist> |
654 | It is possible to have functions run before and after a task's main | 654 | It is possible to have functions run before and after a task's main |
655 | function. | 655 | function. |
656 | This is done using the "prefuncs" and "postfuncs" flags of the task | 656 | This is done using the <filename>[prefuncs]</filename> |
657 | and <filename>[postfuncs]</filename> flags of the task | ||
657 | that lists the functions to run. | 658 | that lists the functions to run. |
658 | </para> | 659 | </para> |
659 | </section> | 660 | </section> |
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 6fa814866a..4beb5a1d89 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.xml | |||
@@ -372,9 +372,9 @@ | |||
372 | FOO[a] += "456" | 372 | FOO[a] += "456" |
373 | </literallayout> | 373 | </literallayout> |
374 | The variable <filename>FOO</filename> has two flags: | 374 | The variable <filename>FOO</filename> has two flags: |
375 | <filename>a</filename> and <filename>b</filename>. | 375 | <filename>[a]</filename> and <filename>[b]</filename>. |
376 | The flags are immediately set to "abc" and "123", respectively. | 376 | The flags are immediately set to "abc" and "123", respectively. |
377 | The <filename>a</filename> flag becomes "abc 456". | 377 | The <filename>[a]</filename> flag becomes "abc 456". |
378 | </para> | 378 | </para> |
379 | 379 | ||
380 | <para> | 380 | <para> |
@@ -1270,7 +1270,7 @@ | |||
1270 | 1270 | ||
1271 | <para> | 1271 | <para> |
1272 | If you want dependencies such as these to remain intact, use | 1272 | If you want dependencies such as these to remain intact, use |
1273 | the <filename>noexec</filename> varflag to disable the task | 1273 | the <filename>[noexec]</filename> varflag to disable the task |
1274 | instead of using the <filename>deltask</filename> command to | 1274 | instead of using the <filename>deltask</filename> command to |
1275 | delete it: | 1275 | delete it: |
1276 | <literallayout class='monospaced'> | 1276 | <literallayout class='monospaced'> |
@@ -1393,13 +1393,13 @@ | |||
1393 | Tasks support a number of these flags which control various | 1393 | Tasks support a number of these flags which control various |
1394 | functionality of the task: | 1394 | functionality of the task: |
1395 | <itemizedlist> | 1395 | <itemizedlist> |
1396 | <listitem><para><emphasis>cleandirs:</emphasis> | 1396 | <listitem><para><emphasis><filename>[cleandirs]</filename>:</emphasis> |
1397 | Empty directories that should be created before the | 1397 | Empty directories that should be created before the |
1398 | task runs. | 1398 | task runs. |
1399 | Directories that already exist are removed and recreated | 1399 | Directories that already exist are removed and recreated |
1400 | to empty them. | 1400 | to empty them. |
1401 | </para></listitem> | 1401 | </para></listitem> |
1402 | <listitem><para><emphasis>depends:</emphasis> | 1402 | <listitem><para><emphasis><filename>[depends]</filename>:</emphasis> |
1403 | Controls inter-task dependencies. | 1403 | Controls inter-task dependencies. |
1404 | See the | 1404 | See the |
1405 | <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> | 1405 | <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> |
@@ -1407,7 +1407,7 @@ | |||
1407 | "<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>" | 1407 | "<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>" |
1408 | section for more information. | 1408 | section for more information. |
1409 | </para></listitem> | 1409 | </para></listitem> |
1410 | <listitem><para><emphasis>deptask:</emphasis> | 1410 | <listitem><para><emphasis><filename>[deptask]</filename>:</emphasis> |
1411 | Controls task build-time dependencies. | 1411 | Controls task build-time dependencies. |
1412 | See the | 1412 | See the |
1413 | <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> | 1413 | <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> |
@@ -1415,13 +1415,13 @@ | |||
1415 | "<link linkend='build-dependencies'>Build Dependencies</link>" | 1415 | "<link linkend='build-dependencies'>Build Dependencies</link>" |
1416 | section for more information. | 1416 | section for more information. |
1417 | </para></listitem> | 1417 | </para></listitem> |
1418 | <listitem><para><emphasis>dirs:</emphasis> | 1418 | <listitem><para><emphasis><filename>[dirs]</filename>:</emphasis> |
1419 | Directories that should be created before the task runs. | 1419 | Directories that should be created before the task runs. |
1420 | Directories that already exist are left as is. | 1420 | Directories that already exist are left as is. |
1421 | The last directory listed is used as the | 1421 | The last directory listed is used as the |
1422 | current working directory for the task. | 1422 | current working directory for the task. |
1423 | </para></listitem> | 1423 | </para></listitem> |
1424 | <listitem><para><emphasis>lockfiles:</emphasis> | 1424 | <listitem><para><emphasis><filename>[lockfiles]</filename>:</emphasis> |
1425 | Specifies one or more lockfiles to lock while the task | 1425 | Specifies one or more lockfiles to lock while the task |
1426 | executes. | 1426 | executes. |
1427 | Only one task may hold a lockfile, and any task that | 1427 | Only one task may hold a lockfile, and any task that |
@@ -1430,23 +1430,23 @@ | |||
1430 | You can use this variable flag to accomplish mutual | 1430 | You can use this variable flag to accomplish mutual |
1431 | exclusion. | 1431 | exclusion. |
1432 | </para></listitem> | 1432 | </para></listitem> |
1433 | <listitem><para><emphasis>noexec:</emphasis> | 1433 | <listitem><para><emphasis><filename>[noexec]</filename>:</emphasis> |
1434 | Marks the tasks as being empty and no execution required. | 1434 | Marks the tasks as being empty and no execution required. |
1435 | The <filename>noexec</filename> flag can be used to set up | 1435 | The <filename>[noexec]</filename> flag can be used to set up |
1436 | tasks as dependency placeholders, or to disable tasks defined | 1436 | tasks as dependency placeholders, or to disable tasks defined |
1437 | elsewhere that are not needed in a particular recipe. | 1437 | elsewhere that are not needed in a particular recipe. |
1438 | </para></listitem> | 1438 | </para></listitem> |
1439 | <listitem><para><emphasis>nostamp:</emphasis> | 1439 | <listitem><para><emphasis><filename>[nostamp]</filename>:</emphasis> |
1440 | Tells BitBake to not generate a stamp file for a task, | 1440 | Tells BitBake to not generate a stamp file for a task, |
1441 | which implies the task should always be executed. | 1441 | which implies the task should always be executed. |
1442 | </para></listitem> | 1442 | </para></listitem> |
1443 | <listitem><para><emphasis>postfuncs:</emphasis> | 1443 | <listitem><para><emphasis><filename>[postfuncs]</filename>:</emphasis> |
1444 | List of functions to call after the completion of the task. | 1444 | List of functions to call after the completion of the task. |
1445 | </para></listitem> | 1445 | </para></listitem> |
1446 | <listitem><para><emphasis>prefuncs:</emphasis> | 1446 | <listitem><para><emphasis><filename>[prefuncs]</filename>:</emphasis> |
1447 | List of functions to call before the task executes. | 1447 | List of functions to call before the task executes. |
1448 | </para></listitem> | 1448 | </para></listitem> |
1449 | <listitem><para><emphasis>rdepends:</emphasis> | 1449 | <listitem><para><emphasis><filename>[rdepends]</filename>:</emphasis> |
1450 | Controls inter-task runtime dependencies. | 1450 | Controls inter-task runtime dependencies. |
1451 | See the | 1451 | See the |
1452 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> | 1452 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> |
@@ -1456,7 +1456,7 @@ | |||
1456 | "<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>" | 1456 | "<link linkend='inter-task-dependencies'>Inter-Task Dependencies</link>" |
1457 | section for more information. | 1457 | section for more information. |
1458 | </para></listitem> | 1458 | </para></listitem> |
1459 | <listitem><para><emphasis>rdeptask:</emphasis> | 1459 | <listitem><para><emphasis><filename>[rdeptask]</filename>:</emphasis> |
1460 | Controls task runtime dependencies. | 1460 | Controls task runtime dependencies. |
1461 | See the | 1461 | See the |
1462 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> | 1462 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> |
@@ -1466,12 +1466,12 @@ | |||
1466 | "<link linkend='runtime-dependencies'>Runtime Dependencies</link>" | 1466 | "<link linkend='runtime-dependencies'>Runtime Dependencies</link>" |
1467 | section for more information. | 1467 | section for more information. |
1468 | </para></listitem> | 1468 | </para></listitem> |
1469 | <listitem><para><emphasis>recideptask:</emphasis> | 1469 | <listitem><para><emphasis><filename>[recideptask]</filename>:</emphasis> |
1470 | When set in conjunction with | 1470 | When set in conjunction with |
1471 | <filename>recrdeptask</filename>, specifies a task that | 1471 | <filename>recrdeptask</filename>, specifies a task that |
1472 | should be inspected for additional dependencies. | 1472 | should be inspected for additional dependencies. |
1473 | </para></listitem> | 1473 | </para></listitem> |
1474 | <listitem><para><emphasis>recrdeptask:</emphasis> | 1474 | <listitem><para><emphasis><filename>[recrdeptask]</filename>:</emphasis> |
1475 | Controls task recursive runtime dependencies. | 1475 | Controls task recursive runtime dependencies. |
1476 | See the | 1476 | See the |
1477 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> | 1477 | <link linkend='var-RDEPENDS'><filename>RDEPENDS</filename></link> |
@@ -1481,12 +1481,12 @@ | |||
1481 | "<link linkend='recursive-dependencies'>Recursive Dependencies</link>" | 1481 | "<link linkend='recursive-dependencies'>Recursive Dependencies</link>" |
1482 | section for more information. | 1482 | section for more information. |
1483 | </para></listitem> | 1483 | </para></listitem> |
1484 | <listitem><para><emphasis>stamp-extra-info:</emphasis> | 1484 | <listitem><para><emphasis><filename>[stamp-extra-info]</filename>:</emphasis> |
1485 | Extra stamp information to append to the task's stamp. | 1485 | Extra stamp information to append to the task's stamp. |
1486 | As an example, OpenEmbedded uses this flag to allow | 1486 | As an example, OpenEmbedded uses this flag to allow |
1487 | machine-specific tasks. | 1487 | machine-specific tasks. |
1488 | </para></listitem> | 1488 | </para></listitem> |
1489 | <listitem><para><emphasis>umask:</emphasis> | 1489 | <listitem><para><emphasis><filename>[umask]</filename>:</emphasis> |
1490 | The umask to run the task under. | 1490 | The umask to run the task under. |
1491 | </para></listitem> | 1491 | </para></listitem> |
1492 | </itemizedlist> | 1492 | </itemizedlist> |
@@ -1499,7 +1499,7 @@ | |||
1499 | "<link linkend='checksums'>Checksums (Signatures)</link>" | 1499 | "<link linkend='checksums'>Checksums (Signatures)</link>" |
1500 | section. | 1500 | section. |
1501 | <itemizedlist> | 1501 | <itemizedlist> |
1502 | <listitem><para><emphasis>vardeps:</emphasis> | 1502 | <listitem><para><emphasis><filename>[vardeps]</filename>:</emphasis> |
1503 | Specifies a space-separated list of additional | 1503 | Specifies a space-separated list of additional |
1504 | variables to add to a variable's dependencies | 1504 | variables to add to a variable's dependencies |
1505 | for the purposes of calculating its signature. | 1505 | for the purposes of calculating its signature. |
@@ -1508,17 +1508,17 @@ | |||
1508 | does not allow BitBake to automatically determine | 1508 | does not allow BitBake to automatically determine |
1509 | that the variable is referred to. | 1509 | that the variable is referred to. |
1510 | </para></listitem> | 1510 | </para></listitem> |
1511 | <listitem><para><emphasis>vardepsexclude:</emphasis> | 1511 | <listitem><para><emphasis><filename>[vardepsexclude]</filename>:</emphasis> |
1512 | Specifies a space-separated list of variables | 1512 | Specifies a space-separated list of variables |
1513 | that should be excluded from a variable's dependencies | 1513 | that should be excluded from a variable's dependencies |
1514 | for the purposes of calculating its signature. | 1514 | for the purposes of calculating its signature. |
1515 | </para></listitem> | 1515 | </para></listitem> |
1516 | <listitem><para><emphasis>vardepvalue:</emphasis> | 1516 | <listitem><para><emphasis><filename>[vardepvalue]</filename>:</emphasis> |
1517 | If set, instructs BitBake to ignore the actual | 1517 | If set, instructs BitBake to ignore the actual |
1518 | value of the variable and instead use the specified | 1518 | value of the variable and instead use the specified |
1519 | value when calculating the variable's signature. | 1519 | value when calculating the variable's signature. |
1520 | </para></listitem> | 1520 | </para></listitem> |
1521 | <listitem><para><emphasis>vardepvalueexclude:</emphasis> | 1521 | <listitem><para><emphasis><filename>[vardepvalueexclude]</filename>:</emphasis> |
1522 | Specifies a pipe-separated list of strings to exclude | 1522 | Specifies a pipe-separated list of strings to exclude |
1523 | from the variable's value when calculating the | 1523 | from the variable's value when calculating the |
1524 | variable's signature. | 1524 | variable's signature. |
@@ -1816,7 +1816,8 @@ | |||
1816 | BitBake uses the | 1816 | BitBake uses the |
1817 | <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> | 1817 | <link linkend='var-DEPENDS'><filename>DEPENDS</filename></link> |
1818 | variable to manage build time dependencies. | 1818 | variable to manage build time dependencies. |
1819 | The "deptask" varflag for tasks signifies the task of each | 1819 | The <filename>[deptask]</filename> varflag for tasks |
1820 | signifies the task of each | ||
1820 | item listed in <filename>DEPENDS</filename> that must | 1821 | item listed in <filename>DEPENDS</filename> that must |
1821 | complete before that task can be executed. | 1822 | complete before that task can be executed. |
1822 | Here is an example: | 1823 | Here is an example: |
@@ -1845,7 +1846,8 @@ | |||
1845 | packages. | 1846 | packages. |
1846 | Each of those packages can have <filename>RDEPENDS</filename> and | 1847 | Each of those packages can have <filename>RDEPENDS</filename> and |
1847 | <filename>RRECOMMENDS</filename> runtime dependencies. | 1848 | <filename>RRECOMMENDS</filename> runtime dependencies. |
1848 | The "rdeptask" flag for tasks is used to signify the task of each | 1849 | The <filename>[rdeptask]</filename> flag for tasks is used to |
1850 | signify the task of each | ||
1849 | item runtime dependency which must have completed before that | 1851 | item runtime dependency which must have completed before that |
1850 | task can be executed. | 1852 | task can be executed. |
1851 | <literallayout class='monospaced'> | 1853 | <literallayout class='monospaced'> |
@@ -1861,7 +1863,7 @@ | |||
1861 | <title>Recursive Dependencies</title> | 1863 | <title>Recursive Dependencies</title> |
1862 | 1864 | ||
1863 | <para> | 1865 | <para> |
1864 | BitBake uses the "recrdeptask" flag to manage | 1866 | BitBake uses the <filename>[recrdeptask]</filename> flag to manage |
1865 | recursive task dependencies. | 1867 | recursive task dependencies. |
1866 | BitBake looks through the build-time and runtime | 1868 | BitBake looks through the build-time and runtime |
1867 | dependencies of the current recipe, looks through | 1869 | dependencies of the current recipe, looks through |
@@ -1875,7 +1877,8 @@ | |||
1875 | </para> | 1877 | </para> |
1876 | 1878 | ||
1877 | <para> | 1879 | <para> |
1878 | The "recrdeptask" flag is most commonly used in high-level | 1880 | The <filename>[recrdeptask]</filename> flag is most commonly |
1881 | used in high-level | ||
1879 | recipes that need to wait for some task to finish "globally". | 1882 | recipes that need to wait for some task to finish "globally". |
1880 | For example, <filename>image.bbclass</filename> has the following: | 1883 | For example, <filename>image.bbclass</filename> has the following: |
1881 | <literallayout class='monospaced'> | 1884 | <literallayout class='monospaced'> |
@@ -1905,7 +1908,8 @@ | |||
1905 | <title>Inter-Task Dependencies</title> | 1908 | <title>Inter-Task Dependencies</title> |
1906 | 1909 | ||
1907 | <para> | 1910 | <para> |
1908 | BitBake uses the "depends" flag in a more generic form | 1911 | BitBake uses the <filename>[depends]</filename> |
1912 | flag in a more generic form | ||
1909 | to manage inter-task dependencies. | 1913 | to manage inter-task dependencies. |
1910 | This more generic form allows for inter-dependency | 1914 | This more generic form allows for inter-dependency |
1911 | checks for specific tasks rather than checks for | 1915 | checks for specific tasks rather than checks for |
@@ -1921,7 +1925,8 @@ | |||
1921 | </para> | 1925 | </para> |
1922 | 1926 | ||
1923 | <para> | 1927 | <para> |
1924 | The "rdepends" flag works in a similar way but takes targets | 1928 | The <filename>[rdepends]</filename> flag works in a similar |
1929 | way but takes targets | ||
1925 | in the runtime namespace instead of the build-time dependency | 1930 | in the runtime namespace instead of the build-time dependency |
1926 | namespace. | 1931 | namespace. |
1927 | </para> | 1932 | </para> |