From 6bb0173d909ef2e47c8622fc9b7fbecf0ae58c2c Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Tue, 3 Dec 2013 14:21:57 -0600
Subject: ref-manual: Added pixbufcache class and PIXBUF_PACKAGES variable.

(From yocto-docs rev: 88186f1a694b655d92f936935743759788e834f6)

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   | 24 ++++++++++++++++++++++++
 documentation/ref-manual/ref-variables.xml | 18 ++++++++++++++++++
 2 files changed, 42 insertions(+)

(limited to 'documentation/ref-manual')

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 2e6a17f255..615adb96cb 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -1369,6 +1369,30 @@
     </para>
 </section>
 
+<section id='ref-classes-pixbufcache'>
+    <title><filename>pixbufcache.bbclass</filename></title>
+
+    <para>
+        The <filename>pixbufcache</filename> class generates the proper
+        post-install and post-remove (postinst/postrm) scriptlets for packages
+        that install pixbuf loaders, which are used with
+        <filename>gdk-pixbuf</filename>.
+        These scriptlets call <filename>update_pixbuf_cache</filename>
+        to add the input method modules to the cache.
+        Since the cache files are architecture-specific,
+        <filename>update_pixbuf_cache</filename> is run using QEMU if the
+        postinst scriptlets need to be run on the build host during image
+        creation.
+    </para>
+
+    <para>
+        If the pixbuf loaders modules being installed are in packages other
+        than the main package, set
+        <link linkend='var-PIXBUF_PACKAGES'><filename>PIXBUF_PACKAGES</filename></link>
+        to include the packages containing the modules.
+    </para>
+</section>
+
 <section id='ref-classes-perl'>
     <title>Perl Modules - <filename>cpan.bbclass</filename></title>
 
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 5e3edcd937..fccffe77bb 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -4646,6 +4646,24 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
             </glossdef>
         </glossentry>
 
+        <glossentry id='var-PIXBUF_PACKAGES'><glossterm>PIXBUF_PACKAGES</glossterm>
+            <glossdef>
+                <para>
+                    When a recipe inherits the
+                    <link linkend='ref-classes-pixbufcache'><filename>pixbufcache</filename></link>
+                    class, this variable identifies packages that contain
+                    the pixbuf loaders modules used with
+                    <filename>gdk-pixbuf</filename> that the OpenEmbedded build
+                    system installs.
+                    By default, these modules appear in the main package
+                    (i.e. <filename>${</filename><link linkend='var-PN'><filename>PN</filename></link><filename>}</filename>).
+                    Use this variable if the modules that have the pixbuf
+                    loaders you need appear in a package other than that main
+                    package.
+                </para>
+            </glossdef>
+        </glossentry>
+
         <glossentry id='var-PKGD'><glossterm>PKGD</glossterm>
             <glossdef>
                 <para>
-- 
cgit v1.2.3-54-g00ecf