Message ID | 20220204170144.105536-6-saul.wold@windriver.com |
---|---|
State | New |
Headers | show |
Series | Use more descriptive variable for skipping recipes | expand |
Hi Saul, On 2/4/22 18:01, 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> > --- > meta/conf/documentation.conf | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf > index 6b50ad08a8b..9614448a1fe 100644 > --- a/meta/conf/documentation.conf > +++ b/meta/conf/documentation.conf > @@ -331,7 +331,6 @@ PKGDATA_DIR[doc] = "Points to a shared, global-state directory that holds data g > PKGDEST[doc] = "Points to the parent directory for files to be packaged after they have been split into individual packages." > PKGDESTWORK[doc] = "Points to a temporary work area used by the do_package task to write output from the do_packagedata task." > PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. It refers to a package name in the context of a file created or produced by the OpenEmbedded build system." > -PNBLACKLIST[doc] = "Lists recipes you do not want the OpenEmbedded build system to build." > PR[doc] = "The revision of the recipe. The default value for this variable is 'r0'." > PREFERRED_PROVIDER[doc] = "If multiple recipes provide an item, this variable determines which recipe should be given preference." > PREFERRED_VERSION[doc] = "If there are multiple versions of recipes available, this variable determines which recipe should be given preference." > @@ -385,6 +384,7 @@ SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS[doc] = "A list of recipe dependencies that shoul > SIGGEN_EXCLUDERECIPES_ABISAFE[doc] = "A list of recipes that are completely stable and will never change." > SITEINFO_BITS[doc] = "Specifies the number of bits for the target system CPU." > SITEINFO_ENDIANNESS[doc] = "Specifies the endian byte order of the target system. The value should be either 'le' for 'little-endian' or 'be' for 'big-endian'." > +SKIP_RECIPE[doc] = "Lists recipes you do not want the OpenEmbedded build system to build." Mmm with this sentence I would basically try to use it this way: SKIP_RECIPE += "libndf" instead of SKIP_RECIPE[libdnf] = "message to be printed" I think we can do better :) Maybe add something like "e.g. SKIP_RECIPE[my-recipe] = "This is the reason for skipping this recipe"" at the end of the sentence? Also, can you add some words in documentation/migration-guides/migration-3.5.rst in yocto-docs to explain this migration so we don't forget about it before the release :) ? Thanks! Cheers, Quentin > SOC_FAMILY[doc] = "Groups together machines based upon the same family of SOC (System On Chip). You typically set this variable in a common .inc file that you include in the configuration files of all the machines." > SOLIBS[doc] = "Defines the suffix for shared libraries used on the target platform." > SOLIBSDEV[doc] = "Defines the suffix for the development symbolic link (symlink) for shared libraries on the target platform." > > > > -=-=-=-=-=-=-=-=-=-=-=- > Links: You receive all messages sent to this group. > View/Reply Online (#161370): https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.openembedded.org_g_openembedded-2Dcore_message_161370&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=uiHZKRqLMObgXqpXUwRFi8y7UtEaiVhDs8cQdPQk0Tdl2K_q3sYbssh1fwYeBTYV&s=dbpnhNdhY-cK8zLxdt9j35m75kaNaiam5c8Uj8YG66E&e= > Mute This Topic: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.openembedded.org_mt_88911226_6293953&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=uiHZKRqLMObgXqpXUwRFi8y7UtEaiVhDs8cQdPQk0Tdl2K_q3sYbssh1fwYeBTYV&s=N3WJTb7jcA-mNcna2UbtcBfV9fXbBYnRGcDLzvyL3sE&e= > Group Owner: openembedded-core+owner@lists.openembedded.org > Unsubscribe: https://urldefense.proofpoint.com/v2/url?u=https-3A__lists.openembedded.org_g_openembedded-2Dcore_unsub&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=uiHZKRqLMObgXqpXUwRFi8y7UtEaiVhDs8cQdPQk0Tdl2K_q3sYbssh1fwYeBTYV&s=nXnfk2h1SI1tLsRNpDucivTBifk_qM77Ldm0sTsIKQw&e= [quentin.schulz@theobroma-systems.com] > -=-=-=-=-=-=-=-=-=-=-=- >
diff --git a/meta/conf/documentation.conf b/meta/conf/documentation.conf index 6b50ad08a8b..9614448a1fe 100644 --- a/meta/conf/documentation.conf +++ b/meta/conf/documentation.conf @@ -331,7 +331,6 @@ PKGDATA_DIR[doc] = "Points to a shared, global-state directory that holds data g PKGDEST[doc] = "Points to the parent directory for files to be packaged after they have been split into individual packages." PKGDESTWORK[doc] = "Points to a temporary work area used by the do_package task to write output from the do_packagedata task." PN[doc] = "PN refers to a recipe name in the context of a file used by the OpenEmbedded build system as input to create a package. It refers to a package name in the context of a file created or produced by the OpenEmbedded build system." -PNBLACKLIST[doc] = "Lists recipes you do not want the OpenEmbedded build system to build." PR[doc] = "The revision of the recipe. The default value for this variable is 'r0'." PREFERRED_PROVIDER[doc] = "If multiple recipes provide an item, this variable determines which recipe should be given preference." PREFERRED_VERSION[doc] = "If there are multiple versions of recipes available, this variable determines which recipe should be given preference." @@ -385,6 +384,7 @@ SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS[doc] = "A list of recipe dependencies that shoul SIGGEN_EXCLUDERECIPES_ABISAFE[doc] = "A list of recipes that are completely stable and will never change." SITEINFO_BITS[doc] = "Specifies the number of bits for the target system CPU." SITEINFO_ENDIANNESS[doc] = "Specifies the endian byte order of the target system. The value should be either 'le' for 'little-endian' or 'be' for 'big-endian'." +SKIP_RECIPE[doc] = "Lists recipes you do not want the OpenEmbedded build system to build." SOC_FAMILY[doc] = "Groups together machines based upon the same family of SOC (System On Chip). You typically set this variable in a common .inc file that you include in the configuration files of all the machines." SOLIBS[doc] = "Defines the suffix for shared libraries used on the target platform." SOLIBSDEV[doc] = "Defines the suffix for the development symbolic link (symlink) for shared libraries on the target platform."
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> --- meta/conf/documentation.conf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)