Skip to content

Commit 9ed1ec6

Browse files
authored
Update Getting started.md
1 parent 9b11449 commit 9ed1ec6

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

Documentation/Getting started.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,5 @@ In order to get accurate IntelliSense results with either engine, the extension
1919

2020
This command will create or open a file called **c_cpp_properties.json** in your workspace. In this file, you can specify the paths to the headers that your project depends on. There are two settings in this file that you should pay particular attention to: `"includePath"` and `"browse.path"`. `"includePath"` is the setting used by the `"Default"` IntelliSense engine and `"browse.path"` is the setting used by the tag parser engine. [More information about these settings is documented here](https://github.com/Microsoft/vscode-cpptools/blob/master/Documentation/LanguageServer/FAQ.md#what-is-the-difference-between-includepath-and-browsepath-in-c_cpp_propertiesjson).
2121

22+
If your build system is able to produce a compile_commands.json file, the extension can get the information for the `"includePath"` and `"defines"` from that. Set the `"compileCommands"` property to the full path to your compile_commands.json file and the extension will use that instead of the `"includePath"` and `"defines"` properties for IntelliSense. You should still set the `"browse.path"` property since code navigation uses that property.
23+

0 commit comments

Comments
 (0)