docs: clarify prune commands#758
Merged
Merged
Conversation
Contributor
Greptile SummaryThis PR is a documentation-only change that clarifies the distinction between project-level cleanup (
Confidence Score: 5/5Safe to merge — all changes are help text and documentation strings with no runtime logic touched. Every change is limited to doc comments, string constants, KDL help blocks, generated JSON, and Markdown files. The wording is accurate and consistent across all eight changed files, and there are no modifications to executable code paths. No files require special attention. Important Files Changed
Reviews (2): Last reviewed commit: "docs: clarify prune commands" | Re-trigger Greptile |
1a33730 to
05ab94a
Compare
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
aube prunehelp and docs with lockfile/node_modules behavioraube store prunefor global store cleanupaube store prunescope, cached-index reachability, and hardlink/reflink behaviorValidation
cargo buildcargo fmt --check./target/debug/aube prune --help./target/debug/aube store prune --helpNote
Low Risk
Low risk: changes are limited to CLI help/long-help text and generated docs, with no changes to pruning behavior or data handling.
Overview
Clarifies the CLI/documentation for pruning by expanding
aube prunehelp text to explicitly describe its lockfile-driven cleanup of projectnode_modules(including virtual-store entries and.binlinks) without modifying manifests/lockfiles, and adds anafter_long_helphint pointing users toaube store prunefor global store cleanup.Adds detailed long help for
aube store prunedocumenting that it only operates on the global store returned byaube store path, and explains how cached indexes and hardlink vs reflink filesystems affect reachability. Regenerates the CLI docs/JSON to reflect these help updates.Reviewed by Cursor Bugbot for commit 05ab94a. Bugbot is set up for automated code reviews on this repo. Configure here.