Skip to content

Commit

Permalink
docs: review fixes for qmake plugin reference
Browse files Browse the repository at this point in the history
  • Loading branch information
tigarmo committed May 29, 2024
1 parent bb3d2a7 commit d4c9984
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions docs/common/craft-parts/reference/plugins/qmake_plugin.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Sets the Qt major version. The default is Qt 5, set to 6 for Qt 6 projects.
Environment variables
---------------------

The plugin sets the QT_SELECT environment variable to ref:`qt-major-version`.
The plugin sets the QT_SELECT environment variable to ref:`qmake-major-version`.


Dependencies
Expand All @@ -62,7 +62,7 @@ During the build step the plugin performs the following actions:

* Run ``qmake`` in the build directory to setup the ``Makefiles``, the
project is configured with any ``qmake-parameters`` that might have
been set. If ``qmake-project-file`` has been set, ``qmake`` refer to
been set. If ``qmake-project-file`` has been set, ``qmake`` refers to
the defined file to configure the project;
* ``make`` is run to build the source;
* ``make`` calls the ``install`` target with ``DESTDIR`` set to
Expand All @@ -72,14 +72,19 @@ Examples
--------

The following snippet declares a part using the ``qmake`` plugin for a
local source that contains a ``.pro`` project file:
local source that contains a ``.pro`` project file. It specifies that Qt's
major version is 6, and that the project should be built with the Debug
configuration.

.. code-block:: yaml
parts:
hello:
source: .
plugin: qmake
qmake-major-version: 6
qmake-parameters:
- "CONFIG+=debug"
.. _qmake: https://doc.qt.io/qt-6/qmake-manual.html
Expand Down

0 comments on commit d4c9984

Please sign in to comment.