summaryrefslogtreecommitdiffstats
path: root/Help/variable/CPACK_SET_DESTDIR.rst
diff options
context:
space:
mode:
authorJames Johnston <johnstonj.public@codenest.com>2015-08-18 05:34:01 (GMT)
committerBrad King <brad.king@kitware.com>2015-08-21 13:32:08 (GMT)
commit3bb707f0a1408dc0381ecbf4ec934e9f14d8927c (patch)
tree1e6c4f6a4ad78a3d1635070207aa281bbd0e9493 /Help/variable/CPACK_SET_DESTDIR.rst
parent404d16e7bc1b18027f719cd8642d0a90c679c396 (diff)
downloadCMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.zip
CMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.tar.gz
CMake-3bb707f0a1408dc0381ecbf4ec934e9f14d8927c.tar.bz2
Help: Improve formatting of variable documentation
Improve formatting, primarily by: * Adding links to relevant commands, properties, generators, and so on. * Converting code, symbols, paths, and so on to fixed-width fonts. * Hard wrapping lines to 80 characters or less.
Diffstat (limited to 'Help/variable/CPACK_SET_DESTDIR.rst')
-rw-r--r--Help/variable/CPACK_SET_DESTDIR.rst31
1 files changed, 16 insertions, 15 deletions
diff --git a/Help/variable/CPACK_SET_DESTDIR.rst b/Help/variable/CPACK_SET_DESTDIR.rst
index 69d82e6..27fd355 100644
--- a/Help/variable/CPACK_SET_DESTDIR.rst
+++ b/Help/variable/CPACK_SET_DESTDIR.rst
@@ -1,30 +1,31 @@
CPACK_SET_DESTDIR
-----------------
-Boolean toggle to make CPack use DESTDIR mechanism when packaging.
+Boolean toggle to make CPack use ``DESTDIR`` mechanism when packaging.
-DESTDIR means DESTination DIRectory. It is commonly used by makefile
+``DESTDIR`` means DESTination DIRectory. It is commonly used by makefile
users in order to install software at non-default location. It is a
basic relocation mechanism that should not be used on Windows (see
-CMAKE_INSTALL_PREFIX documentation). It is usually invoked like this:
+:variable:`CMAKE_INSTALL_PREFIX` documentation). It is usually invoked like
+this:
::
make DESTDIR=/home/john install
which will install the concerned software using the installation
-prefix, e.g. "/usr/local" prepended with the DESTDIR value which
-finally gives "/home/john/usr/local". When preparing a package, CPack
+prefix, e.g. ``/usr/local`` prepended with the ``DESTDIR`` value which
+finally gives ``/home/john/usr/local``. When preparing a package, CPack
first installs the items to be packaged in a local (to the build tree)
-directory by using the same DESTDIR mechanism. Nevertheless, if
-CPACK_SET_DESTDIR is set then CPack will set DESTDIR before doing the
+directory by using the same ``DESTDIR`` mechanism. Nevertheless, if
+``CPACK_SET_DESTDIR`` is set then CPack will set ``DESTDIR`` before doing the
local install. The most noticeable difference is that without
-CPACK_SET_DESTDIR, CPack uses CPACK_PACKAGING_INSTALL_PREFIX as a
-prefix whereas with CPACK_SET_DESTDIR set, CPack will use
-CMAKE_INSTALL_PREFIX as a prefix.
+``CPACK_SET_DESTDIR``, CPack uses :variable:`CPACK_PACKAGING_INSTALL_PREFIX`
+as a prefix whereas with ``CPACK_SET_DESTDIR`` set, CPack will use
+:variable:`CMAKE_INSTALL_PREFIX` as a prefix.
-Manually setting CPACK_SET_DESTDIR may help (or simply be necessary)
-if some install rules uses absolute DESTINATION (see CMake INSTALL
-command). However, starting with CPack/CMake 2.8.3 RPM and DEB
-installers tries to handle DESTDIR automatically so that it is seldom
-necessary for the user to set it.
+Manually setting ``CPACK_SET_DESTDIR`` may help (or simply be necessary)
+if some install rules uses absolute ``DESTINATION`` (see CMake
+:command:`install` command). However, starting with CPack/CMake 2.8.3 RPM
+and DEB installers tries to handle ``DESTDIR`` automatically so that it is
+seldom necessary for the user to set it.