summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-07-22 12:20:09 (GMT)
committerKitware Robot <kwrobot@kitware.com>2019-07-22 12:20:34 (GMT)
commitc1cb4945f3ffbabe84bcf7e55aa9f6341bdae097 (patch)
treee70df7e6daaca8a7bb5ba7b6260e432d393784cc
parent303cf2791a1edb6f216e5306ea01ee0aa0bd9024 (diff)
parentc94e62c07eab14d6f36c18e11712d9d788fafd87 (diff)
downloadCMake-c1cb4945f3ffbabe84bcf7e55aa9f6341bdae097.zip
CMake-c1cb4945f3ffbabe84bcf7e55aa9f6341bdae097.tar.gz
CMake-c1cb4945f3ffbabe84bcf7e55aa9f6341bdae097.tar.bz2
Merge topic 'tutorial_reference_cmake_install_command'
c94e62c07e Tutorial: Updated to reference using cmake --install Acked-by: Kitware Robot <kwrobot@kitware.com> Merge-request: !3572
-rw-r--r--Help/guide/tutorial/index.rst14
1 files changed, 8 insertions, 6 deletions
diff --git a/Help/guide/tutorial/index.rst b/Help/guide/tutorial/index.rst
index db8e7a0..41ed0c4 100644
--- a/Help/guide/tutorial/index.rst
+++ b/Help/guide/tutorial/index.rst
@@ -228,7 +228,8 @@ remove our uses of the ``EXTRA_INCLUDES`` variable from the top-level
CMakeLists.
Once this is done, run **cmake** or **cmake-gui** to configure the project
-and then build it with your chosen build tool.
+and then build it with your chosen build tool or by using ``cmake --build .``
+from the build directory.
Installing and Testing (Step 4)
===============================
@@ -258,14 +259,15 @@ And the to top-level ``CMakeLists.txt`` we add:
That is all that is needed to create a basic local install of the tutorial.
Run **cmake** or **cmake-gui** to configure the project and then build it
-with your chosen build tool. Build the ``install`` target by typing
-``make install`` from the command line or build the ``INSTALL`` target from
-an IDE. This will install the appropriate header files, libraries, and
-executables.
+with your chosen build tool. Run the install step by typing
+``cmake --install .`` or from the command line, or build the ``INSTALL``
+target from an IDE. This will install the appropriate header files, libraries,
+and executables.
Verify that the installed Tutorial runs. Note: The CMake variable
``CMAKE_INSTALL_PREFIX`` is used to determine the root of where the files will
-be installed.
+be installed. If using ``cmake --install`` a custom installation directory can
+be given via ``--prefix`` argument.
Testing Support
---------------