From 8c930e521723bb00c5ab852048307680773c87a8 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Tue, 10 Dec 2013 16:30:10 -0600
Subject: ref-manual: Added more info to distrodata class.

Saul Wold provided me with more detail on this class, which
I added.

(From yocto-docs rev: 73c79f0460511039d5497bfd303cdc88f96e2fcc)

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

(limited to 'documentation/ref-manual/ref-classes.xml')

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 0626e6cc75..ce76140edd 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -579,6 +579,26 @@
     <para>
         The <filename>distrodata</filename> class
         provides for automatic checking for upstream recipe updates.
+        The class creates a comma-separated value (CSV) spreadsheet that
+        contains information about the recipes.
+        The information provides the <filename>distrodata</filename> and
+        <filename>distro_check</filename> tasks, which do upstream checking
+        and also verify if a package is used in multiple major distributions.
+    </para>
+
+    <para>
+        The class is not included by default.
+        To use it, you must include the following files and set the
+        <link linkend='var-INHERIT'><filename>INHERIT</filename></link>
+        variable:
+        <literallayout class='monospaced'>
+     include conf/distro/include/distro_alias.inc
+     include conf/distro/include/recipe_color.inc
+     include conf/distro/include/maintainers.inc
+     include conf/distro/include/upstream_tracking.inc
+     include conf/distro/include/package_regex.inc
+     INHERIT+= "distrodata"
+        </literallayout>
     </para>
 </section>
 
-- 
cgit v1.2.3-54-g00ecf