mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-01-29 21:08:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

ref-manual: expand documentation on image-buildinfo class

Browse Source 
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 <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Paul Eggleton
2022-10-06 13:36:38 +13:00
committed by Richard Purdie
parent 500d5bc5c9
commit 8ba77dd403
2 changed files with 32 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
documentation/ref-manual/classes.rst
View File

@@ -881,8 +881,22 @@ Yocto Project Overview and Concepts Manual.
``image-buildinfo.bbclass``
===========================
The ``image-buildinfo`` class writes information to the target
filesystem on ``/etc/build``.
The ``image-buildinfo`` class writes a plain text file containing
build information to the target filesystem at ``${sysconfdir}/buildinfo``
by default (as specified by :term:`IMAGE_BUILDINFO_FILE`.
This can be useful for manually determining the origin of any given
image. It writes out two sections:
1. `Build Configuration`: a list of variables and their values (specified
by :term:`IMAGE_BUILDINFO_VARS`, which defaults to :term:`DISTRO` and
:term:`DISTRO_VERSION`)
2. `Layer Revisions`: the revisions of all of the layers used in the
build.
Additionally, when building an SDK it will write the same contents
to ``/buildinfo`` by default (as specified by
:term:`SDK_BUILDINFO_FILE`).
.. _ref-classes-image_types:

16
documentation/ref-manual/variables.rst
View File

@@ -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 <ref-classes-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 <ref-classes-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 <ref-classes-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