summaryrefslogtreecommitdiffstats
path: root/Modules/GNUInstallDirs.cmake
diff options
context:
space:
mode:
authorNikita Nemkin <nikita@nemkin.ru>2020-11-12 08:40:33 (GMT)
committerNikita Nemkin <nikita@nemkin.ru>2020-12-02 16:00:30 (GMT)
commit8fea95319bcaac741faf93bd66b3a1838b56a418 (patch)
tree2bc107ce0cc4844e79f0baf93a394d93c27edaa8 /Modules/GNUInstallDirs.cmake
parent8634561dcae9f5ff5128eaf7c83aa71170992ec2 (diff)
downloadCMake-8fea95319bcaac741faf93bd66b3a1838b56a418.zip
CMake-8fea95319bcaac741faf93bd66b3a1838b56a418.tar.gz
CMake-8fea95319bcaac741faf93bd66b3a1838b56a418.tar.bz2
Help: Add `.. versionadded` directives to module docs
Issue: #19715
Diffstat (limited to 'Modules/GNUInstallDirs.cmake')
-rw-r--r--Modules/GNUInstallDirs.cmake11
1 files changed, 10 insertions, 1 deletions
diff --git a/Modules/GNUInstallDirs.cmake b/Modules/GNUInstallDirs.cmake
index 888f7b1..37869fb 100644
--- a/Modules/GNUInstallDirs.cmake
+++ b/Modules/GNUInstallDirs.cmake
@@ -46,7 +46,8 @@ where ``<dir>`` is one of:
``LOCALSTATEDIR``
modifiable single-machine data (``var``)
``RUNSTATEDIR``
- run-time variable data (``LOCALSTATEDIR/run``)
+ .. versionadded:: 3.9
+ run-time variable data (``LOCALSTATEDIR/run``)
``LIBDIR``
object code libraries (``lib`` or ``lib64``
or ``lib/<multiarch-tuple>`` on Debian)
@@ -73,6 +74,8 @@ used and the value will appear in the cache for editing by the user.
Special Cases
^^^^^^^^^^^^^
+.. versionadded:: 3.4
+
The following values of :variable:`CMAKE_INSTALL_PREFIX` are special:
``/``
@@ -115,6 +118,8 @@ Macros
GNUInstallDirs_get_absolute_install_dir(absvar var dirname)
+ .. versionadded:: 3.7
+
Set the given variable ``absvar`` to the absolute path contained
within the variable ``var``. This is to allow the computation of an
absolute path, accounting for all the special cases documented
@@ -123,6 +128,10 @@ Macros
allow users who create additional path variables to also compute
absolute paths where necessary, using the same logic. ``dirname`` is
the directory name to get, e.g. ``BINDIR``.
+
+ .. versionchanged:: 3.20
+ Added the ``<dirname>`` parameter. Previous versions of CMake passed
+ this value through the variable ``${dir}``.
#]=======================================================================]
cmake_policy(PUSH)