Uploaded image for project: 'Qt'
  1. Qt
  2. QTBUG-53219

document the qml (runtime) tool; de-emphasize usage of qmlscene

    XMLWordPrintable

Details

    Description

      https://www.youtube.com/watch?v=2nnrl1v7LcE explains why we have it: it is intended to be an ordinary script interpreter, like perl or python; it should not load modules (like widgets) until you need them; it handles the shebang mechanism; and it is intended as the canonical way to run a QML file, even for end-users. Yet the docs still mention using qmlscene for testing/debugging applications, and don't mention the qml tool at all AFAICT. There also needs to be documentation of what can be achieved with custom config files (tools/qml/conf/configuration.qml is the default, but we have no alternative examples).

      Attachments

        Issue Links

          depends on

          Task - A task that needs to be done. QTBUG-96800 deprecate and later remove the qml (and qmlscene) --dummy-data argument

          • Not Evaluated - Not yet evaluated/prioritized
          • Closed

          Task - A task that needs to be done. QTBUG-53557 ensure that the qml runtime is really a suitable replacement for all qmlscene use cases

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          is duplicated by

          Task - A task that needs to be done. QTBUG-65862 documentation: remove most mentions of qmlscene, use qml instead

          • Not Evaluated - Not yet evaluated/prioritized
          • Closed
          is required for

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. QTBUG-95302 Update/overhaul QML documentation

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          relates to

          Task - A task that needs to be done. QTBUG-33659 set qml tool as the system viewer for qml files

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • Reported

          User Story - Created by Jira Software - do not edit or delete. Issue type for a user story. QTBUG-82340 Consider which qml tools to deprecate/unify in Qt 6

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Withdrawn
          For Gerrit Dashboard: QTBUG-53219
          # Subject Branch Project Status CR V
          373730,4 WIP add back information about qml's options, with details about import path dev qt/qtdoc Status: NEW -2 0
          336816,5 qmlscene: Show deprecation warning dev qt/qtdeclarative Status: MERGED +2 0
          372287,5 Convert the qmlscene documentation to qml documentation dev qt/qtdoc Status: MERGED +2 0
          372629,3 doc: Replace qmlscene with qml dev qt/qtdeclarative Status: MERGED +2 0
          372631,4 Update QML Runtime docs for 6.3 dev qt/qtdoc Status: MERGED +2 0
          373880,2 Convert the qmlscene documentation to qml documentation 6.2 qt/qtdoc Status: MERGED +2 0
          373881,7 Add qml runtime tool documentation tqtc/lts-5.15 qt/tqtc-qtdoc Status: MERGED +2 0
          374095,3 doc: Replace qmlscene with qml 6.2 qt/qtdeclarative Status: MERGED +2 0

          Activity

            People

              srutledg Shawn Rutledge
              srutledg Shawn Rutledge
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews

                  There is 1 open Gerrit change