[Sync-EN] Revise the Yaconf extension documentation - #1804
Open
lacatoire wants to merge 1 commit into
Open
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.
Syncs the
reference/yaconf/pages with php/doc-en#5801.book.xml: the introduction is rewritten around what the extension actually does: parsing at startup with no per-request I/O, zero-copy retrieval, the 1.2.0 compacted storage block, the copy-on-write sharing between PHP-FPM workers, the ZTS restriction on automatic reloading, the 1.2.0 recursive sub-directory loading, and the attack-surface argument for keeping the INI files outside the web tree.setup.xml: documents the three installation routes, PECL, PIE (pie install laruence/yaconf, since 1.2.0) and building from source, each with its own example.ini.xml:yaconf.directorycomes first, with its real default (empty, not/tmp/conf/), the.iniextension requirement and the recursive sub-directory behaviour, plus the INI syntax and section inheritance examples moved here from the book.yaconf.check_delayexplains that0means checking on every request, not that a restart is required, and gains the note that the directive only exists in non-ZTS builds.Yaconf::get()andYaconf::has(): the dot notation is documented, including the 64 nesting levels and the sub-directory addressing, with worked examples;Yaconf::get()documents thedefaultparameter and what is returned when the key is missing.Yaconf::__debug_info(), translating the new page, with the warning that it exists only for the extension's own test suite.reference/yaconf/versions.xmlis not added: it is EN-only infrastructure with no Russian counterpart.EN-Revision bumped to 3b052562d228be18fa6dce221df7e375469fb7ad on the six files.
Fixes: #1702