diff options
| author | Paul Eggleton <paul.eggleton@microsoft.com> | 2022-10-06 13:36:38 +1300 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-10-19 17:32:56 +0100 |
| commit | 8ba77dd4034dc74e1891578e977efb817045dc8a (patch) | |
| tree | fb22c9f820b9d1481e2ca088fa6270fa7f44b8e6 /documentation/ref-manual/classes.rst | |
| parent | 500d5bc5c9ef820b5465400571eb2a478074d58a (diff) | |
| download | poky-8ba77dd4034dc74e1891578e977efb817045dc8a.tar.gz | |
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 <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/classes.rst')
| -rw-r--r-- | documentation/ref-manual/classes.rst | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 5e49613b2f..cc0d212130 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
| @@ -881,8 +881,22 @@ Yocto Project Overview and Concepts Manual. | |||
| 881 | ``image-buildinfo.bbclass`` | 881 | ``image-buildinfo.bbclass`` |
| 882 | =========================== | 882 | =========================== |
| 883 | 883 | ||
| 884 | The ``image-buildinfo`` class writes information to the target | 884 | The ``image-buildinfo`` class writes a plain text file containing |
| 885 | filesystem on ``/etc/build``. | 885 | build information to the target filesystem at ``${sysconfdir}/buildinfo`` |
| 886 | by default (as specified by :term:`IMAGE_BUILDINFO_FILE`. | ||
| 887 | This can be useful for manually determining the origin of any given | ||
| 888 | image. It writes out two sections: | ||
| 889 | |||
| 890 | 1. `Build Configuration`: a list of variables and their values (specified | ||
| 891 | by :term:`IMAGE_BUILDINFO_VARS`, which defaults to :term:`DISTRO` and | ||
| 892 | :term:`DISTRO_VERSION`) | ||
| 893 | |||
| 894 | 2. `Layer Revisions`: the revisions of all of the layers used in the | ||
| 895 | build. | ||
| 896 | |||
| 897 | Additionally, when building an SDK it will write the same contents | ||
| 898 | to ``/buildinfo`` by default (as specified by | ||
| 899 | :term:`SDK_BUILDINFO_FILE`). | ||
| 886 | 900 | ||
| 887 | .. _ref-classes-image_types: | 901 | .. _ref-classes-image_types: |
| 888 | 902 | ||
