diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-03-19 09:59:55 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-03-19 10:50:43 +0100 |
| commit | a86c08345730bae70f32cfc9ff2f298a2e8cbfad (patch) | |
| tree | e858788c1676766128a9e48bb618fa7b180d75b2 | |
| parent | 4afa8125ec447d73e333e60138e804d4c5b9c80c (diff) | |
doc: add page for pyside6-qmlcachegen
Change-Id: Ieac855ed8bf776759ee314ea99d25613eef03d2c
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
| -rw-r--r-- | sources/pyside6/doc/tools/pyside-qmlcachegen.rst | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/sources/pyside6/doc/tools/pyside-qmlcachegen.rst b/sources/pyside6/doc/tools/pyside-qmlcachegen.rst new file mode 100644 index 000000000..ecd8e6afd --- /dev/null +++ b/sources/pyside6/doc/tools/pyside-qmlcachegen.rst @@ -0,0 +1,25 @@ +.. _pyside6-qmlcachegen: + +pyside6-qmlcachegen +=================== + +``pyside6-qmlcachegen`` is a command line tool that wraps `qmlcachegen`_. +This tool creates C++ code or `QML byte code` for ``.qml`` files. For +Qt for Python, only `QML byte code` is relevant. The file suffix is +``.qmlc`` and it works similar to compiled Python bytecode +(``.pyc`` files). + +Usage +----- + +The command line option ``--only-bytecode`` should be used to +create `QML byte code`. For example: + +.. code-block:: bash + + qmlcachegen --only-bytecode gallery.qml + +produces a file ``gallery.qmlc`` containing `QML byte code` which is +automatically loaded by the QML engine. + +.. _`qmlcachegen`: https://doc.qt.io/qt-6/qtqml-tool-qmlcachegen.html |