Skip to content

docs(cli): enhance documentation for memory block buffer target configuration #19957

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0xSooki wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −0
Open

docs(cli): enhance documentation for memory block buffer target configuration #19957

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions crates/node/core/src/args/engine.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ pub struct EngineArgs {
pub persistence_threshold: u64,

/// Configure the target number of blocks to keep in memory.
///
/// This represents the number of most recent blocks to keep in memory for quick access and reorgs.
///
/// This target is maintained after flushing canonical blocks to disk (controlled by
/// --engine.persistence-threshold).
#[arg(long = "engine.memory-block-buffer-target", default_value_t = DEFAULT_MEMORY_BLOCK_BUFFER_TARGET)]
pub memory_block_buffer_target: u64,

Expand Down
4 changes: 4 additions & 0 deletions docs/vocs/docs/pages/cli/reth/node.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -880,6 +880,10 @@ Engine:
--engine.memory-block-buffer-target <MEMORY_BLOCK_BUFFER_TARGET>
Configure the target number of blocks to keep in memory

This represents the number of most recent blocks to keep in memory for quick access and reorgs.

This target is maintained after flushing canonical blocks to disk (controlled by --engine.persistence-threshold).

[default: 0]

--engine.legacy-state-root
Expand Down