Update debugging.md #1323
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
| with Xdebug v3.0.2, Copyright (c) 2002-2021, by Derick Rethans | ||
| … | ||
| ``` | ||
|
|
There was a problem hiding this comment.
These extra blank lines must be removed.
moved comments around
`Fenced code blocks should have a language specified`
distribution/debugging.md
Outdated
| remote_handler=dbgp | ||
| ``` | ||
| In VSCode, alongside the default php config in `launch.json`, you'll need path mappings for a docker image. |
There was a problem hiding this comment.
I don't think it's a good idea to add IDE specific related configuration.
There was a problem hiding this comment.
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.
I'm in favor of having docs for VSCode and PHPStorm as it's the two most popular tools in the PHP world.
distribution/debugging.md
Outdated
| remote_port=9000 | ||
| idekey=PHPSTORM | ||
| client_host=host.docker.internal | ||
| client_port=9003 |
There was a problem hiding this comment.
I don't think this line is necessary. This is the default port for Xdebug 3.
There was a problem hiding this comment.
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.
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! |
3 participants
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?