View Issue Details

IDProjectCategoryView StatusLast Update
0001596XdebugDocumentationpublic2019-02-12 16:03
Reporterspeller3Assigned Toderick 
PrioritynormalSeverityminorReproducibilityalways
Status resolvedResolutionno change required 
Product Version 
Target VersionFixed in Version 
Summary0001596: Lack of documentation to set up xdebug without PEAR
DescriptionThe documentation is completely unclear for beginner to setup Xdebug and start working if not using PEAR.

1. Docs says: "add the correct line to your php.ini ... zend_extension=..." but nowhere you can find it should be under the "[Zend]" section. So users need to google "How to setup xdebug" or similar instead of reading original docs.

2. Full lust of config parameters is fine, but no any word thet parameters must be under the "[xdebug]" section. Again googling instead of reading original docs is required.

3. Windows installation page https://xdebug.org/wizard.php is completely useless. Instead of providing SIMPLE installation instructions you require to paste phpinfo output. WHAT????

4. The minimum working configuration can be as simple as 2x2:

[Zend]
zend_extension="c:\\develop\\soft\\php-7.2\\ext\\php_xdebug.dll"

[xdebug]
xdebug.remote_connect_back=On
xdebug.remote_autostart=On
xdebug.remote_enable=On

Instead of showing a simple example as starting point you are leaving users frustrating.
TagsNo tags attached.
Operating System
PHP Version7.2.5-7.2.9

Activities

derick

2018-12-13 15:57

administrator   ~0004770

Neither "1" or "2" are necessary, as the PHP php.ini parser ignores section headers. The "3" is there to help people and provides the easiest way to provide tailored instructions for your specific set-up. For "4", turning on xdebug.remote_autostart isn't always wise.

Instructions for compilation are at https://xdebug.org/docs/install#source
And instructions on how to set-up the debugger are on the debugger documentation page: https://xdebug.org/docs/remote#starting — both linked on the documentation page on the website: https://xdebug.org/docs/

So, what are you asking about specifically?

speller3

2019-01-09 06:23

reporter   ~0004796

1 and 2 - you are assuming users know that. After 10 years of PHP development (not configuring) I didn't know that.

3. It is still unclear where to find a starting point, sample php.ini config to start from. A lot of docs is good when user already have an experience. For me I was using XDebug for 5 years copy-pasting my initial php.ini config googled somewhere. Recently, when I tried to configure it from scratch on a new machine I was completely stucked.

derick

2019-01-22 22:17

administrator   ~0004829

Can you point out where in the docs it mentions your point 1 and 2? I don't believe I have written that anywhere, as I can't find that in the documentation on https://xdebug.org

I can look at an easier-to-look at bit to https://xdebug.org/docs/remote#starting for a minimal config, but the docs are all there in the first paragraph.

derick

2019-02-12 16:03

administrator   ~0004892

I'm closing this out as: a. I believe the documentation is clear enough, as long as you spend some time reading, and b. no additional information was provided after requesting feedback.

Feel free to reopen and add comments in case more information becomes available.

Issue History

Date Modified Username Field Change
2018-12-13 14:30 speller3 New Issue
2018-12-13 15:57 derick Note Added: 0004770
2018-12-13 15:57 derick Assigned To => derick
2018-12-13 15:57 derick Status new => feedback
2019-01-09 06:23 speller3 Note Added: 0004796
2019-01-09 06:23 speller3 Status feedback => assigned
2019-01-22 22:17 derick Note Added: 0004829
2019-01-22 22:17 derick Status assigned => feedback
2019-02-12 16:03 derick Note Added: 0004892
2019-02-12 16:03 derick Status feedback => resolved
2019-02-12 16:03 derick Resolution open => no change required