Dev/gcampbell/add load compile commands docs (#3746)

* Style: Clean-up

* Remove redundant whitespace characters and exports

* update docs

---------

Co-authored-by: Orkun Tokdemir <orkun.tokdemir@qt.io>
This commit is contained in:
Garrett Campbell 2024-05-10 09:13:41 -04:00 коммит произвёл GitHub
Родитель 3bc2567d2d
Коммит a5b3992e19
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: B5690EEEBB952194
1 изменённых файлов: 1 добавлений и 0 удалений

Просмотреть файл

@ -22,6 +22,7 @@ Options that support substitution, in the table below, allow variable references
| `cmake.configureOnEdit` | Automatically configure CMake project directories when the path in the `cmake.sourceDirectory` setting is updated or when `CMakeLists.txt` or `*.cmake` files are saved. | `true` | no |
| `cmake.configureOnOpen` | Automatically configure CMake project directories when they are opened. | `null` (prompt for configure) | no |
| `cmake.configureSettings` | An object containing `key:value` pairs, which will be passed to CMake when configuring. The same as passing `-DVAR_NAME=ON` via `cmake.configureArgs`. NOTE: If you are setting an array argument within `cmake.configureSettings`, you should use array notation, i.e. `"CONFIGURE_SETTINGS_LIST": [ "a", "b" ]` | `null` (no values) | yes |
| `cmake.loadCompileCommands` | Controls whether the extension reads compile_commands.json to enable single file compilation. | `true` | no |
| `cmake.copyCompileCommands`| If not `null`, copies the `compile_commands.json` file generated by CMake to the path specified by this setting whenever CMake successfully configures. | `null` (do not copy the file) | yes |
| `cmake.debugConfig`| The debug configuration to use when debugging a target | `null` (no values) | yes |
| `cmake.defaultVariants` | Override the default set of variants that will be supplied when no variants file is present. See [CMake variants](variants.md). | | no |