diff options
author | Alexander Kanavin <alex.kanavin@gmail.com> | 2024-03-18 16:02:11 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2024-03-19 15:22:27 +0000 |
commit | bc06390947e560bbd999fc09b789cee93a324c7d (patch) | |
tree | 74bb40b8db604dfd906177b487428870c5be2a71 | |
parent | b685c76b682aa16e98b5b2ac21ba289d4f510d49 (diff) | |
download | poky-bc06390947e560bbd999fc09b789cee93a324c7d.tar.gz |
dev/ref-manual: document conf-summary.txt together with conf-notes.txt
(From yocto-docs rev: b92f2eac3b7455ebfc87f668b9442122dbf1c66f)
Signed-off-by: Alexander Kanavin <alex@linutronix.de>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r-- | documentation/dev-manual/custom-template-configuration-directory.rst | 6 | ||||
-rw-r--r-- | documentation/ref-manual/structure.rst | 7 |
2 files changed, 7 insertions, 6 deletions
diff --git a/documentation/dev-manual/custom-template-configuration-directory.rst b/documentation/dev-manual/custom-template-configuration-directory.rst index 9bffef35b4..06fcada822 100644 --- a/documentation/dev-manual/custom-template-configuration-directory.rst +++ b/documentation/dev-manual/custom-template-configuration-directory.rst | |||
@@ -42,11 +42,11 @@ would be:: | |||
42 | TEMPLATECONF=${TEMPLATECONF:-meta-poky/conf/templates/default} | 42 | TEMPLATECONF=${TEMPLATECONF:-meta-poky/conf/templates/default} |
43 | 43 | ||
44 | If you look at a configuration template directory, you will | 44 | If you look at a configuration template directory, you will |
45 | see the ``bblayers.conf.sample``, ``local.conf.sample``, and | 45 | see the ``bblayers.conf.sample``, ``local.conf.sample``, ``conf-summary.txt`` and |
46 | ``conf-notes.txt`` files. The build system uses these files to form the | 46 | ``conf-notes.txt`` files. The build system uses these files to form the |
47 | respective ``bblayers.conf`` file, ``local.conf`` file, and show | 47 | respective ``bblayers.conf`` file, ``local.conf`` file, and show |
48 | users a note about the build they're setting up | 48 | users usage information about the build they're setting up |
49 | when running the ``oe-init-build-env`` setup script. These can be | 49 | when running the ``oe-init-build-env`` setup script. These can be |
50 | edited further if needed to improve or change the build configurations | 50 | edited further if needed to improve or change the build configurations |
51 | available to the users. | 51 | available to the users, and provide useful summaries and detailed usage notes. |
52 | 52 | ||
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index acadd5efa3..e4d8b54bb9 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
@@ -172,10 +172,11 @@ targets to build. Here is an example:: | |||
172 | You can also run generated QEMU images with a command like 'runqemu qemux86-64' | 172 | You can also run generated QEMU images with a command like 'runqemu qemux86-64' |
173 | 173 | ||
174 | The default output of the ``oe-init-build-env`` script is from the | 174 | The default output of the ``oe-init-build-env`` script is from the |
175 | ``conf-notes.txt`` file, which is found in the ``meta-poky`` directory | 175 | ``conf-summary.txt`` and ``conf-notes.txt`` files, which are found in the ``meta-poky`` directory |
176 | within the :term:`Source Directory`. If you design a | 176 | within the :term:`Source Directory`. If you design a |
177 | custom distribution, you can include your own version of this | 177 | custom distribution, you can include your own versions of these |
178 | configuration file to mention the targets defined by your distribution. | 178 | configuration files where you can provide a brief summary and detailed usage |
179 | notes, such as a list of the targets defined by your distribution. | ||
179 | See the | 180 | See the |
180 | ":ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`" | 181 | ":ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`" |
181 | section in the Yocto Project Development Tasks Manual for more | 182 | section in the Yocto Project Development Tasks Manual for more |