summaryrefslogtreecommitdiffstats
path: root/Source/cmConfigureFileCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2009-09-16 19:09:29 (GMT)
committerBrad King <brad.king@kitware.com>2009-09-16 19:09:29 (GMT)
commit700cdf393af6aec04917a190122d7d46a1ba720e (patch)
tree2f36d85bbc9ed26876f6ea85a00c055c7ad01af4 /Source/cmConfigureFileCommand.h
parentdda0da8b9ef32d4ac36961bb5345988ca502c357 (diff)
downloadCMake-700cdf393af6aec04917a190122d7d46a1ba720e.zip
CMake-700cdf393af6aec04917a190122d7d46a1ba720e.tar.gz
CMake-700cdf393af6aec04917a190122d7d46a1ba720e.tar.bz2
Teach configure_file to handle relative paths
The configure_file() command now converts relative output paths to full paths using the current binary directory. Input relative paths were already converted using the current source directory, but this behavior was not previously documented.
Diffstat (limited to 'Source/cmConfigureFileCommand.h')
-rw-r--r--Source/cmConfigureFileCommand.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/Source/cmConfigureFileCommand.h b/Source/cmConfigureFileCommand.h
index 9e22897..58ce10a 100644
--- a/Source/cmConfigureFileCommand.h
+++ b/Source/cmConfigureFileCommand.h
@@ -60,9 +60,15 @@ public:
virtual const char* GetFullDocumentation()
{
return
- " configure_file(InputFile OutputFile\n"
+ " configure_file(<input> <output>\n"
" [COPYONLY] [ESCAPE_QUOTES] [@ONLY])\n"
- "The Input and Output files have to have full paths. "
+ "Copies a file <input> to file <output> and substitutes variable "
+ "values referenced in the file content. "
+ "If <input> is a relative path it is evaluated with respect to "
+ "the current source directory. "
+ "If <output> is a relative path it is evaluated with respect to "
+ "the current binary directory. "
+ "\n"
"This command replaces any variables in the input file referenced as "
"${VAR} or @VAR@ with their values as determined by CMake. If a "
"variable is not defined, it will be replaced with nothing. "