help_unknown_ref(): check for refname ambiguity
[git/git.git] / help.c
CommitLineData
70827b15 1#include "cache.h"
b2141fc1 2#include "config.h"
70827b15 3#include "builtin.h"
d807c4a0 4#include "exec-cmd.h"
38124a40 5#include "run-command.h"
8af84dad 6#include "levenshtein.h"
940208a7 7#include "help.h"
cfb22a02 8#include "command-list.h"
dbfae689
NTND
9#include "string-list.h"
10#include "column.h"
816fb46b 11#include "version.h"
e5618106 12#include "refs.h"
b48cbfc5 13#include "parse-options.h"
64949984 14
cfb22a02
NTND
15struct category_description {
16 uint32_t category;
17 const char *desc;
18};
19static uint32_t common_mask =
20 CAT_init | CAT_worktree | CAT_info |
21 CAT_history | CAT_remote;
22static struct category_description common_categories[] = {
23 { CAT_init, N_("start a working area (see also: git help tutorial)") },
24 { CAT_worktree, N_("work on the current change (see also: git help everyday)") },
25 { CAT_info, N_("examine the history and state (see also: git help revisions)") },
26 { CAT_history, N_("grow, mark and tweak your common history") },
27 { CAT_remote, N_("collaborate (see also: git help workflows)") },
28 { 0, NULL }
29};
63eae83f
NTND
30static struct category_description main_categories[] = {
31 { CAT_mainporcelain, N_("Main Porcelain Commands") },
32 { CAT_ancillarymanipulators, N_("Ancillary Commands / Manipulators") },
33 { CAT_ancillaryinterrogators, N_("Ancillary Commands / Interrogators") },
34 { CAT_foreignscminterface, N_("Interacting with Others") },
35 { CAT_plumbingmanipulators, N_("Low-level Commands / Manipulators") },
36 { CAT_plumbinginterrogators, N_("Low-level Commands / Interrogators") },
37 { CAT_synchingrepositories, N_("Low-level Commands / Synching Repositories") },
38 { CAT_purehelpers, N_("Low-level Commands / Internal Helpers") },
39 { 0, NULL }
40};
cfb22a02 41
1b81d8cb 42static const char *drop_prefix(const char *name, uint32_t category)
cfb22a02
NTND
43{
44 const char *new_name;
45
46 if (skip_prefix(name, "git-", &new_name))
47 return new_name;
1b81d8cb
NTND
48 if (category == CAT_guide && skip_prefix(name, "git", &new_name))
49 return new_name;
cfb22a02
NTND
50 return name;
51
52}
53
54static void extract_cmds(struct cmdname_help **p_cmds, uint32_t mask)
55{
56 int i, nr = 0;
57 struct cmdname_help *cmds;
58
59 if (ARRAY_SIZE(command_list) == 0)
60 BUG("empty command_list[] is a sign of broken generate-cmdlist.sh");
61
62 ALLOC_ARRAY(cmds, ARRAY_SIZE(command_list) + 1);
63
64 for (i = 0; i < ARRAY_SIZE(command_list); i++) {
65 const struct cmdname_help *cmd = command_list + i;
66
67 if (!(cmd->category & mask))
68 continue;
69
70 cmds[nr] = *cmd;
1b81d8cb 71 cmds[nr].name = drop_prefix(cmd->name, cmd->category);
cfb22a02
NTND
72
73 nr++;
74 }
75 cmds[nr].name = NULL;
76 *p_cmds = cmds;
77}
78
79static void print_command_list(const struct cmdname_help *cmds,
80 uint32_t mask, int longest)
81{
82 int i;
83
84 for (i = 0; cmds[i].name; i++) {
85 if (cmds[i].category & mask) {
1c4b9859 86 size_t len = strlen(cmds[i].name);
cfb22a02 87 printf(" %s ", cmds[i].name);
6195a76d
NTND
88 if (longest > len)
89 mput_char(' ', longest - len);
cfb22a02
NTND
90 puts(_(cmds[i].help));
91 }
92 }
93}
94
95static int cmd_name_cmp(const void *elem1, const void *elem2)
96{
97 const struct cmdname_help *e1 = elem1;
98 const struct cmdname_help *e2 = elem2;
99
100 return strcmp(e1->name, e2->name);
101}
102
26c7d067
NTND
103static void print_cmd_by_category(const struct category_description *catdesc,
104 int *longest_p)
cfb22a02
NTND
105{
106 struct cmdname_help *cmds;
107 int longest = 0;
108 int i, nr = 0;
109 uint32_t mask = 0;
110
111 for (i = 0; catdesc[i].desc; i++)
112 mask |= catdesc[i].category;
113
114 extract_cmds(&cmds, mask);
115
116 for (i = 0; cmds[i].name; i++, nr++) {
117 if (longest < strlen(cmds[i].name))
118 longest = strlen(cmds[i].name);
119 }
120 QSORT(cmds, nr, cmd_name_cmp);
121
122 for (i = 0; catdesc[i].desc; i++) {
123 uint32_t mask = catdesc[i].category;
124 const char *desc = catdesc[i].desc;
125
126 printf("\n%s\n", _(desc));
127 print_command_list(cmds, mask, longest);
128 }
129 free(cmds);
26c7d067
NTND
130 if (longest_p)
131 *longest_p = longest;
cfb22a02
NTND
132}
133
940208a7 134void add_cmdname(struct cmdnames *cmds, const char *name, int len)
70827b15 135{
96ffc06f
JK
136 struct cmdname *ent;
137 FLEX_ALLOC_MEM(ent, name, name, len);
70827b15 138 ent->len = len;
1eb05690
SP
139
140 ALLOC_GROW(cmds->names, cmds->cnt + 1, cmds->alloc);
141 cmds->names[cmds->cnt++] = ent;
70827b15
LT
142}
143
8af84dad
JS
144static void clean_cmdnames(struct cmdnames *cmds)
145{
146 int i;
147 for (i = 0; i < cmds->cnt; ++i)
148 free(cmds->names[i]);
149 free(cmds->names);
150 cmds->cnt = 0;
151 cmds->alloc = 0;
152}
153
70827b15
LT
154static int cmdname_compare(const void *a_, const void *b_)
155{
156 struct cmdname *a = *(struct cmdname **)a_;
157 struct cmdname *b = *(struct cmdname **)b_;
158 return strcmp(a->name, b->name);
159}
160
1eb05690
SP
161static void uniq(struct cmdnames *cmds)
162{
163 int i, j;
164
165 if (!cmds->cnt)
166 return;
167
4a15758f
JK
168 for (i = j = 1; i < cmds->cnt; i++) {
169 if (!strcmp(cmds->names[i]->name, cmds->names[j-1]->name))
170 free(cmds->names[i]);
171 else
1eb05690 172 cmds->names[j++] = cmds->names[i];
4a15758f 173 }
1eb05690
SP
174
175 cmds->cnt = j;
176}
177
940208a7 178void exclude_cmds(struct cmdnames *cmds, struct cmdnames *excludes)
f3fa1838 179{
1eb05690
SP
180 int ci, cj, ei;
181 int cmp;
182
183 ci = cj = ei = 0;
184 while (ci < cmds->cnt && ei < excludes->cnt) {
185 cmp = strcmp(cmds->names[ci]->name, excludes->names[ei]->name);
186 if (cmp < 0)
187 cmds->names[cj++] = cmds->names[ci++];
6a17f583
JH
188 else if (cmp == 0) {
189 ei++;
190 free(cmds->names[ci++]);
191 } else if (cmp > 0)
1eb05690
SP
192 ei++;
193 }
194
195 while (ci < cmds->cnt)
196 cmds->names[cj++] = cmds->names[ci++];
197
198 cmds->cnt = cj;
199}
200
d10cb3df 201static void pretty_print_cmdnames(struct cmdnames *cmds, unsigned int colopts)
70827b15 202{
dbfae689
NTND
203 struct string_list list = STRING_LIST_INIT_NODUP;
204 struct column_options copts;
205 int i;
70827b15 206
dbfae689
NTND
207 for (i = 0; i < cmds->cnt; i++)
208 string_list_append(&list, cmds->names[i]->name);
209 /*
210 * always enable column display, we only consult column.*
211 * about layout strategy and stuff
212 */
213 colopts = (colopts & ~COL_ENABLE_MASK) | COL_ENABLED;
214 memset(&copts, 0, sizeof(copts));
215 copts.indent = " ";
216 copts.padding = 2;
217 print_columns(&list, colopts, &copts);
218 string_list_clear(&list, 0);
70827b15
LT
219}
220
e321180e 221static void list_commands_in_dir(struct cmdnames *cmds,
940208a7
MV
222 const char *path,
223 const char *prefix)
70827b15 224{
1eb05690 225 DIR *dir = opendir(path);
70827b15 226 struct dirent *de;
f5d600e2
JS
227 struct strbuf buf = STRBUF_INIT;
228 int len;
70827b15 229
f5d600e2 230 if (!dir)
e321180e 231 return;
940208a7
MV
232 if (!prefix)
233 prefix = "git-";
70827b15 234
f5d600e2
JS
235 strbuf_addf(&buf, "%s/", path);
236 len = buf.len;
237
70827b15 238 while ((de = readdir(dir)) != NULL) {
de8118e1 239 const char *ent;
26936bfd 240 size_t entlen;
70827b15 241
de8118e1 242 if (!skip_prefix(de->d_name, prefix, &ent))
70827b15 243 continue;
0966003c 244
f5d600e2
JS
245 strbuf_setlen(&buf, len);
246 strbuf_addstr(&buf, de->d_name);
247 if (!is_executable(buf.buf))
70827b15
LT
248 continue;
249
de8118e1 250 entlen = strlen(ent);
6e409473 251 strip_suffix(ent, ".exe", &entlen);
70827b15 252
de8118e1 253 add_cmdname(cmds, ent, entlen);
70827b15
LT
254 }
255 closedir(dir);
f5d600e2 256 strbuf_release(&buf);
1eb05690
SP
257}
258
e321180e 259void load_command_list(const char *prefix,
940208a7
MV
260 struct cmdnames *main_cmds,
261 struct cmdnames *other_cmds)
1eb05690 262{
1eb05690 263 const char *env_path = getenv("PATH");
1eb05690
SP
264 const char *exec_path = git_exec_path();
265
1f08e5ce 266 if (exec_path) {
e321180e 267 list_commands_in_dir(main_cmds, exec_path, prefix);
9ed0d8d6 268 QSORT(main_cmds->names, main_cmds->cnt, cmdname_compare);
1f08e5ce 269 uniq(main_cmds);
1eb05690
SP
270 }
271
1f08e5ce
AR
272 if (env_path) {
273 char *paths, *path, *colon;
274 path = paths = xstrdup(env_path);
275 while (1) {
276 if ((colon = strchr(path, PATH_SEP)))
277 *colon = 0;
746c221a
PB
278 if (!exec_path || strcmp(path, exec_path))
279 list_commands_in_dir(other_cmds, path, prefix);
1eb05690 280
1f08e5ce
AR
281 if (!colon)
282 break;
283 path = colon + 1;
284 }
285 free(paths);
1eb05690 286
9ed0d8d6 287 QSORT(other_cmds->names, other_cmds->cnt, cmdname_compare);
1f08e5ce
AR
288 uniq(other_cmds);
289 }
940208a7 290 exclude_cmds(other_cmds, main_cmds);
2156435f
JK
291}
292
f4ed0af6 293void list_commands(unsigned int colopts,
dbfae689 294 struct cmdnames *main_cmds, struct cmdnames *other_cmds)
2156435f 295{
940208a7 296 if (main_cmds->cnt) {
61c5d431 297 const char *exec_path = git_exec_path();
4470ef94 298 printf_ln(_("available git commands in '%s'"), exec_path);
1eb05690 299 putchar('\n');
d10cb3df 300 pretty_print_cmdnames(main_cmds, colopts);
1eb05690
SP
301 putchar('\n');
302 }
303
940208a7 304 if (other_cmds->cnt) {
4470ef94 305 printf_ln(_("git commands available from elsewhere on your $PATH"));
940208a7 306 putchar('\n');
d10cb3df 307 pretty_print_cmdnames(other_cmds, colopts);
1eb05690
SP
308 putchar('\n');
309 }
70827b15
LT
310}
311
1542d4cd 312void list_common_cmds_help(void)
22414770 313{
22414770 314 puts(_("These are common Git commands used in various situations:"));
26c7d067 315 print_cmd_by_category(common_categories, NULL);
1542d4cd 316}
22414770 317
6bb2dc0b
NTND
318void list_all_main_cmds(struct string_list *list)
319{
320 struct cmdnames main_cmds, other_cmds;
321 int i;
322
323 memset(&main_cmds, 0, sizeof(main_cmds));
324 memset(&other_cmds, 0, sizeof(other_cmds));
325 load_command_list("git-", &main_cmds, &other_cmds);
326
327 for (i = 0; i < main_cmds.cnt; i++)
328 string_list_append(list, main_cmds.names[i]->name);
329
330 clean_cmdnames(&main_cmds);
331 clean_cmdnames(&other_cmds);
22414770
SG
332}
333
6bb2dc0b 334void list_all_other_cmds(struct string_list *list)
1542d4cd 335{
6bb2dc0b
NTND
336 struct cmdnames main_cmds, other_cmds;
337 int i;
1542d4cd 338
6bb2dc0b
NTND
339 memset(&main_cmds, 0, sizeof(main_cmds));
340 memset(&other_cmds, 0, sizeof(other_cmds));
341 load_command_list("git-", &main_cmds, &other_cmds);
1542d4cd 342
6bb2dc0b
NTND
343 for (i = 0; i < other_cmds.cnt; i++)
344 string_list_append(list, other_cmds.names[i]->name);
22414770 345
6bb2dc0b
NTND
346 clean_cmdnames(&main_cmds);
347 clean_cmdnames(&other_cmds);
348}
349
3c777767
NTND
350void list_cmds_by_category(struct string_list *list,
351 const char *cat)
352{
353 int i, n = ARRAY_SIZE(command_list);
354 uint32_t cat_id = 0;
22414770 355
3c777767
NTND
356 for (i = 0; category_names[i]; i++) {
357 if (!strcmp(cat, category_names[i])) {
358 cat_id = 1UL << i;
359 break;
22414770 360 }
3c777767
NTND
361 }
362 if (!cat_id)
363 die(_("unsupported command listing type '%s'"), cat);
364
365 for (i = 0; i < n; i++) {
366 struct cmdname_help *cmd = command_list + i;
367
1b81d8cb
NTND
368 if (!(cmd->category & cat_id))
369 continue;
370 string_list_append(list, drop_prefix(cmd->name, cmd->category));
3c777767
NTND
371 }
372}
373
6532f374
NTND
374void list_cmds_by_config(struct string_list *list)
375{
376 const char *cmd_list;
377
378 /*
379 * There's no actual repository setup at this point (and even
380 * if there is, we don't really care; only global config
381 * matters). If we accidentally set up a repository, it's ok
382 * too since the caller (git --list-cmds=) should exit shortly
383 * anyway.
384 */
385 if (git_config_get_string_const("completion.commands", &cmd_list))
386 return;
387
388 string_list_sort(list);
389 string_list_remove_duplicates(list, 0);
390
391 while (*cmd_list) {
392 struct strbuf sb = STRBUF_INIT;
393 const char *p = strchrnul(cmd_list, ' ');
22414770 394
6532f374
NTND
395 strbuf_add(&sb, cmd_list, p - cmd_list);
396 if (*cmd_list == '-')
397 string_list_remove(list, cmd_list + 1, 0);
398 else
399 string_list_insert(list, sb.buf);
400 strbuf_release(&sb);
401 while (*p == ' ')
402 p++;
403 cmd_list = p;
1542d4cd
JH
404 }
405}
406
1b81d8cb
NTND
407void list_common_guides_help(void)
408{
409 struct category_description catdesc[] = {
410 { CAT_guide, N_("The common Git guides are:") },
411 { 0, NULL }
412 };
26c7d067 413 print_cmd_by_category(catdesc, NULL);
1b81d8cb
NTND
414 putchar('\n');
415}
416
3ac68a93
NTND
417struct slot_expansion {
418 const char *prefix;
419 const char *placeholder;
420 void (*fn)(struct string_list *list, const char *prefix);
421 int found;
422};
423
e17ca926 424void list_config_help(int for_human)
3ac68a93
NTND
425{
426 struct slot_expansion slot_expansions[] = {
427 { "advice", "*", list_config_advices },
428 { "color.branch", "<slot>", list_config_color_branch_slots },
429 { "color.decorate", "<slot>", list_config_color_decorate_slots },
430 { "color.diff", "<slot>", list_config_color_diff_slots },
431 { "color.grep", "<slot>", list_config_color_grep_slots },
432 { "color.interactive", "<slot>", list_config_color_interactive_slots },
bf1a11f0 433 { "color.remote", "<slot>", list_config_color_sideband_slots },
3ac68a93
NTND
434 { "color.status", "<slot>", list_config_color_status_slots },
435 { "fsck", "<msg-id>", list_config_fsck_msg_ids },
436 { "receive.fsck", "<msg-id>", list_config_fsck_msg_ids },
437 { NULL, NULL, NULL }
438 };
439 const char **p;
440 struct slot_expansion *e;
441 struct string_list keys = STRING_LIST_INIT_DUP;
442 int i;
443
444 for (p = config_name_list; *p; p++) {
445 const char *var = *p;
446 struct strbuf sb = STRBUF_INIT;
447
448 for (e = slot_expansions; e->prefix; e++) {
449
450 strbuf_reset(&sb);
451 strbuf_addf(&sb, "%s.%s", e->prefix, e->placeholder);
452 if (!strcasecmp(var, sb.buf)) {
453 e->fn(&keys, e->prefix);
454 e->found++;
455 break;
456 }
457 }
458 strbuf_release(&sb);
459 if (!e->prefix)
460 string_list_append(&keys, var);
461 }
462
463 for (e = slot_expansions; e->prefix; e++)
464 if (!e->found)
465 BUG("slot_expansion %s.%s is not used",
466 e->prefix, e->placeholder);
467
468 string_list_sort(&keys);
e17ca926
NTND
469 for (i = 0; i < keys.nr; i++) {
470 const char *var = keys.items[i].string;
471 const char *wildcard, *tag, *cut;
472
473 if (for_human) {
474 puts(var);
475 continue;
476 }
477
478 wildcard = strchr(var, '*');
479 tag = strchr(var, '<');
480
481 if (!wildcard && !tag) {
482 puts(var);
483 continue;
484 }
485
486 if (wildcard && !tag)
487 cut = wildcard;
488 else if (!wildcard && tag)
489 cut = tag;
490 else
491 cut = wildcard < tag ? wildcard : tag;
492
493 /*
494 * We may produce duplicates, but that's up to
495 * git-completion.bash to handle
496 */
497 printf("%.*s\n", (int)(cut - var), var);
498 }
3ac68a93
NTND
499 string_list_clear(&keys, 0);
500}
501
26c7d067
NTND
502static int get_alias(const char *var, const char *value, void *data)
503{
504 struct string_list *list = data;
505
506 if (skip_prefix(var, "alias.", &var))
507 string_list_append(list, var)->util = xstrdup(value);
508
509 return 0;
510}
511
63eae83f
NTND
512void list_all_cmds_help(void)
513{
26c7d067
NTND
514 struct string_list others = STRING_LIST_INIT_DUP;
515 struct string_list alias_list = STRING_LIST_INIT_DUP;
516 struct cmdname_help *aliases;
517 int i, longest;
518
519 printf_ln(_("See 'git help <command>' to read about a specific subcommand"));
520 print_cmd_by_category(main_categories, &longest);
521
522 list_all_other_cmds(&others);
523 if (others.nr)
524 printf("\n%s\n", _("External commands"));
525 for (i = 0; i < others.nr; i++)
526 printf(" %s\n", others.items[i].string);
527 string_list_clear(&others, 0);
528
529 git_config(get_alias, &alias_list);
530 string_list_sort(&alias_list);
1c4b9859
JS
531
532 for (i = 0; i < alias_list.nr; i++) {
533 size_t len = strlen(alias_list.items[i].string);
534 if (longest < len)
535 longest = len;
536 }
537
26c7d067
NTND
538 if (alias_list.nr) {
539 printf("\n%s\n", _("Command aliases"));
540 ALLOC_ARRAY(aliases, alias_list.nr + 1);
541 for (i = 0; i < alias_list.nr; i++) {
542 aliases[i].name = alias_list.items[i].string;
543 aliases[i].help = alias_list.items[i].util;
544 aliases[i].category = 1;
545 }
546 aliases[alias_list.nr].name = NULL;
547 print_command_list(aliases, 1, longest);
548 free(aliases);
549 }
550 string_list_clear(&alias_list, 1);
63eae83f
NTND
551}
552
940208a7 553int is_in_cmdlist(struct cmdnames *c, const char *s)
2156435f
JK
554{
555 int i;
556 for (i = 0; i < c->cnt; i++)
557 if (!strcmp(s, c->names[i]->name))
558 return 1;
559 return 0;
560}
561
f0e90716 562static int autocorrect;
746c221a 563static struct cmdnames aliases;
f0e90716
AR
564
565static int git_unknown_cmd_config(const char *var, const char *value, void *cb)
566{
ae021d87
JK
567 const char *p;
568
f0e90716
AR
569 if (!strcmp(var, "help.autocorrect"))
570 autocorrect = git_config_int(var,value);
746c221a 571 /* Also use aliases for command lookup */
ae021d87
JK
572 if (skip_prefix(var, "alias.", &p))
573 add_cmdname(&aliases, p, strlen(p));
f0e90716
AR
574
575 return git_default_config(var, value, cb);
576}
577
8af84dad 578static int levenshtein_compare(const void *p1, const void *p2)
822a7d50 579{
8af84dad
JS
580 const struct cmdname *const *c1 = p1, *const *c2 = p2;
581 const char *s1 = (*c1)->name, *s2 = (*c2)->name;
582 int l1 = (*c1)->len;
583 int l2 = (*c2)->len;
584 return l1 != l2 ? l1 - l2 : strcmp(s1, s2);
585}
586
746c221a
PB
587static void add_cmd_list(struct cmdnames *cmds, struct cmdnames *old)
588{
589 int i;
590 ALLOC_GROW(cmds->names, cmds->cnt + old->cnt, cmds->alloc);
591
592 for (i = 0; i < old->cnt; i++)
593 cmds->names[cmds->cnt++] = old->names[i];
88ce3ef6 594 FREE_AND_NULL(old->names);
746c221a 595 old->cnt = 0;
746c221a
PB
596}
597
06500a02 598/* An empirically derived magic number */
6612b9e4
EFL
599#define SIMILARITY_FLOOR 7
600#define SIMILAR_ENOUGH(x) ((x) < SIMILARITY_FLOOR)
06500a02 601
823e0ded
MS
602static const char bad_interpreter_advice[] =
603 N_("'%s' appears to be a git command, but we were not\n"
604 "able to execute it. Maybe git-%s is broken?");
605
8af84dad 606const char *help_unknown_cmd(const char *cmd)
822a7d50 607{
8af84dad
JS
608 int i, n, best_similarity = 0;
609 struct cmdnames main_cmds, other_cmds;
cfb22a02 610 struct cmdname_help *common_cmds;
8af84dad
JS
611
612 memset(&main_cmds, 0, sizeof(main_cmds));
0b74f5dc 613 memset(&other_cmds, 0, sizeof(other_cmds));
746c221a 614 memset(&aliases, 0, sizeof(aliases));
8af84dad 615
659fef19 616 read_early_config(git_unknown_cmd_config, NULL);
f0e90716 617
8af84dad
JS
618 load_command_list("git-", &main_cmds, &other_cmds);
619
746c221a
PB
620 add_cmd_list(&main_cmds, &aliases);
621 add_cmd_list(&main_cmds, &other_cmds);
9ed0d8d6 622 QSORT(main_cmds.names, main_cmds.cnt, cmdname_compare);
746c221a 623 uniq(&main_cmds);
8af84dad 624
cfb22a02
NTND
625 extract_cmds(&common_cmds, common_mask);
626
6612b9e4
EFL
627 /* This abuses cmdname->len for levenshtein distance */
628 for (i = 0, n = 0; i < main_cmds.cnt; i++) {
629 int cmp = 0; /* avoid compiler stupidity */
630 const char *candidate = main_cmds.names[i]->name;
631
823e0ded
MS
632 /*
633 * An exact match means we have the command, but
634 * for some reason exec'ing it gave us ENOENT; probably
635 * it's a bad interpreter in the #! line.
636 */
637 if (!strcmp(candidate, cmd))
638 die(_(bad_interpreter_advice), cmd, cmd);
639
6612b9e4 640 /* Does the candidate appear in common_cmds list? */
cfb22a02 641 while (common_cmds[n].name &&
6612b9e4
EFL
642 (cmp = strcmp(common_cmds[n].name, candidate)) < 0)
643 n++;
cfb22a02 644 if (common_cmds[n].name && !cmp) {
6612b9e4
EFL
645 /* Yes, this is one of the common commands */
646 n++; /* use the entry from common_cmds[] */
59556548 647 if (starts_with(candidate, cmd)) {
6612b9e4
EFL
648 /* Give prefix match a very good score */
649 main_cmds.names[i]->len = 0;
650 continue;
651 }
652 }
653
8af84dad 654 main_cmds.names[i]->len =
c41494f8 655 levenshtein(cmd, candidate, 0, 2, 1, 3) + 1;
6612b9e4 656 }
cfb22a02 657 FREE_AND_NULL(common_cmds);
8af84dad 658
9ed0d8d6 659 QSORT(main_cmds.names, main_cmds.cnt, levenshtein_compare);
8af84dad
JS
660
661 if (!main_cmds.cnt)
9665627d 662 die(_("Uh oh. Your system reports no Git commands at all."));
8af84dad 663
6612b9e4
EFL
664 /* skip and count prefix matches */
665 for (n = 0; n < main_cmds.cnt && !main_cmds.names[n]->len; n++)
666 ; /* still counting */
667
668 if (main_cmds.cnt <= n) {
669 /* prefix matches with everything? that is too ambiguous */
670 best_similarity = SIMILARITY_FLOOR + 1;
671 } else {
672 /* count all the most similar ones */
673 for (best_similarity = main_cmds.names[n++]->len;
674 (n < main_cmds.cnt &&
675 best_similarity == main_cmds.names[n]->len);
676 n++)
677 ; /* still counting */
678 }
06500a02 679 if (autocorrect && n == 1 && SIMILAR_ENOUGH(best_similarity)) {
8af84dad
JS
680 const char *assumed = main_cmds.names[0]->name;
681 main_cmds.names[0] = NULL;
682 clean_cmdnames(&main_cmds);
9665627d
NTND
683 fprintf_ln(stderr,
684 _("WARNING: You called a Git command named '%s', "
968b1fe2
MB
685 "which does not exist."),
686 cmd);
687 if (autocorrect < 0)
688 fprintf_ln(stderr,
689 _("Continuing under the assumption that "
690 "you meant '%s'."),
691 assumed);
692 else {
693 fprintf_ln(stderr,
694 _("Continuing in %0.1f seconds, "
695 "assuming that you meant '%s'."),
696 (float)autocorrect/10.0, assumed);
2024d317 697 sleep_millisec(autocorrect * 100);
f0e90716 698 }
8af84dad
JS
699 return assumed;
700 }
701
9665627d 702 fprintf_ln(stderr, _("git: '%s' is not a git command. See 'git --help'."), cmd);
8af84dad 703
06500a02 704 if (SIMILAR_ENOUGH(best_similarity)) {
9665627d 705 fprintf_ln(stderr,
6c486862
JNA
706 Q_("\nThe most similar command is",
707 "\nThe most similar commands are",
9665627d 708 n));
8af84dad
JS
709
710 for (i = 0; i < n; i++)
711 fprintf(stderr, "\t%s\n", main_cmds.names[i]->name);
712 }
713
822a7d50
RJ
714 exit(1);
715}
716
a633fca0 717int cmd_version(int argc, const char **argv, const char *prefix)
70827b15 718{
b48cbfc5
JK
719 int build_options = 0;
720 const char * const usage[] = {
721 N_("git version [<options>]"),
722 NULL
723 };
724 struct option options[] = {
725 OPT_BOOL(0, "build-options", &build_options,
726 "also print build options"),
727 OPT_END()
728 };
729
730 argc = parse_options(argc, argv, prefix, options, usage, 0);
731
f2de0b97
DA
732 /*
733 * The format of this string should be kept stable for compatibility
734 * with external projects that rely on the output of "git version".
b48cbfc5
JK
735 *
736 * Always show the version, even if other options are given.
f2de0b97 737 */
70827b15 738 printf("git version %s\n", git_version_string);
b48cbfc5
JK
739
740 if (build_options) {
b2289404 741 printf("cpu: %s\n", GIT_HOST_CPU);
ed32b788
JS
742 if (git_built_from_commit_string[0])
743 printf("built from commit: %s\n",
744 git_built_from_commit_string);
745 else
746 printf("no commit associated with this build\n");
b48cbfc5 747 printf("sizeof-long: %d\n", (int)sizeof(long));
6c213e86 748 printf("sizeof-size_t: %d\n", (int)sizeof(size_t));
b48cbfc5 749 /* NEEDSWORK: also save and output GIT-BUILD_OPTIONS? */
6b9c38e1 750 }
70827b15
LT
751 return 0;
752}
e5618106
VV
753
754struct similar_ref_cb {
755 const char *base_ref;
756 struct string_list *similar_refs;
757};
758
91d6e94e 759static int append_similar_ref(const char *refname, const struct object_id *oid,
e5618106
VV
760 int flags, void *cb_data)
761{
762 struct similar_ref_cb *cb = (struct similar_ref_cb *)(cb_data);
763 char *branch = strrchr(refname, '/') + 1;
95b567c7 764
e5618106 765 /* A remote branch of the same name is deemed similar */
2ed2e199 766 if (starts_with(refname, "refs/remotes/") &&
e5618106 767 !strcmp(branch, cb->base_ref))
2ed2e199
JK
768 string_list_append_nodup(cb->similar_refs,
769 shorten_unambiguous_ref(refname, 1));
e5618106
VV
770 return 0;
771}
772
773static struct string_list guess_refs(const char *ref)
774{
775 struct similar_ref_cb ref_cb;
8ed51b06 776 struct string_list similar_refs = STRING_LIST_INIT_DUP;
e5618106
VV
777
778 ref_cb.base_ref = ref;
779 ref_cb.similar_refs = &similar_refs;
780 for_each_ref(append_similar_ref, &ref_cb);
781 return similar_refs;
782}
783
784void help_unknown_ref(const char *ref, const char *cmd, const char *error)
785{
786 int i;
787 struct string_list suggested_refs = guess_refs(ref);
788
789 fprintf_ln(stderr, _("%s: %s - %s"), cmd, ref, error);
790
791 if (suggested_refs.nr > 0) {
792 fprintf_ln(stderr,
793 Q_("\nDid you mean this?",
794 "\nDid you mean one of these?",
795 suggested_refs.nr));
796 for (i = 0; i < suggested_refs.nr; i++)
797 fprintf(stderr, "\t%s\n", suggested_refs.items[i].string);
798 }
799
800 string_list_clear(&suggested_refs, 0);
801 exit(1);
802}