Lack of documentation for kdev-xdebug plugin

[Kevin Funk]

On Wednesday, 20 December 2017 12:00:16 CET santilin wrote:
> Yes, I have the motivation to do so.
> 
> I guess I should start off at
> https://userbase.kde.org/KDevelop5/Manual/Debugging_programs#Running_a_progr
> am_in_the_debugger and add a section to debug php applications, and then
> write about
> kdev-executebrowser and kdev-xdebug and who to set up them.

Yep. But maybe keep the notes about those two in a separate section, i.e. 
  https://userbase.kde.org/KDevelop5/Manual/Plugins:_PHP_Debugging (new)

Only link to that new sub-page in 
Debugging_programs#Running_a_program_in_the_debugger maybe.

Anyhow we/I can still shuffle around things later. Just the content needs to 
be there. Thanks!

Regards,
Kevin

> Is that all right?
> 
> On 20/12/17 00:34, Kevin Funk wrote:
> > On Tuesday, 19 December 2017 13:00:06 CET santilin wrote:
> >> Hi all, I have been striving to debug php with xdebug and the
> >> kdev-xdebug plugin for a while and I was to give up when I found a good
> >> documentation in the counterpart plugin for code :(.
> > 
> > Heya!
> > 
> > Thanks a lot for the patience and still going through the necessary setup
> > and even then coming back to us notifying us about the lacking
> > documentation. Great!
> > 
> > I don't know PHP debugging myself, but it would be super helpful if you
> > could> 
> > put up your notes on the KDE UserBase Wiki for KDevelop:
> >    https://userbase.kde.org/KDevelop5/Manual
> > 
> > Probably some extra section specifically for kdev-xdebug would be
> > appropriate,> 
> > like:
> >    https://userbase.kde.org/KDevelop5/Manual/Plugins:_Code_Generation
> > 
> > Do you have the time and motivation to do this? That'd be appreciated.
> > 
> > If you need any assistance, just ping us in #kdevelop on Freenode [1]
> > 
> > Regards,
> > Kevin
> > 
> > [1] https://www.kdevelop.org/contribute-kdevelop
> > 
> >> I would like to add that information to the kdevelop plugin so that
> >> other users can debug without problems. The relevant intormation is:
> >> 
> >> 
> >> Install XDebug I highly recommend you make a simple test.php file, put a
> >> phpinfo(); statement in there, then copy the output and paste it into
> >> the XDebug installation wizard. It will analyze it and give you tailored
> >> 
> >> installation instructions for your environment. In short:
> >>      On Windows: Download the appropiate precompiled DLL for your PHP
> >> 
> >> version, architecture (64/32 Bit), thread safety (TS/NTS) and Visual
> >> Studio compiler version and place it in your PHP extension folder.
> >> 
> >>      On Linux: Either download the source code as a tarball or clone it
> >> 
> >> with git, then compile it.
> >> 
> >> Configure PHP to use XDebug by adding zend_extension=path/to/xdebug to
> >> your php.ini. The path of your php.ini is shown in your phpinfo() output
> >> under "Loaded Configuration File".
> >> Enable remote debugging in your php.ini:
> >> 
> >> [XDebug]
> >> xdebug.remote_enable = 1
> >> xdebug.remote_autostart = 1
> >> 
> >> There are other ways to tell XDebug to connect to a remote debugger than
> >> remote_autostart, like cookies, query parameters or browser extensions.
> >> I recommend remote_autostart because it "just works". There are also a
> >> variety of other options, like the port (by default 9000), please see
> >> the XDebug documentation on remote debugging for more information.
> >> 
> >> If you are doing web development, don't forget to restart your webserver
> >> to reload the settings
> >> 
> >> Verify your installation by checking your phpinfo() output for an XDebug
> >> section.
> >> 
> >> Kind regards.


-- 
Kevin Funk | kfunk at kde.org | http://kfunk.org
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 163 bytes
Desc: This is a digitally signed message part.
URL: <http://mail.kde.org/pipermail/kdevelop-devel/attachments/20171220/4eecd1c7/attachment-0001.sig>