From b99eebb47f092e24ccda689233e388126cc4bf4c Mon Sep 17 00:00:00 2001 From: Kai Pastor Date: Sat, 10 Dec 2022 00:26:12 +0100 Subject: [PATCH] [doc] Replace "Build Mode" with "Project Mode" (#28196) * [doc] Replace "Build Mode" with "Project Mode" CMake clearly separates commands into "Scripting Commands" and "Project Commands", thus implying an official terminology for both modes. * Update --- docs/maintainers/maintainer-guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/maintainers/maintainer-guide.md b/docs/maintainers/maintainer-guide.md index d02da50546b5a1..47703b246a2fa5 100644 --- a/docs/maintainers/maintainer-guide.md +++ b/docs/maintainers/maintainer-guide.md @@ -410,11 +410,11 @@ We require that the manifest file be formatted. Use the following command to for ### Portfiles are run in Script Mode -While `portfile.cmake`'s and `CMakeLists.txt`'s share a common syntax and core CMake language constructs, portfiles run in "Script Mode", whereas `CMakeLists.txt` files run in "Build Mode" (unofficial term). The most important difference between these two modes is that "Script Mode" does not have a concept of "Target" -- any behaviors that depend on the "target" machine (`CMAKE_CXX_COMPILER`, `CMAKE_EXECUTABLE_SUFFIX`, `CMAKE_SYSTEM_NAME`, etc) will not be correct. +While `portfile.cmake`'s and `CMakeLists.txt`'s share a common syntax and core CMake language constructs (aka "Scripting Commands"), portfiles run in "Script Mode", whereas `CMakeLists.txt` files run in "Project Mode". The most important difference between these two modes is that "Script Mode" does not have the concepts of "Toolchain", "Language" and "Target". Any behaviors, including scripting commands, which depend on these constructs (e.g. `CMAKE_CXX_COMPILER`, `CMAKE_EXECUTABLE_SUFFIX`, `CMAKE_SYSTEM_NAME`) will not be correct. Portfiles have direct access to variables set in the triplet file, but `CMakeLists.txt`s do not (though there is often a translation that happens -- `VCPKG_LIBRARY_LINKAGE` versus `BUILD_SHARED_LIBS`). -Portfiles and CMake builds invoked by portfiles are run in different processes. Conceptually: +Portfiles and Project builds invoked by portfiles are run in different processes. Conceptually: ```no-highlight +----------------------------+ +------------------------------------+