diff options
| author | Brad King <brad.king@kitware.com> | 2012-04-18 17:28:45 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2012-04-19 13:41:17 (GMT) |
| commit | 5ed93db4cf6408c245d58a1bfaa63048bc54fc00 (patch) | |
| tree | dacb5074635704fb2dfc0830ef7cbb9758b2ab44 /Source/cmFindPackageCommand.cxx | |
| parent | 6c12e820b84a1a509dced0efe8118eca2a141473 (diff) | |
| download | CMake-5ed93db4cf6408c245d58a1bfaa63048bc54fc00.zip CMake-5ed93db4cf6408c245d58a1bfaa63048bc54fc00.tar.gz CMake-5ed93db4cf6408c245d58a1bfaa63048bc54fc00.tar.bz2 | |
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.
Diffstat (limited to 'Source/cmFindPackageCommand.cxx')
| -rw-r--r-- | Source/cmFindPackageCommand.cxx | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Source/cmFindPackageCommand.cxx b/Source/cmFindPackageCommand.cxx index 0a055a2..4f9ba7e 100644 --- a/Source/cmFindPackageCommand.cxx +++ b/Source/cmFindPackageCommand.cxx @@ -89,7 +89,7 @@ void cmFindPackageCommand::GenerateDocumentation() "FIND_XXX", "find_package"); this->CommandDocumentation = " find_package(<package> [version] [EXACT] [QUIET] [MODULE]\n" - " [[REQUIRED|COMPONENTS] [components...]]\n" + " [REQUIRED] [[COMPONENTS] [components...]]\n" " [OPTIONAL_COMPONENTS components...]\n" " [NO_POLICY_SCOPE])\n" "Finds and loads settings from an external project. " @@ -102,7 +102,7 @@ void cmFindPackageCommand::GenerateDocumentation() "package cannot be found." "\n" "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. " "Available components and their influence on whether a package is " "considered to be found are defined by the target package." @@ -136,7 +136,7 @@ void cmFindPackageCommand::GenerateDocumentation() "proceeds to Config mode.\n" "The complete Config mode command signature is:\n" " find_package(<package> [version] [EXACT] [QUIET]\n" - " [[REQUIRED|COMPONENTS] [components...]]\n" + " [REQUIRED] [[COMPONENTS] [components...]]\n" " [CONFIG|NO_MODULE]\n" " [NO_POLICY_SCOPE]\n" " [NAMES name1 [name2 ...]]\n" |