mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-07 06:09:52 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge topic 'doc-DESTDIR'

Browse Source 
a9b8c9d33e Help: Clarify roles of DESTDIR and CMAKE_INSTALL_PREFIX

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6955
This commit is contained in:
Brad King
2022-02-07 16:49:20 +00:00
committed by Kitware Robot
parent c308000ca1 a9b8c9d33e
commit 533760ac29
2 changed files with 30 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
Help/envvar/DESTDIR.rst
View File

@@ -5,17 +5,26 @@ DESTDIR
On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the
whole installation. ``DESTDIR`` means DESTination DIRectory. It is
commonly used by makefile users in order to install software at
non-default location. It is usually invoked like this:
commonly used by packagers to install software in a staging directory.
::
For example, running
make DESTDIR=/home/john install
.. code-block:: shell
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``.
make DESTDIR=/package/stage install
WARNING: ``DESTDIR`` may not be used on Windows because installation
prefix usually contains a drive letter like in ``C:/Program Files``
which cannot be prepended with some other prefix.
will install the software using the installation prefix, e.g. ``/usr/local``,
prepended with the ``DESTDIR`` value which gives ``/package/stage/usr/local``.
The packaging tool may then construct the package from the content of the
``/package/stage`` directory.
See the :variable:`CMAKE_INSTALL_PREFIX` variable to control the
installation prefix when configuring a build tree. Or, when using
the :manual:`cmake(1)` command-line tool's ``--install`` mode,
one may specify a different prefix using the ``--prefix`` option.
.. note::
``DESTDIR`` may not be used on Windows because installation
prefix usually contains a drive letter like in ``C:/Program Files``
which cannot be prepended with some other prefix.

12
Help/variable/CMAKE_INSTALL_PREFIX.rst
View File

@@ -10,7 +10,8 @@ See :variable:`CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT` for how a
project might choose its own default.
On UNIX one can use the ``DESTDIR`` mechanism in order to relocate the
whole installation. See :envvar:`DESTDIR` for more information.
whole installation to a staging area. See the :envvar:`DESTDIR` environment
variable for more information.
The installation prefix is also added to :variable:`CMAKE_SYSTEM_PREFIX_PATH`
so that :command:`find_package`, :command:`find_program`,
@@ -21,3 +22,12 @@ will search the prefix for other software.
Use the :module:`GNUInstallDirs` module to provide GNU-style
options for the layout of directories within the installation.
The ``CMAKE_INSTALL_PREFIX`` may be defined when configuring a build tree
to set its installation prefix. Or, when using the :manual:`cmake(1)`
command-line tool's ``--install`` mode, one may specify a different prefix
using the ``--prefix`` option:
.. code-block:: shell
cmake --install . --prefix /my/install/prefix