| Message ID | 20220204172917.110423-1-saul.wold@windriver.com |
|---|---|
| State | New |
| Headers | show |
| Series | documentation: Update for skip_recipe rename | expand |
Hi Saul, On 2/4/22 18:29, Saul Wold wrote: > This change better aligns the name of the variable with it's > purpose. Since we removed the odler class, the associated > documentation is also removed. > > Signed-off-by: Saul Wold <saul.wold@windriver.com> > --- > documentation/ref-manual/classes.rst | 17 ----------------- > documentation/ref-manual/variables.rst | 24 ++++++++++++------------ > 2 files changed, 12 insertions(+), 29 deletions(-) > > diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst > index 949217bf42..8444fa4621 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 > :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`` > diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst > index d4f40b6929..323f9a4ced 100644 > --- a/documentation/ref-manual/variables.rst > +++ b/documentation/ref-manual/variables.rst > @@ -5683,18 +5683,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 > @@ -6929,6 +6917,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) We could probably link to the syntax documentation? https://docs.yoctoproject.org/bitbake/bitbake-user-manual/bitbake-user-manual-metadata.html#variable-flag-syntax or put varflag in tick quotes at least? > + and provide a reason, which is reported, if the package is requested > + to be built 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 distrbution configuration. distribution > + Here is an example that prevents ``myrecipe`` from being built:: > + s/that/which/ ? don't know, I've always struggled with this one. Thanks for doing this! Can you add a few words on this change in the migration guide too please? Cheers, Quentin > + 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 > > > > -=-=-=-=-=-=-=-=-=-=-=- > Links: You receive all messages sent to this group. > View/Reply Online (#2461): https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_message_2461&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=QwAVv26m3nhxkLg8vIRbg36-64e9TOFcu4EwANM184tkx4wepEJJqTALti_MunCq&s=AQxZ3r5lqvoIAHpA1QN7ZyhKXkiD6ZZ0WUtvzjvHT98&e= > Mute This Topic: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_mt_88911954_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=QwAVv26m3nhxkLg8vIRbg36-64e9TOFcu4EwANM184tkx4wepEJJqTALti_MunCq&s=yia1KFy-nyY6I3BSOlf6PkQpRbNnZM9Nk9JU5JeK0jA&e= > Group Owner: docs+owner@lists.yoctoproject.org > Unsubscribe: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.yoctoproject.org_g_docs_unsub&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=QwAVv26m3nhxkLg8vIRbg36-64e9TOFcu4EwANM184tkx4wepEJJqTALti_MunCq&s=epVA_LS6rJTNC3JYzQlRyuXnY2XcLU7GW66huIz2Rg4&e= [quentin.schulz@theobroma-systems.com] > -=-=-=-=-=-=-=-=-=-=-=- >
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 949217bf42..8444fa4621 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 :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`` diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index d4f40b6929..323f9a4ced 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -5683,18 +5683,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 @@ -6929,6 +6917,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 is reported, if the package is requested + to be built + + To prevent a recipe from being built, use the :term:`SKIP_RECIPE` + variable in your ``local.conf`` file or distrbution configuration. + Here is an example that 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
This change better aligns the name of the variable with it's purpose. Since we removed the odler class, the associated documentation is also removed. Signed-off-by: Saul Wold <saul.wold@windriver.com> --- documentation/ref-manual/classes.rst | 17 ----------------- documentation/ref-manual/variables.rst | 24 ++++++++++++------------ 2 files changed, 12 insertions(+), 29 deletions(-)