summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-10-20 08:45:03 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-10-21 15:09:15 +0100
commit12fb49eb88956c6262e574646d5a35a1ce837041 (patch)
tree5e1f5ff11c73ec926fa245095f55738c74ae022b
parent924da20c6f2f183fa7e930e4c3c6b14c090acbe5 (diff)
downloadpoky-12fb49eb88956c6262e574646d5a35a1ce837041.tar.gz
poky-12fb49eb88956c6262e574646d5a35a1ce837041.tar.bz2
poky-12fb49eb88956c6262e574646d5a35a1ce837041.zip
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>
-rw-r--r--documentation/ref-manual/ref-classes.xml13
-rw-r--r--documentation/ref-manual/ref-variables.xml16
2 files changed, 29 insertions, 0 deletions
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>