summaryrefslogtreecommitdiffstats
path: root/Source/cmConfigureFileCommand.h
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-10-16 13:28:12 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2013-10-16 13:28:12 (GMT)
commitc49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740 (patch)
tree96102c69673467ce7b922697cd5f378511249201 /Source/cmConfigureFileCommand.h
parent5029da5eac08171653a92b961c341f7ffcca3640 (diff)
parent7038a93a7eafa83d506dd73bed171dc72dfbd9a5 (diff)
downloadCMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.zip
CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.gz
CMake-c49083e9a4cddbdc6cbcc582e2d8d5fc7cfd7740.tar.bz2
Merge topic 'doc-reStructuredText'
7038a93 Modules/readme.txt: Update steps to add module documentation a77e308 CPack: Replace #<type> markup with reStructuredText equivalent e7ca48f Help: Factor out cmake-generator-expressions manual page 97e8650 Help: Factor out COMPILE_DEFINITIONS disclaimer duplication 8982161 Help: Factor out find_* command duplication 30b2186 Help: Factor out *_OUTPUT_(NAME|DIRECTORY).rst duplication bfe07aa Build Help documentation during CMake build using Sphinx 53ded59 Drop unused builtin documentation APIs 0c39a75 Drop the 'Full' field from cmDocumentationEntry e33d8d2 Drop builtin command documentation 399e9c4 Drop builtin property documentation 6035c04 get_property: Drop test for builtin property documentation 80a3273 Drop all documentation formatters except Usage b336a1eb Teach COMPATIBLE_INTERFACE_* checks to use Help .rst documents ec6df36 Teach --help-* options to load documentation from .rst files 25f2877 Add class cmRST to do basic reStructuredText processing ...
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 0393ecf..605b58b 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; }