Skip to content

Commit

Permalink
Dev/gcampbell/add load compile commands docs (#3746)
Browse files Browse the repository at this point in the history
* Style: Clean-up

* Remove redundant whitespace characters and exports

* update docs

---------

Co-authored-by: Orkun Tokdemir <[email protected]>
  • Loading branch information
gcampbell-msft and OrkunTokdemir authored May 10, 2024
1 parent 3bc2567 commit a5b3992
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions docs/cmake-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
Expand Down

0 comments on commit a5b3992

Please sign in to comment.