diff options
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/migration.xml | 37 | ||||
-rw-r--r-- | documentation/ref-manual/ref-classes.xml | 2 | ||||
-rw-r--r-- | documentation/ref-manual/ref-variables.xml | 73 |
3 files changed, 57 insertions, 55 deletions
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index a0da6b75c7..e1faea0fa9 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml | |||
@@ -351,15 +351,34 @@ | |||
351 | <title>Variables</title> | 351 | <title>Variables</title> |
352 | 352 | ||
353 | <para> | 353 | <para> |
354 | The <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link> | 354 | The following variables have changed: |
355 | variable now uses a | 355 | <itemizedlist> |
356 | distribution ID, which is composed of the host distributor ID | 356 | <listitem><para><emphasis><filename>SANITY_TESTED_DISTROS</filename>:</emphasis> |
357 | followed by the release. | 357 | This variable now uses a distribution ID, which is composed |
358 | Previously, it was composed of the description field. | 358 | of the host distributor ID followed by the release. |
359 | For example, "Ubuntu 12.10" becomes "Ubuntu-12.10". | 359 | Previously, |
360 | You do not need to worry about this change if you are not | 360 | <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link> |
361 | specifically setting this variable, or if you are | 361 | was composed of the description field. |
362 | specifically setting it to "". | 362 | For example, "Ubuntu 12.10" becomes "Ubuntu-12.10". |
363 | You do not need to worry about this change if you are not | ||
364 | specifically setting this variable, or if you are | ||
365 | specifically setting it to "". | ||
366 | </para></listitem> | ||
367 | <listitem><para><emphasis><filename>SRC_URI</filename>:</emphasis> | ||
368 | The <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>, | ||
369 | <filename>${</filename><link linkend='var-PF'><filename>PF</filename></link><filename>}</filename>, | ||
370 | and <filename>${</filename><link linkend='var-P'><filename>P</filename></link><filename>}</filename> | ||
371 | directories have been dropped from the default value of the | ||
372 | <link linkend='var-FILESPATH'><filename>FILESPATH</filename></link> | ||
373 | variable, which is used as the search path for finding files | ||
374 | referred to in | ||
375 | <link linkend='var-SRC_URI'><filename>SRC_URI</filename></link>. | ||
376 | If you have a recipe that relied upon these directories, | ||
377 | which would be unusual, then you will need to add the | ||
378 | appropriate paths to | ||
379 | <link linkend='var-FILESEXTRAPATHS'><filename>FILESEXTRAPATHS</filename></link>. | ||
380 | </para></listitem> | ||
381 | </itemizedlist> | ||
363 | </para> | 382 | </para> |
364 | </section> | 383 | </section> |
365 | 384 | ||
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index c6453a7be9..69ca78c380 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml | |||
@@ -632,7 +632,7 @@ | |||
632 | To exclude some recipes from having their work directories deleted by | 632 | To exclude some recipes from having their work directories deleted by |
633 | <filename>rm_work</filename>, you can add the names of the recipe or | 633 | <filename>rm_work</filename>, you can add the names of the recipe or |
634 | recipes you are working on to the <filename>RM_WORK_EXCLUDE</filename> | 634 | recipes you are working on to the <filename>RM_WORK_EXCLUDE</filename> |
635 | variable, which is also found in your <filename>local.conf</filename> | 635 | variable, which can also be set in your <filename>local.conf</filename> |
636 | file. | 636 | file. |
637 | Here is an example: | 637 | Here is an example: |
638 | <literallayout class='monospaced'> | 638 | <literallayout class='monospaced'> |
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 3d4a03e6d6..b5f04cbf6c 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml | |||
@@ -600,10 +600,11 @@ Core layer for images cannot be removed | |||
600 | 600 | ||
601 | <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm> | 601 | <glossentry id='var-COMPATIBLE_HOST'><glossterm>COMPATIBLE_HOST</glossterm> |
602 | <glossdef> | 602 | <glossdef> |
603 | <para>A regular expression matched against | 603 | <para>A regular expression that resolves to one or more hosts |
604 | <link linkend="var-HOST_SYS"><filename>HOST_SYS</filename></link> | 604 | (when the recipe is native) or one or more targets (when |
605 | that the OpenEmbedded build system evaluates against | 605 | the recipe is non-native) with which a recipe is compatible. |
606 | systems with which the recipe works. | 606 | The regular expression is matched against |
607 | <link linkend="var-HOST_SYS"><filename>HOST_SYS</filename></link>. | ||
607 | You can use the variable to stop recipes from being built | 608 | You can use the variable to stop recipes from being built |
608 | for classes of systems with which the recipes are not | 609 | for classes of systems with which the recipes are not |
609 | compatible. | 610 | compatible. |
@@ -616,10 +617,10 @@ Core layer for images cannot be removed | |||
616 | 617 | ||
617 | <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> | 618 | <glossentry id='var-COMPATIBLE_MACHINE'><glossterm>COMPATIBLE_MACHINE</glossterm> |
618 | <glossdef> | 619 | <glossdef> |
619 | <para>A regular expression matched against | 620 | <para>A regular expression that resolves to one or more |
620 | <link linkend="var-MACHINEOVERRIDES"><filename>MACHINEOVERRIDES</filename></link> | 621 | target machines with which a recipe is compatible. |
621 | that the OpenEmbedded build system evaluates against | 622 | The regular expression is matched against |
622 | machines with which the recipe works. | 623 | <link linkend="var-MACHINEOVERRIDES"><filename>MACHINEOVERRIDES</filename></link>. |
623 | You can use the variable to stop recipes from being built | 624 | You can use the variable to stop recipes from being built |
624 | for machines with which the recipes are not compatible. | 625 | for machines with which the recipes are not compatible. |
625 | Stopping these builds is particularly useful with kernels. | 626 | Stopping these builds is particularly useful with kernels. |
@@ -743,8 +744,6 @@ Core layer for images cannot be removed | |||
743 | <glossdef> | 744 | <glossdef> |
744 | <para> | 745 | <para> |
745 | Specifies a weak bias for recipe selection priority. | 746 | Specifies a weak bias for recipe selection priority. |
746 | Use this variable when more than one provider/version | ||
747 | satisfies a dependency. | ||
748 | </para> | 747 | </para> |
749 | <para> | 748 | <para> |
750 | The most common usage of this is variable is to set | 749 | The most common usage of this is variable is to set |
@@ -759,7 +758,7 @@ Core layer for images cannot be removed | |||
759 | The bias provided by <filename>DEFAULT_PREFERENCE</filename> | 758 | The bias provided by <filename>DEFAULT_PREFERENCE</filename> |
760 | is weak and is overridden by | 759 | is weak and is overridden by |
761 | <filename><link linkend='var-BBFILE_PRIORITY'>BBFILE_PRIORITY</link></filename> | 760 | <filename><link linkend='var-BBFILE_PRIORITY'>BBFILE_PRIORITY</link></filename> |
762 | if the selection priority is different between two layers | 761 | if the that variable is different between two layers |
763 | that contain different versions of the same recipe. | 762 | that contain different versions of the same recipe. |
764 | </note> | 763 | </note> |
765 | </glossdef> | 764 | </glossdef> |
@@ -1279,7 +1278,8 @@ Core layer for images cannot be removed | |||
1279 | <glossdef> | 1278 | <glossdef> |
1280 | <para> | 1279 | <para> |
1281 | Specifies the system, including the architecture and the | 1280 | Specifies the system, including the architecture and the |
1282 | operating system, being built in the context of the current | 1281 | operating system, for with the build is occurring |
1282 | in the context of the current | ||
1283 | recipe. | 1283 | recipe. |
1284 | The OpenEmbedded build system automatically sets this | 1284 | The OpenEmbedded build system automatically sets this |
1285 | variable. | 1285 | variable. |
@@ -1389,7 +1389,7 @@ Core layer for images cannot be removed | |||
1389 | <glossdef> | 1389 | <glossdef> |
1390 | <para> | 1390 | <para> |
1391 | Specifies the list of locales to install into the image | 1391 | Specifies the list of locales to install into the image |
1392 | during the packaging process. | 1392 | during the root filesystem construction process. |
1393 | The OpenEmbedded build system automatically splits locale | 1393 | The OpenEmbedded build system automatically splits locale |
1394 | files, which are used for localization, into separate | 1394 | files, which are used for localization, into separate |
1395 | packages. | 1395 | packages. |
@@ -1648,8 +1648,8 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
1648 | For example, to skip the check for symbolic link | 1648 | For example, to skip the check for symbolic link |
1649 | <filename>.so</filename> files in the main package of a | 1649 | <filename>.so</filename> files in the main package of a |
1650 | recipe, add the following to the recipe. | 1650 | recipe, add the following to the recipe. |
1651 | In this example, the package name override | 1651 | The package name override must be used, which in this |
1652 | <filename>${PN}</filename> must be used: | 1652 | example is <filename>${PN}</filename>: |
1653 | <literallayout class='monospaced'> | 1653 | <literallayout class='monospaced'> |
1654 | INSANE_SKIP_${PN} += "dev-so" | 1654 | INSANE_SKIP_${PN} += "dev-so" |
1655 | </literallayout> | 1655 | </literallayout> |
@@ -3158,8 +3158,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
3158 | <glossentry id='var-RSUGGESTS'><glossterm>RSUGGESTS</glossterm> | 3158 | <glossentry id='var-RSUGGESTS'><glossterm>RSUGGESTS</glossterm> |
3159 | <glossdef> | 3159 | <glossdef> |
3160 | <para> | 3160 | <para> |
3161 | A list of additional packages that you can suggest the | 3161 | A list of additional packages that you can suggest for |
3162 | package manager installs. | 3162 | installation by the package manager at the time a package |
3163 | is installed. | ||
3163 | Not all package managers support this functionality. | 3164 | Not all package managers support this functionality. |
3164 | </para> | 3165 | </para> |
3165 | <para> | 3166 | <para> |
@@ -3214,7 +3215,7 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
3214 | Identifiers consist of the host distributor ID | 3215 | Identifiers consist of the host distributor ID |
3215 | followed by the release, | 3216 | followed by the release, |
3216 | as reported by the <filename>lsb_release</filename> tool | 3217 | as reported by the <filename>lsb_release</filename> tool |
3217 | or as read from <filename>/etc/lsb-release</filename>.) | 3218 | or as read from <filename>/etc/lsb-release</filename>. |
3218 | Separate the list items with explicit newline | 3219 | Separate the list items with explicit newline |
3219 | characters (<filename>\n</filename>). | 3220 | characters (<filename>\n</filename>). |
3220 | If <filename>SANITY_TESTED_DISTROS</filename> is not empty | 3221 | If <filename>SANITY_TESTED_DISTROS</filename> is not empty |
@@ -3281,9 +3282,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
3281 | thus force rebuilds when the recipe changes. | 3282 | thus force rebuilds when the recipe changes. |
3282 | <caution> | 3283 | <caution> |
3283 | If you add an inappropriate variable to this list, | 3284 | If you add an inappropriate variable to this list, |
3284 | other recipes might break when the interface of the | 3285 | the software might break at runtime if the |
3285 | recipe changes after the other recipes have been | 3286 | interface of the recipe was changed after the other |
3286 | built. | 3287 | had been built. |
3287 | </caution> | 3288 | </caution> |
3288 | </para> | 3289 | </para> |
3289 | </glossdef> | 3290 | </glossdef> |
@@ -3309,9 +3310,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
3309 | recipe changes. | 3310 | recipe changes. |
3310 | <caution> | 3311 | <caution> |
3311 | If you add an inappropriate dependency for a recipe | 3312 | If you add an inappropriate dependency for a recipe |
3312 | relationship, the build might break when the interface | 3313 | relationship, the software might break during |
3313 | of the second recipe changes after the first recipe has | 3314 | runtime if the interface of the second recipe was |
3314 | been built. | 3315 | changed after the first recipe had been built. |
3315 | </caution> | 3316 | </caution> |
3316 | </para> | 3317 | </para> |
3317 | </glossdef> | 3318 | </glossdef> |
@@ -3387,24 +3388,6 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
3387 | which are assumed to be a subdirectories of the directory in which the | 3388 | which are assumed to be a subdirectories of the directory in which the |
3388 | recipe file resides: | 3389 | recipe file resides: |
3389 | <itemizedlist> | 3390 | <itemizedlist> |
3390 | <listitem><para><emphasis><filename>${PN}</filename> -</emphasis> The recipe name | ||
3391 | with any special suffix or prefix, if applicable. | ||
3392 | For example, using <filename>bash</filename> to build for the native | ||
3393 | machine, <filename>PN</filename> is <filename>bash-native</filename>. | ||
3394 | Using <filename>bash</filename> to build for the target and for Multilib, | ||
3395 | <link linkend='var-PN'><filename>PN</filename></link> | ||
3396 | would be <filename>bash</filename> and | ||
3397 | <filename>lib64-bash</filename>, respectively. | ||
3398 | </para></listitem> | ||
3399 | <listitem><para><emphasis><filename>${PF}</filename> - </emphasis> | ||
3400 | <filename>${PN}-${EXTENDPE}${<link linkend='var-PV'>PV</link>}-${<link linkend='var-PR'>PR</link>}</filename>. | ||
3401 | The recipe name including all version and revision numbers | ||
3402 | (i.e. <filename>eglibc-2.13-r20+svnr15508/</filename> and | ||
3403 | <filename>bash-4.2-r1/</filename>).</para></listitem> | ||
3404 | <listitem><para><emphasis><filename>${P}</filename> -</emphasis> | ||
3405 | <filename>${PN}-${PV}</filename>. | ||
3406 | The recipe name and version (i.e. <filename>bash-4.2</filename>). | ||
3407 | </para></listitem> | ||
3408 | <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> The | 3391 | <listitem><para><emphasis><filename>${BPN}</filename> -</emphasis> The |
3409 | base recipe name without any special suffix or version numbers. | 3392 | base recipe name without any special suffix or version numbers. |
3410 | </para></listitem> | 3393 | </para></listitem> |
@@ -3683,9 +3666,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3" | |||
3683 | <para> | 3666 | <para> |
3684 | A list of functions to execute after files are staged into | 3667 | A list of functions to execute after files are staged into |
3685 | the sysroot. | 3668 | the sysroot. |
3686 | The OpenEmbedded build system usually uses such functions | 3669 | These functions are usually used to apply additional |
3687 | to apply additional processing on the | 3670 | processing on the staged files, or to stage additional |
3688 | staged files, or to stage additional files. | 3671 | files. |
3689 | </para> | 3672 | </para> |
3690 | </glossdef> | 3673 | </glossdef> |
3691 | </glossentry> | 3674 | </glossentry> |