Repository navigation
docs(config): update example to include max_file_size - #3125
Merged
Merged
Conversation
pszymkowiak
approved these changes
Jul 25, 2026
pszymkowiak
left a comment
Collaborator
There was a problem hiding this comment.
Verified this is a real bug, not just a cosmetic doc gap: copying the current docs example verbatim (with a [tee] section, no max_file_size) produces a hard TOML parse failure:
rtk: TOML parse error at line 17, column 1
|
17 | [tee]
| ^^^^^
missing field `max_file_size`
Root cause: TeeConfig::max_file_size (src/core/tee.rs) has no #[serde(default)], unlike the top-level tee field on RtkConfig which defaults only when the whole [tee] section is absent. So: no [tee] section → fine; [tee] section present but missing max_file_size → hard parse error, exactly what the previous docs example triggered.
With the PR's added line (max_file_size = 1048576, matching DEFAULT_MAX_FILE_SIZE in tee.rs), the same config parses cleanly. Minimal, accurate, one-line fix. Approving.
Merged
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.
Summary
max_file_size.Test plan
adding the value to my config allowed rtk to successfully parse it
cargo fmt --all && cargo clippy --all-targets && cargo testrtk <command>output inspected