|
1 | | -# FAQs |
2 | | - |
3 | | -## Table of Contents |
4 | | -* Setup: [Debugging Setup](#debugging-setup) |
5 | | -* Setup: [What is the .vscode/ipch folder?](#what-is-the-vscodeipch-folder) |
6 | | -* Setup: [How do I disable the IntelliSense cache (ipch)?](#how-do-i-disable-the-intellisense-cache-ipch) |
7 | | -* Debugger: [Why is debugging not working?](#why-is-debugging-not-working) |
8 | | -* Build: [How to enable debug symbols](#how-to-enable-debug-symbols) |
9 | | -* Logging: [How to enable logging](#how-to-enable-logging) |
10 | | - |
11 | | -## Debugging Setup |
12 | | -The debugger needs to be configured to know which executable and debugger to use: |
13 | | - |
14 | | -Click menu item: `Debug` -> `Add Configuration...` |
15 | | - |
16 | | -The file **launch.json** will now be open for editing with a new configuration. The default settings will *probably* work except that you need to specify the **program** setting. |
17 | | - |
18 | | -See the [**Documentation/Debugger**](https://github.com/Microsoft/vscode-cpptools/tree/master/Documentation/Debugger) folder in this repository for more in-depth documentation on how to configure the debugger. |
19 | | - |
20 | | -## What is the .vscode/ipch folder? |
21 | | - |
22 | | -The language server caches information about included header files to improve the performance of IntelliSense. When you edit C/C++ files in your workspace folder, the language server will store cache files in the `.vscode/ipch` folder by default. VS Code per-workspace storage folders were not selected for the following reasons: |
23 | | -* The workspace storage location provided by VS Code is somewhat obscure and we had reservations about writing GB's worth of files in this location where users may not see them or know where to find them. |
24 | | -* Parity with Visual Studio. This is how Visual Studio works and they receive little to no feedback/complaints on the location. |
25 | | - |
26 | | -With this in mind we knew that we wouldn't be able to please everyone, so we provided settings to allow you to customize this the way that works best for your situation. We also figured that putting the files in the workspace folder would bring the issue to your attention quickly so that you can take action if you don't like the default behavior. |
27 | | - |
28 | | -#### `"C_Cpp.intelliSenseCachePath": <string>` |
29 | | -This setting allows you to set workspace or global overrides for the cache path. For example, if you want to share a single cache location for all workspace folders, you just open the VS Code settings, and add a "User" setting for "IntelliSense Cache Path". |
30 | | - |
31 | | -#### `"C_Cpp.intelliSenseCacheSize": <number>` |
32 | | -This setting allows you to set a limit on the amount of caching the extension does. This is an approximation, but the extension will make a best effort to keep the cache size as close to the limit you set as possible. If you are sharing the cache location across workspaces as explained above, you can still increase/decrease the limit, but you should make sure that you add a "User" setting for "IntelliSense Cache Size". |
33 | | - |
34 | | -## How do I disable the IntelliSense cache (ipch)? |
35 | | - |
36 | | -If you do not want to use the IntelliSense caching feature to improve the performance of IntelliSense, you can disable the feature by setting the "IntelliSense Cache Size" setting to 0. (or `"C_Cpp.intelliSenseCacheSize": 0"` in the JSON settings editor) |
37 | | - |
38 | | -## Why is debugging not working? |
39 | | - |
40 | | -### My breakpoints aren't being hit |
41 | | - |
42 | | -When you start debugging, if it is showing that your breakpoints aren't bound (solid red circle) or they are not being hit, you may need to enable [debug symbols](#how-to-enable-debug-symbols) during compilation. |
43 | | - |
44 | | -### Debugging starts but all the lines in my stack trace are grey |
45 | | - |
46 | | -If your debugger is showing a grey stacktrace or won't stop at a breakpoint, or the symbols in the call stack are grey then your executable was compiled without [debug symbols](#how-to-enable-debug-symbols). |
47 | | - |
48 | | -## How to enable debug symbols? |
49 | | - |
50 | | -Enabling debug symbols are dependent on the type of compiler you are using. Below are some of the compilers and the compiler options necessary to enable debug symbols. |
51 | | - |
52 | | -When in doubt, please check your compiler's documentation for the options necessary to include debug symbols in the output. This may be some variant of `-g` or `--debug`. |
53 | | - |
54 | | -* #### Clang (C++) |
55 | | - * If you invoke the compiler manually then add the `--debug` option. |
56 | | - * If you're using a script then make sure the `CXXFLAGS` environment variable is set; e.g. `export CXXFLAGS="${CXXFLAGS} --debug"` |
57 | | - * If you're using CMake then set make sure the `CMAKE_CXX_FLAGS` is set; e.g. `export CMAKE_CXX_FLAGS=${CXXFLAGS}` |
58 | | - |
59 | | -* #### Clang (C) |
60 | | - See Clang C++ but use `CFLAGS` instead of `CXXFLAGS`. |
61 | | - |
62 | | -* #### gcc or g++ |
63 | | - If you invoke the compiler manually, add the `-g` option. |
64 | | - |
65 | | -* #### cl.exe |
66 | | - Symbols are located in the `*.pdb` file. |
67 | | - |
68 | | -## How to enable logging |
69 | | - |
70 | | -Enabling logging will show communication information between VS Code and our extension and between our extension and the debugger. |
71 | | - |
72 | | -### Logging for `MI` debuggers |
73 | | - |
74 | | -The logging block with its defaults is as follows: |
75 | | - |
76 | | -``` |
77 | | -"logging": { |
78 | | - "trace": false, |
79 | | - "traceResponse": false, |
80 | | - "engineLogging": false |
81 | | -} |
82 | | -``` |
83 | | - |
84 | | -#### VS Code and the CppTools extension |
85 | | - |
86 | | -The logging here is called `trace` logging and can be enabled by setting `trace` and `traceResponse` to `true` in the logging block inside `launch.json`. This will help diagnose issues related to VS Code's communication to our extension and our responses. |
87 | | - |
88 | | -#### CppTools extension and the debugger |
89 | | - |
90 | | -The logging between CppTools and the debugger is called `engineLogging`. When using an `MI` debugger such as `gdb` or `lldb`, this will show the request, response and events using the `mi` interpreter. This logging will help us determine whether the debugger is receiving the right commands and generating the correct responses. |
91 | | - |
92 | | -### Logging for `Visual C++` debugger |
93 | | - |
94 | | -The logging block with its defaults is as follows: |
95 | | - |
96 | | -``` |
97 | | -"logging": { |
98 | | - "engineLogging": false |
99 | | -} |
100 | | -``` |
101 | | - |
102 | | -The `Visual C++` debugger logging will show only the communication to and from VS Code as all communication to the debugger is done internally to the process and is not visible through logging. |
| 1 | +The FAQs for the C/C++ extension has moved to https://code.visualstudio.com/docs/cpp/faq-cpp. |
0 commit comments