summaryrefslogtreecommitdiff
path: root/Source/cmConfigureFileCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-09-17 13:23:40 -0400
committerBrad King <brad.king@kitware.com>2013-10-16 09:22:36 -0400
commite33d8d2d7799271e94b4f1215c77d6a685f82b88 (patch)
tree03726a7dacd9c06731de417d3f8c82f7bbb5e8f1 /Source/cmConfigureFileCommand.h
parent399e9c46d88c12507f1a762e69225c5ab9f4ac08 (diff)
downloadcmake-e33d8d2d7799271e94b4f1215c77d6a685f82b88.tar.gz
Drop builtin command documentation
Drop all GetTerseDocumentation and GetFullDocumentation methods from commands. The command documentation is now in Help/command/*.rst files.
Diffstat (limited to 'Source/cmConfigureFileCommand.h')
-rw-r--r--Source/cmConfigureFileCommand.h55
1 files changed, 0 insertions, 55 deletions
diff --git a/Source/cmConfigureFileCommand.h b/Source/cmConfigureFileCommand.h
index 0393ecfa9b..605b58b03e 100644
--- a/Source/cmConfigureFileCommand.h
+++ b/Source/cmConfigureFileCommand.h
@@ -41,61 +41,6 @@ public:
*/
virtual bool IsScriptable() const { return true; }
- /**
- * Succinct documentation.
- */
- virtual const char* GetTerseDocumentation() const
- {
- return "Copy a file to another location and modify its contents.";
- }
-
- /**
- * Longer documentation.
- */
- virtual const char* GetFullDocumentation() const
- {
- return
- " configure_file(<input> <output>\n"
- " [COPYONLY] [ESCAPE_QUOTES] [@ONLY] \n"
- " [NEWLINE_STYLE [UNIX|DOS|WIN32|LF|CRLF] ])\n"
- "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. "
- "The <input> must be a file, not a directory. "
- "If <output> is a relative path it is evaluated with respect to "
- "the current binary directory. "
- "If <output> names an existing directory the input file is placed "
- "in that directory with its original name. "
- "\n"
- "If the <input> file is modified the build system will re-run CMake "
- "to re-configure the file and generate the build system again."
- "\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. "
- "If COPYONLY is specified, then no variable expansion will take "
- "place. If ESCAPE_QUOTES is specified then any substituted quotes "
- "will be C-style escaped. "
- "The file will be configured with the current values of CMake "
- "variables. If @ONLY is specified, only variables "
- "of the form @VAR@ will be replaced and ${VAR} will be ignored. "
- "This is useful for configuring scripts that use ${VAR}."
- "\n"
- "Input file lines of the form \"#cmakedefine VAR ...\" "
- "will be replaced with either \"#define VAR ...\" or "
- "\"/* #undef VAR */\" depending on whether VAR is set in CMake to "
- "any value not considered a false constant by the if() command. "
- "(Content of \"...\", if any, is processed as above.) "
- "Input file lines of the form \"#cmakedefine01 VAR\" "
- "will be replaced with either \"#define VAR 1\" or "
- "\"#define VAR 0\" similarly."
- "\n"
- "With NEWLINE_STYLE the line ending could be adjusted: \n"
- " 'UNIX' or 'LF' for \\n, 'DOS', 'WIN32' or 'CRLF' for \\r\\n.\n"
- "COPYONLY must not be used with NEWLINE_STYLE.\n";
- }
-
virtual void FinalPass();
virtual bool HasFinalPass() const { return !this->Immediate; }