Skip to content

Commit

Permalink
cli util gc: document the fact that evolution log limits gc
Browse files Browse the repository at this point in the history
This is a followup to the discussion in
#4953 (comment)
  • Loading branch information
ilyagr committed Nov 28, 2024
1 parent 8c5b39e commit a8792e0
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 0 deletions.
3 changes: 3 additions & 0 deletions cli/src/commands/util/gc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ use crate::ui::Ui;
///
/// To garbage-collect old operations and the commits/objects referenced by
/// then, run `jj op abandon ..<some old operation>` before `jj util gc`.
///
/// Note that previous versions of a change that are reachable via the evolution
/// log are not currently garbage-collected.
#[derive(clap::Args, Clone, Debug)]
pub struct UtilGcArgs {
/// Time threshold
Expand Down
2 changes: 2 additions & 0 deletions cli/tests/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -2268,6 +2268,8 @@ Run backend-dependent garbage collection.
To garbage-collect old operations and the commits/objects referenced by then, run `jj op abandon ..<some old operation>` before `jj util gc`.
At present, jj's garbage collection is not comprehensive. If a commit is preserved by the garbage collection, objects reachable from its evolution log cannot be garbage collected.
**Usage:** `jj util gc [OPTIONS]`
###### **Options:**
Expand Down

0 comments on commit a8792e0

Please sign in to comment.