i18n: git-checkout describe_detached_head messages
[gitweb.git] / help.c
diff --git a/help.c b/help.c
index 300cd38a9fc2afa61d4390a8fee590997bb6e590..7654f1bfd608d151a213937614449cc497bb638b 100644 (file)
--- a/help.c
+++ b/help.c
@@ -3,6 +3,7 @@
 #include "exec_cmd.h"
 #include "levenshtein.h"
 #include "help.h"
+#include "common-cmds.h"
 
 /* most GUI terminals set COLUMNS (although some don't export it) */
 static int term_columns(void)
@@ -100,7 +101,7 @@ static void pretty_print_string_list(struct cmdnames *cmds, int longest)
 
        if (space < max_cols)
                cols = max_cols / space;
-       rows = (cmds->cnt + cols - 1) / cols;
+       rows = DIV_ROUND_UP(cmds->cnt, cols);
 
        for (i = 0; i < rows; i++) {
                printf("  ");
@@ -126,8 +127,8 @@ static int is_executable(const char *name)
            !S_ISREG(st.st_mode))
                return 0;
 
-#ifdef __MINGW32__
-       /* cannot trust the executable bit, peek into the file instead */
+#ifdef WIN32
+{      /* cannot trust the executable bit, peek into the file instead */
        char buf[3] = { 0 };
        int n;
        int fd = open(name, O_RDONLY);
@@ -140,6 +141,7 @@ static int is_executable(const char *name)
                                st.st_mode |= S_IXUSR;
                close(fd);
        }
+}
 #endif
        return st.st_mode & S_IXUSR;
 }
@@ -204,8 +206,8 @@ void load_command_list(const char *prefix,
                while (1) {
                        if ((colon = strchr(path, PATH_SEP)))
                                *colon = 0;
-
-                       list_commands_in_dir(other_cmds, path, prefix);
+                       if (!exec_path || strcmp(path, exec_path))
+                               list_commands_in_dir(other_cmds, path, prefix);
 
                        if (!colon)
                                break;
@@ -262,11 +264,15 @@ int is_in_cmdlist(struct cmdnames *c, const char *s)
 }
 
 static int autocorrect;
+static struct cmdnames aliases;
 
 static int git_unknown_cmd_config(const char *var, const char *value, void *cb)
 {
        if (!strcmp(var, "help.autocorrect"))
                autocorrect = git_config_int(var,value);
+       /* Also use aliases for command lookup */
+       if (!prefixcmp(var, "alias."))
+               add_cmdname(&aliases, var + 6, strlen(var + 6));
 
        return git_default_config(var, value, cb);
 }
@@ -280,29 +286,63 @@ static int levenshtein_compare(const void *p1, const void *p2)
        return l1 != l2 ? l1 - l2 : strcmp(s1, s2);
 }
 
+static void add_cmd_list(struct cmdnames *cmds, struct cmdnames *old)
+{
+       int i;
+       ALLOC_GROW(cmds->names, cmds->cnt + old->cnt, cmds->alloc);
+
+       for (i = 0; i < old->cnt; i++)
+               cmds->names[cmds->cnt++] = old->names[i];
+       free(old->names);
+       old->cnt = 0;
+       old->names = NULL;
+}
+
+/* An empirically derived magic number */
+#define SIMILARITY_FLOOR 7
+#define SIMILAR_ENOUGH(x) ((x) < SIMILARITY_FLOOR)
+
 const char *help_unknown_cmd(const char *cmd)
 {
        int i, n, best_similarity = 0;
        struct cmdnames main_cmds, other_cmds;
 
        memset(&main_cmds, 0, sizeof(main_cmds));
-       memset(&other_cmds, 0, sizeof(main_cmds));
+       memset(&other_cmds, 0, sizeof(other_cmds));
+       memset(&aliases, 0, sizeof(aliases));
 
        git_config(git_unknown_cmd_config, NULL);
 
        load_command_list("git-", &main_cmds, &other_cmds);
 
-       ALLOC_GROW(main_cmds.names, main_cmds.cnt + other_cmds.cnt,
-                  main_cmds.alloc);
-       memcpy(main_cmds.names + main_cmds.cnt, other_cmds.names,
-              other_cmds.cnt * sizeof(other_cmds.names[0]));
-       main_cmds.cnt += other_cmds.cnt;
-       free(other_cmds.names);
+       add_cmd_list(&main_cmds, &aliases);
+       add_cmd_list(&main_cmds, &other_cmds);
+       qsort(main_cmds.names, main_cmds.cnt,
+             sizeof(main_cmds.names), cmdname_compare);
+       uniq(&main_cmds);
+
+       /* This abuses cmdname->len for levenshtein distance */
+       for (i = 0, n = 0; i < main_cmds.cnt; i++) {
+               int cmp = 0; /* avoid compiler stupidity */
+               const char *candidate = main_cmds.names[i]->name;
+
+               /* Does the candidate appear in common_cmds list? */
+               while (n < ARRAY_SIZE(common_cmds) &&
+                      (cmp = strcmp(common_cmds[n].name, candidate)) < 0)
+                       n++;
+               if ((n < ARRAY_SIZE(common_cmds)) && !cmp) {
+                       /* Yes, this is one of the common commands */
+                       n++; /* use the entry from common_cmds[] */
+                       if (!prefixcmp(candidate, cmd)) {
+                               /* Give prefix match a very good score */
+                               main_cmds.names[i]->len = 0;
+                               continue;
+                       }
+               }
 
-       /* This reuses cmdname->len for similarity index */
-       for (i = 0; i < main_cmds.cnt; ++i)
                main_cmds.names[i]->len =
-                       levenshtein(cmd, main_cmds.names[i]->name, 0, 2, 1, 4);
+                       levenshtein(cmd, candidate, 0, 2, 1, 4) + 1;
+       }
 
        qsort(main_cmds.names, main_cmds.cnt,
              sizeof(*main_cmds.names), levenshtein_compare);
@@ -310,15 +350,26 @@ const char *help_unknown_cmd(const char *cmd)
        if (!main_cmds.cnt)
                die ("Uh oh. Your system reports no Git commands at all.");
 
-       best_similarity = main_cmds.names[0]->len;
-       n = 1;
-       while (n < main_cmds.cnt && best_similarity == main_cmds.names[n]->len)
-               ++n;
-       if (autocorrect && n == 1) {
+       /* skip and count prefix matches */
+       for (n = 0; n < main_cmds.cnt && !main_cmds.names[n]->len; n++)
+               ; /* still counting */
+
+       if (main_cmds.cnt <= n) {
+               /* prefix matches with everything? that is too ambiguous */
+               best_similarity = SIMILARITY_FLOOR + 1;
+       } else {
+               /* count all the most similar ones */
+               for (best_similarity = main_cmds.names[n++]->len;
+                    (n < main_cmds.cnt &&
+                     best_similarity == main_cmds.names[n]->len);
+                    n++)
+                       ; /* still counting */
+       }
+       if (autocorrect && n == 1 && SIMILAR_ENOUGH(best_similarity)) {
                const char *assumed = main_cmds.names[0]->name;
                main_cmds.names[0] = NULL;
                clean_cmdnames(&main_cmds);
-               fprintf(stderr, "WARNING: You called a Git program named '%s', "
+               fprintf(stderr, "WARNING: You called a Git command named '%s', "
                        "which does not exist.\n"
                        "Continuing under the assumption that you meant '%s'\n",
                        cmd, assumed);
@@ -330,9 +381,9 @@ const char *help_unknown_cmd(const char *cmd)
                return assumed;
        }
 
-       fprintf(stderr, "git: '%s' is not a git-command. See 'git --help'.\n", cmd);
+       fprintf(stderr, "git: '%s' is not a git command. See 'git --help'.\n", cmd);
 
-       if (best_similarity < 6) {
+       if (SIMILAR_ENOUGH(best_similarity)) {
                fprintf(stderr, "\nDid you mean %s?\n",
                        n < 2 ? "this": "one of these");