docs/manual: do not expose CPE_ID_VALID as package-settable
authorYann E. MORIN <yann.morin.1998@free.fr>
Fri, 5 Mar 2021 22:27:42 +0000 (23:27 +0100)
committerPeter Korsgaard <peter@korsgaard.com>
Sat, 6 Mar 2021 16:05:59 +0000 (17:05 +0100)
FOO_CPE_ID_VALID is an internal implementation detail. Packages should
really define an actual CPE_ID variable to trigger their full CPE_ID
definition.

Reported-by: Peter Korsgaard <peter@korsgaard.com>
Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
Cc: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
Cc: Arnout Vandecappelle (Essensium/Mind) <arnout@mind.be>
Cc: Matthew Weber <matthew.weber@rockwellcollins.com>
Cc: Fabrice Fontaine <fontaine.fabrice@gmail.com>
[Peter: completely drop any mention of _CPE_ID_VALID in the manual]
Signed-off-by: Peter Korsgaard <peter@korsgaard.com>
docs/manual/adding-packages-generic.txt

index 75af18b70c14abbdd956c58ea233abd2e73a2b4c..2201d4385ef1eb5955d5cb5c0fb804fa629f70e4 100644 (file)
@@ -528,14 +528,8 @@ LIBFOO_IGNORE_CVES += CVE-2020-54321
 +
 If any of those variables is defined, then the generic package
 infrastructure assumes the package provides valid CPE information. In
-this case, +LIBFOO_CPE_ID_VALID = YES+ will be set, and the generic
-package infrastructure will define +LIBFOO_CPE_ID+.
-+
-Alternatively, a package can also explicitly set +LIBFOO_CPE_ID_VALID
-= YES+ if the default values for +LIBFOO_CPE_ID_PREFIX+,
-+LIBFOO_CPE_ID_VENDOR+, +LIBFOO_CPE_ID_PRODUCT+,
-+LIBFOO_CPE_ID_VERSION+, +LIBFOO_CPE_ID_UPDATE+ are all correct for
-this package and don't need to be explicitly overridden.
+this case, the generic package infrastructure will define
++LIBFOO_CPE_ID+.
 +
 For a host package, if its +LIBFOO_CPE_ID_*+ variables are not
 defined, it inherits the value of those variables from the