diff options
| author | Friedrich W. H. Kossebau <kossebau@kde.org> | 2017-07-18 18:34:55 +0200 |
|---|---|---|
| committer | Friedrich W. H. Kossebau <kossebau@kde.org> | 2017-07-20 20:32:03 +0200 |
| commit | f5c11c00198e809d45399b6c8496ac838f28ad60 (patch) | |
| tree | c476424d1f8471b57a04fca2623919e7bba76bc5 | |
| parent | db46fb7c2fdcfbff5f8a0445e4d055cf4388ead8 (diff) | |
| download | extra-cmake-modules-f5c11c00198e809d45399b6c8496ac838f28ad60.tar.gz extra-cmake-modules-f5c11c00198e809d45399b6c8496ac838f28ad60.tar.bz2 | |
Add API dox for KDEInstallDirs' KDE_INSTALL_USE_QT_SYS_PATHS
Reviewers: #frameworks, apol
Reviewed By: apol
Subscribers: #build_system
Tags: #frameworks, #build_system
Differential Revision: https://phabricator.kde.org/D6773
| -rw-r--r-- | kde-modules/KDEInstallDirs.cmake | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/kde-modules/KDEInstallDirs.cmake b/kde-modules/KDEInstallDirs.cmake index cd004dd3..8029f0af 100644 --- a/kde-modules/KDEInstallDirs.cmake +++ b/kde-modules/KDEInstallDirs.cmake @@ -35,13 +35,13 @@ # CMake packages, including config files (``LIBDIR/cmake``) # [``CMAKECONFIG_INSTALL_PREFIX``] # ``QTPLUGINDIR`` -# Qt plugins (``LIBDIR/plugins``) [``QT_PLUGIN_INSTALL_DIR``] +# Qt plugins (``LIBDIR/plugins`` or qmake-qt5's ``QT_INSTALL_PLUGINS``) [``QT_PLUGIN_INSTALL_DIR``] # ``PLUGINDIR`` # Plugins (``QTPLUGINDIR``) [``PLUGIN_INSTALL_DIR``] # ``QTQUICKIMPORTSDIR`` -# QtQuick1 imports (``QTPLUGINDIR/imports``) [``IMPORTS_INSTALL_DIR``] +# QtQuick1 imports (``QTPLUGINDIR/imports`` or qmake-qt5's ``QT_INSTALL_IMPORTS``) [``IMPORTS_INSTALL_DIR``] # ``QMLDIR`` -# QtQuick2 imports (``LIBDIR/qml``) [``QML_INSTALL_DIR``] +# QtQuick2 imports (``LIBDIR/qml`` or qmake-qt5's ``QT_INSTALL_QML``) [``QML_INSTALL_DIR``] # ``INCLUDEDIR`` # C and C++ header files (``include``) [``INCLUDE_INSTALL_DIR``] # ``LOCALSTATEDIR`` @@ -101,7 +101,7 @@ # ``METAINFODIR`` # AppStream component metadata files (``DATAROOTDIR/metainfo``) # ``QTQCHDIR`` -# documentation bundles in QCH format for Qt-extending libraries (``DATAROOTDIR/doc/qch``) Since 5.36.0. +# documentation bundles in QCH format for Qt-extending libraries (``DATAROOTDIR/doc/qch`` or qmake-qt5's ``QT_INSTALL_DOCS``) Since 5.36.0. # ``QCHDIR`` # documentation bundles in QCH format (``DATAROOTDIR/doc/qch``) Since 5.36.0. # ``MANDIR`` @@ -129,6 +129,16 @@ # ``AUTOSTARTDIR`` # autostart files (``CONFDIR/autostart``) [``AUTOSTART_INSTALL_DIR``] # +# If ``KDE_INSTALL_USE_QT_SYS_PATHS`` is set to TRUE before including this +# module, the default values for some variables are instead queried from +# Qt5's qmake (where mentioned in the parentheses above). +# If not set, it will default to TRUE if Qt5's qmake is found and +# it's ``QT_INSTALL_PREFIX`` is the same as ``CMAKE_INSTALL_PREFIX``, +# otherwise default to FALSE. +# This variable should NOT be set from within CMakeLists.txt files, instead +# is intended to be set manually when configuring a project which uses +# KDEInstallDirs (e.g. by packagers). +# # If ``KDE_INSTALL_DIRS_NO_DEPRECATED`` is set to TRUE before including this # module, the deprecated variables (listed in the square brackets above) are # not defined. |