Received: from cpanel7.indieserve.net (cpanel7.indieserve.net [199.212.143.8]) by mx.groups.io with SMTP id smtpd.web10.2958.1589626342751392915 for ; Sat, 16 May 2020 03:52:23 -0700 Authentication-Results: mx.groups.io; dkim=missing; spf=pass (domain: crashcourse.ca, ip: 199.212.143.8, mailfrom: rpjday@crashcourse.ca) Received: from cpeac202e043973-cmac202e043970.sdns.net.rogers.com ([174.114.100.179]:33424 helo=localhost.localdomain) by cpanel7.indieserve.net with esmtpsa (TLS1.2) tls TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (Exim 4.93) (envelope-from ) id 1jZuQU-00GQN9-EF; Sat, 16 May 2020 06:52:20 -0400 Date: Sat, 16 May 2020 06:52:15 -0400 (EDT) From: "Robert P. J. Day" X-X-Sender: rpjday@localhost.localdomain To: YP docs mailing list cc: Mark Morton Subject: [PATCH][RFC] ref-manual: add content for new features_check.bbclass Message-ID: MIME-Version: 1.0 X-OutGoing-Spam-Status: No, score=-0.2 X-AntiAbuse: This header was added to track abuse, please include it with any abuse report X-AntiAbuse: Primary Hostname - cpanel7.indieserve.net X-AntiAbuse: Original Domain - lists.yoctoproject.org X-AntiAbuse: Originator/Caller UID/GID - [47 12] / [47 12] X-AntiAbuse: Sender Address Domain - crashcourse.ca X-Get-Message-Sender-Via: cpanel7.indieserve.net: authenticated_id: rpjday+crashcourse.ca/only user confirmed/virtual account not confirmed X-Authenticated-Sender: cpanel7.indieserve.net: rpjday@crashcourse.ca X-Source: X-Source-Args: X-Source-Dir: Content-Type: text/plain; charset=US-ASCII first pass at adding everything related to features_check.bbclass; lots of changes so good chance i missed something. if no objections, will submit for real. related bugzilla entry: https://bugzilla.yoctoproject.org/show_bug.cgi?id=13884 rday --- diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml index affc8b90a..66133f6ef 100644 --- a/documentation/ref-manual/migration.xml +++ b/documentation/ref-manual/migration.xml @@ -7188,7 +7188,26 @@ id=f4d4f99cfbc2396e49c1613a7d237b9e57f06f81'>commit message. features_check class replaces distro_features_check - The distro_features_check class has had its functionality expanded, now supporting ANY_OF_MACHINE_FEATURES, REQUIRED_MACHINE_FEATURES, CONFLICT_MACHINE_FEATURES, ANY_OF_COMBINED_FEATURES, REQUIRED_COMBINED_FEATURES, CONFLICT_COMBINED_FEATURES. As a result the class has now been renamed to features_check; the distro_features_check class still exists but generates a warning and redirects to the new class. In preparation for a future removal of the old class it is recommended that you update recipes currently inheriting distro_features_check to inherit features_check instead. + The distro_features_check class has had its functionality expanded, + now supporting the checks: + + REQUIRED_MACHINE_FEATURES + ANY_OF_MACHINE_FEATURES + CONFLICT_MACHINE_FEATURES + REQUIRED_DISTRO_FEATURES + ANY_OF_DISTRO_FEATURES + CONFLICT_DISTRO_FEATURES + REQUIRED_COMBINED_FEATURES + ANY_OF_COMBINED_FEATURES + CONFLICT_COMBINED_FEATURES + + As a result, the class has been renamed to + features_check; + the distro_features_check + class still exists but generates a deprecation warning and redirects to the new class. + In preparation for a future removal of the old class, it is recommended that you + update recipes currently inheriting distro_features_check + to inherit features_check instead. diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml index f9bbddd72..d3dd5f348 100644 --- a/documentation/ref-manual/ref-classes.xml +++ b/documentation/ref-manual/ref-classes.xml @@ -677,19 +677,8 @@ <filename>distro_features_check.bbclass</filename> - The distro_features_check class - allows individual recipes to check for required and conflicting - DISTRO_FEATURES. - - - - This class provides support for the - REQUIRED_DISTRO_FEATURES - and - CONFLICT_DISTRO_FEATURES - variables. - If any conditions specified in the recipe using the above variables are - not met, the recipe will be skipped. + This class has been deprecated in favour of the newer + features_check class. @@ -865,6 +854,34 @@ +
+ <filename>features_check.bbclass</filename> + + + The features_check class + allows individual recipes to check for required and conflicting + DISTRO_FEATURES and + MACHINE_FEATURES, + and replaces the now-deprecated + distro_features_check class. + + + + This class now supports the definition of the feature tests: + + REQUIRED_MACHINE_FEATURES + ANY_OF_MACHINE_FEATURES + CONFLICT_MACHINE_FEATURES + REQUIRED_DISTRO_FEATURES + ANY_OF_DISTRO_FEATURES + CONFLICT_DISTRO_FEATURES + REQUIRED_COMBINED_FEATURES + ANY_OF_COMBINED_FEATURES + CONFLICT_COMBINED_FEATURES + + +
+
<filename>fontcache.bbclass</filename> diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml index 364cd09eb..3ef302df4 100644 --- a/documentation/ref-manual/ref-variables.xml +++ b/documentation/ref-manual/ref-variables.xml @@ -246,6 +246,60 @@ + ANY_OF_COMBINED_FEATURES + + ANY_OF_COMBINED_FEATURES[doc] = "When a recipe inherits the features_check class, this variable identifies combined features of which at least one must be selected." + + + + When inheriting the + features_check + class, this variable identifies combined features of which + at least one must be selected. + In other words, if none of the features listed in the + ANY_OF_COMBINED_FEATURES variable appears in + COMBINED_FEATURES + within the current configuration, an error occurs and the build stops. + + + + + ANY_OF_DISTRO_FEATURES + + ANY_OF_DISTRO_FEATURES[doc] = "When a recipe inherits the features_check class, this variable identifies distro features of which at least one must be selected." + + + + When inheriting the + features_check + class, this variable identifies distribution features of which + at least one must be selected. + In other words, if none of the features listed in the + ANY_OF_DISTRO_FEATURES variable appears in + DISTRO_FEATURES + within the current configuration, an error occurs and the build stops. + + + + + ANY_OF_MACHINE_FEATURES + + ANY_OF_MACHINE_FEATURES[doc] = "When a recipe inherits the features_check class, this variable identifies machine features of which at least one must be selected." + + + + When inheriting the + features_check + class, this variable identifies machine features of which + at least one must be selected. + In other words, if none of the features listed in the + ANY_OF_MACHINE_FEATURES variable appears in + MACHINE_FEATURES + within the current configuration, an error occurs and the build stops. + + + + APPEND APPEND[doc] = "An override list of append strings for target specified using LABELS." @@ -2536,20 +2590,36 @@ + CONFLICT_COMBINED_FEATURES + + CONFLICT_COMBINED_FEATURES[doc] = "When a recipe inherits the features_check class, this variable identifies combined features that would be in conflict should the recipe be built." + + + + When inheriting the + features_check + class, this variable identifies combined features that would + be in conflict should the recipe be built. + In other words, if the CONFLICT_COMBINED_FEATURES variable + lists a feature that also appears in + COMBINED_FEATURES within the + current configuration, an error occurs and the + build stops. + + + + CONFLICT_DISTRO_FEATURES - CONFLICT_DISTRO_FEATURES[doc] = "When a recipe inherits the distro_features_check class, this variable identifies distribution features that would be in conflict should the recipe be built." + CONFLICT_DISTRO_FEATURES[doc] = "When a recipe inherits the features_check class, this variable identifies distribution features that would be in conflict should the recipe be built." When inheriting the - distro_features_check - class, this - variable identifies distribution features that would - be in conflict should the recipe - be built. - In other words, if the - CONFLICT_DISTRO_FEATURES variable + features_check + class, this variable identifies distribution features that would + be in conflict should the recipe be built. + In other words, if the CONFLICT_DISTRO_FEATURES variable lists a feature that also appears in DISTRO_FEATURES within the current configuration, an error occurs and the @@ -2558,6 +2628,25 @@ + CONFLICT_MACHINE_FEATURES + + CONFLICT_MACHINE_FEATURES[doc] = "When a recipe inherits the features_check class, this variable identifies machine features that would be in conflict should the recipe be built." + + + + When inheriting the + features_check + class, this variable identifies machine features that would + be in conflict should the recipe be built. + In other words, if the CONFLICT_MACHINE_FEATURES variable + lists a feature that also appears in + MACHINE_FEATURES within the + current configuration, an error occurs and the + build stops. + + + + COPYLEFT_LICENSE_EXCLUDE COPYLEFT_LICENSE_EXCLUDE[doc] = "Licenses to exclude in the source archived by the archiver class." @@ -11596,23 +11685,64 @@ + REQUIRED_COMBINED_FEATURES + + REQUIRED_COMBINED_FEATURES[doc] = "When a recipe inherits the features_check class, this variable identifies combined features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe." + + + + When inheriting the + features_check + class, this variable identifies combined features that must + exist in the current configuration in order for the + OpenEmbedded build system to build the recipe. + In other words, if the + REQUIRED_COMBINED_FEATURES variable + lists a feature that does not appear in + COMBINED_FEATURES + within the current configuration, an error occurs and the + build stops. + + + + REQUIRED_DISTRO_FEATURES - REQUIRED_DISTRO_FEATURES[doc] = "When a recipe inherits the distro_features_check class, this variable identifies distribution features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe." + REQUIRED_DISTRO_FEATURES[doc] = "When a recipe inherits the features_check class, this variable identifies distribution features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe." When inheriting the - distro_features_check - class, this - variable identifies distribution features that must + features_check + class, this variable identifies distribution features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe. In other words, if the REQUIRED_DISTRO_FEATURES variable lists a feature that does not appear in - DISTRO_FEATURES within the - current configuration, an error occurs and the + DISTRO_FEATURES + within the current configuration, an error occurs and the + build stops. + + + + + REQUIRED_MACHINE_FEATURES + + REQUIRED_MACHINE_FEATURES[doc] = "When a recipe inherits the features_check class, this variable identifies machine features that must exist in the current configuration in order for the OpenEmbedded build system to build the recipe." + + + + When inheriting the + features_check + class, this variable identifies machine features that must + exist in the current configuration in order for the + OpenEmbedded build system to build the recipe. + In other words, if the + REQUIRED_MACHINE_FEATURES variable + lists a feature that does not appear in + MACHINE_FEATURES + within the current configuration, an error occurs and the build stops. -- ======================================================================== Robert P. J. Day Ottawa, Ontario, CANADA http://crashcourse.ca Twitter: http://twitter.com/rpjday LinkedIn: http://ca.linkedin.com/in/rpjday ========================================================================