summaryrefslogtreecommitdiff
path: root/Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst
diff options
context:
space:
mode:
Diffstat (limited to 'Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst')
-rw-r--r--Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst b/Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst
new file mode 100644
index 000000000..6718ecfd9
--- /dev/null
+++ b/Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst
@@ -0,0 +1,21 @@
+<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`