[yocto] [PATCH] ref-manual: add EXCLUDE_PACKAGES_FROM_SHLIBS description

[Oleksii Konoplitskyi]

Some packages containing shared libraries might be registered as shlib
providers when they shouldn't (for example, the lib is for their private use
and must not generate any dependency).

EXCLUDE_FROM_SHLIBS is targeted at that, but it could be set for entire
recipe
only.

Variable EXCLUDE_PACKAGES_FROM_SHLIBS allows to set list of packages
that are
not candidates for shlib providers.

Signed-off-by:OleksiiKonoplitskyi<***@cisco.com>
---
  documentation/ref-manual/ref-variables.xml | 28
++++++++++++++++++++++++++++
  1 file changed, 28 insertions(+)

diff --git a/documentation/ref-manual/ref-variables.xml
b/documentation/ref-manual/ref-variables.xml
index 595f2db..98d3f86 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -4289,6 +4289,34 @@
</glossdef>
</glossentry>

+ <glossentry
id='var-EXCLUDE_PACKAGES_FROM_SHLIBS'><glossterm>EXCLUDE_PACKAGES_FROM_SHLIBS</glossterm>
+ <info>
+ EXCLUDE_PACKAGES_FROM_SHLIBS[doc] = "Causes the
OpenEmbedded build system's shared libraries resolver to exclude
packages when scanning for shared libraries."
+ </info>
+ <glossdef>
+ <para role="glossdeffirst">
+<!-- <para role="glossdeffirst"><imagedata
fileref="figures/define-generic.png" /> -->
+ Triggers the OpenEmbedded build system's shared
libraries
+ resolver to exclude packages when scanning for
+ shared libraries.
+ The
<filename>EXCLUDE_PACKAGES_FROM_SHLIBS</filename> variable is
+ similar to the
+ <link
linkend='var-EXCLUDE_FROM_SHLIBS'><filename>EXCLUDE_FROM_SHLIBS</filename></link>
+ variable, which excludes all the packages provided
by recipe
+ and not excludes particular package.
+ </para>
+
+ <para>
+ Use the
+ <filename>EXCLUDE_PACKAGES_FROM_SHLIBS</filename> variable as a list
of packages that
+ are not candidates for shared libraries providers:
+ <literallayout class='monospaced'>
+ EXCLUDE_PACKAGES_FROM_SHLIBS += "glibc-ptest glibc-dev"
+ </literallayout>
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry
id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm>
<info>
EXCLUDE_FROM_WORLD[doc] = "Directs BitBake to exclude
a recipe from world builds (i.e. bitbake world)."
--
2.7.4

[Tim Orling]

Variable documentation is pulled in from:
http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/meta/conf/documentation.conf

Notably, EXCLUDE_PACKAGES_FROM_SHLIBS is not defined there, which is why it
is not in the generated docs.

Post by Oleksii Konoplitskyi
Some packages containing shared libraries might be registered as shlib
providers when they shouldn't (for example, the lib is for their private use
and must not generate any dependency).
EXCLUDE_FROM_SHLIBS is targeted at that, but it could be set for entire
recipe
only.
Variable EXCLUDE_PACKAGES_FROM_SHLIBS allows to set list of packages
that are
not candidates for shlib providers.
---
documentation/ref-manual/ref-variables.xml | 28
++++++++++++++++++++++++++++
1 file changed, 28 insertions(+)
diff --git a/documentation/ref-manual/ref-variables.xml
b/documentation/ref-manual/ref-variables.xml
index 595f2db..98d3f86 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -4289,6 +4289,34 @@
</glossdef>
</glossentry>
+ <glossentry
id='var-EXCLUDE_PACKAGES_FROM_SHLIBS'><glossterm>EXCLUDE_PACKAGES_FROM_SHLIBS</glossterm>
+ <info>
+ EXCLUDE_PACKAGES_FROM_SHLIBS[doc] = "Causes the
OpenEmbedded build system's shared libraries resolver to exclude
packages when scanning for shared libraries."
+ </info>
+ <glossdef>
+ <para role="glossdeffirst">
+<!-- <para role="glossdeffirst"><imagedata
fileref="figures/define-generic.png" /> -->
+ Triggers the OpenEmbedded build system's shared
libraries
+ resolver to exclude packages when scanning for
+ shared libraries.
+ The
<filename>EXCLUDE_PACKAGES_FROM_SHLIBS</filename> variable is
+ similar to the
+ <link
linkend='var-EXCLUDE_FROM_SHLIBS'><filename>EXCLUDE_FROM_SHLIBS</filename></link>
+ variable, which excludes all the packages provided
by recipe
+ and not excludes particular package.
+ </para>
+
+ <para>
+ Use the
+ <filename>EXCLUDE_PACKAGES_FROM_SHLIBS</filename> variable as a list
of packages that
+ <literallayout class='monospaced'>
+ EXCLUDE_PACKAGES_FROM_SHLIBS += "glibc-ptest glibc-dev"
+ </literallayout>
+ </para>
+ </glossdef>
+ </glossentry>
+
<glossentry
id='var-EXCLUDE_FROM_WORLD'><glossterm>EXCLUDE_FROM_WORLD</glossterm>
<info>
EXCLUDE_FROM_WORLD[doc] = "Directs BitBake to exclude
a recipe from world builds (i.e. bitbake world)."
--
2.7.4
--
_______________________________________________
yocto mailing list
https://lists.yoctoproject.org/listinfo/yocto