kolan/CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge topic 'doc-output_required_files'

Browse Source 
5cf4ff6 Document status of output_required_files command (#12214)
This commit is contained in:
Brad King 2011-05-24 14:34:48 -04:00 committed by CMake Topic Stage
commit 0f843584f3
1 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
Source/cmOutputRequiredFilesCommand.h
View File

@ -47,8 +47,7 @@ public:
*/ */
virtual const char* GetTerseDocumentation() virtual const char* GetTerseDocumentation()
{ {
return return "Deprecated. Approximate C preprocessor dependency scanning.";
"Output a list of required source files for a specified source file.";
} }
/** /**
@ -57,12 +56,22 @@ public:
virtual const char* GetFullDocumentation() virtual const char* GetFullDocumentation()
{ {
return return
"This command exists only because ancient CMake versions provided it. "
"CMake handles preprocessor dependency scanning automatically using a "
"more advanced scanner.\n"
" output_required_files(srcfile outputfile)\n" " output_required_files(srcfile outputfile)\n"
"Outputs a list of all the source files that are required by the " "Outputs a list of all the source files that are required by the "
"specified srcfile. This list is written into outputfile. This is " "specified srcfile. This list is written into outputfile. This is "
"similar to writing out the dependencies for srcfile except that it " "similar to writing out the dependencies for srcfile except that it "
"jumps from .h files into .cxx, .c and .cpp files if possible."; "jumps from .h files into .cxx, .c and .cpp files if possible.";
} }
/** This command is kept for compatibility with older CMake versions. */
virtual bool IsDiscouraged()
{
return true;
}
cmTypeMacro(cmOutputRequiredFilesCommand, cmCommand); cmTypeMacro(cmOutputRequiredFilesCommand, cmCommand);
void ListDependencies(cmDependInformation const *info, void ListDependencies(cmDependInformation const *info,