-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Update FAQs.md to include debugging #2343
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
|
||
| ## How to enable logging | ||
|
|
||
| Enabling logging will show communication information between VS Code and our extension and between our extension and the debugger. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence seems a little vague. Maybe be more specific on what you mean when you say "our extension" and the "debugger" just in case people don't know what's being referred to?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Leslie and I talked offline. This is documentation in our repo so "this extension" should be clear but i'll change it to say "cpptools extension"
|
|
||
| ### Logging for `MI` debuggers | ||
|
|
||
| The logging block with its defaults is as follows: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it might be better to show code snippets with the values you want people to copy. If you redirect people here, they are likely to want to do that rather than see what the defaults are.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are different combinations depending on what the user wants to see.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, but the topic is called "how to enable logging" and I suspect not everyone is going to read deeply. You don't have to change it. It's just my 2 cents.
I don't imagine most people will know what an "MI" debugger is either.
|
What's the status of this? |
@bobbrow @sean-mcmanus @ronglums @WardenGnaw @grdowns
Let me know if you have feedback.
@leslierichardson95