aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2015-09-18 07:57:45 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2015-10-21 23:06:21 +0100
commit0d1c86b558105f8101776d72c6e8131cce358551 (patch)
treef2a904f4f90cdfaa907bd605ac7f3e0000249cba /documentation
parenteea7521f59676fc4621bdc82bffba641f46e1242 (diff)
downloadopenembedded-core-contrib-0d1c86b558105f8101776d72c6e8131cce358551.tar.gz
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>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/ref-manual/ref-variables.xml35
1 files changed, 13 insertions, 22 deletions
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 43715da5d8..fd13746a81 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -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>