Enhance the Yac extension documentation - #5810
Merged
Merged
Conversation
- Highlight the performance characteristics of the lock-free design and document the embedded values and the LZ4 compression backend introduced in yac 2.4.0 in the introduction - Fill in the Yac class introduction and the _prefix property, and describe the overloaded property access - Document the deferred-expiry semantics of Yac::delete(): entries are only marked expired, slots_used does not decrease, expired entries still show up in the dump and must be filtered by the caller - Document that Yac::dump() $offset is available as of 2.4.0, and that passing -1 as $limit dumps all entries - Document installing yac with PIE (as of 2.3.2) and the switch from FastLZ to LZ4 in 2.4.0
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
book.xml): highlight that the lock-free shared-memory design makes Yac extremely fast, and document the embedded values and the LZ4 compression backend introduced in yac 2.4.0yac.xml): fill in the class introduction, the_prefixproperty and the overloaded property accessYac::delete(): document the deferred-expiry semantics — entries are only marked expired,slots_useddoes not decrease, expired entries still show up in the dump and have to be filtered out by the caller; also fix the return-value semantics for repeated and multi-key deletionsYac::dump(): document that$offsetis available as of 2.4.0, and that passing-1as$limitdumps all entriessetup.xml): document installing yac with PIE (as of 2.3.2) and the switch from FastLZ to LZ4 in 2.4.0All version facts were verified against the yac 2.4.0 source code and confirmed with a live yac.so build.
Test plan
php configure.php(doc-base) passesdocbook-csstyle check passes with zero findings