Factor generator expression docs out of add_test
This documentation may be reused wherever generator expressions are supported.
This commit is contained in:
parent
bfb7288f81
commit
4091bca4ec
|
@ -158,6 +158,7 @@ SET(SRCS
|
||||||
cmDocumentationFormatterText.cxx
|
cmDocumentationFormatterText.cxx
|
||||||
cmDocumentationFormatterUsage.cxx
|
cmDocumentationFormatterUsage.cxx
|
||||||
cmDocumentationSection.cxx
|
cmDocumentationSection.cxx
|
||||||
|
cmDocumentGeneratorExpressions.h
|
||||||
cmDocumentVariables.cxx
|
cmDocumentVariables.cxx
|
||||||
cmDynamicLoader.cxx
|
cmDynamicLoader.cxx
|
||||||
cmDynamicLoader.h
|
cmDynamicLoader.h
|
||||||
|
|
|
@ -13,6 +13,7 @@
|
||||||
#define cmAddTestCommand_h
|
#define cmAddTestCommand_h
|
||||||
|
|
||||||
#include "cmCommand.h"
|
#include "cmCommand.h"
|
||||||
|
#include "cmDocumentGeneratorExpressions.h"
|
||||||
|
|
||||||
/** \class cmAddTestCommand
|
/** \class cmAddTestCommand
|
||||||
* \brief Add a test to the lists of tests to run.
|
* \brief Add a test to the lists of tests to run.
|
||||||
|
@ -77,19 +78,7 @@ public:
|
||||||
"\n"
|
"\n"
|
||||||
"Arguments after COMMAND may use \"generator expressions\" with the "
|
"Arguments after COMMAND may use \"generator expressions\" with the "
|
||||||
"syntax \"$<...>\". "
|
"syntax \"$<...>\". "
|
||||||
"These expressions are evaluted during build system generation and "
|
CM_DOCUMENT_COMMAND_GENERATOR_EXPRESSIONS
|
||||||
"produce information specific to each generated 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"
|
|
||||||
"Example usage:\n"
|
"Example usage:\n"
|
||||||
" add_test(NAME mytest\n"
|
" add_test(NAME mytest\n"
|
||||||
" COMMAND testDriver --config $<CONFIGURATION>\n"
|
" COMMAND testDriver --config $<CONFIGURATION>\n"
|
||||||
|
|
|
@ -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
|
Loading…
Reference in New Issue