Details
-
Task
-
Resolution: Done
-
P2: Important
-
5.13.0
Description
Now that CMake is becoming a major player in Qt, we should try to improve the current CMake Manual that is part of the Qt Reference documentation: http://doc.qt.io/qt-5/cmake-manual.html
We have the following options:
- Improve the manual as a part of Qt docs by restructuring it and adding information
- Add documentation about Qt-specific features upstream to CMake documentation: https://cmake.org/cmake/help/latest/index.html
There is already a Qt-specific section in the CMake docs that contains a link to the Qt CMake Manual: https://cmake.org/cmake/help/latest/manual/cmake-qt.7.html
CMake documentation is already shipped as a Qt Help file, so we should look into delivering as a part of Qt docs.
If we want to keep the CMake Manual in the Qt docs, I would suggest the following changes:
- Move all the sections to separate pages and create a front page with mostly a TOC;
- Getting Started
- Building Common Project Types
- Shared Library
- Static Library
- Unit Tests for Libraries
- Widget-Based Applications (that use libraries)
- Qt Quick Applications (that use libraries)
- Console Application
- Applications with Translations
- Distributables
- Reference
- Variables
- Macros
Each variable and macro should be listed on its own page, with standard content and examples of its use. Unfortunately, the CMake docs are not the best example I've seen of such documentation: https://cmake.org/cmake/help/latest/variable/CMAKE_INCLUDE_CURRENT_DIR.html
- Add links to the CMake docs
If the CMake Manual stays in the Qt docs, should the sources also stay in the qtdoc module, or should they be moved closer to the CMake code?
Attachments
Issue Links
- depends on
-
QTBUG-75472 qdoc: Add support for handling CMake code
- Open
- relates to
-
QTBUG-49573 Cmake: confusion with AUTOMOC
- Closed
-
QTBUG-71482 Describing build components for CMake support with Qt
- Closed
-
QTBUG-73058 Essential Modules: Document how to use module from CMake
- Closed
- resulted in
-
QTBUG-84789 Document building various projects / types with CMake
- Closed
For Gerrit Dashboard: QTBUG-72159 | ||||||
---|---|---|---|---|---|---|
# | Subject | Branch | Project | Status | CR | V |
258623,12 | Qt Core: Document CMake macros | 5.12 | qt/qtbase | Status: MERGED | -2 | 0 |
258677,7 | Rename 'CMake Manual' to 'Building with CMake' | 5.12 | qt/qtdoc | Status: MERGED | +2 | 0 |
258927,2 | Update external links to CMake documentation | 5.12 | qt/qtbase | Status: MERGED | +2 | 0 |
259606,5 | Doc: Improve CMake code example | 5.12 | qt/qtdoc | Status: MERGED | +2 | 0 |
260152,3 | Qt Widgets: Document CMake macros | 5.12 | qt/qtbase | Status: MERGED | +2 | 0 |
260202,9 | Qt D-Bus: Document CMake commands | 5.12 | qt/qtbase | Status: MERGED | +2 | 0 |
262002,4 | Qt Linguist: Document CMake macros | 5.12 | qt/qttools | Status: MERGED | +2 | 0 |