Revise the Yaconf extension documentation - #5801
Merged
Merged
Conversation
* Rewrite the Yaconf class documentation with up-to-date method signatures, including the previously undocumented __debug_info() method added in 1.2.0 * Document the Yaconf 1.2.0 features: compact block storage, sub-directory support and ZTS reloading behaviour * Add installation instructions for PECL, PIE and building from source, and mention the security benefit of storing configuration files outside the web root * Move the INI file examples next to the yaconf.directory description and give the example file names and keys meaningful names * Register __debug_info in versions.xml
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
2 participants
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.
Summary
Yaconf::__debug_info()method (added in 1.2.0, now also registered inversions.xml)yaconf.directory/yaconf.check_delaydescriptionsyaconf.directorydescription and give the example file names and keys meaningful namesTest plan
php doc-base/configure.phppasses (XML validation)docbook-csstyle check passes on the diff