ref-manual: add EXCLUDE_PACKAGES_FROM_SHLIBS description

Submitted by Oleksii Konoplitskyi on Dec. 10, 2018, 12:53 p.m. | Patch ID: 157000

Details

Message ID a14a8e30-2417-c600-5efc-56fc168560f4@cisco.com
State New
Headers show

Commit Message

Oleksii Konoplitskyi Dec. 10, 2018, 12:53 p.m.
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<okonopli@cisco.com>
---
   documentation/ref-manual/ref-variables.xml | 28
++++++++++++++++++++++++++++
   1 file changed, 28 insertions(+)

+ 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

Patch hide | download patch | download mbox

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'>

Comments

Tim Orling Dec. 10, 2018, 4:34 p.m.
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.
On Mon, Dec 10, 2018 at 4:53 AM Oleksii Konoplitskyi <okonopli@cisco.com>
wrote:

> 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: Oleksii Konoplitskyi <okonopli@cisco.com>
> <okonopli@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
>
> --
> _______________________________________________
> yocto mailing list
> yocto@yoctoproject.org
> https://lists.yoctoproject.org/listinfo/yocto
>