summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2013-11-04 12:53:57 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2013-11-04 12:53:57 (GMT)
commita9c8f7b3007f83fd69be2f58b18d39e6cfd120eb (patch)
tree9b8b03eab15eb43cf47f5e980d31f1477e0cc356 /Help
parent1d998085be4d17def0e1163bf078603a21d16880 (diff)
parent12d10a00ac03ad206e00cbec321e76415e2adbe0 (diff)
downloadCMake-a9c8f7b3007f83fd69be2f58b18d39e6cfd120eb.zip
CMake-a9c8f7b3007f83fd69be2f58b18d39e6cfd120eb.tar.gz
CMake-a9c8f7b3007f83fd69be2f58b18d39e6cfd120eb.tar.bz2
Merge topic 'doc-CMAKE_INCLUDE_DIRECTORIES_BEFORE'
12d10a0 Add missing documentation for include dirs related variables. (#12611)
Diffstat (limited to 'Help')
-rw-r--r--Help/command/include_directories.rst2
-rw-r--r--Help/manual/cmake-variables.7.rst2
-rw-r--r--Help/variable/CMAKE_INCLUDE_DIRECTORIES_BEFORE.rst8
-rw-r--r--Help/variable/CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE.rst8
4 files changed, 19 insertions, 1 deletions
diff --git a/Help/command/include_directories.rst b/Help/command/include_directories.rst
index 6744427..3e0c7a0 100644
--- a/Help/command/include_directories.rst
+++ b/Help/command/include_directories.rst
@@ -19,7 +19,7 @@ used by the generators.
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
+:variable:`CMAKE_INCLUDE_DIRECTORIES_BEFORE` to ON. By using AFTER or BEFORE
explicitly, you can select between appending and prepending,
independent of the default.
diff --git a/Help/manual/cmake-variables.7.rst b/Help/manual/cmake-variables.7.rst
index 26205a8..59e8064 100644
--- a/Help/manual/cmake-variables.7.rst
+++ b/Help/manual/cmake-variables.7.rst
@@ -97,6 +97,8 @@ Variables that Change Behavior
/variable/CMAKE_FIND_NO_INSTALL_PREFIX
/variable/CMAKE_IGNORE_PATH
/variable/CMAKE_INCLUDE_PATH
+ /variable/CMAKE_INCLUDE_DIRECTORIES_BEFORE
+ /variable/CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE
/variable/CMAKE_INSTALL_DEFAULT_COMPONENT_NAME
/variable/CMAKE_INSTALL_PREFIX
/variable/CMAKE_LIBRARY_PATH
diff --git a/Help/variable/CMAKE_INCLUDE_DIRECTORIES_BEFORE.rst b/Help/variable/CMAKE_INCLUDE_DIRECTORIES_BEFORE.rst
new file mode 100644
index 0000000..3c1fbcf
--- /dev/null
+++ b/Help/variable/CMAKE_INCLUDE_DIRECTORIES_BEFORE.rst
@@ -0,0 +1,8 @@
+CMAKE_INCLUDE_DIRECTORIES_BEFORE
+--------------------------------
+
+Whether to append or prepend directories by default in :command:`include_directories`.
+
+This variable affects the default behavior of the :command:`include_directories`
+command. Setting this variable to 'ON' is equivalent to using the BEFORE option
+in all uses of that command.
diff --git a/Help/variable/CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE.rst b/Help/variable/CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE.rst
new file mode 100644
index 0000000..cbd04d7
--- /dev/null
+++ b/Help/variable/CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE.rst
@@ -0,0 +1,8 @@
+CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE
+----------------------------------------
+
+Whether to force prepending of project include directories.
+
+This variable affects the order of include directories generated in compiler
+command lines. If set to 'ON', it causes the :variable:`CMAKE_SOURCE_DIR` and
+the :variable:`CMAKE_BINARY_DIR` to appear first.