diff options
Diffstat (limited to 'documentation/ref-manual/ref-variables.xml')
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 63 |
1 files changed, 56 insertions, 7 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 1f4b2171a9..df1631df83 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -8420,18 +8420,60 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
8420 | 8420 | ||
8421 | <glossentry id='var-OVERRIDES'><glossterm>OVERRIDES</glossterm> | 8421 | <glossentry id='var-OVERRIDES'><glossterm>OVERRIDES</glossterm> |
8422 | <info> | 8422 | <info> |
8423 | OVERRIDES[doc] = "BitBake uses OVERRIDES to control what variables are overridden after BitBake parses recipes and configuration files." | 8423 | OVERRIDES[doc] = "A colon-separated list of overrides that currently apply." |
8424 | </info> | 8424 | </info> |
8425 | <glossdef> | 8425 | <glossdef> |
8426 | <para role="glossdeffirst"> | 8426 | <para role="glossdeffirst"> |
8427 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> | 8427 | <!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> |
8428 | BitBake uses <filename>OVERRIDES</filename> to control | 8428 | A colon-separated list of overrides that currently apply. |
8429 | what variables are overridden after BitBake parses | 8429 | Overrides are a BitBake mechanism that allows variables to |
8430 | recipes and configuration files. | 8430 | be selectively overridden at the end of parsing. |
8431 | You can find more information on how overrides are handled | 8431 | The set of overrides in <filename>OVERRIDES</filename> |
8432 | in the | 8432 | represents the "state" during building, which includes |
8433 | the current recipe being built, the machine for which | ||
8434 | is being built, and so forth. | ||
8435 | </para> | ||
8436 | |||
8437 | <para> | ||
8438 | As an example, if the string "an-override" appears as an | ||
8439 | element in the colon-separated list in | ||
8440 | <filename>OVERRIDES</filename>, then the following | ||
8441 | assignment will override <filename>FOO</filename> with the | ||
8442 | value "overridden" at the end of parsing: | ||
8443 | <literallayout class='monospaced'> | ||
8444 | FOO_an-override = "overridden" | ||
8445 | </literallayout> | ||
8446 | See the | ||
8433 | "<ulink url='&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides'>Conditional Syntax (Overrides)</ulink>" | 8447 | "<ulink url='&YOCTO_DOCS_BB_URL;#conditional-syntax-overrides'>Conditional Syntax (Overrides)</ulink>" |
8434 | section of the BitBake User Manual. | 8448 | section in the BitBake User Manual for more information on |
8449 | the overrides mechanism. | ||
8450 | </para> | ||
8451 | |||
8452 | <para> | ||
8453 | The default value of <filename>OVERRIDES</filename> | ||
8454 | includes the values of the | ||
8455 | <link linkend='var-CLASSOVERRIDE'><filename>CLASSOVERRIDE</filename></link>, | ||
8456 | <link linkend='var-MACHINEOVERRIDES'><filename>MACHINEOVERRIDES</filename></link>, | ||
8457 | and | ||
8458 | <link linkend='var-DISTROOVERRIDES'><filename>DISTROOVERRIDES</filename></link> | ||
8459 | variables. | ||
8460 | Another important override included by default is | ||
8461 | <filename>pn-${PN}</filename>. | ||
8462 | This override allows variables to be set for a single | ||
8463 | recipe within configuration (<filename>.conf</filename>) | ||
8464 | files. | ||
8465 | Here is an example: | ||
8466 | <literallayout class='monospaced'> | ||
8467 | FOO_pn-myrecipe = "myrecipe-specific value" | ||
8468 | </literallayout> | ||
8469 | <note><title>Tip</title> | ||
8470 | An easy way to see what overrides apply is to search for | ||
8471 | <filename>OVERRIDES</filename> in the output of the | ||
8472 | <filename>bitbake -e</filename> command. | ||
8473 | See the | ||
8474 | "<link linkend='usingpoky-debugging-viewing-variable-values'>Viewing Variable Values</link>" | ||
8475 | section for more information. | ||
8476 | </note> | ||
8435 | </para> | 8477 | </para> |
8436 | </glossdef> | 8478 | </glossdef> |
8437 | </glossentry> | 8479 | </glossentry> |
@@ -9830,6 +9872,13 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
9830 | <literallayout class='monospaced'> | 9872 | <literallayout class='monospaced'> |
9831 | PREFERRED_VERSION_linux-yocto_forcevariable = "3.4%" | 9873 | PREFERRED_VERSION_linux-yocto_forcevariable = "3.4%" |
9832 | </literallayout> | 9874 | </literallayout> |
9875 | <note> | ||
9876 | The <filename>_forcevariable</filename> override is | ||
9877 | not handled specially. | ||
9878 | This override only works because the default value of | ||
9879 | <link linkend='var-OVERRIDES'><filename>OVERRIDES</filename></link> | ||
9880 | includes "forcevariable". | ||
9881 | </note> | ||
9833 | </para> | 9882 | </para> |
9834 | </glossdef> | 9883 | </glossdef> |
9835 | </glossentry> | 9884 | </glossentry> |