1
0
mirror of https://git.yoctoproject.org/poky synced 2026-05-08 05:09:24 +00:00

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>
This commit is contained in:
Saul Wold
2022-02-04 12:22:58 -08:00
committed by Richard Purdie
parent de54ea299b
commit 7c617ecb4d
3 changed files with 22 additions and 29 deletions
@@ -56,3 +56,13 @@ Recipe changes
- The `distutils*.bbclasses` have been moved to `meta-python`. The classes and
`DISTUTILS*` variables have been removed from the documentation.
Class changes
-------------
- ``blacklist.bbclass`` is removed and the functionality moved to the
:ref:`base <ref-classes-base>` class with a more descriptive
``varflag`` named :term:`SKIP_RECIPE` which will use the `SkipRecipe()`
function. The usage will remain the same::
SKIP_RECIPE[my-recipe] = "Reason for skipping recipe"
-17
View File
@@ -208,23 +208,6 @@ scripts to be disabled should be specified using the
:term:`BINCONFIG` variable within the recipe inheriting
the class.
.. _ref-classes-blacklist:
``blacklist.bbclass``
=====================
The ``blacklist`` class prevents the OpenEmbedded build system from
building specific recipes. To use this class, inherit
the class globally and set :term:`PNBLACKLIST` for
each recipe you wish to ignore. Specify the :term:`PN`
value as a variable flag (varflag) and provide a reason, which is
reported, if the package is requested to be built as the value. For
example, if you want to ignore a recipe called "exoticware", you
add the following to your ``local.conf`` or distribution configuration::
INHERIT += "blacklist"
PNBLACKLIST[exoticware] = "Not supported by our organization."
.. _ref-classes-buildhistory:
``buildhistory.bbclass``
+12 -12
View File
@@ -5700,18 +5700,6 @@ system and gives an overview of their function and contents.
packages for the target and for Multilib, :term:`PN` would be ``bash``
and ``lib64-bash``, respectively.
:term:`PNBLACKLIST`
Lists recipes you do not want the OpenEmbedded build system to build.
This variable works in conjunction with the
:ref:`blacklist <ref-classes-blacklist>` class, which is inherited
globally.
To prevent a recipe from being built, use the :term:`PNBLACKLIST`
variable in your ``local.conf`` file. Here is an example that
prevents ``myrecipe`` from being built::
PNBLACKLIST[myrecipe] = "Not supported by our organization."
:term:`POPULATE_SDK_POST_HOST_COMMAND`
Specifies a list of functions to call once the OpenEmbedded build
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.
SKIP_FILEDEPS = "1"
:term:`SKIP_RECIPE`
Used to prevent the OpenEmbedded build system from building a given
recipe. Specify the :term:`PN` value as a variable flag (``varflag``)
and provide a reason, which will be reported when attempting to
build the recipe.
To prevent a recipe from being built, use the :term:`SKIP_RECIPE`
variable in your ``local.conf`` file or distribution configuration.
Here is an example which prevents ``myrecipe`` from being built::
SKIP_RECIPE[myrecipe] = "Not supported by our organization."
:term:`SOC_FAMILY`
Groups together machines based upon the same family of SOC (System On
Chip). You typically set this variable in a common ``.inc`` file that