summaryrefslogtreecommitdiffstats
path: root/Help/command/install.rst
diff options
context:
space:
mode:
authorKyle Edwards <kyle.edwards@kitware.com>2020-03-31 19:05:24 (GMT)
committerKyle Edwards <kyle.edwards@kitware.com>2020-04-01 15:39:28 (GMT)
commit0f76839bc78453f49da7b770ae65090e48fdd63a (patch)
tree8c9a85eac94892e16eb5f3fc16d09fed815f7853 /Help/command/install.rst
parent7c6a0253f366d3cdbd1266c00e8c5d304afd2010 (diff)
downloadCMake-0f76839bc78453f49da7b770ae65090e48fdd63a.zip
CMake-0f76839bc78453f49da7b770ae65090e48fdd63a.tar.gz
CMake-0f76839bc78453f49da7b770ae65090e48fdd63a.tar.bz2
Help: Discourage direct use of cmake_install.cmake
Encourage people to use cmake(1) --install instead.
Diffstat (limited to 'Help/command/install.rst')
-rw-r--r--Help/command/install.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Help/command/install.rst b/Help/command/install.rst
index cf04eda..3b72ea6 100644
--- a/Help/command/install.rst
+++ b/Help/command/install.rst
@@ -705,6 +705,11 @@ executable from the installation tree using the imported target name
Generated Installation Script
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. note::
+
+ Use of this feature is not recommended. Please consider using the
+ ``--install`` argument of :manual:`cmake(1)` instead.
+
The ``install()`` command generates a file, ``cmake_install.cmake``, inside
the build directory, which is used internally by the generated install target
and by CPack. You can also invoke this script manually with ``cmake -P``. This