From 44ffdd948740ca184ba9a69f884416b208499d2b Mon Sep 17 00:00:00 2001 From: tobinio Date: Sun, 28 Dec 2025 11:39:43 +0100 Subject: [PATCH] expand README about prune --- README.md | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eaf3df3..3d6e1e2 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,33 @@ You can run prune with `cargo features prune` this will disable all features which are not required to compile. +### flags + +*--dry-run* + +Run the prune process without modifying Cargo.toml. +All changes are reported, but nothing is written to disk. + +*--only-dependency, -d* + +Only consider features that enable optional dependencies. +This will improve runtime performance but will not disable all possible features. + +*--skip-tests* + +Skip compiling tests when checking whether a feature is required. +This speeds up pruning but may remove features only needed for tests. + +*--no-tmp, -t* + +Run prune directly in the current project directory instead of using a temporary copy. +This might be necessary for specific project setups. + +*--clean * + +Control how often `cargo clean` is run during pruning. +This can decrease disk usage but will increase runtime. + ### false positives Some features may not cause the compilation to fail but still remove functionality. To limit the extent of such cases we @@ -107,4 +134,4 @@ color-eyre = ["capture-spantrace", "track-caller"] [workspace.cargo-features-manager.keep] clap = ["default"] color-eyre = ["capture-spantrace", "track-caller"] -``` \ No newline at end of file +``` -- 2.51.2