summaryrefslogtreecommitdiffstats
path: root/Source/cmFileCommand.h
diff options
context:
space:
mode:
authorAndreas Mohr <andim2@users.sourceforge.net>2012-11-07 16:12:03 (GMT)
committerBrad King <brad.king@kitware.com>2012-11-07 19:10:56 (GMT)
commit07d5e4b871dae45a3ffcc839965dabf495679e1b (patch)
treeb3b6dbf89ba169d1c4e824c3b3109f57646004eb /Source/cmFileCommand.h
parent965de974b24ecafc420885eff68a3917471ff181 (diff)
downloadCMake-07d5e4b871dae45a3ffcc839965dabf495679e1b.zip
CMake-07d5e4b871dae45a3ffcc839965dabf495679e1b.tar.gz
CMake-07d5e4b871dae45a3ffcc839965dabf495679e1b.tar.bz2
Documentation: Clarify some command descriptions
- file(WRITE): add configure_file() decoupling hint - function(): definitely mention PARENT_SCOPE - include_directories(): mention possible results of SYSTEM setting - macro(): mention scope specifics of function() - message(): improve SEND_ERROR / FATAL_ERROR docs, since people said it's not obvious
Diffstat (limited to 'Source/cmFileCommand.h')
-rw-r--r--Source/cmFileCommand.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/Source/cmFileCommand.h b/Source/cmFileCommand.h
index b4aa903..a0862ec 100644
--- a/Source/cmFileCommand.h
+++ b/Source/cmFileCommand.h
@@ -89,7 +89,8 @@ public:
" [TIMEOUT timeout] [STATUS status] [LOG log] [SHOW_PROGRESS])\n"
"WRITE will write a message into a file called 'filename'. It "
"overwrites the file if it already exists, and creates the file "
- "if it does not exist.\n"
+ "if it does not exist. (If the file is a build input, use "
+ "configure_file to update the file only when its content changes.)\n"
"APPEND will write a message into a file same as WRITE, except "
"it will append it to the end of the file\n"
"READ will read the content of a file and store it into the "