Help: Clarify PROJECT_IS_TOP_LEVEL behavior w.r.t. add_subdirectory

Clarify documentation added by commit 2df4badc5f (Help: Note
PROJECT_IS_TOP_LEVEL behavior w.r.t. ExternalProject, 2021-07-05,
v3.21.0-rc3~1^2).

Fixes: #23511
This commit is contained in:
Michael Hirsch 2022-06-13 20:25:13 -04:00 committed by Brad King
parent 18687760f4
commit 75aedb1204
2 changed files with 20 additions and 6 deletions

View File

@ -13,9 +13,16 @@ the current directory scope or above, see the
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 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
The variable value will be false in:
* a directory added by :command:`add_subdirectory`
* a directory added by :module:`FetchContent`
* 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

View File

@ -24,9 +24,16 @@ options:
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 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
The variable value will be false in:
* a directory added by :command:`add_subdirectory`
* a directory added by :module:`FetchContent`
* 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