mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-06 13:51:33 -06:00
Code Issues Packages Projects Releases Wiki Activity

project: Define variables indicating whether project is top level

Browse Source 
Define `PROJECT_IS_TOP_LEVEL` and `<PROJECT-NAME>_IS_TOP_LEVEL`.  The
latter is a STATIC cache entry just like other `<PROJECT-NAME>_*`
variables so that it is globally scoped.

Issue: #20310
Fixes: #21961
This commit is contained in:
friendlyanon
2021-03-24 19:59:14 +00:00
committed by Brad King
parent 3706e9c97c
commit 96a7040107
14 changed files with 100 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
Help/variable/PROJECT_IS_TOP_LEVEL.rst Normal file
View File

@@ -0,0 +1,21 @@
PROJECT_IS_TOP_LEVEL
--------------------
.. versionadded:: 3.21
A boolean variable indicating whether :command:`project` was called in a top
level ``CMakeLists.txt`` file.
Some modules should only be included as part of the top level
``CMakeLists.txt`` file to not cause unintended side effects in the build
tree, and this variable can be used to conditionally execute such code. For
example, consider the :module:`CTest` module, which creates targets and
options:
.. code-block:: cmake
project(MyProject)
...
if(PROJECT_IS_TOP_LEVEL)
include(CTest)
endif()