Skip to content

Commit e97ca7f

Browse files
Greg Pricegitster
authored andcommitted
commit: --cleanup is a message option
In the usage message for "git commit", the --cleanup option appeared at the end, as one of the "contents options": usage: git commit [options] [--] <filepattern>... ... Commit message options ... Commit contents options ... --allow-empty ok to record an empty change --cleanup <default> how to strip spaces and #comments from message This is confusing, in part because it makes it ambiguous whether --allow-empty, just above, refers to an empty diff or an empty message. Move --cleanup into the 'message options' group. Also add a pair of comments to prevent similar oversights in the future. Signed-off-by: Greg Price <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 153bb83 commit e97ca7f

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

builtin-commit.c

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,8 +86,8 @@ static int opt_parse_m(const struct option *opt, const char *arg, int unset)
8686
static struct option builtin_commit_options[] = {
8787
OPT__QUIET(&quiet),
8888
OPT__VERBOSE(&verbose),
89-
OPT_GROUP("Commit message options"),
9089

90+
OPT_GROUP("Commit message options"),
9191
OPT_STRING('F', "file", &logfile, "FILE", "read log from file"),
9292
OPT_STRING(0, "author", &force_author, "AUTHOR", "override author for commit"),
9393
OPT_CALLBACK('m', "message", &message, "MESSAGE", "specify commit message", opt_parse_m),
@@ -96,6 +96,8 @@ static struct option builtin_commit_options[] = {
9696
OPT_BOOLEAN('s', "signoff", &signoff, "add Signed-off-by:"),
9797
OPT_STRING('t', "template", &template_file, "FILE", "use specified template file"),
9898
OPT_BOOLEAN('e', "edit", &edit_flag, "force edit of commit"),
99+
OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
100+
/* end commit message options */
99101

100102
OPT_GROUP("Commit contents options"),
101103
OPT_BOOLEAN('a', "all", &all, "commit all changed files"),
@@ -106,7 +108,7 @@ static struct option builtin_commit_options[] = {
106108
OPT_BOOLEAN(0, "amend", &amend, "amend previous commit"),
107109
{ OPTION_STRING, 'u', "untracked-files", &untracked_files_arg, "mode", "show untracked files, optional modes: all, normal, no. (Default: all)", PARSE_OPT_OPTARG, NULL, (intptr_t)"all" },
108110
OPT_BOOLEAN(0, "allow-empty", &allow_empty, "ok to record an empty change"),
109-
OPT_STRING(0, "cleanup", &cleanup_arg, "default", "how to strip spaces and #comments from message"),
111+
/* end commit contents options */
110112

111113
OPT_END()
112114
};

0 commit comments

Comments
 (0)