write the settings reference page - #21
Merged
Merged
Conversation
|
This file contains hidden or 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
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.
First page of the Reference section. Renames the
configuration-fileplaceholder tosettingsand writes it, listing every setting alphabetically with type, default, where it can be set, an explanation and an ini example.Placed first in Reference, ahead of CLI Options.
Read from
origin/main, not the local checkout. The working copy sits on a feature branch whosexdebug.cdiffers from main, including four settings main has that the branch does not.24 settings exist on main; 19 are documented. The page's headings were diffed against every
"php_debugger.*"string inorigin/main:xdebug.c— exact match before the five below were dropped, and confirmed alphabetical. Note thatstart_with_request,start_upon_errorandcontrol_socketusePHP_INI_ENTRY_EXrather thanSTD_PHP_INI_ENTRY, so a naive grep misses them.The five omitted are registered and stored but never read anywhere in
src/—file_link_format,filename_format,max_nesting_level,output_diranduse_compression. They belong to features this project does not have. They are left undocumented rather than described as inert.Also settled from the source:
php_debugger.wins only when explicitly setstart_upon_erroris enabled byyesalone;defaultandnoboth mean offmodeis logged and falls back todebug(xdebug.c:510), confirmed by runningphp -d php_debugger.mode=bogus, which still reports the step debugger as enabled