diff options
| author | Michael Hirsch <scivision@users.noreply.gitlab.kitware.com> | 2021-07-05 15:37:02 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2021-07-08 13:37:37 (GMT) |
| commit | 2df4badc5f5902ae6808cb3c4b0c3c8484686b5d (patch) | |
| tree | 5a29b5adc7fb182c443f5e237eb46b9da3fbb279 | |
| parent | eb692af623379085169229fe5c2c9d3fba3a020d (diff) | |
| download | CMake-2df4badc5f5902ae6808cb3c4b0c3c8484686b5d.zip CMake-2df4badc5f5902ae6808cb3c4b0c3c8484686b5d.tar.gz CMake-2df4badc5f5902ae6808cb3c4b0c3c8484686b5d.tar.bz2 | |
Help: Note PROJECT_IS_TOP_LEVEL behavior w.r.t. ExternalProject
Extend the documentation added by commit 96a7040107 (project: Define
variables indicating whether project is top level, 2021-03-24,
v3.21.0-rc1~443^2) to give some examples of how the variables are set in
each context.
| -rw-r--r-- | Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst | 10 | ||||
| -rw-r--r-- | Help/variable/PROJECT_IS_TOP_LEVEL.rst | 10 |
2 files changed, 20 insertions, 0 deletions
diff --git a/Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst b/Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst index 953e978..6718ecf 100644 --- a/Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst +++ b/Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst @@ -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` diff --git a/Help/variable/PROJECT_IS_TOP_LEVEL.rst b/Help/variable/PROJECT_IS_TOP_LEVEL.rst index e5eb6c1..ad61fec 100644 --- a/Help/variable/PROJECT_IS_TOP_LEVEL.rst +++ b/Help/variable/PROJECT_IS_TOP_LEVEL.rst @@ -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` |