git: 78deabd3b1 - main - [doc-en][phb] Document Qt 6 bits in the ports framework.
- Go to: [ bottom of page ] [ top of archives ] [ this month ]
Date: Wed, 21 Sep 2022 17:27:11 UTC
The branch main has been updated by fernape:
URL: https://cgit.FreeBSD.org/doc/commit/?id=78deabd3b1b2aabe9960c24d0c7e8df3fb57e607
commit 78deabd3b1b2aabe9960c24d0c7e8df3fb57e607
Author: Fernando Apesteguía <fernape@FreeBSD.org>
AuthorDate: 2022-09-20 16:09:50 +0000
Commit: Fernando Apesteguía <fernape@FreeBSD.org>
CommitDate: 2022-09-21 14:15:37 +0000
[doc-en][phb] Document Qt 6 bits in the ports framework.
Follow the work done in different commits in the ports repo.
Approved by: kde@ (tcberner@)
Differential Revision: https://reviews.freebsd.org/D36647
---
.../en/books/porters-handbook/special/_index.adoc | 37 ++++++++++++++++++----
.../en/books/porters-handbook/uses/_index.adoc | 23 ++++++++++++--
2 files changed, 51 insertions(+), 9 deletions(-)
diff --git a/documentation/content/en/books/porters-handbook/special/_index.adoc b/documentation/content/en/books/porters-handbook/special/_index.adoc
index 63d9623d2b..8a91a56bb0 100644
--- a/documentation/content/en/books/porters-handbook/special/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/special/_index.adoc
@@ -2065,7 +2065,8 @@ For ports that are part of Qt itself, see crossref:uses[uses-qt-dist,`qt-dist`].
[[qt-common]]
=== Ports That Require Qt
-The Ports Collection provides support for Qt 5 with `USES+=qt:5`.
+The Ports Collection provides support for Qt 5 and Qt 6 with `USES+=qt:5` and
+`USES+=qt:6` respectively.
Set `USE_QT` to the list of required Qt components (libraries, tools, plugins).
The Qt framework exports a number of variables which can be used by ports, some of them listed below:
@@ -2106,7 +2107,7 @@ Individual Qt tool and library dependencies must be specified in `USE_QT`.
Every component can be suffixed with `_build` or `_run`, the suffix indicating whether the dependency on the component is at buildtime or runtime.
If unsuffixed, the component will be depended on at both build- and runtime.
Usually, library components are specified unsuffixed, tool components are mostly specified with the `_build` suffix and plugin components are specified with the `_run` suffix.
-The most commonly used components are listed below (all available components are listed in `_USE_QT_ALL`, and `_USE_QT5_ONLY` in [.filename]#/usr/ports/Mk/Uses/qt.mk#):
+The most commonly used components are listed below (all available components are listed in `_USE_QT_ALL`, which is generated from `_USE_QT_COMMON` and `_USE_QT[56]_ONLY` in [.filename]#/usr/ports/Mk/Uses/qt.mk#):
[[using-qt-library-list]]
.Available Qt Library Components
@@ -2118,9 +2119,15 @@ The most commonly used components are listed below (all available components are
|`3d`
|Qt3D module
+|`5compat`
+|Qt 5 compatibility module for Qt 6
+
|`assistant`
|Qt 5 documentation browser
+|`base`
+|Qt 6 base module
+
|`canvas3d`
|Qt canvas3d module
@@ -2172,12 +2179,18 @@ The most commonly used components are listed below (all available components are
|`l10n`
|Qt localized messages
+|`languageserver`
+|Qt 6 Language Server Protocol implementation
+
|`linguist`
|Qt 5 translation tool
|`location`
|Qt location module
+|`lottie`
+|Qt 6 QML API for rendering graphics and animations
+
|`multimedia`
|Qt audio, video, radio and camera support module
@@ -2200,7 +2213,10 @@ The most commonly used components are listed below (all available components are
|Qt 5 screen magnifier
|`plugininfo`
-|Qt5 plugin metadata dumper
+|Qt 5 plugin metadata dumper
+
+|`positioning`
+|Qt 6 positioning API from sources such as satellite, wifi or text files.
|`printsupport`
|Qt print support module
@@ -2230,7 +2246,7 @@ The most commonly used components are listed below (all available components are
|Set of controls for building complete interfaces in Qt Quick
|`remoteobjects`
-|Qt5 SXCML module
+|Qt 5 SXCML module
|`script`
|Qt 4-compatible scripting module
@@ -2239,7 +2255,7 @@ The most commonly used components are listed below (all available components are
|Qt Script additional components
|`scxml`
-|Qt5 SXCML module
+|Qt 5 SXCML module
|`sensors`
|Qt sensors module
@@ -2250,6 +2266,9 @@ The most commonly used components are listed below (all available components are
|`serialport`
|Qt functions to access serial ports
+|`shadertools`
+|Qt 6 tools for the cross-platform Qt shader pipeline
+
|`speech`
|Accessibility features for Qt5
@@ -2283,6 +2302,12 @@ The most commonly used components are listed below (all available components are
|`testlib`
|Qt unit testing module
+|`tools`
+|Qt 6 assorted tools
+
+|`translations`
+|Qt 6 translation module
+
|`uiplugin`
|Custom Qt widget plugin interface for Qt Designer
@@ -2293,7 +2318,7 @@ The most commonly used components are listed below (all available components are
|Qt 5 Virtual Keyboard Module
|`wayland`
-|Qt5 wrapper for Wayland
+|Qt 5 wrapper for Wayland
|`webchannel`
|Qt 5 library for integration of C++/QML with HTML/js clients
diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc
index d5999cdc5f..3136699969 100644
--- a/documentation/content/en/books/porters-handbook/uses/_index.adoc
+++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc
@@ -1560,7 +1560,7 @@ Uses QMake for configuring. For more information see crossref:special[using-qmak
[[uses-qt]]
== `qt`
-Possible arguments: `5`, `no_env`
+Possible arguments: `5`, `6`, `no_env`
Add dependency on Qt components.
`no_env` is passed directly to `USES= qmake`.
@@ -1569,9 +1569,9 @@ See crossref:special[using-qt,Using Qt] for more information.
[[uses-qt-dist]]
== `qt-dist`
-Possible arguments: (none) or `5` and (none) or one of `3d`, `activeqt`, `androidextras`, `base`, `canvas3d`, `charts`, `connectivity`, `datavis3d`, `declarative`, `doc`, `gamepad`, `graphicaleffects`, `imageformats`, `location`, `macextras`, `multimedia`, `networkauth`, `purchasing`, `quickcontrols2`, `quickcontrols`, `remoteobjects`, `script`, `scxml`, `sensors`, `serialbus`, `serialport`, `speech`, `svg`, `tools`, `translations`, `virtualkeyboard`, `wayland`, `webchannel`, `webengine`, `websockets`, `webview`, `winextras`, `x11extras`, `xmlpatterns`
+Possible arguments: (none) or `5` and (none) or `6` and (none) or one of `3d`, `5compat`, `base`, `charts`, `connectivity`, `datavis3d`, `declarative`, `doc` `languageserver`, `gamepad`, `graphicaleffects`, `imageformats`, `locat ion`, `lottie`, `multimedia`, `networkauth`, `positioning`, `quick3d`, `quickcontrols2`, `quickcontrols`, `quicktimeline`, `remoteobjects`, `script`, `scxml `, `sensors`, `serialbus`, `serialport`, `shadertools`, `speech`, `svg`, `tools`, `translations`, `virtualkeyboard`, `wayland`, `webchannel`, `webengine`, `webglplugin`, `websockets`, `webview`, `x11extras`, `xmlpatterns`.
-Provides support for building Qt 5 components.
+Provides support for building Qt 5 and Qt 6 components.
It takes care of setting up the appropriate configuration environment for the port to build.
[[qt5-dist-example]]
@@ -1590,6 +1590,23 @@ USES= qt-dist:5
====
+
+[[qt6-dist-example]]
+.Building Qt 6 Components
+[example]
+====
+The port is Qt 6's `websockets` component, which is part of the `websockets` distribution file.
+
+[.programlisting]
+....
+PORTNAME= websockets
+PORTVERSION= ${QT6_VERSION}
+
+USES= qt-dist:6
+....
+
+====
+
If `PORTNAME` does not match the component name, it can be passed as an argument to `qt-dist`.
[[qt5-dist-example-explicit]]