From 12fb49eb88956c6262e574646d5a35a1ce837041 Mon Sep 17 00:00:00 2001
From: Scott Rifenbark <scott.m.rifenbark@intel.com>
Date: Mon, 20 Oct 2014 08:45:03 -0700
Subject: ref-manual: Added compress_doc class and DOC_COMPRESS variable.

(From yocto-docs rev: 875b6eb2e01b1bb9b4c8ed3c80553c1d0870cf78)

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   | 13 +++++++++++++
 documentation/ref-manual/ref-variables.xml | 16 ++++++++++++++++
 2 files changed, 29 insertions(+)

(limited to 'documentation')

diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index 6880c60a5a..3f1814c253 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -434,6 +434,19 @@
     </para>
 </section>
 
+<section id='ref-classes-compress_doc'>
+    <title><filename>compress_doc.bbclass</filename></title>
+
+    <para>
+        Enables compression for man pages and information pages.
+        This class is intended to be inherited globally.
+        The default compression mechanism is gz (gzip) but you can
+        select an alternative mechanism by setting the
+        <link linkend='var-DOC_COMPRESS'><filename>DOC_COMPRESS</filename>
+        variable.
+    </para>
+</section>
+
 <section id='ref-classes-copyleft_compliance'>
     <title><filename>copyleft_compliance.bbclass</filename></title>
 
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index 1aabd5c71d..fe5738ec9f 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -2191,8 +2191,24 @@
                     chapter.
                 </para>
             </glossdef>
+        </glossentry>
+
+        <glossentry id='var-DOC_COMPRESS'><glossterm>DOC_COMPRESS</glossterm>
+            <glossdef>
+                <para>
+                    Sets the compression policy used when the OpenEmbedded
+                    build system compresses man pages and info pages.
+                    By default, the compression method used is gs (gzip).
+                </para>
 
+                <para>
+                    For information on how to use this variable, see the
+                    comments in the
+                    <filename>compress_doc.bbclass</filename> file.
+                </para>
+            </glossdef>
         </glossentry>
+
     </glossdiv>
 
     <glossdiv id='var-glossary-e'><title>E</title>
-- 
cgit v1.2.3-54-g00ecf