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

Build examples as external projects within the main build

    XMLWordPrintable

Details

    • Suggestion
    • Resolution: Unresolved
    • P2: Important
    • None
    • 6.0.0, 6.5.1
    • Build System: CMake
    • None
    • All
    • 4e70ab5ee (dev), 432083949 (tqtc/lts-6.2), abe3e465b (tqtc/lts-6.2), 72de1af9e (tqtc/lts-6.2), 15cfb9392 (dev), 4a71a001a (tqtc/lts-6.5), aacc31815 (dev), 56d1754c2 (6.7), 68b2e1db0 (dev), 2a54183be (6.6), 4a45c5f2e (dev), ae53b20f2 (dev), 17fbd90a5 (6.7)

    Description

      When using a static Qt, we can't build examples as part of the main Qt build due to issues with cyclic dependencies between the main Qt module libraries and the plugins (see QTBUG-90819). We would have to manually link to the plugins in every example, but this is something that user projects wouldn't need to do and the examples would then be tainted with things that are only relevant to building Qt itself.

      Ideally, we want the examples to be built in their own separate build. They should build against the Qt that the main build provides somehow. A potential solution to this is to move the examples out to their own test case(s) and make use of the ctest --build-and-test functionality. That ctest feature is specifically meant for situations like this, where you want to verify that a project can be configured and built.

      While it would be nice to make every single example its own separate test case, that would have a fairly strong negative impact on test time. Every sub-build will need to do a full CMake run, which means performing compiler checks, etc. and this can take several seconds with some generators. We can minimise this impact by grouping examples by functionality, feature, etc. such that one test case builds multiple examples. We could potentially offer a CMake option for fine-grained tests if the user wanted it.

      Tests support labels in CMake. We could potentially assign some labels based on the module, etc. for each example or group of examples. This would enable the developer to select just the subset of tests for the examples they want.

      A further advantage of this approach is that it may open up the opportunity for building the examples against an existing Qt installation, similar to how we currently support the standalone test capabilities. This may have some advantages for CI as well.

      Attachments

        Issue Links

          blocks

          Task - A task that needs to be done. QTBUG-101340 Use qt_generate_deploy_qml_app_script MACOS_BUNDLE_POST_BUILD in QML examples

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

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-90579 building qtbase with -DBUILD_SHARED_LIBS=OFF leads to endless cmake loop

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

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-112489 QML examples installation is bogus

          • 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-86669 Investigate automatic calling of qt6_import_qml_plugins for examples using a static Qt build

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

          Task - A task that needs to be done. QTBUG-102057 Use CMake deployment API in Qt examples once the API is out of TP

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

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-86669 Investigate automatic calling of qt6_import_qml_plugins for examples using a static Qt build

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

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-90819 Linking relationships to plugins are incorrectly specified

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

          User Story - Created by Jira Software - do not edit or delete. Issue type for a user story. QTBUG-98545 Provide CMake API for deployment support

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

          Suggestion - Public suggestions QTBUG-112135 Add CMake target for installing sources of Qt examples

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

          Sub-task - The sub-task of the issue QTBUG-90884 Localstorage example

          • Not Evaluated - Not yet evaluated/prioritized
          • Closed

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-110369 AUTOUIC can't handle relative paths referring to parent dirs with Ninja Multi-Config

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

          Task - A task that needs to be done. QTBUG-102056 Remove usage of INSTALL_EXAMPLESDIR and INSTALL_EXAMPLEDIR in examples

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

          Bug - A problem which impairs or prevents the functions of the product. QTBUG-101290 Unable to build examples when building as module with -DQT_BUILD_EXAMPLES=ON

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

          Task - A task that needs to be done. QTBUG-123100 Support per-directory building of ExternalProject examples

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

          Task - A task that needs to be done. QTBUG-123096 Examples should be added via qt_internal_add_example instead of add_subdirectory

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

          Task - A task that needs to be done. QTBUG-96232 Figure out how to build examples as ExternalProjects in a prefix build setup so it can be used in the CI

          • P3: Somewhat important - Should be fixed, but doesn't affect the release in any way.
          • In Progress
          For Gerrit Dashboard: QTBUG-90820
          # Subject Branch Project Status CR V
          394002,27 CMake: Re-enable building external examples in prefix builds dev qt/qtbase Status: NEW -2 0
          431085,9 WIP: CMake: Test examples as external projects dev qt/qt5 Status: NEW -2 0
          547206,3 coin: Build standalone examples in a separate build directory dev qt/qt5 Status: NEW 0 0

          Activity

            People

              alexandru.croitor Alexandru Croitor
              crscott Craig Scott
              Votes:
              0 Vote for this issue
              Watchers:
              6 Start watching this issue

              Dates

                Created:
                Updated:

                Gerrit Reviews

                  There are 3 open Gerrit changes