cli util gc: document the fact that it does not abandon operations
Some checks are pending
build / build (, macos-13) (push) Waiting to run
build / build (, macos-14) (push) Waiting to run
build / build (, ubuntu-latest) (push) Waiting to run
build / build (, windows-latest) (push) Waiting to run
build / build (--all-features, ubuntu-latest) (push) Waiting to run
build / Build jj-lib without Git support (push) Waiting to run
build / Check protos (push) Waiting to run
build / Check formatting (push) Waiting to run
build / Check that MkDocs can build the docs (push) Waiting to run
build / Check that MkDocs can build the docs with latest Python and uv (push) Waiting to run
build / cargo-deny (advisories) (push) Waiting to run
build / cargo-deny (bans licenses sources) (push) Waiting to run
build / Clippy check (push) Waiting to run

This UI will probably change eventually, but let's document it for now.
This commit is contained in:
Ilya Grigoriev 2024-11-22 20:07:58 -08:00
parent 7906b3f4a5
commit 232ff86bfa
2 changed files with 6 additions and 1 deletions

View file

@ -24,6 +24,9 @@ use crate::command_error::CommandError;
use crate::ui::Ui; use crate::ui::Ui;
/// 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`.
#[derive(clap::Args, Clone, Debug)] #[derive(clap::Args, Clone, Debug)]
pub struct UtilGcArgs { pub struct UtilGcArgs {
/// Time threshold /// Time threshold

View file

@ -2264,7 +2264,9 @@ echo "args: $@"
## `jj util gc` ## `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]` **Usage:** `jj util gc [OPTIONS]`