]> git.ipfire.org Git - thirdparty/git.git/commitdiff
git-rebase.txt: update description of --allow-empty-message
authorElijah Newren <newren@gmail.com>
Thu, 16 Jan 2020 06:14:15 +0000 (06:14 +0000)
committerJunio C Hamano <gitster@pobox.com>
Fri, 17 Jan 2020 21:58:30 +0000 (13:58 -0800)
Commit b00bf1c9a8dd ("git-rebase: make --allow-empty-message the
default", 2018-06-27) made --allow-empty-message the default and thus
turned --allow-empty-message into a no-op but did not update the
documentation to reflect this.  Update the documentation now, and hide
the option from the normal -h output since it is not useful.

Signed-off-by: Elijah Newren <newren@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-rebase.txt
builtin/rebase.c

index 0c4f038dd6077fb47436e82c2ce80b78fa6b9304..c83be7ffc201f2014c89948343c58146235d0ba9 100644 (file)
@@ -265,9 +265,10 @@ See also INCOMPATIBLE OPTIONS below.
 See also INCOMPATIBLE OPTIONS below.
 
 --allow-empty-message::
-       By default, rebasing commits with an empty message will fail.
-       This option overrides that behavior, allowing commits with empty
-       messages to be rebased.
+       No-op.  Rebasing commits with an empty message used to fail
+       and this option would override that behavior, allowing commits
+       with empty messages to be rebased.  Now commits with an empty
+       message do not cause rebasing to halt.
 +
 See also INCOMPATIBLE OPTIONS below.
 
index 8081741f8aac4e64010ae11871078917b5d535e8..faa4e0d4065f411d68f5521841827f830289e8e3 100644 (file)
@@ -453,8 +453,9 @@ int cmd_rebase__interactive(int argc, const char **argv, const char *prefix)
                OPT_NEGBIT(0, "ff", &opts.flags, N_("allow fast-forward"),
                           REBASE_FORCE),
                OPT_BOOL(0, "keep-empty", &opts.keep_empty, N_("keep empty commits")),
-               OPT_BOOL(0, "allow-empty-message", &opts.allow_empty_message,
-                        N_("allow commits with empty messages")),
+               OPT_BOOL_F(0, "allow-empty-message", &opts.allow_empty_message,
+                          N_("allow commits with empty messages"),
+                          PARSE_OPT_HIDDEN),
                OPT_BOOL(0, "rebase-merges", &opts.rebase_merges, N_("rebase merge commits")),
                OPT_BOOL(0, "rebase-cousins", &opts.rebase_cousins,
                         N_("keep original branch points of cousins")),
@@ -1495,9 +1496,10 @@ int cmd_rebase(int argc, const char **argv, const char *prefix)
                OPT_STRING_LIST('x', "exec", &exec, N_("exec"),
                                N_("add exec lines after each commit of the "
                                   "editable list")),
-               OPT_BOOL(0, "allow-empty-message",
-                        &options.allow_empty_message,
-                        N_("allow rebasing commits with empty messages")),
+               OPT_BOOL_F(0, "allow-empty-message",
+                          &options.allow_empty_message,
+                          N_("allow rebasing commits with empty messages"),
+                          PARSE_OPT_HIDDEN),
                {OPTION_STRING, 'r', "rebase-merges", &rebase_merges,
                        N_("mode"),
                        N_("try to rebase merges instead of skipping them"),