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

Provide documentation for all options and their valid values for .qmlformat.ini file

    XMLWordPrintable

Details

    • a485ea061 (6.9), 9ff0c8f02 (tqtc/lts-6.8), 91f22df8f (dev), fb4fe1944 (6.9.1)

    Description

      https://doc.qt.io/qt-6/qtqml-tooling-qmlformat.html documents the options accepted by the console tool. Similar documentation is needed for the options accepted in a .qmlformat.ini file.

      Currently the only way to find these options is to inspect the qmlformat source code. qmlformat --write-defaults produces a small, non-comprehensive file.

      Attachments

        Issue Links

          is required for

          Task - A task that needs to be done. QTCREATORBUG-32964 Document how to use the new "Global qmlformat Configuration"

          • Not Evaluated - Not yet evaluated/prioritized
          • Closed
          relates to

          Suggestion - Public suggestions QTBUG-107213 Doc: Polish docs for qmlformat

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

          Suggestion - Public suggestions QTBUG-127344 qmlformat: Distinguish between options that control I/O vs. options that control a QML document's format

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Reported
          For Gerrit Dashboard: QTBUG-127286
          # Subject Branch Project Status CR V
          646117,7 qmlformat: document .qmlformat.ini settings dev qt/qtdeclarative Status: MERGED +2 0
          646151,1 qmlformat: document .qmlformat.ini settings, pick 2 dev qt/qtdeclarative Status: ABANDONED 0 0
          646152,1 qmlformat: document .qmlformat.ini settings dev qt/qtdeclarative Status: ABANDONED 0 0
          646187,3 qmlformat: document .qmlformat.ini settings for Qt 6.9 6.9 qt/qtdeclarative Status: MERGED +2 0
          646198,2 qmlformat: document .qmlformat.ini settings for Qt 6.8 tqtc/lts-6.8 qt/tqtc-qtdeclarative Status: MERGED +2 0
          646841,2 qmlformat: document .qmlformat.ini settings for Qt 6.9 6.9.1 qt/qtdeclarative Status: MERGED +2 0

          Activity

            People

              semih.yavuz Semih Yavuz
              skoh-qt Sze Howe Koh
              Votes:
              2 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Gerrit Reviews