docs: mostly warn people off of using xdebug_ide_location #5857
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| @@ -666,7 +666,7 @@ Whether Xdebug should be enabled for [step debugging](../debugging-profiling/ste | |||
|
|
|||
| ## `xdebug_ide_location` | |||
|
|
|||
| Adjust Xdebug listen location for WSL2 or in-container. | |||
| Adjust Xdebug listen location for WSL2 or in-container. This is used very rarely, please don't change it unless you really know why. | |||
There was a problem hiding this comment.
Suggested change
| Adjust Xdebug listen location for WSL2 or in-container. This is used very rarely, please don't change it unless you really know why. | |
| Adjust Xdebug listen location for WSL2 or in-container. This is used very rarely, please don't change it unless you really know what you're doing. |
There was a problem hiding this comment.
Might make sense to add something like "seek advice in one of our support channels before making any of these changes unless you really know what you're doing" and link to https://ddev.com/support-ddev/#help-others or similar location
rfay
force-pushed
the
2240216_better_warning_about_xdebug_ide_location
branch
from
898d83a
to
ea4e55a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Issue
A user in Discord set xdebug_ide_location to
containerand didn't know why it didn't workHow This PR Solves The Issue
Try to get people not to use it except in the obscure situations it's needed for.