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
This commit is contained in:
Brad King
2022-10-17 11:34:07 -04:00
parent 787fc8caa8
commit a739b55bb6

View File

@@ -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.