| Message ID | 20240318150211.1192651-3-alex@linutronix.de |
|---|---|
| State | New |
| Headers | show |
| Series | [1/3] dev-manual: improve descriptions of 'bitbake -S printdiff' | expand |
Hi again Alex Thanks for the update! On 3/18/24 at 16:02, Alexander Kanavin wrote: > Signed-off-by: Alexander Kanavin <alex@linutronix.de> > --- > .../dev-manual/custom-template-configuration-directory.rst | 6 +++--- > 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 9bffef35b46..06fcada822d 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:: > TEMPLATECONF=${TEMPLATECONF:-meta-poky/conf/templates/default} > > If you look at a configuration template directory, you will > -see the ``bblayers.conf.sample``, ``local.conf.sample``, and > +see the ``bblayers.conf.sample``, ``local.conf.sample``, ``conf-summary.txt`` and > ``conf-notes.txt`` files. The build system uses these files to form the > respective ``bblayers.conf`` file, ``local.conf`` file, and show > -users a note about the build they're setting up > +users usage information about the build they're setting up > when running the ``oe-init-build-env`` setup script. These can be > edited further if needed to improve or change the build configurations > -available to the users. > +available to the users, and provide useful summaries and detailed usage notes. > > diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst > index acadd5efa3c..9f26319c327 100644 > --- a/documentation/ref-manual/structure.rst > +++ b/documentation/ref-manual/structure.rst > @@ -172,10 +172,11 @@ targets to build. Here is an example:: > You can also run generated QEMU images with a command like 'runqemu qemux86-64' > > The default output of the ``oe-init-build-env`` script is from the > -``conf-notes.txt`` file, which is found in the ``meta-poky`` directory > +``conf-summary.txt`` and ``conf-notes.txt`` files, which are found in the ``meta-poky`` directory > within the :term:`Source Directory`. If you design a > -custom distribution, you can include your own version of this > -configuration file to mention the targets defined by your distribution. > +custom distribution, you can include your own versions of these > +configuration files where you can provide a brief summary and detailed useage s/useage/usage/ I fixed that. Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Merged into "master-next" Thanks again Michael.
diff --git a/documentation/dev-manual/custom-template-configuration-directory.rst b/documentation/dev-manual/custom-template-configuration-directory.rst index 9bffef35b46..06fcada822d 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:: TEMPLATECONF=${TEMPLATECONF:-meta-poky/conf/templates/default} If you look at a configuration template directory, you will -see the ``bblayers.conf.sample``, ``local.conf.sample``, and +see the ``bblayers.conf.sample``, ``local.conf.sample``, ``conf-summary.txt`` and ``conf-notes.txt`` files. The build system uses these files to form the respective ``bblayers.conf`` file, ``local.conf`` file, and show -users a note about the build they're setting up +users usage information about the build they're setting up when running the ``oe-init-build-env`` setup script. These can be edited further if needed to improve or change the build configurations -available to the users. +available to the users, and provide useful summaries and detailed usage notes. diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index acadd5efa3c..9f26319c327 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst @@ -172,10 +172,11 @@ targets to build. Here is an example:: You can also run generated QEMU images with a command like 'runqemu qemux86-64' The default output of the ``oe-init-build-env`` script is from the -``conf-notes.txt`` file, which is found in the ``meta-poky`` directory +``conf-summary.txt`` and ``conf-notes.txt`` files, which are found in the ``meta-poky`` directory within the :term:`Source Directory`. If you design a -custom distribution, you can include your own version of this -configuration file to mention the targets defined by your distribution. +custom distribution, you can include your own versions of these +configuration files where you can provide a brief summary and detailed useage +notes, such as a list of the targets defined by your distribution. See the ":ref:`dev-manual/custom-template-configuration-directory:creating a custom template configuration directory`" section in the Yocto Project Development Tasks Manual for more
Signed-off-by: Alexander Kanavin <alex@linutronix.de> --- .../dev-manual/custom-template-configuration-directory.rst | 6 +++--- documentation/ref-manual/structure.rst | 7 ++++--- 2 files changed, 7 insertions(+), 6 deletions(-)