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

qmltyperegistrar --help looks bad

    XMLWordPrintable

Details

    • Linux/X11
    • dbde4265657db16621551d12a25ff8ffaa18eb73 (qt/qtdeclarative/5.15)

    Description

      The long parameter descriptions push the descriptive text over into a narrower column; the worst is

      <Comma separated list of other modules to consult for types.>
      

      I think the idea is to keep those shorter, like just <other modules>, and describe what it means in the descriptive paragraph instead.

      But IMO it's also a bug that QCommandLineParser doesn't take terminal width into account: I can make the terminal wider, but qmltyperegistrar help still tries to fit into 80-ish columns, and fails miserably. Querying terminal width would require non-portable techniques though (at least one way for Windows and one for Unix/Linux). https://stackoverflow.com/questions/263890/how-do-i-find-the-width-height-of-a-terminal-window

      [i7][21:24:30] /home/rutledge/dev/qt5-dbg/qtbase/bin/qmltyperegistrar --help
      Usage: /home/rutledge/dev/qt5-dbg/qtbase/bin/qmltyperegistrar [options] [MOC generated json file]
      
      Options:
        -h, --help                                                                     D
                                                                                       is
                                                                                       pl
                                                                                       ay
                                                                                       s
                                                                                       he
                                                                                       lp
                                                                                       on
                                                                                       co
                                                                                       mm
                                                                                       an
                                                                                       dl
                                                                                       in
                                                                                       e
                                                                                       op
                                                                                       ti
                                                                                       on
                                                                                       s.
        --help-all                                                                     D
                                                                                       is
                                                                                       pl
                                                                                       ay
                                                                                       s
                                                                                       he
                                                                                       lp
                                                                                       in
                                                                                       cl
                                                                                       ud
                                                                                       in
                                                                                       g
                                                                                       Qt
                                                                                       sp
                                                                                       ec
                                                                                       if
                                                                                       ic
                                                                                       op
                                                                                       ti
                                                                                       on
                                                                                       s.
        -v, --version                                                                  D
                                                                                       is
                                                                                       pl
                                                                                       ay
                                                                                       s
                                                                                       ve
                                                                                       rs
                                                                                       io
                                                                                       n
                                                                                       in
                                                                                       fo
                                                                                       rm
                                                                                       at
                                                                                       io
                                                                                       n.
        -o <file>                                                                      W
                                                                                       ri
                                                                                       te
                                                                                       ou
                                                                                       tp
                                                                                       ut
                                                                                       to
                                                                                       sp
                                                                                       ec
                                                                                       if
                                                                                       ie
                                                                                       d
                                                                                       fi
                                                                                       le
        --private-includes                                                             I
                                                                                       nc
                                                                                       lu
                                                                                       de
                                                                                       he
                                                                                       ad
                                                                                       er
                                                                                       s
                                                                                       en
                                                                                       di
                                                                                       ng
                                                                                       in
                                                                                       "_
                                                                                       p.
                                                                                       h"
                                                                                       us
                                                                                       in
                                                                                       g
                                                                                       "#
                                                                                       in
                                                                                       cl
                                                                                       ud
                                                                                       e
                                                                                       <p
                                                                                       ri
                                                                                       va
                                                                                       te
                                                                                       /f
                                                                                       oo
                                                                                       _p
                                                                                       .h
                                                                                       >"
                                                                                       ra
                                                                                       th
                                                                                       er
                                                                                       th
                                                                                       an
                                                                                       "#
                                                                                       in
                                                                                       cl
                                                                                       ud
                                                                                       e
                                                                                       <f
                                                                                       oo
                                                                                       _p
                                                                                       .h
                                                                                       >"
        --import-name <QML module name>                                                N
                                                                                       am
                                                                                       e
                                                                                       of
                                                                                       th
                                                                                       e
                                                                                       mo
                                                                                       du
                                                                                       le
                                                                                       to
                                                                                       us
                                                                                       e
                                                                                       wi
                                                                                       th
                                                                                       QM
                                                                                       L
                                                                                       ty
                                                                                       pe
                                                                                       re
                                                                                       gi
                                                                                       st
                                                                                       ra
                                                                                       ti
                                                                                       on
                                                                                       s.
        --major-version <major version>                                                M
                                                                                       aj
                                                                                       or
                                                                                       ve
                                                                                       rs
                                                                                       io
                                                                                       n
                                                                                       to
                                                                                       us
                                                                                       e
                                                                                       fo
                                                                                       r
                                                                                       ty
                                                                                       pe
                                                                                       re
                                                                                       gi
                                                                                       st
                                                                                       ra
                                                                                       ti
                                                                                       on
                                                                                       s.
        --minor-version <minor version>                                                M
                                                                                       in
                                                                                       or
                                                                                       ve
                                                                                       rs
                                                                                       io
                                                                                       n
                                                                                       to
                                                                                       us
                                                                                       e
                                                                                       fo
                                                                                       r
                                                                                       mo
                                                                                       du
                                                                                       le
                                                                                       re
                                                                                       gi
                                                                                       st
                                                                                       ra
                                                                                       ti
                                                                                       on
        --generate-plugintypes <qmltypes target Directory>                             G
                                                                                       en
                                                                                       er
                                                                                       at
                                                                                       e
                                                                                       pl
                                                                                       ug
                                                                                       in
                                                                                       s.
                                                                                       qm
                                                                                       lt
                                                                                       yp
                                                                                       es
                                                                                       in
                                                                                       to
                                                                                       sp
                                                                                       ec
                                                                                       if
                                                                                       ie
                                                                                       d
                                                                                       di
                                                                                       re
                                                                                       ct
                                                                                       or
                                                                                       y.
        --foreign-types <Comma separated list of other modules to consult for types.>  C
                                                                                       on
                                                                                       si
                                                                                       de
                                                                                       r
                                                                                       fo
                                                                                       re
                                                                                       ig
                                                                                       n
                                                                                       ty
                                                                                       pe
                                                                                       s
                                                                                       wh
                                                                                       en
                                                                                       ge
                                                                                       ne
                                                                                       ra
                                                                                       ti
                                                                                       ng
                                                                                       pl
                                                                                       ug
                                                                                       in
                                                                                       s.
                                                                                       qm
                                                                                       lt
                                                                                       yp
                                                                                       es
        --dependencies <name of JSON file with dependencies>                           D
                                                                                       ep
                                                                                       en
                                                                                       de
                                                                                       nc
                                                                                       ie
                                                                                       s
                                                                                       to
                                                                                       be
                                                                                       st
                                                                                       at
                                                                                       ed
                                                                                       in
                                                                                       pl
                                                                                       ug
                                                                                       in
                                                                                       s.
                                                                                       qm
                                                                                       lt
                                                                                       yp
                                                                                       es
      
      Arguments:
        [MOC generated json file]                                                      M
                                                                                       OC
                                                                                       ge
                                                                                       ne
                                                                                       ra
                                                                                       te
                                                                                       d
                                                                                       js
                                                                                       on
                                                                                       ou
                                                                                       tp
                                                                                       ut
      

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            ulherman Ulf Hermann
            srutledg Shawn Rutledge
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes