rebase -i: clarify what happens on a failed `exec`
[git/git.git] / rebase-interactive.c
CommitLineData
145e05ac
AG
1#include "cache.h"
2#include "commit.h"
3#include "rebase-interactive.h"
4#include "sequencer.h"
5#include "strbuf.h"
6
a9f5476f
AG
7void append_todo_help(unsigned edit_todo, unsigned keep_empty,
8 struct strbuf *buf)
145e05ac 9{
145e05ac
AG
10 const char *msg = _("\nCommands:\n"
11"p, pick <commit> = use commit\n"
12"r, reword <commit> = use commit, but edit the commit message\n"
13"e, edit <commit> = use commit, but stop for amending\n"
14"s, squash <commit> = use commit, but meld into previous commit\n"
15"f, fixup <commit> = like \"squash\", but discard this commit's log message\n"
16"x, exec <command> = run command (the rest of the line) using shell\n"
17"d, drop <commit> = remove commit\n"
18"l, label <label> = label current HEAD with a name\n"
19"t, reset <label> = reset HEAD to a label\n"
20"m, merge [-C <commit> | -c <commit>] <label> [# <oneline>]\n"
21". create a merge commit using the original merge commit's\n"
22". message (or the oneline, if no original merge commit was\n"
23". specified). Use -c <commit> to reword the commit message.\n"
24"\n"
25"These lines can be re-ordered; they are executed from top to bottom.\n");
26
a9f5476f 27 strbuf_add_commented_lines(buf, msg, strlen(msg));
145e05ac
AG
28
29 if (get_missing_commit_check_level() == MISSING_COMMIT_CHECK_ERROR)
30 msg = _("\nDo not remove any line. Use 'drop' "
31 "explicitly to remove a commit.\n");
32 else
33 msg = _("\nIf you remove a line here "
34 "THAT COMMIT WILL BE LOST.\n");
35
a9f5476f 36 strbuf_add_commented_lines(buf, msg, strlen(msg));
145e05ac
AG
37
38 if (edit_todo)
39 msg = _("\nYou are editing the todo file "
40 "of an ongoing interactive rebase.\n"
41 "To continue rebase after editing, run:\n"
42 " git rebase --continue\n\n");
43 else
44 msg = _("\nHowever, if you remove everything, "
45 "the rebase will be aborted.\n\n");
46
a9f5476f 47 strbuf_add_commented_lines(buf, msg, strlen(msg));
145e05ac
AG
48
49 if (!keep_empty) {
50 msg = _("Note that empty commits are commented out");
a9f5476f 51 strbuf_add_commented_lines(buf, msg, strlen(msg));
145e05ac 52 }
a9f5476f
AG
53}
54
64a43cbd
AG
55int edit_todo_list(unsigned flags)
56{
57 struct strbuf buf = STRBUF_INIT;
58 const char *todo_file = rebase_path_todo();
59
60 if (strbuf_read_file(&buf, todo_file, 0) < 0)
61 return error_errno(_("could not read '%s'."), todo_file);
62
63 strbuf_stripspace(&buf, 1);
64 if (write_message(buf.buf, buf.len, todo_file, 0)) {
65 strbuf_release(&buf);
66 return -1;
67 }
68
69 strbuf_release(&buf);
70
71 transform_todos(flags | TODO_LIST_SHORTEN_IDS);
a9f5476f
AG
72
73 if (strbuf_read_file(&buf, todo_file, 0) < 0)
74 return error_errno(_("could not read '%s'."), todo_file);
75
76 append_todo_help(1, 0, &buf);
77 if (write_message(buf.buf, buf.len, todo_file, 0)) {
78 strbuf_release(&buf);
79 return -1;
80 }
81
82 strbuf_release(&buf);
64a43cbd
AG
83
84 if (launch_sequence_editor(todo_file, NULL, NULL))
85 return -1;
86
87 transform_todos(flags & ~(TODO_LIST_SHORTEN_IDS));
88
89 return 0;
90}