summaryrefslogtreecommitdiffstats
path: root/Source/cmIncludeDirectoryCommand.h
diff options
context:
space:
mode:
authorDavid Cole <david.cole@kitware.com>2012-02-22 19:30:00 (GMT)
committerDavid Cole <david.cole@kitware.com>2012-02-22 20:22:03 (GMT)
commit8233636dbe531ccf36510242e7c997dfa6529bde (patch)
tree217b3e29bf4f2faec33568bbc73fdab4c7155cbb /Source/cmIncludeDirectoryCommand.h
parentd899eb71b52616c9e3f3f5987f229619605e632b (diff)
downloadCMake-8233636dbe531ccf36510242e7c997dfa6529bde.zip
CMake-8233636dbe531ccf36510242e7c997dfa6529bde.tar.gz
CMake-8233636dbe531ccf36510242e7c997dfa6529bde.tar.bz2
Update the documentation regarding INCLUDE_DIRECTORIES.
It is now a target property and is affected by the use of the include_directories command.
Diffstat (limited to 'Source/cmIncludeDirectoryCommand.h')
-rw-r--r--Source/cmIncludeDirectoryCommand.h22
1 files changed, 15 insertions, 7 deletions
diff --git a/Source/cmIncludeDirectoryCommand.h b/Source/cmIncludeDirectoryCommand.h
index 3b35d55..cbe344f 100644
--- a/Source/cmIncludeDirectoryCommand.h
+++ b/Source/cmIncludeDirectoryCommand.h
@@ -58,13 +58,21 @@ public:
{
return
" include_directories([AFTER|BEFORE] [SYSTEM] dir1 dir2 ...)\n"
- "Add the given directories to those searched by the compiler for "
- "include files. By default the directories are appended onto "
- "the current list of directories. This default behavior can be "
- "changed by setting CMAKE_INCLUDE_DIRECTORIES_BEFORE to ON. "
- "By using BEFORE or AFTER you can select between appending and "
- "prepending, independent from the default. "
- "If the SYSTEM option is given the compiler will be told that the "
+ "Add the given directories to those the compiler uses to search "
+ "for include files. "
+ "These directories are added to the directory property "
+ "INCLUDE_DIRECTORIES for the current CMakeLists file. "
+ "They are also added to the target property INCLUDE_DIRECTORIES "
+ "for each target in the current CMakeLists file. "
+ "The target property values are the ones used by the generators."
+ "\n"
+ "By default the directories are appended onto the current list of "
+ "directories. "
+ "This default behavior can be changed by setting "
+ "CMAKE_INCLUDE_DIRECTORIES_BEFORE to ON. "
+ "By using AFTER or BEFORE explicitly, you can select between "
+ "appending and prepending, independent of the default. "
+ "If the SYSTEM option is given, the compiler will be told the "
"directories are meant as system include directories on some "
"platforms.";
}