php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #76503 phpdbg docs have wrong userland function names
Submitted: 2018-06-20 08:29 UTC Modified: 2018-06-24 16:23 UTC
From: wosc+php at wosc dot de Assigned: cmb (profile)
Status: Closed Package: phpdbg
PHP Version: 7.1.18 OS:
Private report: No CVE-ID: None
View Add Comment Developer Edit
Welcome! If you don't have a Git account, you can't do anything here.
You can add a comment by following this link or if you reported this bug, you can edit this bug over here.
(description)
Block user comment
Status: Assign to:
Package:
Bug Type:
Summary:
From: wosc+php at wosc dot de
New email:
PHP Version: OS:

 

 [2018-06-20 08:29 UTC] wosc+php at wosc dot de
Description:
------------
https://phpdbg.room11.org/getting-started.html talks about a "phpdbg_break()" PHP function, which however has been renamed to "phpdbg_break_next()" in PHP-7 (https://github.com/php/php-src/commit/29446f2f043fd3eeb6fbb800389348a1418c148d)

This is really confusing if you're new to phpdbg, because you're of course greeted with "Call to undefined function".

(Also, there seem to be no docs for all the other userland functions.)


Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2018-06-24 15:09 UTC] cmb@php.net
-Status: Open +Status: Closed -Assigned To: +Assigned To: cmb
 [2018-06-24 15:09 UTC] cmb@php.net
The docs on <https://phpdbg.room11.org/> have to be considered
obsolete.  We're in the process of integrating phpdbg
documentation into the PHP manual[1] (contributions are welcome!),
where at least basic documentation of the phpdbg functions is
already available.

[1] <http://php.net/manual/en/book.phpdbg.php>
 [2018-06-24 15:53 UTC] wosc+php at wosc dot de
http://php.net/manual/en/book.phpdbg.php looks great!

It would be helpful if you could remove the misleading room1 link -- if you type "debugger" into the php.net search, the first hit is http://php.net/manual/en/debugger-about.php
which links to http://php.net/manual/en/migration56.new-features.php#migration56.new-features.phpdbg which links to https://phpdbg.room11.org/
 [2018-06-24 16:23 UTC] cmb@php.net
> It would be helpful if you could remove the misleading room1
> link […]

I suppose most users are more interested on how to use phpdbg
interactively instead of programmatically, and these still find
more relevant information in the original docs.  Therefore I
suggest to keep the old link until bug #67165 will be resolved.
 
PHP Copyright © 2001-2020 The PHP Group
All rights reserved.
Last updated: Mon Oct 19 20:01:23 2020 UTC