Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

cli: Improve pruning documentation #12819

Merged
paritytech-processbot merged 13 commits into from
Dec 8, 2022
Merged

cli: Improve pruning documentation #12819

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
7ece645
cli: Improve pruning documentation
lexnv Dec 1, 2022
fdbc9a0
cli: Keep `finalized` notation and remove `canonical` one
lexnv Dec 1, 2022
804aff6
cli: Fix cargo doc
lexnv Dec 1, 2022
eb579bc
cli: `PruningModeClap` IR enum
lexnv Dec 5, 2022
7eb7956
cli: Convert PruningModeClap into pruning modes
lexnv Dec 5, 2022
8da7e10
cli: Use `PruningModeClap`
lexnv Dec 5, 2022
9cf6f5e
cli: Rename to `DatabasePruningMode`
lexnv Dec 5, 2022
9379757
cli: Implement `FromStr` instead of `clap::ValueEnum`
lexnv Dec 5, 2022
5356629
Update client/cli/src/params/pruning_params.rs
lexnv Dec 8, 2022
f25b491
Fix clippy
lexnv Dec 8, 2022
e3ffe3e
cli: Add option documentation back
lexnv Dec 8, 2022
a4e88bf
Merge remote-tracking branch 'origin/master' into lexnv/cli_db_docume…
lexnv Dec 8, 2022
aee8844
Apply suggestions from code review
bkchr Dec 8, 2022
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
Prev Previous commit
Next Next commit
cli: Keep finalized notation and remove canonical one
  • Loading branch information
@lexnv
lexnv authored Dec 1, 2022
commit fdbc9a09fb8b4eb84be4667996e3b9f72a506187
8 changes: 4 additions & 4 deletions client/cli/src/params/pruning_params.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ pub struct PruningParams {
///
/// Options available:
/// 'archive' Keep the state of all blocks.
/// 'archive-canonical' Keep only the state of finalized (canonical) blocks.
/// [number] Keep the state of the last number of finalized (canonical) blocks.
/// 'archive-canonical' Keep only the state of finalized blocks.
/// [number] Keep the state of the last number of finalized blocks.
///
/// The default option is to keep the last 256 blocks (number == 256).
#[arg(alias = "pruning", long, value_name = "PRUNING_MODE")]
Expand All @@ -43,8 +43,8 @@ pub struct PruningParams {
///
/// Options available:
/// 'archive' Keep all blocks.
/// 'archive-canonical' Keep only finalized (canonical) blocks.
/// [number] Keep the last number of finalized (canonical) blocks.
/// 'archive-canonical' Keep only finalized blocks.
/// [number] Keep the last number of finalized blocks.
///
/// The default option is 'archive-canonical'.
#[arg(alias = "keep-blocks", long, value_name = "COUNT")]
Expand Down