Source/cmDocumentCompileDefinitions.h

   1 /*============================================================================
   2   CMake - Cross Platform Makefile Generator
   3   Copyright 2000-2011 Kitware, Inc., Insight Software Consortium
   4
   5   Distributed under the OSI-approved BSD License (the "License");
   6   see accompanying file Copyright.txt for details.
   7
   8   This software is distributed WITHOUT ANY WARRANTY; without even the
   9   implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  10   See the License for more information.
  11 ============================================================================*/
  12 #ifndef cmDocumentCompileDefinitions_h
  13 #define cmDocumentCompileDefinitions_h
  14
  15 #define CM_DOCUMENT_COMPILE_DEFINITIONS_DISCLAIMER \
  16   "Disclaimer: Most native build tools have poor support for escaping " \
  17   "certain values.  CMake has work-arounds for many cases but some "    \
  18   "values may just not be possible to pass correctly.  If a value "     \
  19   "does not seem to be escaped correctly, do not attempt to "           \
  20   "work-around the problem by adding escape sequences to the value.  "  \
  21   "Your work-around may break in a future version of CMake that "       \
  22   "has improved escape support.  Instead consider defining the macro "  \
  23   "in a (configured) header file.  Then report the limitation.  "       \
  24   "Known limitations include:\n"                                        \
  25   "  #          - broken almost everywhere\n"                           \
  26   "  ;          - broken in VS IDE 7.0 and Borland Makefiles\n"         \
  27   "  ,          - broken in VS IDE\n"                                   \
  28   "  %          - broken in some cases in NMake\n"                      \
  29   "  & |        - broken in some cases on MinGW\n"                      \
  30   "  ^ < > \\\"   - broken in most Make tools on Windows\n"             \
  31   "CMake does not reject these values outright because they do work "   \
  32   "in some cases.  Use with caution.  "
  33
  34 #endif