Skip to content

Commit

Permalink
ref-manual: fix typo and move SYSROOT_DIRS example
Browse files Browse the repository at this point in the history
1. Changed one letter (s/B/A), so the sentence is correct again.
2. Moved example from SYSROOT_DIRS_IGNORE into SYSROOT_DIRS section.

(From yocto-docs rev: 9fcd6d6ef4a87f69b8a00907051c1ece41e75a82)

Signed-off-by: Matthias Pritschet <matthias@pritschet.eu>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Steve Sakoman <steve@sakoman.com>
  • Loading branch information
Matthias Pritschet authored and sakoman committed Aug 23, 2024
1 parent 54d061a commit fbba5a6
Showing 1 changed file with 24 additions and 24 deletions.
48 changes: 24 additions & 24 deletions documentation/ref-manual/variables.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8123,29 +8123,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}``"
Expand All @@ -8157,7 +8134,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
Expand All @@ -8175,6 +8152,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
Expand Down

0 comments on commit fbba5a6

Please sign in to comment.