Browse Source

Consistent documentation for deprecation message variables.

Make the documentation for the 'CMAKE_ERROR_DEPRECATED' CMake
variable consistent with the documentation for the
'CMAKE_WARN_DEPRECATED' CMake variable, in terms of wording.
pull/203/head
Michael Scott 10 years ago
committed by Brad King
parent
commit
b146747ed7
  1. 7
      Help/variable/CMAKE_ERROR_DEPRECATED.rst

7
Help/variable/CMAKE_ERROR_DEPRECATED.rst

@ -1,8 +1,7 @@
CMAKE_ERROR_DEPRECATED
----------------------
Whether to issue deprecation errors for macros and functions.
Whether to issue errors for deprecated functionality.
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.
If ``TRUE``, use of deprecated functionality will issue fatal errors.
If this variable is not set, CMake behaves as if it were set to ``FALSE``.
Loading…
Cancel
Save