From 94de63effa4560e9e6e3432dddc6662517a00d46 Mon Sep 17 00:00:00 2001 From: Kyle Edwards Date: Fri, 7 Jan 2022 11:58:10 -0500 Subject: Guide: Recommend -C for IDE presets instead of -D Issue: #23083 --- Help/guide/ide-integration/index.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/Help/guide/ide-integration/index.rst b/Help/guide/ide-integration/index.rst index 779883b..0d818c2 100644 --- a/Help/guide/ide-integration/index.rst +++ b/Help/guide/ide-integration/index.rst @@ -65,6 +65,12 @@ run: cmake -S /path/to/source -B /path/to/source/build -G Ninja +In cases where a preset contains lots of cache variables, and passing all of +them as ``-D`` flags would cause the command line length limit of the platform +to be exceeded, the IDE should instead construct a temporary cache script and +pass it with the ``-C`` flag. See :ref:`CMake Options` for details on how the +``-C`` flag is used. + While reading, parsing, and evaluating the contents of ``CMakePresets.json`` is straightforward, it is not trivial. In addition to the documentation, IDE vendors may also wish to refer to the CMake source code and test cases for a -- cgit v0.12