cmake/Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst

29 lines
1009 B
ReStructuredText
Raw Normal View History

2021-09-14 00:13:48 +02:00
<PROJECT-NAME>_IS_TOP_LEVEL
---------------------------
.. versionadded:: 3.21
A boolean variable indicating whether the named project was called in a top
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
2022-08-04 22:12:04 +02:00
* the top-level directory of an external project added by
:module:`ExternalProject`
* a directory added by :command:`add_subdirectory` that does not also contain
a :command:`project` call
* a directory added by :command:`FetchContent_MakeAvailable`,
if the fetched content does not contain a :command:`project` call
2021-09-14 00:13:48 +02:00
The variable value will be false in:
2022-08-04 22:12:04 +02:00
* a directory added by :command:`add_subdirectory` that also contains
a :command:`project` call
* a directory added by :command:`FetchContent_MakeAvailable`,
if the fetched content contains a :command:`project` call