ref-manual: Updated EXCLUDE_FROM_SHLIBS description.

Fixes [YOCTO #8066]

Applied some review edits to the variable's description in the
glossary.  Also, changed the name of the variable to be correct.

(From yocto-docs rev: f3ab503301db9d22cb85da0f7518d266f230bd3d)

Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Scott Rifenbark 2015-09-18 07:57:45 -07:00 committed by Richard Purdie
parent eea7521f59
commit 0d1c86b558
1 changed files with 13 additions and 22 deletions

View File

@ -3533,40 +3533,31 @@
</glossdef>
</glossentry>
<glossentry id='var-EXCLUDE_FROM_SHLIB'><glossterm>EXCLUDE_FROM_SHLIB</glossterm>
<glossentry id='var-EXCLUDE_FROM_SHLIBS'><glossterm>EXCLUDE_FROM_SHLIBS</glossterm>
<info>
EXCLUDE_FROM_SHLIB[doc] = "Prevents exposure of a package to all of the package's libraries."
EXCLUDE_FROM_SHLIBS[doc] = "Causes the OpenEmbedded build system's shared resolver to exclued an entire package when scanning for shared libraries."
</info>
<glossdef>
<para role="glossdeffirst">
<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
Prevents exposing a package to all of the package's
libraries.
The <filename>EXCLUDE_FROM_SHLIB</filename> variable is
useful for prebuilt packages that should not be exposed
to any of the package's libraries.
In other words, you want to skip the
<filename>shlib</filename> procedure for the package.
Triggers the OpenEmbedded build system's shared resolver to
exclude an entire package when scanning for shared
libraries (i.e. the <filename>shlib</filename> procedure.
The <filename>EXCLUDE_FROM_SHLIBS</filename> variable is
similar to the
<link linkend='var-PRIVATE_LIBS'><filename>PRIVATE_LIBS</filename></link>
variable, which exludes a package's particular libraries
only and not the whole package.
</para>
<para>
Use the variable by setting it to "1" for a particular
package:
Use the
<filename>EXCLUDE_FROM_SHLIBS</filename> variable by
setting it to "1" for a particular package:
<literallayout class='monospaced'>
EXCLUDE_FROM_SHLIB = "1"
</literallayout>
</para>
<para>
You can achieve similar results by using the
<link linkend='var-PRIVATE_LIBS'><filename>PRIVATE_LIBS</filename></link>
variable.
However, with the <filename>PRIVATE_LIBS</filename>
variable, you must specifically list all of a package's
libraries.
Using the <filename>EXCLUDE_FROM_SHLIB</filename> variable,
allows you to quickly prevent exposure to all the libraries.
</para>
</glossdef>
</glossentry>