summaryrefslogtreecommitdiffstats
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)
downloadpoky-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 @@
3533 </glossdef> 3533 </glossdef>
3534 </glossentry> 3534 </glossentry>
3535 3535
3536 <glossentry id='var-EXCLUDE_FROM_SHLIB'><glossterm>EXCLUDE_FROM_SHLIB</glossterm> 3536 <glossentry id='var-EXCLUDE_FROM_SHLIBS'><glossterm>EXCLUDE_FROM_SHLIBS</glossterm>
3537 <info> 3537 <info>
3538 EXCLUDE_FROM_SHLIB[doc] = "Prevents exposure of a package to all of the package's libraries." 3538 EXCLUDE_FROM_SHLIBS[doc] = "Causes the OpenEmbedded build system's shared resolver to exclued an entire package when scanning for shared libraries."
3539 </info> 3539 </info>
3540 <glossdef> 3540 <glossdef>
3541 <para role="glossdeffirst"> 3541 <para role="glossdeffirst">
3542<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> --> 3542<!-- <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
3543 Prevents exposing a package to all of the package's 3543 Triggers the OpenEmbedded build system's shared resolver to
3544 libraries. 3544 exclude an entire package when scanning for shared
3545 The <filename>EXCLUDE_FROM_SHLIB</filename> variable is 3545 libraries (i.e. the <filename>shlib</filename> procedure.
3546 useful for prebuilt packages that should not be exposed 3546 The <filename>EXCLUDE_FROM_SHLIBS</filename> variable is
3547 to any of the package's libraries. 3547 similar to the
3548 In other words, you want to skip the 3548 <link linkend='var-PRIVATE_LIBS'><filename>PRIVATE_LIBS</filename></link>
3549 <filename>shlib</filename> procedure for the package. 3549 variable, which exludes a package's particular libraries
3550 only and not the whole package.
3550 </para> 3551 </para>
3551 3552
3552 <para> 3553 <para>
3553 Use the variable by setting it to "1" for a particular 3554 Use the
3554 package: 3555 <filename>EXCLUDE_FROM_SHLIBS</filename> variable by
3556 setting it to "1" for a particular package:
3555 <literallayout class='monospaced'> 3557 <literallayout class='monospaced'>
3556 EXCLUDE_FROM_SHLIB = "1" 3558 EXCLUDE_FROM_SHLIB = "1"
3557 </literallayout> 3559 </literallayout>
3558 </para> 3560 </para>
3559
3560 <para>
3561 You can achieve similar results by using the
3562 <link linkend='var-PRIVATE_LIBS'><filename>PRIVATE_LIBS</filename></link>
3563 variable.
3564 However, with the <filename>PRIVATE_LIBS</filename>
3565 variable, you must specifically list all of a package's
3566 libraries.
3567 Using the <filename>EXCLUDE_FROM_SHLIB</filename> variable,
3568 allows you to quickly prevent exposure to all the libraries.
3569 </para>
3570 </glossdef> 3561 </glossdef>
3571 </glossentry> 3562 </glossentry>
3572 3563