diff options
| author | Mathieu Malaterre <mathieu.malaterre@gmail.com> | 2009-11-02 16:50:33 (GMT) |
|---|---|---|
| committer | Mathieu Malaterre <mathieu.malaterre@gmail.com> | 2009-11-02 16:50:33 (GMT) |
| commit | 59ce04d4f8014ea96f9cca6618606ea30761c9b9 (patch) | |
| tree | 55c1766bc62ad431cb1632fd37f6bfe7589051d8 /Modules/readme.txt | |
| parent | ccb8accc1b705c62f10e2f75f961667c76535365 (diff) | |
| download | CMake-59ce04d4f8014ea96f9cca6618606ea30761c9b9.zip CMake-59ce04d4f8014ea96f9cca6618606ea30761c9b9.tar.gz CMake-59ce04d4f8014ea96f9cca6618606ea30761c9b9.tar.bz2 | |
STYLE: minor documentation + typo
Diffstat (limited to 'Modules/readme.txt')
| -rw-r--r-- | Modules/readme.txt | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Modules/readme.txt b/Modules/readme.txt index d23c4c3..a292e20 100644 --- a/Modules/readme.txt +++ b/Modules/readme.txt @@ -88,7 +88,7 @@ If the find module supports versioning it should locate a version of the package that is compatible with the version requested. If a compatible version of the package cannot be found the module should not report success. The version of the package found should be stored -in "XXX_VERSION..." version variables docmented by the module. +in "XXX_VERSION..." version variables documented by the module. If the QUIET option is given to the command it will set the variable XXX_FIND_QUIETLY to true before loading the FindXXX.cmake module. If @@ -110,3 +110,6 @@ error if the module is not found. To get this behaviour you can use the FIND_PACKAGE_HANDLE_STANDARD_ARGS() macro, as an example see FindJPEG.cmake. +For internal implementation, it's a generally accepted convention that variables starting with +underscore are for temporary use only. (variable starting with an underscore +are not intended as a reserved prefix). |