diff options
| author | Stephen Kelly <steveire@gmail.com> | 2013-11-02 14:56:54 (GMT) |
|---|---|---|
| committer | Stephen Kelly <steveire@gmail.com> | 2013-11-02 15:06:19 (GMT) |
| commit | 12d10a00ac03ad206e00cbec321e76415e2adbe0 (patch) | |
| tree | 7d1e99cf64f8f115a1f1ab269e5d7c979128200e | |
| parent | 547c59f000731872d37a5cff128995aabaa5fcdd (diff) | |
| download | CMake-12d10a00ac03ad206e00cbec321e76415e2adbe0.zip CMake-12d10a00ac03ad206e00cbec321e76415e2adbe0.tar.gz CMake-12d10a00ac03ad206e00cbec321e76415e2adbe0.tar.bz2 | |
Add missing documentation for include dirs related variables. (#12611)
Document CMAKE_INCLUDE_DIRECTORIES_BEFORE and
CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE.
| -rw-r--r-- | Help/command/include_directories.rst | 2 | ||||
| -rw-r--r-- | Help/manual/cmake-variables.7.rst | 2 | ||||
| -rw-r--r-- | Help/variable/CMAKE_INCLUDE_DIRECTORIES_BEFORE.rst | 8 | ||||
| -rw-r--r-- | Help/variable/CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE.rst | 8 |
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. |