diff options
| author | Craig Scott <craig.scott@crascit.com> | 2024-02-21 23:33:21 (GMT) |
|---|---|---|
| committer | Craig Scott <craig.scott@crascit.com> | 2024-02-21 23:33:21 (GMT) |
| commit | fb14a54a2555f65595f81cd3c702f21b74947926 (patch) | |
| tree | 45fbbdaf066d4f0d3c9702c16a51db364e13b16c | |
| parent | 6fca88cde11df1f994156cbc9ea658ad0feda9d8 (diff) | |
| download | CMake-fb14a54a2555f65595f81cd3c702f21b74947926.zip CMake-fb14a54a2555f65595f81cd3c702f21b74947926.tar.gz CMake-fb14a54a2555f65595f81cd3c702f21b74947926.tar.bz2 | |
Help: Advise calling option(BUILD_SHARED_LIBS) early enough
Amends 01e33df83f (Help: Modernize BUILD_SHARED_LIBS
documentation, 2024-02-21) to highlight that BUILD_SHARED_LIBS
needs to be set early enough to prevent different behavior between
the first and subsequent runs.
| -rw-r--r-- | Help/variable/BUILD_SHARED_LIBS.rst | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/Help/variable/BUILD_SHARED_LIBS.rst b/Help/variable/BUILD_SHARED_LIBS.rst index dbb08f7..0e80f42 100644 --- a/Help/variable/BUILD_SHARED_LIBS.rst +++ b/Help/variable/BUILD_SHARED_LIBS.rst @@ -32,3 +32,12 @@ often create a cache entry for it using the :command:`option` command: option(BUILD_SHARED_LIBS "Build using shared libraries" ON) This provides a switch that users can control, e.g., with :option:`cmake -D`. +If adding such an option to the project, do so in the top level +``CMakeLists.txt`` file, before any :command:`add_library` calls. +Note that if bringing external dependencies directly into the build, such as +with :module:`FetchContent` or a direct call to :command:`add_subdirectory`, +and one of those dependencies has such a call to +:command:`option(BUILD_SHARED_LIBS ...) <option>`, the top level project must +also call :command:`option(BUILD_SHARED_LIBS ...) <option>` before bringing in +its dependencies. Failure to do so can lead to different behavior between the +first and subsequent CMake runs. |