Merge topic 'help_toplevel'

2df4badc5f Help: Note PROJECT_IS_TOP_LEVEL behavior w.r.t. ExternalProject

Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !6307
This commit is contained in:
Brad King
2021-07-08 13:44:02 +00:00
committed by Kitware Robot
2 changed files with 20 additions and 0 deletions

View File

@@ -9,3 +9,13 @@ level ``CMakeLists.txt`` file.
To obtain the value from the most recent call to :command:`project` in
the current directory scope or above, see the
:variable:`PROJECT_IS_TOP_LEVEL` variable.
The variable value will be true in:
* the top-level directory of the project
* the top-level directory of an external project added by :module:`ExternalProject`
The variable value will be false in:
* a directory added by :command:`add_subdirectory`
* a directory added by :module:`FetchContent`

View File

@@ -19,3 +19,13 @@ options:
if(PROJECT_IS_TOP_LEVEL)
include(CTest)
endif()
The variable value will be true in:
* the top-level directory of the project
* the top-level directory of an external project added by :module:`ExternalProject`
The variable value will be false in:
* a directory added by :command:`add_subdirectory`
* a directory added by :module:`FetchContent`