diff options
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r-- | documentation/ref-manual/variables.rst | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 1198ac5696..0f9e114771 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -591,7 +591,7 @@ system and gives an overview of their function and contents. | |||
591 | This variable is useful in situations where the same recipe appears | 591 | This variable is useful in situations where the same recipe appears |
592 | in more than one layer. Setting this variable allows you to | 592 | in more than one layer. Setting this variable allows you to |
593 | prioritize a layer against other layers that contain the same recipe | 593 | prioritize a layer against other layers that contain the same recipe |
594 | - effectively letting you control the precedence for the multiple | 594 | --- effectively letting you control the precedence for the multiple |
595 | layers. The precedence established through this variable stands | 595 | layers. The precedence established through this variable stands |
596 | regardless of a recipe's version (:term:`PV` variable). For | 596 | regardless of a recipe's version (:term:`PV` variable). For |
597 | example, a layer that has a recipe with a higher :term:`PV` value but for | 597 | example, a layer that has a recipe with a higher :term:`PV` value but for |
@@ -888,7 +888,7 @@ system and gives an overview of their function and contents. | |||
888 | :term:`BUILD_OS` | 888 | :term:`BUILD_OS` |
889 | Specifies the operating system in use on the build host (e.g. | 889 | Specifies the operating system in use on the build host (e.g. |
890 | "linux"). The OpenEmbedded build system sets the value of | 890 | "linux"). The OpenEmbedded build system sets the value of |
891 | :term:`BUILD_OS` from the OS reported by the ``uname`` command - the | 891 | :term:`BUILD_OS` from the OS reported by the ``uname`` command --- the |
892 | first word, converted to lower-case characters. | 892 | first word, converted to lower-case characters. |
893 | 893 | ||
894 | :term:`BUILD_PREFIX` | 894 | :term:`BUILD_PREFIX` |
@@ -1775,7 +1775,7 @@ system and gives an overview of their function and contents. | |||
1775 | ``${TMPDIR}/deploy``. | 1775 | ``${TMPDIR}/deploy``. |
1776 | 1776 | ||
1777 | For more information on the structure of the Build Directory, see | 1777 | For more information on the structure of the Build Directory, see |
1778 | ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. | 1778 | ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. |
1779 | For more detail on the contents of the ``deploy`` directory, see the | 1779 | For more detail on the contents of the ``deploy`` directory, see the |
1780 | ":ref:`overview-manual/concepts:images`", | 1780 | ":ref:`overview-manual/concepts:images`", |
1781 | ":ref:`overview-manual/concepts:package feeds`", and | 1781 | ":ref:`overview-manual/concepts:package feeds`", and |
@@ -1819,7 +1819,7 @@ system and gives an overview of their function and contents. | |||
1819 | <ref-classes-image>` class. | 1819 | <ref-classes-image>` class. |
1820 | 1820 | ||
1821 | For more information on the structure of the Build Directory, see | 1821 | For more information on the structure of the Build Directory, see |
1822 | ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. | 1822 | ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. |
1823 | For more detail on the contents of the ``deploy`` directory, see the | 1823 | For more detail on the contents of the ``deploy`` directory, see the |
1824 | ":ref:`overview-manual/concepts:images`" and | 1824 | ":ref:`overview-manual/concepts:images`" and |
1825 | ":ref:`overview-manual/concepts:application development sdk`" sections both in | 1825 | ":ref:`overview-manual/concepts:application development sdk`" sections both in |
@@ -2348,24 +2348,24 @@ system and gives an overview of their function and contents. | |||
2348 | 2348 | ||
2349 | Here are some examples of features you can add: | 2349 | Here are some examples of features you can add: |
2350 | 2350 | ||
2351 | - "dbg-pkgs" - Adds -dbg packages for all installed packages including | 2351 | - "dbg-pkgs" --- adds -dbg packages for all installed packages including |
2352 | symbol information for debugging and profiling. | 2352 | symbol information for debugging and profiling. |
2353 | 2353 | ||
2354 | - "debug-tweaks" - Makes an image suitable for debugging. For example, allows root logins without passwords and | 2354 | - "debug-tweaks" --- makes an image suitable for debugging. For example, allows root logins without passwords and |
2355 | enables post-installation logging. See the 'allow-empty-password' and | 2355 | enables post-installation logging. See the 'allow-empty-password' and |
2356 | 'post-install-logging' features in the ":ref:`ref-features-image`" | 2356 | 'post-install-logging' features in the ":ref:`ref-features-image`" |
2357 | section for more information. | 2357 | section for more information. |
2358 | - "dev-pkgs" - Adds -dev packages for all installed packages. This is | 2358 | - "dev-pkgs" --- adds -dev packages for all installed packages. This is |
2359 | useful if you want to develop against the libraries in the image. | 2359 | useful if you want to develop against the libraries in the image. |
2360 | - "read-only-rootfs" - Creates an image whose root filesystem is | 2360 | - "read-only-rootfs" --- creates an image whose root filesystem is |
2361 | read-only. See the | 2361 | read-only. See the |
2362 | ":ref:`dev-manual/read-only-rootfs:creating a read-only root filesystem`" | 2362 | ":ref:`dev-manual/read-only-rootfs:creating a read-only root filesystem`" |
2363 | section in the Yocto Project Development Tasks Manual for more | 2363 | section in the Yocto Project Development Tasks Manual for more |
2364 | information | 2364 | information |
2365 | - "tools-debug" - Adds debugging tools such as gdb and strace. | 2365 | - "tools-debug" --- adds debugging tools such as gdb and strace. |
2366 | - "tools-sdk" - Adds development tools such as gcc, make, | 2366 | - "tools-sdk" --- adds development tools such as gcc, make, |
2367 | pkgconfig and so forth. | 2367 | pkgconfig and so forth. |
2368 | - "tools-testapps" - Adds useful testing tools | 2368 | - "tools-testapps" --- adds useful testing tools |
2369 | such as ts_print, aplay, arecord and so forth. | 2369 | such as ts_print, aplay, arecord and so forth. |
2370 | 2370 | ||
2371 | For a complete list of image features that ships with the Yocto | 2371 | For a complete list of image features that ships with the Yocto |
@@ -3454,7 +3454,7 @@ system and gives an overview of their function and contents. | |||
3454 | IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 3454 | IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
3455 | 3455 | ||
3456 | :term:`IMAGE_NAME_SUFFIX` | 3456 | :term:`IMAGE_NAME_SUFFIX` |
3457 | Suffix used for the image output filename - defaults to ``".rootfs"`` | 3457 | Suffix used for the image output filename --- defaults to ``".rootfs"`` |
3458 | to distinguish the image file from other files created during image | 3458 | to distinguish the image file from other files created during image |
3459 | building; however if this suffix is redundant or not desired you can | 3459 | building; however if this suffix is redundant or not desired you can |
3460 | clear the value of this variable (set the value to ""). For example, | 3460 | clear the value of this variable (set the value to ""). For example, |
@@ -6541,7 +6541,7 @@ system and gives an overview of their function and contents. | |||
6541 | ``baz``. | 6541 | ``baz``. |
6542 | 6542 | ||
6543 | The names of the packages you list within :term:`RDEPENDS` must be the | 6543 | The names of the packages you list within :term:`RDEPENDS` must be the |
6544 | names of other packages - they cannot be recipe names. Although | 6544 | names of other packages --- they cannot be recipe names. Although |
6545 | package names and recipe names usually match, the important point | 6545 | package names and recipe names usually match, the important point |
6546 | here is that you are providing package names within the :term:`RDEPENDS` | 6546 | here is that you are providing package names within the :term:`RDEPENDS` |
6547 | variable. For an example of the default list of packages created from | 6547 | variable. For an example of the default list of packages created from |
@@ -7646,35 +7646,35 @@ system and gives an overview of their function and contents. | |||
7646 | 7646 | ||
7647 | There are standard and recipe-specific options. Here are standard ones: | 7647 | There are standard and recipe-specific options. Here are standard ones: |
7648 | 7648 | ||
7649 | - ``apply`` - Whether to apply the patch or not. The default | 7649 | - ``apply`` --- whether to apply the patch or not. The default |
7650 | action is to apply the patch. | 7650 | action is to apply the patch. |
7651 | 7651 | ||
7652 | - ``striplevel`` - Which striplevel to use when applying the | 7652 | - ``striplevel`` --- which striplevel to use when applying the |
7653 | patch. The default level is 1. | 7653 | patch. The default level is 1. |
7654 | 7654 | ||
7655 | - ``patchdir`` - Specifies the directory in which the patch should | 7655 | - ``patchdir`` --- specifies the directory in which the patch should |
7656 | be applied. The default is ``${``\ :term:`S`\ ``}``. | 7656 | be applied. The default is ``${``\ :term:`S`\ ``}``. |
7657 | 7657 | ||
7658 | Here are options specific to recipes building code from a revision | 7658 | Here are options specific to recipes building code from a revision |
7659 | control system: | 7659 | control system: |
7660 | 7660 | ||
7661 | - ``mindate`` - Apply the patch only if | 7661 | - ``mindate`` --- apply the patch only if |
7662 | :term:`SRCDATE` is equal to or greater than | 7662 | :term:`SRCDATE` is equal to or greater than |
7663 | ``mindate``. | 7663 | ``mindate``. |
7664 | 7664 | ||
7665 | - ``maxdate`` - Apply the patch only if :term:`SRCDATE` is not later | 7665 | - ``maxdate`` --- apply the patch only if :term:`SRCDATE` is not later |
7666 | than ``maxdate``. | 7666 | than ``maxdate``. |
7667 | 7667 | ||
7668 | - ``minrev`` - Apply the patch only if :term:`SRCREV` is equal to or | 7668 | - ``minrev`` --- apply the patch only if :term:`SRCREV` is equal to or |
7669 | greater than ``minrev``. | 7669 | greater than ``minrev``. |
7670 | 7670 | ||
7671 | - ``maxrev`` - Apply the patch only if :term:`SRCREV` is not later | 7671 | - ``maxrev`` --- apply the patch only if :term:`SRCREV` is not later |
7672 | than ``maxrev``. | 7672 | than ``maxrev``. |
7673 | 7673 | ||
7674 | - ``rev`` - Apply the patch only if :term:`SRCREV` is equal to | 7674 | - ``rev`` --- apply the patch only if :term:`SRCREV` is equal to |
7675 | ``rev``. | 7675 | ``rev``. |
7676 | 7676 | ||
7677 | - ``notrev`` - Apply the patch only if :term:`SRCREV` is not equal to | 7677 | - ``notrev`` --- apply the patch only if :term:`SRCREV` is not equal to |
7678 | ``rev``. | 7678 | ``rev``. |
7679 | 7679 | ||
7680 | .. note:: | 7680 | .. note:: |
@@ -9461,8 +9461,8 @@ system and gives an overview of their function and contents. | |||
9461 | - :term:`TMPDIR`: The top-level build output directory | 9461 | - :term:`TMPDIR`: The top-level build output directory |
9462 | - :term:`MULTIMACH_TARGET_SYS`: The target system identifier | 9462 | - :term:`MULTIMACH_TARGET_SYS`: The target system identifier |
9463 | - :term:`PN`: The recipe name | 9463 | - :term:`PN`: The recipe name |
9464 | - :term:`EXTENDPE`: The epoch - (if :term:`PE` is not specified, which | 9464 | - :term:`EXTENDPE`: The epoch --- if :term:`PE` is not specified, which |
9465 | is usually the case for most recipes, then `EXTENDPE` is blank) | 9465 | is usually the case for most recipes, then `EXTENDPE` is blank. |
9466 | - :term:`PV`: The recipe version | 9466 | - :term:`PV`: The recipe version |
9467 | - :term:`PR`: The recipe revision | 9467 | - :term:`PR`: The recipe revision |
9468 | 9468 | ||