Fixed pruning docs (#11519)

This commit is contained in:
Sergej Sakac
2022-05-28 11:55:51 +02:00
committed by GitHub
parent 678fd0f52f
commit ccbab1beea
2 changed files with 5 additions and 4 deletions
@@ -25,9 +25,9 @@ use sc_service::{KeepBlocks, PruningMode};
pub struct PruningParams { pub struct PruningParams {
/// Specify the state pruning mode, a number of blocks to keep or 'archive'. /// Specify the state pruning mode, a number of blocks to keep or 'archive'.
/// ///
/// Default is to keep all block states if the node is running as a /// Default is to keep only the last 256 blocks,
/// validator (i.e. 'archive'), otherwise state is only kept for the last /// otherwise, the state can be kept for all of the blocks (i.e 'archive'),
/// 256 blocks. /// or for all of the canonical blocks (i.e 'archive-canonical').
#[clap(long, value_name = "PRUNING_MODE")] #[clap(long, value_name = "PRUNING_MODE")]
pub pruning: Option<String>, pub pruning: Option<String>,
/// Specify the number of finalized blocks to keep in the database. /// Specify the number of finalized blocks to keep in the database.
+2 -1
View File
@@ -239,7 +239,7 @@ impl PruningMode {
} }
} }
/// Is this an archive (either ArchiveAll or ArchiveCanonical) pruning mode? /// Returns the pruning mode
pub fn id(&self) -> &[u8] { pub fn id(&self) -> &[u8] {
match self { match self {
PruningMode::ArchiveAll => PRUNING_MODE_ARCHIVE, PruningMode::ArchiveAll => PRUNING_MODE_ARCHIVE,
@@ -247,6 +247,7 @@ impl PruningMode {
PruningMode::Constrained(_) => PRUNING_MODE_CONSTRAINED, PruningMode::Constrained(_) => PRUNING_MODE_CONSTRAINED,
} }
} }
pub fn from_id(id: &[u8]) -> Option<Self> { pub fn from_id(id: &[u8]) -> Option<Self> {
match id { match id {
PRUNING_MODE_ARCHIVE => Some(Self::ArchiveAll), PRUNING_MODE_ARCHIVE => Some(Self::ArchiveAll),