Browse Source

Merge topic 'doc-CMAKE_ANDROID_API'

a739b55bb6 Help: Clarify historical-only role of CMAKE_ANDROID_API variable

Acked-by: Kitware Robot <[email protected]>
Merge-request: !7800
Brad King 3 years ago
parent
commit
ebcf58ec74
1 changed files with 4 additions and 3 deletions
  1. 4 3
      Help/variable/CMAKE_ANDROID_API.rst

+ 4 - 3
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.