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_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.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_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst')
-rw-r--r-- | Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst b/Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst index 651d68d..38e9b7b 100644 --- a/Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst +++ b/Help/variable/CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION.rst @@ -1,9 +1,10 @@ CMAKE_ERROR_ON_ABSOLUTE_INSTALL_DESTINATION ------------------------------------------- -Ask cmake_install.cmake script to error out as soon as a file with absolute INSTALL DESTINATION is encountered. +Ask ``cmake_install.cmake`` script to error out as soon as a file with +absolute ``INSTALL DESTINATION`` is encountered. The fatal error is emitted before the installation of the offending file takes place. This variable is used by CMake-generated -cmake_install.cmake scripts. If one sets this variable to ON while +``cmake_install.cmake`` scripts. If one sets this variable to ``ON`` while running the script, it may get fatal error messages from the script. |