Skip to content

Commit

Permalink
cli util gc: document the fact that it does not abandon operations
Browse files Browse the repository at this point in the history
This UI will probably change eventually, but let's document it for now.
  • Loading branch information
ilyagr committed Nov 23, 2024
1 parent 7906b3f commit 232ff86
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
3 changes: 3 additions & 0 deletions cli/src/commands/util/gc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion cli/tests/[email protected]
Original file line number Diff line number Diff line change
Expand Up @@ -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]`
Expand Down

0 comments on commit 232ff86

Please sign in to comment.