diff options
| author | Brad King <brad.king@kitware.com> | 2022-10-17 11:34:07 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2022-10-17 11:42:46 -0400 |
| commit | a739b55bb6783200c209f7a0007ff87a1c0dee4b (patch) | |
| tree | ea999d3c420f24eba74b8e8194195eaa669f5444 | |
| parent | 787fc8caa8c46b7c29e05c9b367f8e85665845d4 (diff) | |
| download | cmake-a739b55bb6783200c209f7a0007ff87a1c0dee4b.tar.gz | |
Help: Clarify historical-only role of CMAKE_ANDROID_API variable
Revise documentation added by commit 6b84df8da9 (Help: Document cross
compiling for Android, 2016-06-20, v3.7.0-rc1~229^2~2) to avoid implying
that `CMAKE_ANDROID_API` is interchangeable with `CMAKE_SYSTEM_VERSION`.
The latter is the authoritative value of the Android API level.
Issue: #23830
| -rw-r--r-- | Help/variable/CMAKE_ANDROID_API.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Help/variable/CMAKE_ANDROID_API.rst b/Help/variable/CMAKE_ANDROID_API.rst index 4388bf2e05..aba9b6eb6d 100644 --- a/Help/variable/CMAKE_ANDROID_API.rst +++ b/Help/variable/CMAKE_ANDROID_API.rst @@ -8,6 +8,7 @@ Edition`, this variable may be set to specify the default value for the :prop_tgt:`ANDROID_API` target property. See that target property for additional information. -Otherwise, when :ref:`Cross Compiling for Android`, this variable provides -the Android API version number targeted. This will be the same value as -the :variable:`CMAKE_SYSTEM_VERSION` variable for ``Android`` platforms. +When :ref:`Cross Compiling for Android`, the :variable:`CMAKE_SYSTEM_VERSION` +variable represents the Android API version number targeted. For historical +reasons, if a toolchain file sets ``CMAKE_ANDROID_API``, but not +``CMAKE_SYSTEM_VERSION``, the latter will be initialized using the former. |