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_DEPRECATED.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_DEPRECATED.rst')
-rw-r--r-- | Help/variable/CMAKE_ERROR_DEPRECATED.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Help/variable/CMAKE_ERROR_DEPRECATED.rst b/Help/variable/CMAKE_ERROR_DEPRECATED.rst index 68befc2..39dc4a8 100644 --- a/Help/variable/CMAKE_ERROR_DEPRECATED.rst +++ b/Help/variable/CMAKE_ERROR_DEPRECATED.rst @@ -3,9 +3,9 @@ CMAKE_ERROR_DEPRECATED Whether to issue deprecation errors for macros and functions. -If TRUE, this can be used by macros and functions to issue fatal +If ``TRUE``, this can be used by macros and functions to issue fatal errors when deprecated macros or functions are used. This variable is -FALSE by default. +``FALSE`` by default. These errors can be enabled with the ``-Werror=deprecated`` option, or disabled with the ``-Wno-error=deprecated`` option, when running |