git-revise
git-revise copied to clipboard
Suggestion: rename --edit to --reword, and --cut to --split or --chop
In an interactive rebase, 'edit' means changing the contents of the commit, which is not available in revise. So --edit
might be a bit confusing, as it actually corresponds to rewording a commit.
Should this be renamed to --reword
?
As a non-native English speaker, when I encounter 'cut' in an application, I link it to cut/copy/paste (so: delete-and-place-on-clipboard). I think a term like 'split' covers the goal more clearly (supported by the fact that the man page explains the feature with 'split' and 'splitting').
This should not only impact command line option --cut
, but also command cut
in an interactive revise. Here, split
will conflict with squash
. So maybe chop
(and --chop
) is a feasible alternative?
As a native English speaker I think both of these suggestions make a lot of sense. I remember being confused by both of them. I was so eager to use the tool I got over it, but it's still not intuitive.
Why does "split" conflict with "squash"?
@alerque In an interactive revise, you can type p
instead of pick
, or s
instead of squash
. But that s
will conflict with s
for split
Maybe -e
should be kept as an alias for --reword
/-r
, for those why type git revise -ie
from muscle memory? (same for -c
?)
cut
was actually initially named split
, but was changed due to the first-letter conflict with squash
while I was adding interactive-mode. I don't have any particular attachment to the name cut
, but I'm not convinced that chop
is much more clear. Perhaps it's worth the conflict to use the more intuitive split
name.
I'd be open to supporting --reword
as an alias for --edit
. I honestly don't remember why I chose that name originally, but it may have come from this tool's origin as a commit message editor. The --interactive
feature was added later.
I'm more open to breaking changes to the interactive mode than the command line, which I wouldn't want to mess up anyone (including my) muscle memory with.
split
feels like the most intuitive choice, but if the single letter conflict with squash
is a big problem, maybe divide
would be an alternative?
I'd also appreciate -r/--reword
as a (preferred) alias for --edit
.
Anecdotally, I did try to use -r
assuming it would mean reword just today, and had to look at the help to remember it was -e
.
(cut
makes sense to me, FWIW.)
I support this too