From 32857c5596737b2184f2c9c5a04f963f8bfa6206 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Tue, 8 Apr 2014 09:01:45 -0700
Subject: ref-manual: Added DISK_SIGNATURE variable description to glossary.

Fixes [YOCTO #6125]

(From yocto-docs rev: 5ee5433cc7799a240dd18aa20ce44b3ae978b592)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
---
 documentation/ref-manual/ref-variables.xml | 34 ++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)

(limited to 'documentation/ref-manual')

diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 258ae2c6db..03d2034dba 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -1609,6 +1609,40 @@
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-DISK_SIGNATURE'><glossterm>DISK_SIGNATURE</glossterm>
+            <glossdef>
+                <para>
+                    Automatically generated random signature that allows the
+                    OpenEmbedded build system to create a boot
+                    loader configuration.
+                    <filename>DISK_SIGNATURE</filename> is different each time
+                    a <filename>directdisk</filename> image is built.
+                    <note>
+                        The "live" option used with
+                        <link linkend='var-IMAGE_FSTYPES'><filename>IMAGE_FSTYPES</filename></link>
+                        produces an image file that can be copied directly to
+                        a CD or USB device and run as is.
+                    </note>
+                    The auto-generated <filename>DISK_SIGNATURE</filename> sets
+                    <filename>SYSLINUX_ROOT</filename> as follows:
+                    <literallayout class='monospaced'>
+     SYSLINUX_ROOT = "root=PARTUUID=${DISK_SIGNATURE}-02"
+                    </literallayout>
+                </para>
+
+                <para>
+                    It is possible to set the
+                    <filename>DISK_SIGNATURE</filename> variable in your
+                    <filename>local.conf</filename> file to a fixed
+                    value if you do not want <filename>syslinux.cfg</filename>
+                    changing for each build.
+                    You might find this useful when you want to upgrade the
+                    root filesystem on a device without having to recreate or
+                    modify the master boot record.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-DISTRO'><glossterm>DISTRO</glossterm>
             <glossdef>
                 <para>
-- 
cgit v1.2.3-54-g00ecf