Doc: Mention .qrc compression attributes in resource compiler docs

Fixes: QTBUG-76321
Change-Id: Idf7b4157b46d98392314ccddf6b714f9e620b5f8
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
This commit is contained in:
Topi Reinio 2019-06-12 11:48:53 +02:00
parent 332816779c
commit a8ae9718b0

View File

@ -179,6 +179,17 @@
rcc -compress 2 -compress-algo zlib myresources.qrc
\endcode
It is also possible to use \c threshold, \c compress, and \c compress-algo
as attributes in a .qrc \c file tag.
\code
<qresource>
<file compress="1" compress-algo="zstd">data.txt</file>
</qresource>
\endcode
The above will select the \c zstd algorithm with compression level 1.
\c rcc supports the following compression algorithms and compression
levels:
@ -196,10 +207,10 @@
library to choose an implementation-defined default.
\li \c{zlib}: use the \l{https://zlib.net}{zlib} library to compress
contents. Valid compression levels range from 1 to 9, with 1the least
compression (least CPU time) and 9 the most compression (most CPU time).
The special value 0 means "no compression" and should not be used. The
default is implementation-defined, but usually is level 6.
contents. Valid compression levels range from 1 to 9, with 1 applying
the least compression (least CPU time) and 9 the most compression (most
CPU time). The special value 0 means "no compression" and should not be
used. The default is implementation-defined, but usually is level 6.
\li \c{none}: no compression. This is the same as the \c{-no-compress}
option.