diff options
| author | James Johnston <johnstonj.public@codenest.com> | 2015-08-18 05:34:01 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2015-08-21 13:32:08 (GMT) |
| commit | 3bb707f0a1408dc0381ecbf4ec934e9f14d8927c (patch) | |
| tree | 1e6c4f6a4ad78a3d1635070207aa281bbd0e9493 /Help/variable/CMAKE_INSTALL_PREFIX.rst | |
| parent | 404d16e7bc1b18027f719cd8642d0a90c679c396 (diff) | |
| download | CMake-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/CMAKE_INSTALL_PREFIX.rst')
| -rw-r--r-- | Help/variable/CMAKE_INSTALL_PREFIX.rst | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/Help/variable/CMAKE_INSTALL_PREFIX.rst b/Help/variable/CMAKE_INSTALL_PREFIX.rst index ee9b615..3f3347f 100644 --- a/Help/variable/CMAKE_INSTALL_PREFIX.rst +++ b/Help/variable/CMAKE_INSTALL_PREFIX.rst @@ -1,14 +1,14 @@ CMAKE_INSTALL_PREFIX -------------------- -Install directory used by install. +Install directory used by :command:`install`. -If "make install" is invoked or INSTALL is built, this directory is +If ``make install`` is invoked or ``INSTALL`` is built, this directory is prepended onto all install directories. This variable defaults to -/usr/local on UNIX and c:/Program Files on Windows. +``/usr/local`` on UNIX and ``c:/Program Files`` on Windows. -On UNIX one can use the DESTDIR mechanism in order to relocate the -whole installation. DESTDIR means DESTination DIRectory. It is +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: @@ -17,16 +17,17 @@ non-default location. 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". +prefix, e.g. ``/usr/local`` prepended with the ``DESTDIR`` value which +finally gives ``/home/john/usr/local``. -WARNING: DESTDIR may not be used on Windows because installation -prefix usually contains a drive letter like in "C:/Program Files" +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. -The installation prefix is also added to CMAKE_SYSTEM_PREFIX_PATH so -that find_package, find_program, find_library, find_path, and -find_file will search the prefix for other software. +The installation prefix is also added to :variable:`CMAKE_SYSTEM_PREFIX_PATH` +so that :command:`find_package`, :command:`find_program`, +:command:`find_library`, :command:`find_path`, and :command:`find_file` +will search the prefix for other software. .. note:: |