mirrors/jj
1
0
Fork 1
mirror of https://github.com/martinvonz/jj.git synced 2025-01-15 08:53:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 9

cli: try to clarify the help texts for jj op commands a little

Browse source
This commit is contained in:
Martin von Zweigbergk 2023-03-15 20:32:39 -07:00 committed by Martin von Zweigbergk
parent 0bbf146469
commit 0899260f0c
1 changed files with 16 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
src/commands/operation.rs
View file

@ -10,8 +10,8 @@ use crate::ui::Ui;
/// Commands for working with the operation log
///
/// Commands for working with the operation log. For information about the
/// operation log, see https://github.com/martinvonz/jj/blob/main/docs/operation-log.md.
/// For information about the operation log, see
/// https://github.com/martinvonz/jj/blob/main/docs/operation-log.md.
#[derive(Subcommand, Clone, Debug)]
pub enum OperationCommands {
Log(OperationLogArgs),
@ -29,17 +29,29 @@ pub struct OperationLogArgs {
template: Option<String>,
}
/// Restore to the state at an operation
/// Create a new operation that restores the repo to an earlier state
///
/// This restores the repo to the state at the specified operation, effectively
/// undoing all later operations. It does so by creating a new operation.
#[derive(clap::Args, Clone, Debug)]
pub struct OperationRestoreArgs {
/// The operation to restore to
///
/// Use `jj op log` to find an operation to restore to. Use e.g. `jj
/// --at-op=<operation ID> log` before restoring to an operation to see the
/// state of the repo at that operation.
operation: String,
}
/// Undo an operation
/// Create a new operation that undoes an earlier operation
///
/// This undoes an individual operation by applying the inverse of the
/// operation.
#[derive(clap::Args, Clone, Debug)]
pub struct OperationUndoArgs {
/// The operation to undo
///
/// Use `jj op log` to find an operation to undo.
#[arg(default_value = "@")]
operation: String,
}