mirror of
https://github.com/martinvonz/jj.git
synced 2024-12-27 06:27:43 +00:00
cli: update help message for jj edit
This change updates the language of `jj edit`'s help message to be more clear as to the nature of the command. It also adds a recommendation for a more idiomatic/safer workflow.
This commit is contained in:
parent
f30857190e
commit
289b9bc71f
2 changed files with 6 additions and 6 deletions
|
@ -21,10 +21,10 @@ use crate::cli_util::{CommandHelper, RevisionArg};
|
|||
use crate::command_error::CommandError;
|
||||
use crate::ui::Ui;
|
||||
|
||||
/// Edit a commit in the working copy
|
||||
/// Sets the specified revision as the working-copy revision
|
||||
///
|
||||
/// Puts the contents of a commit in the working copy for editing. Any changes
|
||||
/// you make in the working copy will update (amend) the commit.
|
||||
/// Note: it is generally recommended to instead use `jj new` and `jj
|
||||
/// squash`.
|
||||
#[derive(clap::Args, Clone, Debug)]
|
||||
pub(crate) struct EditArgs {
|
||||
/// The commit to edit
|
||||
|
|
|
@ -113,7 +113,7 @@ To get started, see the tutorial at https://github.com/martinvonz/jj/blob/main/d
|
|||
* `diff` — Compare file contents between two revisions
|
||||
* `diffedit` — Touch up the content changes in a revision with a diff editor
|
||||
* `duplicate` — Create a new change with the same content as an existing one
|
||||
* `edit` — Edit a commit in the working copy
|
||||
* `edit` — Sets the specified revision as the working-copy revision
|
||||
* `files` — List files in a revision
|
||||
* `git` — Commands for working with the underlying Git repo
|
||||
* `init` — Create a new repo in the given directory
|
||||
|
@ -706,9 +706,9 @@ Create a new change with the same content as an existing one
|
|||
|
||||
## `jj edit`
|
||||
|
||||
Edit a commit in the working copy
|
||||
Sets the specified revision as the working-copy revision
|
||||
|
||||
Puts the contents of a commit in the working copy for editing. Any changes you make in the working copy will update (amend) the commit.
|
||||
Note: it is generally recommended to instead use `jj new` and `jj squash`.
|
||||
|
||||
**Usage:** `jj edit <REVISION>`
|
||||
|
||||
|
|
Loading…
Reference in a new issue