From 4a90b6b0d9aabef42da231ac9181829ba42ad7da Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Mon, 20 Apr 2015 07:55:41 -0700
Subject: ref-manual: Updates to ELF binary QA warning

Fixes [YOCTO #7630]

Apparently the text relocation being done here can cause runtime
performance issues.  I documented a potential work-around for the
issue and provided a cross-reference link to an external site for
more general information about text relocation at runtime.

Reported-by: Laszlo Papp <lpapp@kde.org>
(From yocto-docs rev: f7f611a6668b6cd2ee3928ad44c72dbbe5307c38)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/ref-manual/ref-classes.xml   | 6 +++++-
 documentation/ref-manual/ref-qa-checks.xml | 7 ++-----
 2 files changed, 7 insertions(+), 6 deletions(-)

(limited to 'documentation')

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index a000b2ae28..3889473b6e 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1697,7 +1697,11 @@
             <listitem><para><emphasis><filename>textrel:</filename></emphasis>
                 Checks for ELF binaries that contain relocations in their
                 <filename>.text</filename> sections, which can result in a
-                performance impact at runtime.</para></listitem>
+                performance impact at runtime.
+                See the explanation for the
+                <link linkend='qa-issue-textrel'><filename>ELF binary</filename></link>
+                message for more information regarding runtime performance issues.
+                </para></listitem>
             <listitem><para><emphasis><filename>unsafe-references-in-binaries:</filename></emphasis>
                 Reports when a binary installed in
                 <filename>${base_libdir}</filename>,
diff --git a/documentation/ref-manual/ref-qa-checks.xml b/documentation/ref-manual/ref-qa-checks.xml
index 54cd4336eb..7eaeb7fa04 100644
--- a/documentation/ref-manual/ref-qa-checks.xml
+++ b/documentation/ref-manual/ref-qa-checks.xml
@@ -467,8 +467,8 @@ can be found then it should be implemented.  I can't find one at the moment.
                 </para>
 
                 <para>
-                    Typically, the way to solve this performance issue is to
-                    add "-fPIC" to the compiler command-line options.
+                    Typically, the way to solve this performance issue is
+                    to add "-fPIC" to the compiler command-line options.
                     For example, given software that reads
                     <link linkend='var-CFLAGS'><filename>CFLAGS</filename></link>
                     when you build it, you can add the following to your
@@ -476,9 +476,6 @@ can be found then it should be implemented.  I can't find one at the moment.
                     <literallayout class='monospaced'>
      CFLAGS_append = " -fPIC "
                     </literallayout>
-                </para>
-
-                <para>
                     For more information on text relocations at runtime, see
                     <ulink url='http://www.akkadia.org/drepper/textrelocs.html'></ulink>.
                 </para>
-- 
cgit v1.2.3-54-g00ecf