summaryrefslogtreecommitdiffstats
path: root/Help/command/install.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2018-04-09 14:35:31 (GMT)
committerBrad King <brad.king@kitware.com>2018-04-09 15:32:10 (GMT)
commit4a127b78fd44fd3f05eade253051b9e56a1082fc (patch)
treec72120596460c9bce2734dab28aadb84731bb34a /Help/command/install.rst
parent13f19f747230fa2ce414084d1e3a94eb225dbaa1 (diff)
downloadCMake-4a127b78fd44fd3f05eade253051b9e56a1082fc.zip
CMake-4a127b78fd44fd3f05eade253051b9e56a1082fc.tar.gz
CMake-4a127b78fd44fd3f05eade253051b9e56a1082fc.tar.bz2
Help: Fix install(EXPORT_ANDROID_MK) mode documentation
`install(EXPORT_ANDROID_MK)` is its own mode, not an option to the normal `install(EXPORT)` mode. While at it, also fix the prose in our documented example to match the code. Fixes: #17891
Diffstat (limited to 'Help/command/install.rst')
-rw-r--r--Help/command/install.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/Help/command/install.rst b/Help/command/install.rst
index eb7b07c..e9c185c 100644
--- a/Help/command/install.rst
+++ b/Help/command/install.rst
@@ -339,12 +339,12 @@ Installing Exports
install(EXPORT <export-name> DESTINATION <dir>
[NAMESPACE <namespace>] [[FILE <name>.cmake]|
- [EXPORT_ANDROID_MK <name>.mk]]
[PERMISSIONS permissions...]
[CONFIGURATIONS [Debug|Release|...]]
[EXPORT_LINK_INTERFACE_LIBRARIES]
[COMPONENT <component>]
[EXCLUDE_FROM_ALL])
+ install(EXPORT_ANDROID_MK <export-name> DESTINATION <dir> [...])
The ``EXPORT`` form generates and installs a CMake file containing code to
import targets from the installation tree into another project.
@@ -367,8 +367,9 @@ specified that does not match that given to the targets associated with
included in the export but a target to which it links is not included
the behavior is unspecified.
-In addition to cmake language files, the ``EXPORT_ANDROID_MK`` option maybe
-used to specify an export to the android ndk build system. The Android
+In addition to cmake language files, the ``EXPORT_ANDROID_MK`` mode maybe
+used to specify an export to the android ndk build system. This mode
+accepts the same options as the normal export mode. The Android
NDK supports the use of prebuilt libraries, both static and shared. This
allows cmake to build the libraries of a project and make them available
to an ndk build system complete with transitive dependencies, include flags
@@ -385,7 +386,7 @@ and installed by the current project. For example, the code
will install the executable myexe to ``<prefix>/bin`` and code to import
it in the file ``<prefix>/lib/myproj/myproj.cmake`` and
-``<prefix>/lib/share/ndk-modules/Android.mk``. An outside project
+``<prefix>/share/ndk-modules/Android.mk``. An outside project
may load this file with the include command and reference the ``myexe``
executable from the installation tree using the imported target name
``mp_myexe`` as if the target were built in its own tree.