diff options
| author | Brad King <brad.king@kitware.com> | 2011-01-17 13:17:38 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2011-01-17 13:17:38 (GMT) |
| commit | c64d1385b763b7529a19a6f11c816339479dc3dc (patch) | |
| tree | dd5bb82bb35442bb3b8e17369b726428dbf29683 /Source/cmDocumentCompileDefinitions.h | |
| parent | 668ce6b1e88c1732bc677413033552994c951709 (diff) | |
| download | CMake-c64d1385b763b7529a19a6f11c816339479dc3dc.zip CMake-c64d1385b763b7529a19a6f11c816339479dc3dc.tar.gz CMake-c64d1385b763b7529a19a6f11c816339479dc3dc.tar.bz2 | |
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.h | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/Source/cmDocumentCompileDefinitions.h b/Source/cmDocumentCompileDefinitions.h index 3ea5746..ef3b3e7 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 |