From 2ccd2e67c5768e59316b086fa70fef837eecb53a Mon Sep 17 00:00:00 2001
From: Nitin A Kamble <nitin.a.kamble@intel.com>
Date: Fri, 28 May 2010 15:21:49 -0700
Subject: Handbook: Documentation for LIC_FILES_CHKSUM

Signed-off-by: Nitin A Kamble <nitin.a.kamble@intel.com>
---
 handbook/ref-variables.xml | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'handbook/ref-variables.xml')

diff --git a/handbook/ref-variables.xml b/handbook/ref-variables.xml
index 6e8c91b30..b4d5639ec 100644
--- a/handbook/ref-variables.xml
+++ b/handbook/ref-variables.xml
@@ -395,6 +395,19 @@
                 <para>List of package source licenses.</para>
             </glossdef>
         </glossentry>
+        <glossentry id='var-LIC_FILES_CHKSUM'><glossterm>LIC_FILES_CHKSUM</glossterm>
+            <glossdef>
+                <para>Checksums of the license text in the recipe source code.
+                </para>
+                <para>This variables tracks changes in license text of the source
+                code files. If the license text is changed it triggers the build
+                failure. Which gives developer an oppurtunity to review any 
+                license changes</para>
+                <para> This is an optional variable now. And the plan is to make
+                it a required variable in the future </para>
+                <para>See the "meta/package/zlib/zlib_${PV}.bb" file for an example</para>
+            </glossdef>
+        </glossentry>
 
     </glossdiv>
 
-- 
cgit v1.2.3