ref-manual/ref-variables: add SANITY_TESTED_DISTROS and NATIVELSBSTRING

Tightened up the writing for both entries.

(From yocto-docs rev: b6a0679fb74aef4a718e42d20343f5b7ae8e9679)

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

1 files changed, 49 insertions, 2 deletions

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index a862267769..43f76e9211 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -2527,8 +2527,34 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
 
     </glossdiv>
 
-<!--            <glossdiv id='var-glossary-n'><title>N</title>-->
-<!--            </glossdiv>-->
+    <glossdiv id='var-glossary-n'><title>N</title>
+
+        <glossentry id='var-NATIVELSBSTRING'><glossterm>NATIVELSBSTRING</glossterm>
+            <glossdef>
+                <para>
+                    A string identifying the host distribution.
+                    Strings consist of the host distributor ID
+                    followed by the release, as reported by the 
+                    <filename>lsb_release</filename> tool
+                    or as read from <filename>/etc/lsb-release</filename>. 
+                    For example, when running a build on Ubuntu 12.10, the value 
+                    is "Ubuntu-12.10". 
+                    If this information is unable to be determined, the value 
+                    resolves to "Unknown".
+                </para>
+                <para>
+                    This variable is used by default to isolate native shared 
+                    state packages for different distributions (e.g. to avoid 
+                    problems with <filename>glibc</filename> version 
+                    incompatibilities).
+                    Additionally, the variable is checked against
+                    <link linkend='var-SANITY_TESTED_DISTROS'><filename>SANITY_TESTED_DISTROS</filename></link>
+                    if that variable is set.
+                </para>
+            </glossdef>
+        </glossentry>
+
+    </glossdiv>
 
     <glossdiv id='var-glossary-o'><title>O</title>
 
@@ -3165,6 +3191,27 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-SANITY_TESTED_DISTROS'><glossterm>SANITY_TESTED_DISTROS</glossterm>
+            <glossdef>
+                <para>
+                    A list of the host distribution identifiers that the 
+                    build system has been tested against.
+                    Identifiers consist of the host distributor ID
+                    followed by the release, 
+                    as reported by the <filename>lsb_release</filename> tool
+                    or as read from <filename>/etc/lsb-release</filename>.) 
+                    Separate the list items with explicit newline 
+                    characters (<filename>\n</filename>).
+                    If <filename>SANITY_TESTED_DISTROS</filename> is not empty 
+                    and the current value of 
+                    <link linkend='var-NATIVELSBSTRING'><filename>NATIVELSBSTRING</filename></link>
+                    does not appear in the list, then the build system reports        
+                    a warning that indicates the current host distribution has 
+                    not been tested as a build host.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-SDKIMAGE_FEATURES'><glossterm>SDKIMAGE_FEATURES</glossterm>
             <glossdef>
                 <para>Equivalent to