cli util gc: document the fact that evolution log limits gc

This is a followup to the discussion in #4953 (comment)
jj-vcs · Nov 24, 2024 · 718cc66 · 718cc66
1 parent 8c5b39e
commit 718cc66
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/cli/src/commands/util/gc.rs b/cli/src/commands/util/gc.rs
@@ -27,6 +27,10 @@ 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`.
+///
+/// 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.
 #[derive(clap::Args, Clone, Debug)]
 pub struct UtilGcArgs {
     /// Time threshold

diff --git a/cli/tests/[email protected] b/cli/tests/[email protected]
@@ -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:**