434e4a224a
We have two builds we need to cover:
1. Documentation testing, aka 'DocTests' feature
This feature builds docs for every submodule during module
integration, using externally provisioned doc tools.
2. Offline documentation building, aka 'Documentation' feature
This feature builds documentation for use in e.g. Qt Creator
For both these builds we only need a single config to handle them.
The initial configs were based on Ubuntu 22.04, but with the addition
of Ubuntu 24.04, and splitting up X11 and Wayland testing, these configs
multiplied, which is not needed. The inclusion of 'documentation' in
the various test configs was also needlessly confusing when e.g.
looking at test failure results in Grafana.
The previously named 'documentation' configs for Ubuntu have been
renamed to 'developer-build', as this is the significant difference
to the non-developer-build config.
There's still two issues with these configuration:
1. The DocTests configuration also runs the Qt auto tests.
The DoNotRunTests and DisableTests feature flags would
seem to be relevant for skipping the auto-test step in
the coin test instructions, but these are hard coded in
coin to skip the entire test workitem.
2. The offline doc builder builds Qt and tools from scratch
A better approach would be to depend on another build
and just configure and build docs, but doing so requires
more investigation.
Change-Id: I5a041dec697424b85d3b1588cd6e77a80551d2eb
Reviewed-by: Topi Reiniö <topi.reinio@qt.io>
HOW TO BUILD Qt 6
Synopsis
System requirements
- C++ compiler supporting the C++17 standard
- CMake
- Ninja
- Python 3
For more details, see also https://doc.qt.io/qt-6/build-sources.html
Linux, Mac:
cd <path>/<source_package>
./configure -prefix $PWD/qtbase
cmake --build .
Windows:
- Open a command prompt.
- Ensure that the following tools can be found in the path:
- Supported compiler (Visual Studio 2019 or later, or MinGW-builds gcc 11.2 or later)
- Python 3 ([https://www.python.org/downloads/windows/] or from Microsoft Store)
cd <path>\<source_package>
configure -prefix %CD%\qtbase
cmake --build .
More details follow.
Build!
Qt is built with CMake, and a typical
configure && cmake --build . build process is used.
If Ninja is installed, it is automatically chosen as CMake generator.
Some relevant configure options (see configure -help):
-releaseCompile and link Qt with debugging turned off.-debugCompile and link Qt with debugging turned on.
Example for a release build:
./configure -prefix $PWD/qtbase
cmake --build .
Example for a developer build: (enables more autotests, builds debug version of libraries, ...)
./configure -developer-build
cmake --build .
See output of ./configure -help for documentation on various options to
configure.
The above examples will build whatever Qt modules have been enabled by default in the build system.
It is possible to build selected repositories with their dependencies by doing
a ninja <repo-name>/all. For example, to build only qtdeclarative,
and the modules it depends on:
./configure
ninja qtdeclarative/all
This can save a lot of time if you are only interested in a subset of Qt.
Hints
The submodule repository qtrepotools contains useful scripts for
developers and release engineers. Consider adding qtrepotools/bin
to your PATH environment variable to access them.
Building Qt from git
See http://wiki.qt.io/Building_Qt_6_from_Git and README.git for more information. See http://wiki.qt.io/Qt_6 for the reference platforms.
Documentation
After configuring and compiling Qt, building the documentation is possible by running
cmake --build . --target docs
After having built the documentation, you need to install it with the following command:
cmake --build . --target install_docs
The documentation is installed in the path specified with the
configure argument -docdir.
Information about Qt's documentation is located in qtbase/doc/README
Note: Building the documentation is only tested on desktop platforms.