diff options
| author | Richard Weickelt <richard@weickelt.de> | 2020-11-28 10:57:09 +0100 |
|---|---|---|
| committer | Richard Weickelt <richard@weickelt.de> | 2020-11-28 10:57:09 +0100 |
| commit | 629324365334e3a027f53522e8c63980fa2fe8e5 (patch) | |
| tree | 646dda897f6b1179c0b20d2a40f3410ff4f13592 /doc | |
| parent | 625e6b3256b66e995a7b2f073083e3f7395ce4ba (diff) | |
| parent | 578b6d6978d7b42baefd85277c0d332f36142c65 (diff) | |
Merge branch '1.18' into master
Change-Id: If77ea1a92f64a4b6910c4755aa03dd96ec5078fb
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/qbs.qdoc | 46 | ||||
| -rw-r--r-- | doc/reference/items/convenience/application.qdoc | 2 | ||||
| -rw-r--r-- | doc/reference/items/convenience/library.qdoc | 2 |
3 files changed, 48 insertions, 2 deletions
diff --git a/doc/qbs.qdoc b/doc/qbs.qdoc index 885ed6a72..217e41e7c 100644 --- a/doc/qbs.qdoc +++ b/doc/qbs.qdoc @@ -467,6 +467,52 @@ Regenerating the man page requires the \c help2man tool. + \section1 Building \QBS with СMake + + To build \QBS, enter the following commands: + + \code + mkdir build && cd build + cmake -DQt5_DIR=${QT_DIR}/lib/cmake/Qt5/ .. + make + \endcode + + Where \c ${QT_DIR} is the directory where Qt is installed. Passing the \c Qt5_DIR option + is not necessary if \c qmake is present in \c PATH. + + Depending on your platform, you might use \c mingw32-make, \c nmake, or + \c jom instead of \c make. + + Alternatively, you can use the + \l{https://cmake.org/cmake/help/latest/generator/Ninja.html}{Ninja} generator: + \code + cmake -GNinja -DQt5_DIR=${QT_DIR}/lib/cmake/Qt5/ .. + ninja + \endcode + + \section2 CMake Configure Options + + \QBS recognizes the following CMake options (passed to CMake in the form of \c{-DOPTION=value}) + to customize the build: + + \table + \header \li Option \li Notes \li Default value + \row \li WITH_TESTS \li Enable autotests. \li \c ON + \row \li WITH_UNIT_TESTS \li Enable additional autotests. \li \c OFF + \row \li WITH_PROJECT_FILE_UPDATES \li Enable API for updating project files. This + implies a dependency to the QtGui module. + \li \c OFF + \row \li INSTALL_PUBLIC_HEADERS \li Whether to install public headers. \li \c ON + \endtable + + \section2 Using ccache with CMake + + To enable using \l{https://ccache.dev}{ccache} when building \QBS, pass the following options + to CMake: + \code + cmake -DQt5_DIR=${QT_DIR}/lib/cmake/Qt5/ -DCMAKE_C_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_COMPILER_LAUNCHER=ccache .. + \endcode + \section1 Building \QBS with QMake To build \QBS, enter the following command: diff --git a/doc/reference/items/convenience/application.qdoc b/doc/reference/items/convenience/application.qdoc index 01366c4f9..15b05515d 100644 --- a/doc/reference/items/convenience/application.qdoc +++ b/doc/reference/items/convenience/application.qdoc @@ -69,7 +69,7 @@ */ /*! - \qmlproperty string Application::installDebugInformation + \qmlproperty bool Application::installDebugInformation If \c{true}, the debug information will be installed to \l{Application::debugInformationInstallDir}{debugInformationInstallDir}. diff --git a/doc/reference/items/convenience/library.qdoc b/doc/reference/items/convenience/library.qdoc index 7b2ddc5eb..409af3f19 100644 --- a/doc/reference/items/convenience/library.qdoc +++ b/doc/reference/items/convenience/library.qdoc @@ -78,7 +78,7 @@ */ /*! - \qmlproperty string Library::installDebugInformation + \qmlproperty bool Library::installDebugInformation If \c{true}, the debug information will be installed to \l{Library::debugInformationInstallDir}{debugInformationInstallDir}. |