Contributing Advent 22: Documenting changes
Probably one of the easier things to contribute to an Open Source project when you don't really have much experience, or simply don't know the language well enough—or in Xdebug's case, PHP's internals, is documentation. In the past a few people, such as Wim Godden and Jarl Ostensen have already contributed some documentation fixes.
In the last few months I have added support for serialized "collect params", XDEBUG_TRACE_NAKED_FILENAME (issue #971), XDEBUG_STACK_NO_DESC (issue #1003), and the ability to halt on warning/notice (issue #1004). And neither of those are documented now. So this article is about adding the documentation of these new features.
Xdebug's documentation is part of the website, which has a project on GitHub. However, it's not in any standard format. Functions are documented in single files, such as here for xdebug_start_trace(), and in a rather rudimentary format that some other tools I have use to generate stuff as well. So a bit tricky, and this is something I'd like to improve, however it's rather easy to add to.
Configuration settings are all in one file and stored as an nested PHP array. I have now added a new supported value (5) for xdebug.collect_params which needs documenting too, which is as simple as adding a new line to it. Of course, I have also documented the changes to xdebug_print_function_stack() and the addition of xdebug.halt_level.
Xdebug's documentation is (I think pretty good), but if you have sugggestions I would be more than happy to get suggestions, or of course even better would be a pull request.
Life Line
Created 6 benches, a main entrance, and a bicycle_parking; Updated 2 main entrances
Created 4 trees, a balancebeam, and 3 other objects; Updated 5 benches and 2 waste_baskets
Merge branch 'xdebug_3_5'
Merged pull request #1092
Use actual PID here, as we use that to be able to connect
Created 2 main entrances; Updated a vacant shop, a furniture shop, and a cafe; Confirmed an estate_agent office, a laundry shop, and 4 other objects
Merged pull request #1091
PHP 8.6: Fixed test expectation for 'debugInfo' name in error
Add 'strace' to run-xdebug-tests.php command
Oystercatcher Parent and Chick
Standing on the edge of a lake in the Arundel Wetlands.
#birds #birdPhotography #Birdsoffediverse #Photography #Nature #Wildlife
Updated 2 main entrances
Fixed tagging and bollard location
I hiked 8.7km in 4h4m28s
Updated a restaurant
Updated a restaurant
Updated a restaurant
I walked 5.5km in 56m26s
Created an entrance
I walked 5.7km in 1h20m50s
Updated a fitness_centre; Confirmed a charging_station
I walked 4.0km in 47m13s
I walked 1.1km in 9m32s
Also, whatnow‽
`GET /icons/blank.gif HTTP/1.1" 200 398 "https://downloads.php.net/~windows/pecl/releases/?utm_source=chatgpt.com`
WTF does that need an `utm_source` for?
I sometimes wish cache expiries could be fuzzy, like 900±15 seconds. Y'know, to prevent the thundering herd effect.
Created a chemist shop
Shortlink
This article has a short URL available: https://drck.me/adv1322-afh