summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
Diffstat (limited to 'documentation')
-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>