From db24c08bea4a2e7f16ab8f2ff394b9b6dae119f1 Mon Sep 17 00:00:00 2001 From: Thomas Petazzoni Date: Wed, 4 Nov 2020 15:51:38 +0100 Subject: [PATCH] docs/manual: document _CPE_ID variables Signed-off-by: Thomas Petazzoni Reviewed-by: Matt Weber Reviewed-by: Heiko Thiery Signed-off-by: Thomas Petazzoni --- docs/manual/adding-packages-generic.txt | 39 +++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/docs/manual/adding-packages-generic.txt b/docs/manual/adding-packages-generic.txt index b8bfcb4aff..21fedd8b6b 100644 --- a/docs/manual/adding-packages-generic.txt +++ b/docs/manual/adding-packages-generic.txt @@ -502,6 +502,45 @@ LIBFOO_IGNORE_CVES += CVE-2020-12345 LIBFOO_IGNORE_CVES += CVE-2020-54321 ---------------------- +* +LIBFOO_CPE_ID_*+ variables is a set of variables that allows the + package to define its https://nvd.nist.gov/products/cpe[CPE + identifier]. The available variables are: ++ +-- +** +LIBFOO_CPE_ID_PREFIX+, specifies the prefix of the CPE identifier, + i.e the first three fields. When not defined, the default value is + +cpe:2.3:a+. + +** +LIBFOO_CPE_ID_VENDOR+, specifies the vendor part of the CPE + identifier. When not defined, the default value is + +_project+. + +** +LIBFOO_CPE_ID_PRODUCT+, specifies the product part of the CPE + identifier. When not defined, the default value is ++. + +** +LIBFOO_CPE_ID_VERSION+, specifies the version part of the CPE + identifier. When not defined the default value is + +$(LIBFOO_VERSION)+. + +** +LIBFOO_CPE_ID_VERSION_MINOR+ specifies the _update_ part of the + CPE identifier. When not defined the default value is +*+. +-- ++ +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_VERSION_MINOR+ are all correct +for this package and don't need to be explicitly overridden. ++ +For a host package, if its +LIBFOO_CPE_ID_*+ variables are not +defined, it inherits the value of those variables from the +corresponding target package. + The recommended way to define these variables is to use the following syntax: