summaryrefslogtreecommitdiff
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2021-03-03 09:24:03 -0500
committerBrad King <brad.king@kitware.com>2021-03-03 10:27:50 -0500
commit4950d3573331678b58fef36524723579edaa7172 (patch)
tree20c5ff16bb1e8f2e670c5419886a2d40e60cc343 /Help
parent746906242d6e5aca50df621f12cfa0ad71816647 (diff)
downloadcmake-4950d3573331678b58fef36524723579edaa7172.tar.gz
Help: Document CMAKE_ANDROID_NDK_VERSION variable
Diffstat (limited to 'Help')
-rw-r--r--Help/manual/cmake-toolchains.7.rst4
-rw-r--r--Help/manual/cmake-variables.7.rst1
-rw-r--r--Help/release/3.20.rst3
-rw-r--r--Help/variable/CMAKE_ANDROID_NDK_VERSION.rst8
4 files changed, 16 insertions, 0 deletions
diff --git a/Help/manual/cmake-toolchains.7.rst b/Help/manual/cmake-toolchains.7.rst
index 0267ca3803..1ededee189 100644
--- a/Help/manual/cmake-toolchains.7.rst
+++ b/Help/manual/cmake-toolchains.7.rst
@@ -359,6 +359,10 @@ CMake uses the following steps to select one of the environments:
* Else, an error diagnostic will be issued that neither the NDK or
Standalone Toolchain can be found.
+.. versionadded:: 3.20
+ If an Android NDK is selected, its version number is reported
+ in the :variable:`CMAKE_ANDROID_NDK_VERSION` variable.
+
.. _`Cross Compiling for Android with the NDK`:
Cross Compiling for Android with the NDK
diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst
index b6764acdba..4317dd4071 100644
--- a/Help/manual/cmake-variables.7.rst
+++ b/Help/manual/cmake-variables.7.rst
@@ -278,6 +278,7 @@ Variables that Describe the System
/variable/ANDROID
/variable/APPLE
/variable/BORLAND
+ /variable/CMAKE_ANDROID_NDK_VERSION
/variable/CMAKE_CL_64
/variable/CMAKE_COMPILER_2005
/variable/CMAKE_HOST_APPLE
diff --git a/Help/release/3.20.rst b/Help/release/3.20.rst
index b36d1c2ae7..eede36278b 100644
--- a/Help/release/3.20.rst
+++ b/Help/release/3.20.rst
@@ -73,6 +73,9 @@ Platforms
- The default :variable:`CMAKE_BUILD_TYPE` for Android is
now ``RelWithDebInfo``.
+ - The :variable:`CMAKE_ANDROID_NDK_VERSION` variable was added to
+ report the version of the NDK.
+
File-Based API
--------------
diff --git a/Help/variable/CMAKE_ANDROID_NDK_VERSION.rst b/Help/variable/CMAKE_ANDROID_NDK_VERSION.rst
new file mode 100644
index 0000000000..5428d52bce
--- /dev/null
+++ b/Help/variable/CMAKE_ANDROID_NDK_VERSION.rst
@@ -0,0 +1,8 @@
+CMAKE_ANDROID_NDK_VERSION
+-------------------------
+
+.. versionadded:: 3.20
+
+When :ref:`Cross Compiling for Android with the NDK` and using an
+Android NDK version 11 or higher, this variable is provided by
+CMake to report the NDK version number.