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
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 @@
434 </para> 434 </para>
435</section> 435</section>
436 436
437<section id='ref-classes-compress_doc'>
438 <title><filename>compress_doc.bbclass</filename></title>
439
440 <para>
441 Enables compression for man pages and information pages.
442 This class is intended to be inherited globally.
443 The default compression mechanism is gz (gzip) but you can
444 select an alternative mechanism by setting the
445 <link linkend='var-DOC_COMPRESS'><filename>DOC_COMPRESS</filename>
446 variable.
447 </para>
448</section>
449
437<section id='ref-classes-copyleft_compliance'> 450<section id='ref-classes-copyleft_compliance'>
438 <title><filename>copyleft_compliance.bbclass</filename></title> 451 <title><filename>copyleft_compliance.bbclass</filename></title>
439 452
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 @@
2191 chapter. 2191 chapter.
2192 </para> 2192 </para>
2193 </glossdef> 2193 </glossdef>
2194 </glossentry>
2195
2196 <glossentry id='var-DOC_COMPRESS'><glossterm>DOC_COMPRESS</glossterm>
2197 <glossdef>
2198 <para>
2199 Sets the compression policy used when the OpenEmbedded
2200 build system compresses man pages and info pages.
2201 By default, the compression method used is gs (gzip).
2202 </para>
2194 2203
2204 <para>
2205 For information on how to use this variable, see the
2206 comments in the
2207 <filename>compress_doc.bbclass</filename> file.
2208 </para>
2209 </glossdef>
2195 </glossentry> 2210 </glossentry>
2211
2196 </glossdiv> 2212 </glossdiv>
2197 2213
2198 <glossdiv id='var-glossary-e'><title>E</title> 2214 <glossdiv id='var-glossary-e'><title>E</title>