summaryrefslogtreecommitdiff
path: root/Help/prop_dir
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-10-04 15:34:11 -0400
committerBrad King <brad.king@kitware.com>2013-10-16 09:22:38 -0400
commit97e8650d7bd213e5fde721a0f7d71b63ac238370 (patch)
treee159b4dd848a8a4e25027b479194b82dc7330bfb /Help/prop_dir
parent898216137a184940867a1678b07ca8470b2d7b85 (diff)
downloadcmake-97e8650d7bd213e5fde721a0f7d71b63ac238370.tar.gz
Help: Factor out COMPILE_DEFINITIONS disclaimer duplication
The COMPILE_DEFINITIONS escaping disclaimer was represented in builtin documentation using a preprocessor macro. Factor the duplicate content out into a separate .txt file and include it in each document with the reStructuredText include directive.
Diffstat (limited to 'Help/prop_dir')
-rw-r--r--Help/prop_dir/COMPILE_DEFINITIONS.rst21
1 files changed, 1 insertions, 20 deletions
diff --git a/Help/prop_dir/COMPILE_DEFINITIONS.rst b/Help/prop_dir/COMPILE_DEFINITIONS.rst
index bc5f754d67..290d61208c 100644
--- a/Help/prop_dir/COMPILE_DEFINITIONS.rst
+++ b/Help/prop_dir/COMPILE_DEFINITIONS.rst
@@ -17,23 +17,4 @@ CMake will automatically drop some definitions that are not supported
by the native build tool. The VS6 IDE does not support definition
values with spaces (but NMake does).
-Disclaimer: Most native build tools have poor support for escaping
-certain values. CMake has work-arounds for many cases but some values
-may just not be possible to pass correctly. If a value does not seem
-to be escaped correctly, do not attempt to work-around the problem by
-adding escape sequences to the value. Your work-around may break in a
-future version of CMake that has improved escape support. Instead
-consider defining the macro in a (configured) header file. Then
-report the limitation. Known limitations include:
-
-::
-
- # - broken almost everywhere
- ; - broken in VS IDE 7.0 and Borland Makefiles
- , - broken in VS IDE
- % - broken in some cases in NMake
- & | - broken in some cases on MinGW
- ^ < > \" - broken in most Make tools on Windows
-
-CMake does not reject these values outright because they do work in
-some cases. Use with caution.
+.. include:: /include/COMPILE_DEFINITIONS_DISCLAIMER.txt