summaryrefslogtreecommitdiffstats
path: root/Source/cmIncludeCommand.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmIncludeCommand.h')
-rw-r--r--Source/cmIncludeCommand.h18
1 files changed, 11 insertions, 7 deletions
diff --git a/Source/cmIncludeCommand.h b/Source/cmIncludeCommand.h
index a215275..d933ef3 100644
--- a/Source/cmIncludeCommand.h
+++ b/Source/cmIncludeCommand.h
@@ -15,7 +15,7 @@
#include "cmCommand.h"
/** \class cmIncludeCommand
- * \brief
+ * \brief
*
* cmIncludeCommand defines a list of distant
* files that can be "included" in the current list file.
@@ -28,7 +28,7 @@ public:
/**
* This is a virtual constructor for the command.
*/
- virtual cmCommand* Clone()
+ virtual cmCommand* Clone()
{
return new cmIncludeCommand;
}
@@ -49,15 +49,15 @@ public:
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "include";}
-
+
/**
* Succinct documentation.
*/
- virtual const char* GetTerseDocumentation()
+ virtual const char* GetTerseDocumentation()
{
return "Read CMake listfile code from the given file.";
}
-
+
/**
* More documentation.
*/
@@ -73,13 +73,17 @@ public:
"the variable will be set to the full filename which "
"has been included or NOTFOUND if it failed.\n"
"If a module is specified instead of a file, the file with name "
- "<modulename>.cmake is searched in the CMAKE_MODULE_PATH."
+ "<modulename>.cmake is searched first in CMAKE_MODULE_PATH, then in the "
+ "CMake module directory. There is one exception to this: if the file "
+ "which calls include() is located itself in the CMake module directory, "
+ "then first the CMake module directory is searched and "
+ "CMAKE_MODULE_PATH afterwards. See also policy CMP0017."
"\n"
"See the cmake_policy() command documentation for discussion of the "
"NO_POLICY_SCOPE option."
;
}
-
+
cmTypeMacro(cmIncludeCommand, cmCommand);
};