diff options
author | Saul Wold <Saul.Wold@windriver.com> | 2022-02-04 12:22:58 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-03-16 14:25:01 +0000 |
commit | 7c617ecb4d161fc98033534b45c05072cba5647a (patch) | |
tree | ba333270129cc2df0dc46609ad76bc3db3ffbd9b /documentation | |
parent | de54ea299b553c040de8cd1555ca9cf9305c2b0c (diff) | |
download | poky-7c617ecb4d161fc98033534b45c05072cba5647a.tar.gz |
documentation: Update for skip_recipe rename
This change better aligns the name of the variable with its
purpose. Since we removed the older class, the associated
documentation is also removed.
(From yocto-docs rev: aa136a0fb552339db5475fff7947d2248f8af3e1)
Signed-off-by: Saul Wold <saul.wold@windriver.com>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/migration-guides/migration-3.5.rst | 10 | ||||
-rw-r--r-- | documentation/ref-manual/classes.rst | 17 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 24 |
3 files changed, 22 insertions, 29 deletions
diff --git a/documentation/migration-guides/migration-3.5.rst b/documentation/migration-guides/migration-3.5.rst index 556d7da0b6..da09b6f449 100644 --- a/documentation/migration-guides/migration-3.5.rst +++ b/documentation/migration-guides/migration-3.5.rst | |||
@@ -56,3 +56,13 @@ Recipe changes | |||
56 | 56 | ||
57 | - The `distutils*.bbclasses` have been moved to `meta-python`. The classes and | 57 | - The `distutils*.bbclasses` have been moved to `meta-python`. The classes and |
58 | `DISTUTILS*` variables have been removed from the documentation. | 58 | `DISTUTILS*` variables have been removed from the documentation. |
59 | |||
60 | Class changes | ||
61 | ------------- | ||
62 | |||
63 | - ``blacklist.bbclass`` is removed and the functionality moved to the | ||
64 | :ref:`base <ref-classes-base>` class with a more descriptive | ||
65 | ``varflag`` named :term:`SKIP_RECIPE` which will use the `SkipRecipe()` | ||
66 | function. The usage will remain the same:: | ||
67 | |||
68 | SKIP_RECIPE[my-recipe] = "Reason for skipping recipe" | ||
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index cba9793332..d7d86ebc46 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -208,23 +208,6 @@ scripts to be disabled should be specified using the | |||
208 | :term:`BINCONFIG` variable within the recipe inheriting | 208 | :term:`BINCONFIG` variable within the recipe inheriting |
209 | the class. | 209 | the class. |
210 | 210 | ||
211 | .. _ref-classes-blacklist: | ||
212 | |||
213 | ``blacklist.bbclass`` | ||
214 | ===================== | ||
215 | |||
216 | The ``blacklist`` class prevents the OpenEmbedded build system from | ||
217 | building specific recipes. To use this class, inherit | ||
218 | the class globally and set :term:`PNBLACKLIST` for | ||
219 | each recipe you wish to ignore. Specify the :term:`PN` | ||
220 | value as a variable flag (varflag) and provide a reason, which is | ||
221 | reported, if the package is requested to be built as the value. For | ||
222 | example, if you want to ignore a recipe called "exoticware", you | ||
223 | add the following to your ``local.conf`` or distribution configuration:: | ||
224 | |||
225 | INHERIT += "blacklist" | ||
226 | PNBLACKLIST[exoticware] = "Not supported by our organization." | ||
227 | |||
228 | .. _ref-classes-buildhistory: | 211 | .. _ref-classes-buildhistory: |
229 | 212 | ||
230 | ``buildhistory.bbclass`` | 213 | ``buildhistory.bbclass`` |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 005456f0c4..c8b4a157d8 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -5700,18 +5700,6 @@ system and gives an overview of their function and contents. | |||
5700 | packages for the target and for Multilib, :term:`PN` would be ``bash`` | 5700 | packages for the target and for Multilib, :term:`PN` would be ``bash`` |
5701 | and ``lib64-bash``, respectively. | 5701 | and ``lib64-bash``, respectively. |
5702 | 5702 | ||
5703 | :term:`PNBLACKLIST` | ||
5704 | Lists recipes you do not want the OpenEmbedded build system to build. | ||
5705 | This variable works in conjunction with the | ||
5706 | :ref:`blacklist <ref-classes-blacklist>` class, which is inherited | ||
5707 | globally. | ||
5708 | |||
5709 | To prevent a recipe from being built, use the :term:`PNBLACKLIST` | ||
5710 | variable in your ``local.conf`` file. Here is an example that | ||
5711 | prevents ``myrecipe`` from being built:: | ||
5712 | |||
5713 | PNBLACKLIST[myrecipe] = "Not supported by our organization." | ||
5714 | |||
5715 | :term:`POPULATE_SDK_POST_HOST_COMMAND` | 5703 | :term:`POPULATE_SDK_POST_HOST_COMMAND` |
5716 | Specifies a list of functions to call once the OpenEmbedded build | 5704 | Specifies a list of functions to call once the OpenEmbedded build |
5717 | system has created the host part of the SDK. You can specify | 5705 | system has created the host part of the SDK. You can specify |
@@ -6947,6 +6935,18 @@ system and gives an overview of their function and contents. | |||
6947 | 6935 | ||
6948 | SKIP_FILEDEPS = "1" | 6936 | SKIP_FILEDEPS = "1" |
6949 | 6937 | ||
6938 | :term:`SKIP_RECIPE` | ||
6939 | Used to prevent the OpenEmbedded build system from building a given | ||
6940 | recipe. Specify the :term:`PN` value as a variable flag (``varflag``) | ||
6941 | and provide a reason, which will be reported when attempting to | ||
6942 | build the recipe. | ||
6943 | |||
6944 | To prevent a recipe from being built, use the :term:`SKIP_RECIPE` | ||
6945 | variable in your ``local.conf`` file or distribution configuration. | ||
6946 | Here is an example which prevents ``myrecipe`` from being built:: | ||
6947 | |||
6948 | SKIP_RECIPE[myrecipe] = "Not supported by our organization." | ||
6949 | |||
6950 | :term:`SOC_FAMILY` | 6950 | :term:`SOC_FAMILY` |
6951 | Groups together machines based upon the same family of SOC (System On | 6951 | Groups together machines based upon the same family of SOC (System On |
6952 | Chip). You typically set this variable in a common ``.inc`` file that | 6952 | Chip). You typically set this variable in a common ``.inc`` file that |