-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Update debugging.md #1323
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
Update debugging.md #1323
Conversation
Xdebug 3 no longer uses the remote_ convention, they have been removed in Xdebug 3. Need XDEBUG_MODE: debug for step debugging Added sample launch.json for .vscode These changes are all for Ubuntu 20.04, so maybe the different configs could be separated out?
distribution/debugging.md
Outdated
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.
These extra blank lines must be removed.
moved comments around
`Fenced code blocks should have a language specified`
distribution/debugging.md
Outdated
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 don't think it's a good idea to add IDE specific related configuration.
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 for 99% of the docs that is definitely the case, but in the case of debugging, particularly step debugging, it is inherently tied to an IDE. Before my modifications there were already specifics things to php storm in this doc, and there are mentions of php storm and vs code in the recommended IDEs for API Platform. Docker is also recommended, and this path mapping is a quirk of docker and API platform together.
If the intent is to be IDE agnostic, then there likely shouldn't be recommendations to use php storm and vs code elsewhere.
For me, knowing this config info would have saved me a few hours, and this doesn't clutter up the docs much.
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'm in favor of having docs for VSCode and PHPStorm as it's the two most popular tools in the PHP world.
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.
Ok then 😄
distribution/debugging.md
Outdated
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 don't think this line is necessary. This is the default port for Xdebug 3.
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'm happy to remove it, but the line I'm replacing remote_port=9000 was also an unnecessary line, as the default port for Xdebug 2 was 9000 - I'm not sure if the intent was to just be informative?
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 don't know but I think it's safe to remove it.
Co-authored-by: Alan Poulain <contact@alanpoulain.eu>
removed reduntant port setting
Co-authored-by: Alan Poulain <contact@alanpoulain.eu>
Thank you @brettins!
Xdebug 3 no longer uses the remote_ convention, they have been removed in Xdebug 3.
Need XDEBUG_MODE: debug for step debugging
Added sample launch.json for .vscode
These changes are all for Ubuntu 20.04, so maybe the different configs could be separated out?