aboutsummaryrefslogtreecommitdiff
path: root/modules/ECMGeneratePkgConfigFile.cmake
diff options
context:
space:
mode:
authorFriedrich W. H. Kossebau <kossebau@kde.org>2022-06-12 18:11:16 +0200
committerFriedrich W. H. Kossebau <kossebau@kde.org>2022-06-12 18:27:40 +0200
commit97de5ca22bc2e9270809a24d00fe6b748ddbb9e7 (patch)
tree0a79fed871a41afe701c6556bc10c72f93ea786d /modules/ECMGeneratePkgConfigFile.cmake
parent08b0e02f8ecd3cec4840f5025729e5b40d890645 (diff)
downloadextra-cmake-modules-97de5ca22bc2e9270809a24d00fe6b748ddbb9e7.tar.gz
extra-cmake-modules-97de5ca22bc2e9270809a24d00fe6b748ddbb9e7.tar.bz2
API dox: turn some more verbal "Note" into full note sections
Should help readers being aware of pitfalls NO_CHANGELOG
Diffstat (limited to 'modules/ECMGeneratePkgConfigFile.cmake')
-rw-r--r--modules/ECMGeneratePkgConfigFile.cmake10
1 files changed, 6 insertions, 4 deletions
diff --git a/modules/ECMGeneratePkgConfigFile.cmake b/modules/ECMGeneratePkgConfigFile.cmake
index 1b59da8d..c556e31e 100644
--- a/modules/ECMGeneratePkgConfigFile.cmake
+++ b/modules/ECMGeneratePkgConfigFile.cmake
@@ -65,10 +65,12 @@ package. Defaults to "https://www.kde.org/". Since 5.89.0.
``INSTALL`` will cause the module to be installed to the ``pkgconfig``
subdirectory of ``LIB_INSTALL_DIR``, unless the ``ECM_PKGCONFIG_INSTALL_DIR``
-cache variable is set to something different. Note that the first call to
-``ecm_generate_pkgconfig_file()`` with the ``INSTALL`` argument will cause
-``ECM_PKGCONFIG_INSTALL_DIR`` to be set to the cache, and will be used in any
-subsequent calls.
+cache variable is set to something different.
+
+.. note::
+ The first call to ``ecm_generate_pkgconfig_file()`` with the ``INSTALL``
+ argument will cause ``ECM_PKGCONFIG_INSTALL_DIR`` to be set to the cache,
+ and will be used in any subsequent calls.
To properly use this macro a version needs to be set. To retrieve it,
``ECM_PKGCONFIG_INSTALL_DIR`` uses ``PROJECT_VERSION``. To set it, use the