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 f723e38d1a..b42854caaa 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 |
@@ -889,7 +889,7 @@ system and gives an overview of their function and contents. | |||
889 | :term:`BUILD_OS` | 889 | :term:`BUILD_OS` |
890 | Specifies the operating system in use on the build host (e.g. | 890 | Specifies the operating system in use on the build host (e.g. |
891 | "linux"). The OpenEmbedded build system sets the value of | 891 | "linux"). The OpenEmbedded build system sets the value of |
892 | :term:`BUILD_OS` from the OS reported by the ``uname`` command - the | 892 | :term:`BUILD_OS` from the OS reported by the ``uname`` command --- the |
893 | first word, converted to lower-case characters. | 893 | first word, converted to lower-case characters. |
894 | 894 | ||
895 | :term:`BUILD_PREFIX` | 895 | :term:`BUILD_PREFIX` |
@@ -1689,7 +1689,7 @@ system and gives an overview of their function and contents. | |||
1689 | ``${TMPDIR}/deploy``. | 1689 | ``${TMPDIR}/deploy``. |
1690 | 1690 | ||
1691 | For more information on the structure of the Build Directory, see | 1691 | For more information on the structure of the Build Directory, see |
1692 | ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. | 1692 | ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. |
1693 | For more detail on the contents of the ``deploy`` directory, see the | 1693 | For more detail on the contents of the ``deploy`` directory, see the |
1694 | ":ref:`overview-manual/concepts:images`", | 1694 | ":ref:`overview-manual/concepts:images`", |
1695 | ":ref:`overview-manual/concepts:package feeds`", and | 1695 | ":ref:`overview-manual/concepts:package feeds`", and |
@@ -1733,7 +1733,7 @@ system and gives an overview of their function and contents. | |||
1733 | <ref-classes-image>` class. | 1733 | <ref-classes-image>` class. |
1734 | 1734 | ||
1735 | For more information on the structure of the Build Directory, see | 1735 | For more information on the structure of the Build Directory, see |
1736 | ":ref:`ref-manual/structure:the build directory - \`\`build/\`\``" section. | 1736 | ":ref:`ref-manual/structure:the build directory --- \`\`build/\`\``" section. |
1737 | For more detail on the contents of the ``deploy`` directory, see the | 1737 | For more detail on the contents of the ``deploy`` directory, see the |
1738 | ":ref:`overview-manual/concepts:images`" and | 1738 | ":ref:`overview-manual/concepts:images`" and |
1739 | ":ref:`overview-manual/concepts:application development sdk`" sections both in | 1739 | ":ref:`overview-manual/concepts:application development sdk`" sections both in |
@@ -2248,24 +2248,24 @@ system and gives an overview of their function and contents. | |||
2248 | 2248 | ||
2249 | Here are some examples of features you can add: | 2249 | Here are some examples of features you can add: |
2250 | 2250 | ||
2251 | - "dbg-pkgs" - Adds -dbg packages for all installed packages including | 2251 | - "dbg-pkgs" --- adds -dbg packages for all installed packages including |
2252 | symbol information for debugging and profiling. | 2252 | symbol information for debugging and profiling. |
2253 | 2253 | ||
2254 | - "debug-tweaks" - Makes an image suitable for debugging. For example, allows root logins without passwords and | 2254 | - "debug-tweaks" --- makes an image suitable for debugging. For example, allows root logins without passwords and |
2255 | enables post-installation logging. See the 'allow-empty-password' and | 2255 | enables post-installation logging. See the 'allow-empty-password' and |
2256 | 'post-install-logging' features in the ":ref:`ref-features-image`" | 2256 | 'post-install-logging' features in the ":ref:`ref-features-image`" |
2257 | section for more information. | 2257 | section for more information. |
2258 | - "dev-pkgs" - Adds -dev packages for all installed packages. This is | 2258 | - "dev-pkgs" --- adds -dev packages for all installed packages. This is |
2259 | useful if you want to develop against the libraries in the image. | 2259 | useful if you want to develop against the libraries in the image. |
2260 | - "read-only-rootfs" - Creates an image whose root filesystem is | 2260 | - "read-only-rootfs" --- creates an image whose root filesystem is |
2261 | read-only. See the | 2261 | read-only. See the |
2262 | ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" | 2262 | ":ref:`dev-manual/common-tasks:creating a read-only root filesystem`" |
2263 | section in the Yocto Project Development Tasks Manual for more | 2263 | section in the Yocto Project Development Tasks Manual for more |
2264 | information | 2264 | information |
2265 | - "tools-debug" - Adds debugging tools such as gdb and strace. | 2265 | - "tools-debug" --- adds debugging tools such as gdb and strace. |
2266 | - "tools-sdk" - Adds development tools such as gcc, make, | 2266 | - "tools-sdk" --- adds development tools such as gcc, make, |
2267 | pkgconfig and so forth. | 2267 | pkgconfig and so forth. |
2268 | - "tools-testapps" - Adds useful testing tools | 2268 | - "tools-testapps" --- adds useful testing tools |
2269 | such as ts_print, aplay, arecord and so forth. | 2269 | such as ts_print, aplay, arecord and so forth. |
2270 | 2270 | ||
2271 | For a complete list of image features that ships with the Yocto | 2271 | For a complete list of image features that ships with the Yocto |
@@ -3259,7 +3259,7 @@ system and gives an overview of their function and contents. | |||
3259 | IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}" | 3259 | IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}" |
3260 | 3260 | ||
3261 | :term:`IMAGE_NAME_SUFFIX` | 3261 | :term:`IMAGE_NAME_SUFFIX` |
3262 | Suffix used for the image output filename - defaults to ``".rootfs"`` | 3262 | Suffix used for the image output filename --- defaults to ``".rootfs"`` |
3263 | to distinguish the image file from other files created during image | 3263 | to distinguish the image file from other files created during image |
3264 | building; however if this suffix is redundant or not desired you can | 3264 | building; however if this suffix is redundant or not desired you can |
3265 | clear the value of this variable (set the value to ""). For example, | 3265 | clear the value of this variable (set the value to ""). For example, |
@@ -6217,7 +6217,7 @@ system and gives an overview of their function and contents. | |||
6217 | ``baz``. | 6217 | ``baz``. |
6218 | 6218 | ||
6219 | The names of the packages you list within :term:`RDEPENDS` must be the | 6219 | The names of the packages you list within :term:`RDEPENDS` must be the |
6220 | names of other packages - they cannot be recipe names. Although | 6220 | names of other packages --- they cannot be recipe names. Although |
6221 | package names and recipe names usually match, the important point | 6221 | package names and recipe names usually match, the important point |
6222 | here is that you are providing package names within the :term:`RDEPENDS` | 6222 | here is that you are providing package names within the :term:`RDEPENDS` |
6223 | variable. For an example of the default list of packages created from | 6223 | variable. For an example of the default list of packages created from |
@@ -7120,35 +7120,35 @@ system and gives an overview of their function and contents. | |||
7120 | 7120 | ||
7121 | There are standard and recipe-specific options. Here are standard ones: | 7121 | There are standard and recipe-specific options. Here are standard ones: |
7122 | 7122 | ||
7123 | - ``apply`` - Whether to apply the patch or not. The default | 7123 | - ``apply`` --- whether to apply the patch or not. The default |
7124 | action is to apply the patch. | 7124 | action is to apply the patch. |
7125 | 7125 | ||
7126 | - ``striplevel`` - Which striplevel to use when applying the | 7126 | - ``striplevel`` --- which striplevel to use when applying the |
7127 | patch. The default level is 1. | 7127 | patch. The default level is 1. |
7128 | 7128 | ||
7129 | - ``patchdir`` - Specifies the directory in which the patch should | 7129 | - ``patchdir`` --- specifies the directory in which the patch should |
7130 | be applied. The default is ``${``\ :term:`S`\ ``}``. | 7130 | be applied. The default is ``${``\ :term:`S`\ ``}``. |
7131 | 7131 | ||
7132 | Here are options specific to recipes building code from a revision | 7132 | Here are options specific to recipes building code from a revision |
7133 | control system: | 7133 | control system: |
7134 | 7134 | ||
7135 | - ``mindate`` - Apply the patch only if | 7135 | - ``mindate`` --- apply the patch only if |
7136 | :term:`SRCDATE` is equal to or greater than | 7136 | :term:`SRCDATE` is equal to or greater than |
7137 | ``mindate``. | 7137 | ``mindate``. |
7138 | 7138 | ||
7139 | - ``maxdate`` - Apply the patch only if :term:`SRCDATE` is not later | 7139 | - ``maxdate`` --- apply the patch only if :term:`SRCDATE` is not later |
7140 | than ``maxdate``. | 7140 | than ``maxdate``. |
7141 | 7141 | ||
7142 | - ``minrev`` - Apply the patch only if :term:`SRCREV` is equal to or | 7142 | - ``minrev`` --- apply the patch only if :term:`SRCREV` is equal to or |
7143 | greater than ``minrev``. | 7143 | greater than ``minrev``. |
7144 | 7144 | ||
7145 | - ``maxrev`` - Apply the patch only if :term:`SRCREV` is not later | 7145 | - ``maxrev`` --- apply the patch only if :term:`SRCREV` is not later |
7146 | than ``maxrev``. | 7146 | than ``maxrev``. |
7147 | 7147 | ||
7148 | - ``rev`` - Apply the patch only if :term:`SRCREV` is equal to | 7148 | - ``rev`` --- apply the patch only if :term:`SRCREV` is equal to |
7149 | ``rev``. | 7149 | ``rev``. |
7150 | 7150 | ||
7151 | - ``notrev`` - Apply the patch only if :term:`SRCREV` is not equal to | 7151 | - ``notrev`` --- apply the patch only if :term:`SRCREV` is not equal to |
7152 | ``rev``. | 7152 | ``rev``. |
7153 | 7153 | ||
7154 | .. note:: | 7154 | .. note:: |
@@ -8857,8 +8857,8 @@ system and gives an overview of their function and contents. | |||
8857 | - :term:`TMPDIR`: The top-level build output directory | 8857 | - :term:`TMPDIR`: The top-level build output directory |
8858 | - :term:`MULTIMACH_TARGET_SYS`: The target system identifier | 8858 | - :term:`MULTIMACH_TARGET_SYS`: The target system identifier |
8859 | - :term:`PN`: The recipe name | 8859 | - :term:`PN`: The recipe name |
8860 | - :term:`EXTENDPE`: The epoch - (if :term:`PE` is not specified, which | 8860 | - :term:`EXTENDPE`: The epoch --- if :term:`PE` is not specified, which |
8861 | is usually the case for most recipes, then `EXTENDPE` is blank) | 8861 | is usually the case for most recipes, then `EXTENDPE` is blank. |
8862 | - :term:`PV`: The recipe version | 8862 | - :term:`PV`: The recipe version |
8863 | - :term:`PR`: The recipe revision | 8863 | - :term:`PR`: The recipe revision |
8864 | 8864 | ||