buildroot/docs/manual
Yann E. MORIN ddf66867b1 doc/manual: document _CPE_ID_VALID
The way we handle CPE_ID variable is unusual compared to the other
variables: we mostly compute defaults for all of them, and eventually
aggregate the various CPE_ID variables to form the CPE ID name.

However, we do not consider that CPE ID to valid, unless there is one
(or more) CPE_ID variables actually set by the package; this shows that
the CPE ID has been checked to be valid against the NVD CPE database. In
that situation, we internally define the duly undocumented _CPE_ID_VALID
variable.

However, it is totally possible (and very often the case) that the
default value we set to those variables are appropriate, and do defne a
valid CPE ID. In this case, the package will define any arbitrary CPE_ID
variable to its default value, usually by setting either the VENDOR or
PRODUCT field, though there is no rule or requirement that be the case.

This is not very clean, non-obvious, and does not allow for easily
adding checks in check-package.

Add the _CPE_ID_VALID variable to the manual, to make it official that
it should be used when the default values of the others are valid.

Signed-off-by: Yann E. MORIN <yann.morin.1998@free.fr>
Cc: Fabrice Fontaine <fontaine.fabrice@gmail.com>
Signed-off-by: Thomas Petazzoni <thomas.petazzoni@bootlin.com>
2024-02-11 16:29:02 +01:00
..
adding-board-support.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-asciidoc.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-autotools.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-cargo.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-cmake.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-conclusion.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-directory.adoc doc/manual: fixup ordered lists 2024-02-11 16:28:35 +01:00
adding-packages-generic.adoc doc/manual: document _CPE_ID_VALID 2024-02-11 16:29:02 +01:00
adding-packages-gettext.adoc doc/manual: fixup ordered lists 2024-02-11 16:28:35 +01:00
adding-packages-golang.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-hooks.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-kconfig.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-kernel-module.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-linux-kernel-spec-infra.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-luarocks.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-meson.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-perl.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-python.adoc docs/manual: update documentation about support python <pkg>_SETUP_TYPE 2024-02-06 23:21:23 +01:00
adding-packages-qmake.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-rebar.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-tips.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-virtual.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages-waf.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
adding-packages.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
advanced.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
appendix.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
beyond-buildroot.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
ccache-support.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
common-usage.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
configure-other-components.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
configure.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
contribute.adoc docs/manual/contribute.adoc: mention sr.ht as a fallback for sending patches 2024-02-06 18:03:57 +01:00
customize-configuration.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
customize-device-permission-tables.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
customize-directory-structure.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
customize-outside-br.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
customize-packages.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
customize-patches.adoc utils/add-custom-hashes: add script to manage global patch dir hashes 2023-11-12 11:59:27 +01:00
customize-post-image.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
customize-quick-guide.adoc doc/manual: fixup ordered lists 2024-02-11 16:28:35 +01:00
customize-rootfs.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
customize-users-tables.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
customize.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
debugging-buildroot.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
developers.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
download-infra.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
download-location.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
faq-troubleshooting.adoc docs/manual: add a FAQ entry about Y2038 support 2023-10-01 21:14:07 +02:00
getting.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
how-buildroot-works.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
integration-selinux-support.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
integration-systemd.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
integration.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
introduction.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
known-issues.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
legal-notice.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
make-tips.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
makedev-syntax.adoc docs/manual: extend makedev syntax section 2024-02-06 11:52:09 +01:00
makeusers-syntax.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
manual.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
manual.mk docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
migrating.adoc docs/manual: fix typo 2023-10-21 23:30:27 +02:00
package-make-target.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
patch-policy.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
prerequisite.adoc doc/manual: rsync is not optional 2023-12-11 09:21:52 +01:00
quickstart.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
rebuilding-packages.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
release-engineering.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
resources.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
using-buildroot-debugger.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
using-buildroot-development.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
using-buildroot-toolchain.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00
writing-rules.adoc docs/manual: rename *.txt as *.adoc 2023-09-30 10:25:22 +02:00