summaryrefslogtreecommitdiffstats
path: root/src/corelib
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@qt.io>2019-06-12 11:48:53 +0200
committerTopi Reinio <topi.reinio@qt.io>2020-03-10 06:47:45 +0100
commita8ae9718b01e68c5c0367941f7999c59b6da84d4 (patch)
tree61a8d6c7bdabd8c35033a538943b3b6aac9cfef0 /src/corelib
parent332816779c42e8a3fed34e9295c09338bc9b4945 (diff)
Doc: Mention .qrc compression attributes in resource compiler docs
Fixes: QTBUG-76321 Change-Id: Idf7b4157b46d98392314ccddf6b714f9e620b5f8 Reviewed-by: Topi Reiniƶ <topi.reinio@qt.io>
Diffstat (limited to 'src/corelib')
-rw-r--r--src/corelib/doc/src/resource-system.qdoc19
1 files changed, 15 insertions, 4 deletions
diff --git a/src/corelib/doc/src/resource-system.qdoc b/src/corelib/doc/src/resource-system.qdoc
index f9ef317799..6ff10804f5 100644
--- a/src/corelib/doc/src/resource-system.qdoc
+++ b/src/corelib/doc/src/resource-system.qdoc
@@ -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.