From 8ba77dd4034dc74e1891578e977efb817045dc8a Mon Sep 17 00:00:00 2001 From: Paul Eggleton Date: Thu, 6 Oct 2022 13:36:38 +1300 Subject: ref-manual: expand documentation on image-buildinfo class Expand the documentation on the image-buildinfo class, and add variable glossary entries for IMAGE_BUILDINFO_FILE, IMAGE_BUILDINFO_VARS and SDK_BUILDINFO_FILE (latter is new in 4.1). (From yocto-docs rev: f69b2f614aaa56a19432538cb1adf33a441ea31d) Signed-off-by: Paul Eggleton Signed-off-by: Richard Purdie --- documentation/ref-manual/variables.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'documentation/ref-manual/variables.rst') diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 53079c4625..ad9857082d 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -3053,6 +3053,17 @@ system and gives an overview of their function and contents. material for Wic is located in the ":doc:`/ref-manual/kickstart`" chapter. + :term:`IMAGE_BUILDINFO_FILE` + When using the :ref:`image-buildinfo ` class, + specifies the file in the image to write the build information into. The + default value is "``${sysconfdir}/buildinfo``". + + :term:`IMAGE_BUILDINFO_VARS` + When using the :ref:`image-buildinfo ` class, + specifies the list of variables to include in the `Build Configuration` + section of the output file (as a space-separated list). Defaults to + ":term:`DISTRO` :term:`DISTRO_VERSION`". + :term:`IMAGE_CLASSES` A list of classes that all images should inherit. You typically use this variable to specify the list of classes that register the @@ -6627,6 +6638,11 @@ system and gives an overview of their function and contents. The target architecture for the SDK. Typically, you do not directly set this variable. Instead, use :term:`SDKMACHINE`. + :term:`SDK_BUILDINFO_FILE` + When using the :ref:`image-buildinfo ` class, + specifies the file in the SDK to write the build information into. The + default value is "``/buildinfo``". + :term:`SDK_CUSTOM_TEMPLATECONF` When building the extensible SDK, if :term:`SDK_CUSTOM_TEMPLATECONF` is set to "1" and a ``conf/templateconf.cfg`` file exists in the build directory -- cgit v1.2.3-54-g00ecf