Repository navigation
Conversation
Documentation previewCommit: |
skatkov
force-pushed
the
stream-search-index
branch
from
November 4, 2026 13:21
d227d77 to
9831f97
Compare
skatkov
marked this pull request as ready for review
November 5, 2026 00:55
This branch has not been deployed
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.
RDoc built the entire index in memory, then made two copies while preparing to save it. Resulting in 3 similar arrays of data stored in memory.
This PR brings a streaming approach to index creation: RDoc now writes one index entry at a time into a temporary file. Once everything is ready, it saves the finished index.
On the complete Google API Ruby Client documentation build—573 clients, 3,476 inputs, and 118,067 classes/modules—this reduced whole-build peak RSS from 4.33 GiB to 3.99 GiB, saving 350 MB (7.9%).
The tradeoff is temporary disk space.
This change mainly brings peak RSS memory improvements. I see that with different codebases it also brings performance improvement for entire documentation generation, but this improvement heavily depends on library size (more code, better the improvement).
For performance, I have observed improvements from 14% to -3% (again, depending on library size). For minimal libraries this brings negative performance improvements, but time-wise performance degradation for these is not noticeable.