summaryrefslogtreecommitdiffstats
path: root/Source/cmDocumentGeneratorExpressions.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2010-12-06 22:11:36 (GMT)
committerBrad King <brad.king@kitware.com>2010-12-15 19:53:31 (GMT)
commit4091bca4ecf4a7f9c2099a7d34e125494de60e1c (patch)
tree0c801e0274c19f1e5ca72c1447eb386f69713286 /Source/cmDocumentGeneratorExpressions.h
parentbfb7288f8103298bf4cabb60a13208f95595a7db (diff)
downloadCMake-4091bca4ecf4a7f9c2099a7d34e125494de60e1c.zip
CMake-4091bca4ecf4a7f9c2099a7d34e125494de60e1c.tar.gz
CMake-4091bca4ecf4a7f9c2099a7d34e125494de60e1c.tar.bz2
Factor generator expression docs out of add_test
This documentation may be reused wherever generator expressions are supported.
Diffstat (limited to 'Source/cmDocumentGeneratorExpressions.h')
-rw-r--r--Source/cmDocumentGeneratorExpressions.h30
1 files changed, 30 insertions, 0 deletions
diff --git a/Source/cmDocumentGeneratorExpressions.h b/Source/cmDocumentGeneratorExpressions.h
new file mode 100644
index 0000000..5359013
--- /dev/null
+++ b/Source/cmDocumentGeneratorExpressions.h
@@ -0,0 +1,30 @@
+/*============================================================================
+ CMake - Cross Platform Makefile Generator
+ Copyright 2000-2010 Kitware, Inc., Insight Software Consortium
+
+ Distributed under the OSI-approved BSD License (the "License");
+ see accompanying file Copyright.txt for details.
+
+ This software is distributed WITHOUT ANY WARRANTY; without even the
+ implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
+ See the License for more information.
+============================================================================*/
+#ifndef cmDocumentGeneratorExpressions_h
+#define cmDocumentGeneratorExpressions_h
+
+#define CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS \
+ "Generator expressions are evaluted during build system generation " \
+ "to produce information specific to each build configuration. " \
+ "Valid expressions are:\n" \
+ " $<CONFIGURATION> = configuration name\n" \
+ " $<TARGET_FILE:tgt> = main file (.exe, .so.1.2, .a)\n" \
+ " $<TARGET_LINKER_FILE:tgt> = file used to link (.a, .lib, .so)\n" \
+ " $<TARGET_SONAME_FILE:tgt> = file with soname (.so.3)\n" \
+ "where \"tgt\" is the name of a target. " \
+ "Target file expressions produce a full path, but _DIR and _NAME " \
+ "versions can produce the directory and file name components:\n" \
+ " $<TARGET_FILE_DIR:tgt>/$<TARGET_FILE_NAME:tgt>\n" \
+ " $<TARGET_LINKER_FILE_DIR:tgt>/$<TARGET_LINKER_FILE_NAME:tgt>\n" \
+ " $<TARGET_SONAME_FILE_DIR:tgt>/$<TARGET_SONAME_FILE_NAME:tgt>\n"
+
+#endif