View source for Checklist for Qt 6.0 inclusion

[[Category:Developing Qt::Qt6]]

__TOC__

Qt 6 will introduce a lot of changes when compared to Qt 5. To begin with, Qt 6 requires C++17 which by itself excludes some compilers which were supported by Qt 5. Other changes are related to APIs, the build system (move from qmake to cmake as Qt's internal build system) or general infrastructure changes in the CI and test setup. Given the deadline for the Qt 6.0 release at the end of 2020, it is likely that not all Qt modules will be ready for the deadline set by the 6.0 release schedule.

== Ready-For-Qt6-Inclusion ==

The general list of Qt release criteria (e.g. string freeze, API reviews done, branching) as outlined by the general releases notes of every Qt 5 release (e.g. [[Qt 5.14 Release|release wiki for Qt 5.14]]) shall continue to apply. However those deadlines and gate criteria are considered to be as "too late" to make the final decision for inclusion. Therefore the notion of an earlier "Ready-for-Qt6-inclusion" checkpoint is being introduced. The current time suggestion for this checkpoint is end of June 2020. A more precise timeline will be suggested later on. Stay tuned.

During this earlier checkpoint each module is assessed against the criteria set out below. It is the maintainers responsibility to ensure that the data is provided for their module on this wiki page. The received feedback is used to evaluate the readiness of each individual module and in turn the readiness of Qt 6. It may also be used to define the list of Qt modules which are on track and may constitute a sufficiently large but nevertheless reduced set of Qt modules ready for Qt 6.0. If the set is deemed too small other considerations such as a delayed release schedule or feature drop may be considered.

If the release criteria are not met/stated maintainers may choose to release their module via the next minor release after 6.0 in the series.

=== Deadline ===

We want to have clarity on the list of 6.0 modules by end of June. Adding two weeks of deliberations based in the feedback implies that the '''15. June 2020''' is the deadline for the module data. To avoid dragging the process out due to missing information, no response implies the module is automatically not included in Qt 6.0.

== Release Criteria ==
* Port to cmake on target for completion
** Target definition:
*** Library, examples & tests have been ported
*** The module is built & tested in the CI using cmake and tests pass
* Continuous Integration for Qt 6
** CI runs against qtbase/qtdeclarative SHA no older than 2 weeks
** git repo is part of regular submodule update bot runs in dev (qt5.git/.gitmodules status != ignore)
** Works with the supported platforms in CI for Qt 6.0
* Backlog trajectory
** Link to Jira stating the not completed and completed Qt 6.0 development tasks
* Reviews
** Initial review of public API done (is maintainer aware of/happy with the current state?)
** Are the API changes on track measured against the expectations
* Porting/Documentation information available
** Simple list of completed API changes which may later be used to write Qt6 migration docs
* Other open comments serving as extenuating circumstances

== Status per Module ==

=== Review Template ===

==== Module Name ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>        | <span style="color: red">Not Ready</span>
|-
| Cmake port || Complete | Not Complete (<Missing part>)
|-
| Jira backlog || {{Issue|Jira-ticket}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>        | <span style="color: red">No</span>
|-
| gitmodules/submodule bot || ignored
|-
| Comments/Circumstance || 
|}

=== State of Essential Modules ===

Note that the list of essential modules may be revised in light of Qt 6.0.

==== Qt Core ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || {{Issue|QTBUG-71036}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || N/A (qtbase).
|-
| Comments/Circumstance || Definition of Ready is relative to QtCore!
|}

==== Qt GUI ====
{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || {{Issue|QTBUG-72560}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || N/A (qtbase).
|-
| Comments/Circumstance || 
|}
==== Qt Multimedia ====
==== Qt Multimedia Widgets ====
==== Qt Network ====
{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || {{Issue|QTBUG-75638}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || N/A (qtbase).
|-
| Comments/Circumstance || 
|}
==== Qt QML ====
==== Qt Quick ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog ||
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || <span style="color: green">Yes</span>
|-
| Comments/Circumstance || Purging the legacy direct OpenGL rendering bits is on-going
|}

==== Qt Quick Controls 2 ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || {{Issue|QTBUG-82256}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || <span style="color: green">Yes</span>
|-
| Comments/Circumstance || 
|}

==== Qt Quick Dialogs ====
{| class="wikitable"
|-
! Status Summary !! <span style="color: red">Not Ready</span>
|-
| Cmake port || Not started
|-
| Jira backlog ||
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || N/A (qtquickcontrols).
|-
| Comments/Circumstance || Qt Quick Dialogs still live in the Qt Quick Controls 1 repository, which will not be part of Qt 6. Code needs to be moved over to Qt Quick Controls 2 or into a separate repository, and ported to Qt Quick Controls 2. The Dialog in Qt Quick Controls 2 is currently very limited (a popup pane within the window, not independent top level windows, and without implementation of any content for choosing files, colors or fonts); whereas the dialogs in QtQuick.Dialogs are actual top-level windows (when possible, or popup panes otherwise) and work on any platform, with native dialogs or with QML substitute implementations.  So users will not be satisfied if they are missing; they need to be ported forward eventually.  Another fallback for now is Qt.labs.platform, which should not be taken out of Labs because it creates a dependency on widgets.
|}

==== Qt Quick Layouts ====
==== Qt SQL ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || [https://bugreports.qt.io/browse/QTBUG-84760 QTBUG-84760]
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || N/A (qtbase)
|-
| Comments/Circumstance || 
|}

==== Qt Widgets ====
{| class="wikitable"
|-
! Status Summary !! <span style="color: red">Not Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || {{Issue|QTBUG-69410}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || N/A (qtbase).
|-
| Comments/Circumstance || Still some issues left
|}

=== State of Add-on Modules ===

==== Active Qt ====
==== Qt 3D ====
{| class="wikitable"
|-
! Status Summary !! <span style="color: red">Not Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || {{Issue|QTBUG-84552}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || ignored
|-
| Comments/Circumstance || 
|}

==== Qt Android Extras ====
Not included in Qt 6.0. Will find new home in the more relevant modules over time, and the remaining APIs considered included in later 6.x releases.

==== Qt Bluetooth ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: red">Not Ready</span>
|-
| Cmake port || Complete (not yet enabled in CI)
|-
| Jira backlog || {{Issue|QTBUG-62877}}
|-
| Recent CI SHA || <span style="color: red">No</span>
|-
| gitmodules/submodule bot || ignored
|-
| Comments/Circumstance || 
|}

==== Qt Charts ====
==== Qt Concurrent ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || {{Issue|QTBUG-80908}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || N/A (qtbase).
|-
| Comments/Circumstance || 
|}

==== Qt D-Bus ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || No particular item planned
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || N/A (qtbase).
|-
| Comments/Circumstance || 
|}

==== Qt Data Visualization ====
==== Qt Gamepad ====

==== Qt Graphical Effects ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || {{Issue|QTBUG-78572}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || <span style="color: green">Yes</span>
|-
| Comments/Circumstance || The RHI port supports 17 out of 25 effects. The 8 unsupported ones are removed.
|}

==== Qt Help ====
==== Qt Image Formats ====
==== Qt Lottie ====

==== Qt Location ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: red">Not Ready</span>
|-
| Cmake port || Not Complete
|-
| Jira backlog || {{Issue|QTBUG-72239}}
|-
| Recent CI SHA || <span style="color: red">No</span>
|-
| gitmodules/submodule bot || ignored
|-
| Comments/Circumstance || 
|}

==== Qt Mac Extras ====
Not included in Qt 6.0. Will find new home in the more relevant modules over time, and the remaining APIs considered included in later 6.x releases.

==== Qt Network Authorization ====
{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || 
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || <span style="color: green">Yes</span>
|-
| Comments/Circumstance || 
|}

==== Qt OpenGL ====

Note, the contents of this module is different in Qt 6 compared to Qt 5. The old, deprecated, Qt 4 era QGL* classes are removed. Now it contains the QOpenGL* classes.

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>        | <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || 
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || N/A (qtbase).
|-
| Comments/Circumstance ||
|}

==== Qt OpenGL Widgets ====
Note, new in Qt 6. Contains QOpenGLWidget, which used to live in Qt Widgets in Qt 5.

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>        | <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || 
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || N/A (qtbase).
|-
| Comments/Circumstance ||
|}

==== Qt Platform Headers ====

Will become private API in 6.0

==== Qt Positioning ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: red">Not Ready</span>
|-
| Cmake port || Complete (not yet enabled in CI)
|-
| Jira backlog || {{Issue|QTBUG-72240}}
|-
| Recent CI SHA || <span style="color: red">No</span>
|-
| gitmodules/submodule bot || ignored
|-
| Comments/Circumstance || 
|}

==== Qt Printing Support ====
==== Qt Purchasing ====
This module will not be part of Qt 6. Will soon be decided when it will land next ([https://bugreports.qt.io/browse/QTBUG-82847 QTBUG-82847]).

==== Qt Quick 3D ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>        | <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || 
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || <span style="color: green">Yes</span>
|-
| Comments/Circumstance ||
|}

==== Qt Quick Controls 1 ====

Note, this module is deprecated in Qt 5.15 and therefore may no longer be shipped in Qt 6.

==== Qt Quick Extras ====

==== Qt Quick Timeline ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>        | <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || 
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || <span style="color: green">Yes</span>
|-
| Comments/Circumstance ||
|}

==== Qt Quick WebGL ====

==== Qt Quick Widgets ====

Note, this module (and so QQuickWidget) is supported for OpenGL and the 'software' scenegraph backend in Qt 6.0, i.e. what Qt 5 supports. It is not compatible with other graphics APIs.

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>        | <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || 
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || N/A (qtdeclarative).
|-
| Comments/Circumstance ||
|}

==== Qt Remote Objects ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: red">Not Ready</span>
|-
| Cmake port || Not Complete (Needs more testing)
|-
| Jira backlog || {{Issue|QTBUG-84590}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || ignored
|-
| Comments/Circumstance || In progress, but at risk of making 6.0 if binary incompatible changes to the module cannot be contained in time
|}

==== Qt Script ====

Note, this module is deprecated in Qt 5.15 and therefore may no longer be shipped in Qt 6.

==== Qt SCXML ====
==== Qt Script Tools ====

Note, this module is deprecated in Qt 5.15 and therefore may no longer be shipped in Qt 6.

==== Qt Sensors ====
==== Qt Serial Bus ====

https://bugreports.qt.io/browse/QTBUG-64145
{| class="wikitable"
|-
! Status Summary !! <span style="color: red">Not Ready</span>
|-
| Cmake port || Not Complete
|-
| Jira backlog || {{Issue|QTBUG-84145}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || ignored
|-
| Comments/Circumstance || 
|}

==== Qt Shader Tools ====
Note, new in Qt 6.

{| class="wikitable"
|-
! Status Summary !! <span style="color: green">Ready</span>        | <span style="color: green">Ready</span>
|-
| Cmake port || Complete
|-
| Jira backlog || 
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || <span style="color: green">Yes</span>
|-
| Comments/Circumstance ||
|}

==== Qt Speech ====
==== Qt SVG ====
==== Qt UI Tools ====
==== Qt Virtual Keyboard ====

{| class="wikitable"
|-
! Status Summary !! <span style="color: red">Not Ready</span>
|-
| Cmake port || Not Complete ({{Issue|QTBUG-84324}})
|-
| Jira backlog || {{Issue|QTBUG-84322}}
|-
| Recent CI SHA || <span style="color: green">Yes</span>
|-
| gitmodules/submodule bot || <span style="color: green">Yes</span>
|-
| Comments/Circumstance || 
|}

==== Qt WebChannel ====
==== Qt WebEngine ====
Not included in Qt 6.0.
==== Qt WebSockets ====
==== Qt WebView ====
Not included in Qt 6.0.

==== Qt Windows Extras ====
Not included in Qt 6.0. Will find new home in the more relevant modules over time, and the remaining APIs considered included in later 6.x releases.

==== Qt X11 Extras ====
Not included in Qt 6.0. Will find new home in the more relevant modules over time, and the remaining APIs considered included in later 6.x releases.

==== Qt XML ====
==== Qt XML Patterns ====

Note, this module is deprecated in Qt 5.15 and therefore may no longer be shipped in Qt 6.

==== Qt Wayland Compositor ====
==== Qt X11 Extras ====
Not included in Qt 6.0. Will find new home in the more relevant modules over time, and the remaining APIs considered included in later 6.x releases.

=== State of Value Add-on Modules (Qt for Automation) ===
==== Qt COAP ====
==== Qt KNX ====
This module will not be part of Qt 6.

==== Qt MQTT ====
==== Qt OPCUA ====