diff options
| author | Kyle Edwards <kyle.edwards@kitware.com> | 2022-01-07 16:58:10 (GMT) |
|---|---|---|
| committer | Kyle Edwards <kyle.edwards@kitware.com> | 2022-01-07 17:43:53 (GMT) |
| commit | 94de63effa4560e9e6e3432dddc6662517a00d46 (patch) | |
| tree | db14ef13759098dc38e7110fab85aa9c8680918b /Help/guide | |
| parent | b996e576c24c67702c458d16c76a916732ddf024 (diff) | |
| download | CMake-94de63effa4560e9e6e3432dddc6662517a00d46.zip CMake-94de63effa4560e9e6e3432dddc6662517a00d46.tar.gz CMake-94de63effa4560e9e6e3432dddc6662517a00d46.tar.bz2 | |
Guide: Recommend -C for IDE presets instead of -D
Issue: #23083
Diffstat (limited to 'Help/guide')
| -rw-r--r-- | Help/guide/ide-integration/index.rst | 6 |
1 files changed, 6 insertions, 0 deletions
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 |