config: fix --comment formatting

[thirdparty/git.git] / builtin / config.c

diff --git a/builtin/config.c b/builtin/config.c
index c54e9941a5ff7c4df4fc60c3ac2754f616e241ce..e859a659f44eae50ae6433957d5046f67bd9c5de 100644 (file)
--- a/builtin/config.c
+++ b/builtin/config.c
@@ -174,7 +174,7 @@ static struct option builtin_config_options[] = {
        OPT_BOOL(0, "show-origin", &show_origin, N_("show origin of config (file, standard input, blob, command line)")),
        OPT_BOOL(0, "show-scope", &show_scope, N_("show scope of config (worktree, local, global, system, command)")),
        OPT_STRING(0, "default", &default_value, N_("value"), N_("with --get, use default value when missing entry")),
-       OPT_STRING(0, "comment", &comment, N_("value"), N_("human-readable comment string (# will be prepended automatically)")),
+       OPT_STRING(0, "comment", &comment, N_("value"), N_("human-readable comment string (# will be prepended as needed)")),
        OPT_END(),
 };
 
@@ -800,9 +800,9 @@ int cmd_config(int argc, const char **argv, const char *prefix)
        }
 
        if (comment &&
-               !(actions & (ACTION_ADD|ACTION_SET|ACTION_SET_ALL|ACTION_REPLACE_ALL))) {
-                       error(_("--comment is only applicable to add/set/replace operations"));
-                       usage_builtin_config();
+           !(actions & (ACTION_ADD|ACTION_SET|ACTION_SET_ALL|ACTION_REPLACE_ALL))) {
+               error(_("--comment is only applicable to add/set/replace operations"));
+               usage_builtin_config();
        }
 
        /* check usage of --fixed-value */
@@ -841,6 +841,13 @@ int cmd_config(int argc, const char **argv, const char *prefix)
                flags |= CONFIG_FLAGS_FIXED_VALUE;
        }
 
+       if (comment) {
+               if (strchr(comment, '\n'))
+                       die(_("no multi-line comment allowed: '%s'"), comment);
+               if (comment[0] != '#')
+                       comment = xstrfmt("# %s", comment);
+       }
+
        if (actions & PAGING_ACTIONS)
                setup_auto_pager("config", 1);