Skip to content

Conversation

@pieandcakes
Copy link
Contributor

@pieandcakes pieandcakes commented Jul 30, 2018


## How to enable logging

Enabling logging will show communication information between VS Code and our extension and between our extension and the debugger.

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?

Copy link
Contributor Author

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:
Copy link
Member

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.

Copy link
Contributor Author

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.

Copy link
Member

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.

@sean-mcmanus
Copy link
Contributor

What's the status of this?

@pieandcakes pieandcakes merged commit 2388fa9 into master Aug 8, 2018
@bobbrow bobbrow deleted the users/piel/FAQLogging branch August 16, 2018 16:23
@github-actions github-actions bot locked and limited conversation to collaborators Oct 14, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants