summaryrefslogtreecommitdiff
path: root/Source/cmDocumentCompileDefinitions.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2011-01-17 08:17:38 -0500
committerBrad King <brad.king@kitware.com>2011-01-17 08:17:38 -0500
commitc64d1385b763b7529a19a6f11c816339479dc3dc (patch)
treedd5bb82bb35442bb3b8e17369b726428dbf29683 /Source/cmDocumentCompileDefinitions.h
parent668ce6b1e88c1732bc677413033552994c951709 (diff)
downloadcmake-c64d1385b763b7529a19a6f11c816339479dc3dc.tar.gz
Document COMPILE_DEFINITIONS known limitations (#11660, #11712)
Some values simply cannot be escaped properly in all contexts for all native build tools. Document known limitations after the disclaimer that states so.
Diffstat (limited to 'Source/cmDocumentCompileDefinitions.h')
-rw-r--r--Source/cmDocumentCompileDefinitions.h11
1 files changed, 10 insertions, 1 deletions
diff --git a/Source/cmDocumentCompileDefinitions.h b/Source/cmDocumentCompileDefinitions.h
index 3ea574689c..ef3b3e7155 100644
--- a/Source/cmDocumentCompileDefinitions.h
+++ b/Source/cmDocumentCompileDefinitions.h
@@ -20,6 +20,15 @@
"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."
+ "in a (configured) header file. Then report the limitation. " \
+ "Known limitations include:\n" \
+ " # - broken almost everywhere\n" \
+ " ; - broken in VS IDE and Borland Makefiles\n" \
+ " , - broken in VS IDE\n" \
+ " % - broken in some cases in NMake\n" \
+ " & | - broken in some cases on MinGW\n" \
+ " ^ < > \\\" - broken in most Make tools on Windows\n" \
+ "CMake does not reject these values outright because they do work " \
+ "in some cases. Use with caution. "
#endif