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

Provide structured documentation of Qt environment variables

    XMLWordPrintable

Details

    • User Story
    • Resolution: Unresolved
    • P3: Somewhat important
    • None
    • None
    • Build tools: qdoc, Documentation
    • None

    Description

      Qt Libraries and tools can be tweaked at runtime with various environment variables. Most of them are not documented though, and if they are, they are mentioned often just in the running text.

      We could make these environment variables more accessible by always documenting them in their own \page, and providing a full list of these with the help of
      group,
      ingroup. Alternatively, qdoc could learn about environment variables (new
      environmentvariable tag).

      Attachments

        Issue Links

          relates to

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-119259 Missing documentation of QT_IVI_SURFACE_ID

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

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-119425 miss documentation for wayland environment variable

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

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-119874 insufficient explanation of Qt wayland environment variable usage

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

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-94569 Document all the environment variables used by Qt for Android

          • P2: Important - Urgent, should be fixed, but will not stop the release.
          • Closed
          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              docteam Qt Documentation Team
              kkohne Kai Köhne
              Votes:
              2 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are no open Gerrit changes