ref-manual: Added FEED_DEPLOYDIR_BASE_URI variable description

Fixes [YOCTO #5408]

As part of the fix for this bug, I have added a description of this
variable to the glossary.

(From yocto-docs rev: ad988c82b364bb0c629bcb2ce04f99e0e371622e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

1 files changed, 29 insertions, 1 deletions

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 0383dadd5d..8f385799d3 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -21,7 +21,7 @@
        <link linkend='var-CFLAGS'>C</link>
        <link linkend='var-D'>D</link>
        <link linkend='var-ENABLE_BINARY_LOCALE_GENERATION'>E</link>
-       <link linkend='var-FILES'>F</link>
+       <link linkend='var-FEED_DEPLOYDIR_BASE_URI'>F</link>
 <!--               <link linkend='var-glossary-g'>G</link> -->
        <link linkend='var-HOMEPAGE'>H</link>
        <link linkend='var-IMAGE_BASENAME'>I</link>
@@ -1661,6 +1661,34 @@
 
     <glossdiv id='var-glossary-f'><title>F</title>
 
+        <glossentry id='var-FEED_DEPLOYDIR_BASE_URI'><glossterm>FEED_DEPLOYDIR_BASE_URI</glossterm>
+            <glossdef>
+                <para>
+                    Points to the base URL of the server and location within
+                    the document-root that provides the
+                    <ulink url='&YOCTO_DOCS_DEV_URL;#metadata'>Metadata</ulink>
+                    and packages necessary to support runtime package
+                    management of IPK packages.
+                    You set this variable in your
+                    <filename>local.conf</filename> file.
+                </para>
+
+                <para>
+                    Consider the following example:
+                    <literallayout class='monospaced'>
+     FEED_DEPLOYDIR_BASE_URI = "http://192.168.7.1/BOARD-dir"
+                    </literallayout>
+                    This example assumes you are serving your packages over
+                    HTTP and your databases are located in a directory
+                    named <filename>BOARD-dir</filename>, which is underneath
+                    your HTTP server's document-root.
+                    In this case, the OpenEmbedded build system generates a set
+                    of configuration files for you in your target that work
+                    with the feed.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-FILES'><glossterm>FILES</glossterm>
             <glossdef>
                 <para>