diff options
author | Matthias Pritschet <matthias@pritschet.eu> | 2024-07-15 18:23:48 +0200 |
---|---|---|
committer | Steve Sakoman <steve@sakoman.com> | 2024-08-23 14:51:51 -0700 |
commit | fbba5a616d8a96d32b5814eedfeb1b2fad46f8b5 (patch) | |
tree | bc798eabb04dcfc8ca32cf47ec27df658793bd47 | |
parent | 54d061affed29c7fbefcae92b5b3fbfcc971ccd7 (diff) | |
download | poky-fbba5a616d8a96d32b5814eedfeb1b2fad46f8b5.tar.gz |
ref-manual: fix typo and move SYSROOT_DIRS example
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>
-rw-r--r-- | documentation/ref-manual/variables.rst | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 42e9d4d964..cfdd36312f 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -8123,29 +8123,6 @@ system and gives an overview of their function and contents. | |||
8123 | /sysroot-only \ | 8123 | /sysroot-only \ |
8124 | " | 8124 | " |
8125 | 8125 | ||
8126 | :term:`SYSROOT_DIRS_IGNORE` | ||
8127 | Directories that are not staged into the sysroot by the | ||
8128 | :ref:`ref-tasks-populate_sysroot` task. You | ||
8129 | can use this variable to exclude certain subdirectories of | ||
8130 | directories listed in :term:`SYSROOT_DIRS` from | ||
8131 | staging. By default, the following directories are not staged:: | ||
8132 | |||
8133 | SYSROOT_DIRS_IGNORE = " \ | ||
8134 | ${mandir} \ | ||
8135 | ${docdir} \ | ||
8136 | ${infodir} \ | ||
8137 | ${datadir}/X11/locale \ | ||
8138 | ${datadir}/applications \ | ||
8139 | ${datadir}/bash-completion \ | ||
8140 | ${datadir}/fonts \ | ||
8141 | ${datadir}/gtk-doc/html \ | ||
8142 | ${datadir}/installed-tests \ | ||
8143 | ${datadir}/locale \ | ||
8144 | ${datadir}/pixmaps \ | ||
8145 | ${datadir}/terminfo \ | ||
8146 | ${libdir}/${BPN}/ptest \ | ||
8147 | " | ||
8148 | |||
8149 | Consider the following example in which you need to manipulate this variable. | 8126 | Consider the following example in which you need to manipulate this variable. |
8150 | Assume you have a recipe ``A`` that provides a shared library ``.so.*`` that is | 8127 | Assume you have a recipe ``A`` that provides a shared library ``.so.*`` that is |
8151 | installed into a custom folder other than "``${libdir}``" | 8128 | installed into a custom folder other than "``${libdir}``" |
@@ -8157,7 +8134,7 @@ system and gives an overview of their function and contents. | |||
8157 | is just to show the usefulness of setting :term:`SYSROOT_DIRS`. | 8134 | is just to show the usefulness of setting :term:`SYSROOT_DIRS`. |
8158 | 8135 | ||
8159 | When a recipe ``B`` :term:`DEPENDS` on ``A``, it means what is in | 8136 | When a recipe ``B`` :term:`DEPENDS` on ``A``, it means what is in |
8160 | :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``B`` | 8137 | :term:`SYSROOT_DIRS` will be copied from :term:`D` of the recipe ``A`` |
8161 | into ``B``'s :term:`SYSROOT_DESTDIR` that is "``${WORKDIR}/sysroot-destdir``". | 8138 | into ``B``'s :term:`SYSROOT_DESTDIR` that is "``${WORKDIR}/sysroot-destdir``". |
8162 | 8139 | ||
8163 | Now, since ``/opt/lib`` is not in :term:`SYSROOT_DIRS`, it will never be copied to | 8140 | Now, since ``/opt/lib`` is not in :term:`SYSROOT_DIRS`, it will never be copied to |
@@ -8175,6 +8152,29 @@ system and gives an overview of their function and contents. | |||
8175 | 8152 | ||
8176 | TARGET_LDFLAGS:append = " -L${RECIPE_SYSROOT}/opt/lib" | 8153 | TARGET_LDFLAGS:append = " -L${RECIPE_SYSROOT}/opt/lib" |
8177 | 8154 | ||
8155 | :term:`SYSROOT_DIRS_IGNORE` | ||
8156 | Directories that are not staged into the sysroot by the | ||
8157 | :ref:`ref-tasks-populate_sysroot` task. You | ||
8158 | can use this variable to exclude certain subdirectories of | ||
8159 | directories listed in :term:`SYSROOT_DIRS` from | ||
8160 | staging. By default, the following directories are not staged:: | ||
8161 | |||
8162 | SYSROOT_DIRS_IGNORE = " \ | ||
8163 | ${mandir} \ | ||
8164 | ${docdir} \ | ||
8165 | ${infodir} \ | ||
8166 | ${datadir}/X11/locale \ | ||
8167 | ${datadir}/applications \ | ||
8168 | ${datadir}/bash-completion \ | ||
8169 | ${datadir}/fonts \ | ||
8170 | ${datadir}/gtk-doc/html \ | ||
8171 | ${datadir}/installed-tests \ | ||
8172 | ${datadir}/locale \ | ||
8173 | ${datadir}/pixmaps \ | ||
8174 | ${datadir}/terminfo \ | ||
8175 | ${libdir}/${BPN}/ptest \ | ||
8176 | " | ||
8177 | |||
8178 | :term:`SYSROOT_DIRS_NATIVE` | 8178 | :term:`SYSROOT_DIRS_NATIVE` |
8179 | Extra directories staged into the sysroot by the | 8179 | Extra directories staged into the sysroot by the |
8180 | :ref:`ref-tasks-populate_sysroot` task for | 8180 | :ref:`ref-tasks-populate_sysroot` task for |