sysmo-bts
/
generic-poky
9
0
Fork 0
Code Pull Requests Releases Activity

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>
This commit is contained in:
Scott Rifenbark 2014-10-20 08:45:03 -07:00 committed by Richard Purdie
parent 924da20c6f
commit 12fb49eb88
2 changed files with 30 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
documentation/ref-manual/ref-classes.xml
View File

@ -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>

18
documentation/ref-manual/ref-variables.xml
View File

@ -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>