summaryrefslogtreecommitdiffstats
path: root/Modules
diff options
context:
space:
mode:
authorDaniele E. Domenichelli <daniele.domenichelli@iit.it>2020-08-11 10:02:18 (GMT)
committerBrad King <brad.king@kitware.com>2020-08-12 15:25:45 (GMT)
commite7fe0b24c487937e9a6652ffcf81d2b290d9c57b (patch)
treec91d15bc2fbea725cfe7632bb6c4389268208cdf /Modules
parenteaf81817c479185d3a8bccc4b10525f63c036a15 (diff)
downloadCMake-e7fe0b24c487937e9a6652ffcf81d2b290d9c57b.zip
CMake-e7fe0b24c487937e9a6652ffcf81d2b290d9c57b.tar.gz
CMake-e7fe0b24c487937e9a6652ffcf81d2b290d9c57b.tar.bz2
FindRuby: Add documentation for deprecated variables
Since commit e672db628b (FindRuby: Rename variables to match case of module name, 2020-03-11, v3.18.0-rc1~546^2), the upper-case-prefixed variable names are for compatibility only but still exist. Put them back in the documentation. Issue: #21064
Diffstat (limited to 'Modules')
-rw-r--r--Modules/FindRuby.cmake15
1 files changed, 13 insertions, 2 deletions
diff --git a/Modules/FindRuby.cmake b/Modules/FindRuby.cmake
index 3b8122e..0559a69 100644
--- a/Modules/FindRuby.cmake
+++ b/Modules/FindRuby.cmake
@@ -48,10 +48,21 @@ This module will set the following variables in your project:
Ruby patch version.
-Also:
+The following variables are also provided for compatibility reasons,
+don't use them in new code:
+``RUBY_EXECUTABLE``
+ same as Ruby_EXECUTABLE.
+``RUBY_INCLUDE_DIRS``
+ same as Ruby_INCLUDE_DIRS.
``RUBY_INCLUDE_PATH``
- same as Ruby_INCLUDE_DIRS, only provided for compatibility reasons, don't use it
+ same as Ruby_INCLUDE_DIRS.
+``RUBY_LIBRARY``
+ same as Ruby_LIBRARY.
+``RUBY_VERSION``
+ same as Ruby_VERSION.
+``RUBY_FOUND``
+ same as Ruby_FOUND.
Hints
^^^^^