write the environment variables page and drop cli options - #24
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.
Writes the Environment Variables reference page and removes CLI Options, which had nothing to document — the debugger has no command-line options of its own.
Six variables in alphabetical order under the
PHP_DEBUGGER_prefix:CONFIG,IGNORE,MODE,SESSION,SESSION_START,TRIGGER. ThenDBGP_IDEKEYandDBGP_COOKIE, which have no renamed form, and a closing note on theXDEBUG_prefix.Verified against
upstream/mainand by running 0.3.3:PHP_DEBUGGER_CONFIGaccepts exactly eight keys, taken from the parser rather than assumed:client_host,client_port,discover_client_host,cloud_id,idekey,log,log_level,on_demand_debugging_enabledPHP_DEBUGGER_IGNOREignores the request on any value exceptnoand0PHP_DEBUGGER_SESSION_STARTworks from the environment as well as from a request, taking its value as the session identifier; the cookie behaviour is the HTTP-only partDBGP_IDEKEY(debugger.c:77, called fromdebugger.c:882) andDBGP_COOKIE(handler_dbgp.c:2585) are both liveAlso corrects a factual error on a page already published. Starting the Debugger said triggers were looked for "in the environment first, then
$_GET, then$_POST, then$_COOKIE". That is backwards:xdebug_lib_find_in_globals()checks$_GET,$_POST,$_COOKIEand reaches the environment last — the source comment reads "Environment. This goes last." So a query parameter beats an environment variable of the same name.Deleting CLI Options broke the build on all 30 routes, because the navbar's Reference link pointed at it. Repointed to
/reference/settings.