]> git.ipfire.org Git - thirdparty/git.git/blobdiff - advice.c
Merge branch 'ps/transactional-update-ref-stdin'
[thirdparty/git.git] / advice.c
index ce5f374ecd4917346145c8a380ac8c0e45e849a4..f0a3d32d20687d1caadc1534aa15cf50543c27c0 100644 (file)
--- a/advice.c
+++ b/advice.c
@@ -3,6 +3,7 @@
 #include "color.h"
 #include "help.h"
 
+int advice_fetch_show_forced_updates = 1;
 int advice_push_update_rejected = 1;
 int advice_push_non_ff_current = 1;
 int advice_push_non_ff_matching = 1;
@@ -12,9 +13,11 @@ int advice_push_needs_force = 1;
 int advice_push_unqualified_ref_name = 1;
 int advice_status_hints = 1;
 int advice_status_u_option = 1;
+int advice_status_ahead_behind_warning = 1;
 int advice_commit_before_merge = 1;
 int advice_reset_quiet_warning = 1;
 int advice_resolve_conflict = 1;
+int advice_sequencer_in_use = 1;
 int advice_implicit_identity = 1;
 int advice_detached_head = 1;
 int advice_set_upstream_failure = 1;
@@ -26,7 +29,9 @@ int advice_ignored_hook = 1;
 int advice_waiting_for_editor = 1;
 int advice_graft_file_deprecated = 1;
 int advice_checkout_ambiguous_remote_branch_name = 1;
-int advice_nested_tag = 1;
+int advice_submodule_alternate_error_strategy_die = 1;
+int advice_add_ignored_file = 1;
+int advice_add_empty_pathspec = 1;
 
 static int advice_use_color = -1;
 static char advice_colors[][COLOR_MAXLEN] = {
@@ -59,6 +64,7 @@ static struct {
        const char *name;
        int *preference;
 } advice_config[] = {
+       { "fetchShowForcedUpdates", &advice_fetch_show_forced_updates },
        { "pushUpdateRejected", &advice_push_update_rejected },
        { "pushNonFFCurrent", &advice_push_non_ff_current },
        { "pushNonFFMatching", &advice_push_non_ff_matching },
@@ -68,12 +74,14 @@ static struct {
        { "pushUnqualifiedRefName", &advice_push_unqualified_ref_name },
        { "statusHints", &advice_status_hints },
        { "statusUoption", &advice_status_u_option },
+       { "statusAheadBehindWarning", &advice_status_ahead_behind_warning },
        { "commitBeforeMerge", &advice_commit_before_merge },
        { "resetQuiet", &advice_reset_quiet_warning },
        { "resolveConflict", &advice_resolve_conflict },
+       { "sequencerInUse", &advice_sequencer_in_use },
        { "implicitIdentity", &advice_implicit_identity },
        { "detachedHead", &advice_detached_head },
-       { "setupStreamFailure", &advice_set_upstream_failure },
+       { "setUpstreamFailure", &advice_set_upstream_failure },
        { "objectNameWarning", &advice_object_name_warning },
        { "amWorkDir", &advice_amworkdir },
        { "rmHints", &advice_rm_hints },
@@ -82,21 +90,66 @@ static struct {
        { "waitingForEditor", &advice_waiting_for_editor },
        { "graftFileDeprecated", &advice_graft_file_deprecated },
        { "checkoutAmbiguousRemoteBranchName", &advice_checkout_ambiguous_remote_branch_name },
-       { "nestedTag", &advice_nested_tag },
+       { "submoduleAlternateErrorStrategyDie", &advice_submodule_alternate_error_strategy_die },
+       { "addIgnoredFile", &advice_add_ignored_file },
+       { "addEmptyPathspec", &advice_add_empty_pathspec },
 
        /* make this an alias for backward compatibility */
        { "pushNonFastForward", &advice_push_update_rejected }
 };
 
-void advise(const char *advice, ...)
+static struct {
+       const char *key;
+       int enabled;
+} advice_setting[] = {
+       [ADVICE_ADD_EMBEDDED_REPO]                      = { "addEmbeddedRepo", 1 },
+       [ADVICE_AM_WORK_DIR]                            = { "amWorkDir", 1 },
+       [ADVICE_CHECKOUT_AMBIGUOUS_REMOTE_BRANCH_NAME]  = { "checkoutAmbiguousRemoteBranchName", 1 },
+       [ADVICE_COMMIT_BEFORE_MERGE]                    = { "commitBeforeMerge", 1 },
+       [ADVICE_DETACHED_HEAD]                          = { "detachedHead", 1 },
+       [ADVICE_FETCH_SHOW_FORCED_UPDATES]              = { "fetchShowForcedUpdates", 1 },
+       [ADVICE_GRAFT_FILE_DEPRECATED]                  = { "graftFileDeprecated", 1 },
+       [ADVICE_IGNORED_HOOK]                           = { "ignoredHook", 1 },
+       [ADVICE_IMPLICIT_IDENTITY]                      = { "implicitIdentity", 1 },
+       [ADVICE_NESTED_TAG]                             = { "nestedTag", 1 },
+       [ADVICE_OBJECT_NAME_WARNING]                    = { "objectNameWarning", 1 },
+       [ADVICE_PUSH_ALREADY_EXISTS]                    = { "pushAlreadyExists", 1 },
+       [ADVICE_PUSH_FETCH_FIRST]                       = { "pushFetchFirst", 1 },
+       [ADVICE_PUSH_NEEDS_FORCE]                       = { "pushNeedsForce", 1 },
+
+       /* make this an alias for backward compatibility */
+       [ADVICE_PUSH_UPDATE_REJECTED_ALIAS]             = { "pushNonFastForward", 1 },
+
+       [ADVICE_PUSH_NON_FF_CURRENT]                    = { "pushNonFFCurrent", 1 },
+       [ADVICE_PUSH_NON_FF_MATCHING]                   = { "pushNonFFMatching", 1 },
+       [ADVICE_PUSH_UNQUALIFIED_REF_NAME]              = { "pushUnqualifiedRefName", 1 },
+       [ADVICE_PUSH_UPDATE_REJECTED]                   = { "pushUpdateRejected", 1 },
+       [ADVICE_RESET_QUIET_WARNING]                    = { "resetQuiet", 1 },
+       [ADVICE_RESOLVE_CONFLICT]                       = { "resolveConflict", 1 },
+       [ADVICE_RM_HINTS]                               = { "rmHints", 1 },
+       [ADVICE_SEQUENCER_IN_USE]                       = { "sequencerInUse", 1 },
+       [ADVICE_SET_UPSTREAM_FAILURE]                   = { "setUpstreamFailure", 1 },
+       [ADVICE_STATUS_AHEAD_BEHIND_WARNING]            = { "statusAheadBehindWarning", 1 },
+       [ADVICE_STATUS_HINTS]                           = { "statusHints", 1 },
+       [ADVICE_STATUS_U_OPTION]                        = { "statusUoption", 1 },
+       [ADVICE_SUBMODULE_ALTERNATE_ERROR_STRATEGY_DIE] = { "submoduleAlternateErrorStrategyDie", 1 },
+       [ADVICE_WAITING_FOR_EDITOR]                     = { "waitingForEditor", 1 },
+};
+
+static const char turn_off_instructions[] =
+N_("\n"
+   "Disable this message with \"git config advice.%s false\"");
+
+static void vadvise(const char *advice, int display_instructions,
+                   const char *key, va_list params)
 {
        struct strbuf buf = STRBUF_INIT;
-       va_list params;
        const char *cp, *np;
 
-       va_start(params, advice);
        strbuf_vaddf(&buf, advice, params);
-       va_end(params);
+
+       if (display_instructions)
+               strbuf_addf(&buf, turn_off_instructions, key);
 
        for (cp = buf.buf; *cp; cp = np) {
                np = strchrnul(cp, '\n');
@@ -110,6 +163,37 @@ void advise(const char *advice, ...)
        strbuf_release(&buf);
 }
 
+void advise(const char *advice, ...)
+{
+       va_list params;
+       va_start(params, advice);
+       vadvise(advice, 0, "", params);
+       va_end(params);
+}
+
+int advice_enabled(enum advice_type type)
+{
+       switch(type) {
+       case ADVICE_PUSH_UPDATE_REJECTED:
+               return advice_setting[ADVICE_PUSH_UPDATE_REJECTED].enabled &&
+                      advice_setting[ADVICE_PUSH_UPDATE_REJECTED_ALIAS].enabled;
+       default:
+               return advice_setting[type].enabled;
+       }
+}
+
+void advise_if_enabled(enum advice_type type, const char *advice, ...)
+{
+       va_list params;
+
+       if (!advice_enabled(type))
+               return;
+
+       va_start(params, advice);
+       vadvise(advice, 1, advice_setting[type].key, params);
+       va_end(params);
+}
+
 int git_default_advice_config(const char *var, const char *value)
 {
        const char *k, *slot_name;
@@ -136,6 +220,13 @@ int git_default_advice_config(const char *var, const char *value)
                if (strcasecmp(k, advice_config[i].name))
                        continue;
                *advice_config[i].preference = git_config_bool(var, value);
+               break;
+       }
+
+       for (i = 0; i < ARRAY_SIZE(advice_setting); i++) {
+               if (strcasecmp(k, advice_setting[i].key))
+                       continue;
+               advice_setting[i].enabled = git_config_bool(var, value);
                return 0;
        }
 
@@ -146,8 +237,8 @@ void list_config_advices(struct string_list *list, const char *prefix)
 {
        int i;
 
-       for (i = 0; i < ARRAY_SIZE(advice_config); i++)
-               list_config_item(list, prefix, advice_config[i].name);
+       for (i = 0; i < ARRAY_SIZE(advice_setting); i++)
+               list_config_item(list, prefix, advice_setting[i].key);
 }
 
 int error_resolve_conflict(const char *me)
@@ -193,13 +284,22 @@ void NORETURN die_conclude_merge(void)
 void detach_advice(const char *new_name)
 {
        const char *fmt =
-       _("Note: checking out '%s'.\n\n"
+       _("Note: switching to '%s'.\n"
+       "\n"
        "You are in 'detached HEAD' state. You can look around, make experimental\n"
        "changes and commit them, and you can discard any commits you make in this\n"
-       "state without impacting any branches by performing another checkout.\n\n"
+       "state without impacting any branches by switching back to a branch.\n"
+       "\n"
        "If you want to create a new branch to retain commits you create, you may\n"
-       "do so (now or later) by using -b with the checkout command again. Example:\n\n"
-       "  git checkout -b <new-branch-name>\n\n");
+       "do so (now or later) by using -c with the switch command. Example:\n"
+       "\n"
+       "  git switch -c <new-branch-name>\n"
+       "\n"
+       "Or undo this operation with:\n"
+       "\n"
+       "  git switch -\n"
+       "\n"
+       "Turn off this advice by setting config variable advice.detachedHead to false\n\n");
 
        fprintf(stderr, fmt, new_name);
 }