diff options
| author | Brad King <brad.king@kitware.com> | 2022-01-10 22:11:00 (GMT) |
|---|---|---|
| committer | Kitware Robot <kwrobot@kitware.com> | 2022-01-10 22:11:13 (GMT) |
| commit | b9a40fd7ba0e9d0b63b9bb8ba57bd3c07c0c100c (patch) | |
| tree | 632ac8219df7b37537b8df8378524af913138471 | |
| parent | 1e839298b09a9140abcfde9cc0bd29770fecd345 (diff) | |
| parent | 94de63effa4560e9e6e3432dddc6662517a00d46 (diff) | |
| download | CMake-b9a40fd7ba0e9d0b63b9bb8ba57bd3c07c0c100c.zip CMake-b9a40fd7ba0e9d0b63b9bb8ba57bd3c07c0c100c.tar.gz CMake-b9a40fd7ba0e9d0b63b9bb8ba57bd3c07c0c100c.tar.bz2 | |
Merge topic 'cmake-ide-preset-command-line-length'
94de63effa Guide: Recommend -C for IDE presets instead of -D
Acked-by: Kitware Robot <kwrobot@kitware.com>
Acked-by: Bob Brown <bobbrow@microsoft.com>
Merge-request: !6846
| -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 |