From nobody Wed Sep 21 17:27:11 2022 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4MXlhv6KrHz4d4ZV for ; Wed, 21 Sep 2022 17:27:11 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4MXlhv5qs2z3VJM; Wed, 21 Sep 2022 17:27:11 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1663781231; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=dgmH7PlSbwqaDRiBrP+qaOKGmbsfnPBR9uNUgDg+VR8=; b=VVL7vbn6CRyjjLIqI6u0+OnrUItzTX62Pk4jr5YGWG05MgZ2HSI7OT3S9cCYnCTYpei6Ds c2OaCUS7Q3N9Qnc6ncuIltUOzzjgocBp+gAH5manCvCntDlcVUiDd0DuDYwix+Osne/GSk qldZWeWI909J1uG90qteFgeLfclLeR4pSzZFaZROO6V6cWrYUEVckDPs3xfn5lk8kgGQh2 PZziVJdsar9CU6+0bRZk44H3RmpHpLu3fzrd5GWxPRHayoN+z9gN6v5vLDPXuH/EL+1wPJ LhF7V+eB0ocC5LYrA/9y3WMiFnW9OwxNOZ1CF8TptIWpSjXAbU+sRzYf3jsG6Q== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4MXlhv4tpCz17hP; Wed, 21 Sep 2022 17:27:11 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 28LHRBfL050694; Wed, 21 Sep 2022 17:27:11 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 28LHRBCN050693; Wed, 21 Sep 2022 17:27:11 GMT (envelope-from git) Date: Wed, 21 Sep 2022 17:27:11 GMT Message-Id: <202209211727.28LHRBCN050693@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: =?utf-8?Q?Fernando=20Apestegu=C3=ADa?= Subject: git: 78deabd3b1 - main - [doc-en][phb] Document Qt 6 bits in the ports framework. List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: fernape X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 78deabd3b1b2aabe9960c24d0c7e8df3fb57e607 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1663781231; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=dgmH7PlSbwqaDRiBrP+qaOKGmbsfnPBR9uNUgDg+VR8=; b=spYk2m6Afc1grp2rmEIKKBIY4rAqCbZKN122ElK3LxPOuyJa36kMNECvYX5fOGuZQR8z0W 7SmrJYOCLovZ+G5M/nuN90idy9cgMYqAqL75be18+LDGzq+dDn7A5B9NjP7iLkOa4UH0vc /qEc4/kulTWaNvOLN0rVIvSuPtIfZ+DcCnc/ICHlCNGphDH/KvXi5UJrJg/I4d0U7S4aqt LyaeWfRcgceuipgIW9qtfePoDjsG60ALedcT7SzE9GZfwaa8mNPAU4RTCkFKGrDSee0jYx mikDY7NYSYGTPjLLIhR9S4j5nNHxIT+vgOyqJSny9TwtL1S2OSolYpt1vmLSDA== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1663781231; a=rsa-sha256; cv=none; b=f/SbmyxSUnlDEj8pJs6vB0iwLno8vF5oEvlXUvG1RO4V2RmhsPcq2QJnm72r0FliZhKABG zmv+knUv2DTVw3lNcQjx+PlBnNIeE2RPseQ/jyq/YJBTAifZHzru05RS7erDBSY+ZA5VlW 4y6+B3kEIFkaNw+F6hPfsxXwBw//jbg0RP9IRBcGMM1QfN8htgwPA7IelnenlPh7Yfy4G2 fvgiqki9f8TU8H5L0hdcArfL5qSmb4KfMaG4WYe0/T2viMZqPxjvDBvP/MZxYPu/yumCq9 9K9y+5GMPREGSkKLyHJD36PcIVejD7X+bsCqo/SnF82vp1nU2graGKDMtgslvw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by fernape: URL: https://cgit.FreeBSD.org/doc/commit/?id=78deabd3b1b2aabe9960c24d0c7e8df3fb57e607 commit 78deabd3b1b2aabe9960c24d0c7e8df3fb57e607 Author: Fernando Apesteguía AuthorDate: 2022-09-20 16:09:50 +0000 Commit: Fernando Apesteguía 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]]