diff options
| author | Nikita Nemkin <nikita@nemkin.ru> | 2020-11-12 13:40:33 +0500 |
|---|---|---|
| committer | Nikita Nemkin <nikita@nemkin.ru> | 2020-12-02 21:00:30 +0500 |
| commit | 8fea95319bcaac741faf93bd66b3a1838b56a418 (patch) | |
| tree | 2bc107ce0cc4844e79f0baf93a394d93c27edaa8 /Modules/FindRuby.cmake | |
| parent | 8634561dcae9f5ff5128eaf7c83aa71170992ec2 (diff) | |
| download | cmake-8fea95319bcaac741faf93bd66b3a1838b56a418.tar.gz | |
Help: Add `.. versionadded` directives to module docs
Issue: #19715
Diffstat (limited to 'Modules/FindRuby.cmake')
| -rw-r--r-- | Modules/FindRuby.cmake | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/Modules/FindRuby.cmake b/Modules/FindRuby.cmake index d12f8255d5..ee07f83451 100644 --- a/Modules/FindRuby.cmake +++ b/Modules/FindRuby.cmake @@ -37,7 +37,8 @@ This module will set the following variables in your project: ``Ruby_INCLUDE_DIRS`` include dirs to be used when using the ruby library ``Ruby_LIBRARIES`` - libraries needed to use ruby from C. + .. versionadded:: 3.18 + libraries needed to use ruby from C. ``Ruby_VERSION`` the version of ruby which was found, e.g. "1.8.7" ``Ruby_VERSION_MAJOR`` @@ -47,9 +48,10 @@ This module will set the following variables in your project: ``Ruby_VERSION_PATCH`` Ruby patch version. - -The following variables are also provided for compatibility reasons, -don't use them in new code: +.. versionchanged:: 3.18 + Previous versions of CMake used the ``RUBY_`` prefix for all variables. + The following variables are provided for compatibility reasons, + don't use them in new code: ``RUBY_EXECUTABLE`` same as Ruby_EXECUTABLE. @@ -67,6 +69,8 @@ don't use them in new code: Hints ^^^^^ +.. versionadded:: 3.18 + ``Ruby_ROOT_DIR`` Define the root directory of a Ruby installation. |