cli util gc: document the fact that it does not abandon operations

This UI will probably change eventually, but let's document it for now.
martinvonz · Nov 24, 2024 · 8c5b39e · 8c5b39e
1 parent 10c90a5
commit 8c5b39e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/cli/src/commands/util/gc.rs b/cli/src/commands/util/gc.rs
@@ -24,6 +24,9 @@ use crate::command_error::CommandError;
 use crate::ui::Ui;
 
 /// 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`.
 #[derive(clap::Args, Clone, Debug)]
 pub struct UtilGcArgs {
     /// Time threshold

diff --git a/cli/tests/[email protected] b/cli/tests/[email protected]
@@ -2264,7 +2264,9 @@ echo "args: $@"
 
 ## `jj util gc`
 
-Run backend-dependent garbage collection
+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`.
 
 **Usage:** `jj util gc [OPTIONS]`