diff mbox series

[v2] ref-manual: fix typo and move SYSROOT_DIRS example

Message ID 20240715162348.3984456-1-matthias@pritschet.eu
State Accepted
Commit 7d762fbad07bf16a0a657169c09a3e402dabbe90
Headers show
Series [v2] ref-manual: fix typo and move SYSROOT_DIRS example | expand

Commit Message

Matthias Pritschet July 15, 2024, 4:23 p.m. UTC
1. Changed one letter (s/B/A), so the sentence is correct again.
2. Moved example from SYSROOT_DIRS_IGNORE into SYSROOT_DIRS section.

Signed-off-by: Matthias Pritschet <matthias@pritschet.eu>
---
 documentation/ref-manual/variables.rst | 48 +++++++++++++-------------
 1 file changed, 24 insertions(+), 24 deletions(-)

Comments

Quentin Schulz July 16, 2024, 7:28 a.m. UTC | #1
Hi Matthias,

On 7/15/24 6:23 PM, Matthias Pritschet wrote:
> [You don't often get email from matthias@pritschet.eu. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
> 
> 1. Changed one letter (s/B/A), so the sentence is correct again.
> 2. Moved example from SYSROOT_DIRS_IGNORE into SYSROOT_DIRS section.
> 

Would have preferred two separate commits as they are related but not 
co-dependent changes. As a rule of thumb, when you need to list changes 
in the commit log, it usually tells you it should be split into multiple 
individual commits.

I don't think we're too rigorous with yocto-docs so I would probably 
wait for the maintainer to provide their feedback on this (or silently 
apply it :) ).

Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>

@Alex, I believe you're the maintainer now? I think this should also be 
backported to docs of older releases?

Thanks!
Quentin
Matthias Pritschet July 16, 2024, 9:56 a.m. UTC | #2
Hi Quentin,

Am 16.07.24 um 09:28 schrieb Quentin Schulz:
> Hi Matthias,
> 
> On 7/15/24 6:23 PM, Matthias Pritschet wrote:
>> [You don't often get email from matthias@pritschet.eu. Learn why this is important at https://aka.ms/LearnAboutSenderIdentification ]
>>
>> 1. Changed one letter (s/B/A), so the sentence is correct again.
>> 2. Moved example from SYSROOT_DIRS_IGNORE into SYSROOT_DIRS section.
>>
> 
> Would have preferred two separate commits as they are related but not co-dependent changes. As a rule of thumb, when you need to list changes in the commit log, it usually tells you it should be split into multiple individual commits.

Understood!
I was briefly considering splitting the commit, but since the diff turned out to show both changes nicely I took the bold route.

I'll follow your advice next time.

> 
> I don't think we're too rigorous with yocto-docs so I would probably wait for the maintainer to provide their feedback on this (or silently apply it :) ).
> 
> Reviewed-by: Quentin Schulz <quentin.schulz@cherry.de>
> 
> @Alex, I believe you're the maintainer now? I think this should also be backported to docs of older releases?
> 
> Thanks!
> Quentin

Best regards,
Matthias
diff mbox series

Patch

diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 848cea787..f0c8e4f84 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -8584,29 +8584,6 @@  system and gives an overview of their function and contents.
              /sysroot-only \
              "
 
-   :term:`SYSROOT_DIRS_IGNORE`
-      Directories that are not staged into the sysroot by the
-      :ref:`ref-tasks-populate_sysroot` task. You
-      can use this variable to exclude certain subdirectories of
-      directories listed in :term:`SYSROOT_DIRS` from
-      staging. By default, the following directories are not staged::
-
-         SYSROOT_DIRS_IGNORE = " \
-             ${mandir} \
-             ${docdir} \
-             ${infodir} \
-             ${datadir}/X11/locale \
-             ${datadir}/applications \
-             ${datadir}/bash-completion \
-             ${datadir}/fonts \
-             ${datadir}/gtk-doc/html \
-             ${datadir}/installed-tests \
-             ${datadir}/locale \
-             ${datadir}/pixmaps \
-             ${datadir}/terminfo \
-             ${libdir}/${BPN}/ptest \
-             "
-
       Consider the following example in which you need to manipulate this variable.
       Assume you have a recipe ``A`` that provides a shared library ``.so.*`` that is
       installed into a custom folder other than "``${libdir}``"
@@ -8618,7 +8595,7 @@  system and gives an overview of their function and contents.
          is just to show the usefulness of setting :term:`SYSROOT_DIRS`.
 
       When a recipe ``B`` :term:`DEPENDS` on ``A``, it means what is in
-      :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``B``
+      :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``A``
       into ``B``'s :term:`SYSROOT_DESTDIR` that is "``${WORKDIR}/sysroot-destdir``".
 
       Now, since ``/opt/lib`` is not in :term:`SYSROOT_DIRS`, it will never be copied to
@@ -8636,6 +8613,29 @@  system and gives an overview of their function and contents.
 
             TARGET_LDFLAGS:append = " -L${RECIPE_SYSROOT}/opt/lib"
 
+   :term:`SYSROOT_DIRS_IGNORE`
+      Directories that are not staged into the sysroot by the
+      :ref:`ref-tasks-populate_sysroot` task. You
+      can use this variable to exclude certain subdirectories of
+      directories listed in :term:`SYSROOT_DIRS` from
+      staging. By default, the following directories are not staged::
+
+         SYSROOT_DIRS_IGNORE = " \
+             ${mandir} \
+             ${docdir} \
+             ${infodir} \
+             ${datadir}/X11/locale \
+             ${datadir}/applications \
+             ${datadir}/bash-completion \
+             ${datadir}/fonts \
+             ${datadir}/gtk-doc/html \
+             ${datadir}/installed-tests \
+             ${datadir}/locale \
+             ${datadir}/pixmaps \
+             ${datadir}/terminfo \
+             ${libdir}/${BPN}/ptest \
+             "
+
    :term:`SYSROOT_DIRS_NATIVE`
       Extra directories staged into the sysroot by the
       :ref:`ref-tasks-populate_sysroot` task for