From 1f554e801ff101e23810c179dde973f3ca15a8df Mon Sep 17 00:00:00 2001 From: Ilya Grigoriev Date: Sun, 24 Nov 2024 15:52:01 -0800 Subject: [PATCH] cli `util gc`: document the fact that evolution log limits gc This is a followup to the discussion in https://github.com/martinvonz/jj/pull/4953#discussion_r1855328098 --- cli/src/commands/util/gc.rs | 3 +++ cli/tests/cli-reference@.md.snap | 2 ++ 2 files changed, 5 insertions(+) diff --git a/cli/src/commands/util/gc.rs b/cli/src/commands/util/gc.rs index eef16ce00a..7080b35d2b 100644 --- a/cli/src/commands/util/gc.rs +++ b/cli/src/commands/util/gc.rs @@ -27,6 +27,9 @@ use crate::ui::Ui; /// /// To garbage-collect old operations and the commits/objects referenced by /// then, run `jj op abandon ..` before `jj util gc`. +/// +/// Previous versions of a change that are reachable via the evolution log are +/// not garbage-collected. #[derive(clap::Args, Clone, Debug)] pub struct UtilGcArgs { /// Time threshold diff --git a/cli/tests/cli-reference@.md.snap b/cli/tests/cli-reference@.md.snap index 0cd017aa4a..1cbd3cea98 100644 --- a/cli/tests/cli-reference@.md.snap +++ b/cli/tests/cli-reference@.md.snap @@ -2270,6 +2270,8 @@ Run backend-dependent garbage collection. To garbage-collect old operations and the commits/objects referenced by then, run `jj op abandon ..` before `jj util gc`. +Previous versions of a change that are reachable via the evolution log are not garbage-collected. + **Usage:** `jj util gc [OPTIONS]` ###### **Options:**