[OE-core] [yocto-docs][PATCH] ref-manual: mention PREPROCESS_RELOCATE_DIRS variable

[Martin Jansa]

Signed-off-by: Martin Jansa <Martin.Jansa at gmail.com>
---
 documentation/ref-manual/ref-classes.xml   |  5 ++++-
 documentation/ref-manual/ref-variables.xml | 21 +++++++++++++++++++++
 2 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index ece47e757..159efb3b1 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -413,7 +413,10 @@
         <filename>cross</filename>, and
         <filename>cross-canadian</filename> recipes to change
         <filename>RPATH</filename> records within binaries in order to make
-        them relocatable.
+        them relocatable. To extend the list of directories where it searches
+        for binaries to relocate, you can set
+        <link linkend='var-PREPROCESS_RELOCATE_DIRS'><filename>PREPROCESS_RELOCATE_DIRS</filename></link>
+        variable in your recipe.
     </para>
 </section>
 
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 9470a780a..5ac766658 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -11424,6 +11424,27 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-PREPROCESS_RELOCATE_DIRS'><glossterm>PREPROCESS_RELOCATE_DIRS</glossterm>
+            <info>
+                PREPROCESS_RELOCATE_DIRS[doc] = "List of extra directories where to search for binaries which should be relocatable."
+            </info>
+            <glossdef>
+                <para role="glossdeffirst">
+<!--                <para role="glossdeffirst"><imagedata fileref="figures/define-generic.png" /> -->
+                    List of extra directories with binaries.
+                </para>
+
+                <para>
+                    <filename>PREPROCESS_RELOCATE_DIRS</filename> is used by
+                    chrpath.bbclass to allow extending the list where it searches
+                    for binaries. By default it searches in:
+                    ${bindir} ${sbindir} ${base_sbindir} ${base_bindir} ${libdir} ${base_libdir} ${libexecdir}
+                    Thus, <filename>PREPROCESS_RELOCATE_DIRS</filename> usually doesn't
+                    need to be set withing recipes.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-PRIORITY'><glossterm>PRIORITY</glossterm>
             <info>
                 PRIORITY[doc] = "Indicates the importance of a package.  The default value is 'optional'.  Other standard values are 'required', 'standard', and 'extra'."
-- 
2.17.1