From 5f85440bd56783638986006b4f8aaf34e599f806 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Thu, 5 Dec 2013 15:20:01 -0600
Subject: ref-manual: Edits to siteinfo class.

(From yocto-docs rev: 6be23e9efacf2025d1ca337b98dc52bd4ab65477)

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 | 27 ++++++++++++++++++---------
 1 file changed, 18 insertions(+), 9 deletions(-)

(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 18bb9a7cc3..132ffaf875 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -2394,16 +2394,23 @@
 </section>
 
 <section id='ref-classes-siteinfo'>
-    <title>Autotools Configuration Data Cache - <filename>siteinfo.bbclass</filename></title>
+    <title><filename>siteinfo.bbclass</filename></title>
 
     <para>
-        Autotools can require tests that must execute on the target hardware.
-        Since this is not possible in general when cross compiling, site information is
-        used to provide cached test results so these tests can be skipped over but
-        still make the correct values available.
-        The <filename><link linkend='structure-meta-site'>meta/site directory</link></filename>
-        contains test results sorted into different categories such as architecture, endianness, and
-        the <filename>libc</filename> used.
+        The <filename>siteinfo</filename> class provides information about
+        the targets that might be needed by other classes or recipes.
+    </para>
+
+    <para>
+        As an example, consider Autotools, which can require tests that must
+        execute on the target hardware.
+        Since this is not possible in general when cross compiling, site
+        information is used to provide cached test results so these tests can
+        be skipped over but still make the correct values available.
+        The
+        <filename><link linkend='structure-meta-site'>meta/site directory</link></filename>
+        contains test results sorted into different categories such as
+        architecture, endianness, and the <filename>libc</filename> used.
         Site information provides a list of files containing data relevant to
         the current build in the
         <filename><link linkend='var-CONFIG_SITE'>CONFIG_SITE</link></filename> variable
@@ -2418,7 +2425,9 @@
     </para>
 
     <para>
-        Because this class is included from <filename>base.bbclass</filename>, it is always active.
+        Because the
+        <link linkend='ref-classes-base'><filename>base</filename></link> class
+        includes the <filename>siteinfo</filename> class, it is always active.
     </para>
 </section>
 
-- 
cgit v1.2.3-54-g00ecf