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

find_package: Fix components signature documentation (#13142) 

Update the signature notation to show that "REQUIRED COMPONENTS ..." is
allowed and that REQUIRED is an option on its own.
This commit is contained in:
Brad King 2012-04-18 13:28:45 -04:00
parent 6c12e820b8
commit 5ed93db4cf
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Source/cmFindPackageCommand.cxx
View File

@ -89,7 +89,7 @@ void cmFindPackageCommand::GenerateDocumentation()
"FIND_XXX", "find_package"); "FIND_XXX", "find_package");
this->CommandDocumentation = this->CommandDocumentation =
" find_package(<package> [version] [EXACT] [QUIET] [MODULE]\n" " find_package(<package> [version] [EXACT] [QUIET] [MODULE]\n"
" [[REQUIRED|COMPONENTS] [components...]]\n" " [REQUIRED] [[COMPONENTS] [components...]]\n"
" [OPTIONAL_COMPONENTS components...]\n" " [OPTIONAL_COMPONENTS components...]\n"
" [NO_POLICY_SCOPE])\n" " [NO_POLICY_SCOPE])\n"
"Finds and loads settings from an external project. " "Finds and loads settings from an external project. "
@ -102,7 +102,7 @@ void cmFindPackageCommand::GenerateDocumentation()
"package cannot be found." "package cannot be found."
"\n" "\n"
"A package-specific list of required components may be listed after the " "A package-specific list of required components may be listed after the "
"COMPONENTS option or directly after the REQUIRED option. " "COMPONENTS option (or after the REQUIRED option if present). "
"Additional optional components may be listed after OPTIONAL_COMPONENTS. " "Additional optional components may be listed after OPTIONAL_COMPONENTS. "
"Available components and their influence on whether a package is " "Available components and their influence on whether a package is "
"considered to be found are defined by the target package." "considered to be found are defined by the target package."
@ -136,7 +136,7 @@ void cmFindPackageCommand::GenerateDocumentation()
"proceeds to Config mode.\n" "proceeds to Config mode.\n"
"The complete Config mode command signature is:\n" "The complete Config mode command signature is:\n"
" find_package(<package> [version] [EXACT] [QUIET]\n" " find_package(<package> [version] [EXACT] [QUIET]\n"
" [[REQUIRED|COMPONENTS] [components...]]\n" " [REQUIRED] [[COMPONENTS] [components...]]\n"
" [CONFIG|NO_MODULE]\n" " [CONFIG|NO_MODULE]\n"
" [NO_POLICY_SCOPE]\n" " [NO_POLICY_SCOPE]\n"
" [NAMES name1 [name2 ...]]\n" " [NAMES name1 [name2 ...]]\n"