Files
CMake/Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst
Michael Hirsch 2df4badc5f 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.
2021-07-08 09:37:37 -04:00

22 lines
648 B
ReStructuredText

<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
* 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`