| Message ID | 20210207181439.1178-4-charvi077@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Improve the 'fixup [-C | -c]' in interactive rebase | expand |
On Sun, Feb 7, 2021 at 1:19 PM Charvi Mendiratta <charvi077@gmail.com> wrote: > When `-c` says "edit the commit message" it's not clear what will be > edited. The original's commit message or the replacement's message or a > combination of the two. Word it such that it states more precisely what > exactly will be edited and also remove the use of a period and > capitalized word in the to-do help text. If you happen to re-roll for some reason, it might be a good idea to explain why you are removing the period and capitalization since the reason is not otherwise clear to the casual reader. So, perhaps: ... exactly will be edited. While at it, also drop the jarring period and capitalization, neither of which is otherwise present in the message. or something like that. > Signed-off-by: Charvi Mendiratta <charvi077@gmail.com>
On Mon, 8 Feb 2021 at 00:19, Eric Sunshine <sunshine@sunshineco.com> wrote: > > On Sun, Feb 7, 2021 at 1:19 PM Charvi Mendiratta <charvi077@gmail.com> wrote: > > When `-c` says "edit the commit message" it's not clear what will be > > edited. The original's commit message or the replacement's message or a > > combination of the two. Word it such that it states more precisely what > > exactly will be edited and also remove the use of a period and > > capitalized word in the to-do help text. > > If you happen to re-roll for some reason, it might be a good idea to > explain why you are removing the period and capitalization since the > reason is not otherwise clear to the casual reader. So, perhaps: > > ... exactly will be edited. While at it, also drop the jarring > period and capitalization, neither of which is otherwise present > in the message. > > or something like that. okay, I will change it.
diff --git a/rebase-interactive.c b/rebase-interactive.c index c3bd02adee..e85994beb6 100644 --- a/rebase-interactive.c +++ b/rebase-interactive.c @@ -45,8 +45,8 @@ void append_todo_help(int command_count, "e, edit <commit> = use commit, but stop for amending\n" "s, squash <commit> = use commit, but meld into previous commit\n" "f, fixup [-C | -c] <commit> = like \"squash\", but discard this\n" -" commit's log message. Use -C to replace with this\n" -" commit message or -c to edit the commit message\n" +" commit's log message; use -C to replace with this\n" +" commit message or -c to edit this commit message\n" "x, exec <command> = run command (the rest of the line) using shell\n" "b, break = stop here (continue rebase later with 'git rebase --continue')\n" "d, drop <commit> = remove commit\n" @@ -55,7 +55,7 @@ void append_todo_help(int command_count, "m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]\n" ". create a merge commit using the original merge commit's\n" ". message (or the oneline, if no original merge commit was\n" -". specified). Use -c <commit> to reword the commit message.\n" +". specified); use -c <commit> to reword the commit message\n" "\n" "These lines can be re-ordered; they are executed from top to bottom.\n"); unsigned edit_todo = !(shortrevisions && shortonto);
When `-c` says "edit the commit message" it's not clear what will be edited. The original's commit message or the replacement's message or a combination of the two. Word it such that it states more precisely what exactly will be edited and also remove the use of a period and capitalized word in the to-do help text. Mentored-by: Christian Couder <chriscool@tuxfamily.org> Mentored-by: Phillip Wood <phillip.wood@dunelm.org.uk> Helped-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Charvi Mendiratta <charvi077@gmail.com> --- rebase-interactive.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)