From 2df4badc5f5902ae6808cb3c4b0c3c8484686b5d Mon Sep 17 00:00:00 2001 From: Michael Hirsch Date: Mon, 5 Jul 2021 11:37:02 -0400 Subject: 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. --- Help/variable/PROJECT-NAME_IS_TOP_LEVEL.rst | 10 ++++++++++ Help/variable/PROJECT_IS_TOP_LEVEL.rst | 10 ++++++++++ 2 files changed, 20 insertions(+) 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` -- cgit v0.12