trace2: Documentation/technical/api-trace2.txt
[git/git.git] / git.c
CommitLineData
85023577 1#include "builtin.h"
b2141fc1 2#include "config.h"
d807c4a0 3#include "exec-cmd.h"
fd5c363d 4#include "help.h"
d8e96fd8 5#include "run-command.h"
65b5f948 6#include "alias.h"
8e49d503 7
007aa8d8
NTND
8#define RUN_SETUP (1<<0)
9#define RUN_SETUP_GENTLY (1<<1)
10#define USE_PAGER (1<<2)
11/*
12 * require working tree to be present -- anything uses this needs
13 * RUN_SETUP for reading from the configuration file.
14 */
15#define NEED_WORK_TREE (1<<3)
16#define SUPPORT_SUPER_PREFIX (1<<4)
17#define DELAY_PAGER_CONFIG (1<<5)
e9547947 18#define NO_PARSEOPT (1<<6) /* parse-options is not used */
007aa8d8
NTND
19
20struct cmd_struct {
21 const char *cmd;
22 int (*fn)(int, const char **, const char *);
e9547947 23 unsigned int option;
007aa8d8
NTND
24};
25
822a7d50 26const char git_usage_string[] =
fc045fe7
AS
27 N_("git [--version] [--help] [-C <path>] [-c <name>=<value>]\n"
28 " [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
7213c288 29 " [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--bare]\n"
fc045fe7
AS
30 " [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
31 " <command> [<args>]");
822a7d50 32
b7d96819 33const char git_more_info_string[] =
ad5fe377 34 N_("'git help -a' and 'git help -g' list available subcommands and some\n"
73903d0b
PO
35 "concept guides. See 'git help <command>' or 'git help <concept>'\n"
36 "to read about a specific subcommand or concept.");
b7d96819 37
4e10738a 38static int use_pager = -1;
c0562611 39
e5d7a619 40static void list_builtins(struct string_list *list, unsigned int exclude_option);
8893fd95 41
e11dca10
NTND
42static void exclude_helpers_from_list(struct string_list *list)
43{
44 int i = 0;
45
46 while (i < list->nr) {
47 if (strstr(list->items[i].string, "--"))
48 unsorted_string_list_delete_item(list, i, 0);
49 else
50 i++;
51 }
52}
53
0089521c
NTND
54static int match_token(const char *spec, int len, const char *token)
55{
56 int token_len = strlen(token);
57
58 return len == token_len && !strncmp(spec, token, token_len);
59}
60
61static int list_cmds(const char *spec)
62{
e5d7a619
NTND
63 struct string_list list = STRING_LIST_INIT_DUP;
64 int i;
65
0089521c
NTND
66 while (*spec) {
67 const char *sep = strchrnul(spec, ',');
68 int len = sep - spec;
69
70 if (match_token(spec, len, "builtins"))
e5d7a619 71 list_builtins(&list, 0);
6bb2dc0b
NTND
72 else if (match_token(spec, len, "main"))
73 list_all_main_cmds(&list);
74 else if (match_token(spec, len, "others"))
75 list_all_other_cmds(&list);
e11dca10
NTND
76 else if (match_token(spec, len, "nohelpers"))
77 exclude_helpers_from_list(&list);
3301d36b
NTND
78 else if (match_token(spec, len, "alias"))
79 list_aliases(&list);
6532f374
NTND
80 else if (match_token(spec, len, "config"))
81 list_cmds_by_config(&list);
3c777767
NTND
82 else if (len > 5 && !strncmp(spec, "list-", 5)) {
83 struct strbuf sb = STRBUF_INIT;
84
85 strbuf_add(&sb, spec + 5, len - 5);
86 list_cmds_by_category(&list, sb.buf);
87 strbuf_release(&sb);
88 }
0089521c
NTND
89 else
90 die(_("unsupported command listing type '%s'"), spec);
91 spec += len;
92 if (*spec == ',')
93 spec++;
94 }
e5d7a619
NTND
95 for (i = 0; i < list.nr; i++)
96 puts(list.items[i].string);
97 string_list_clear(&list, 0);
0089521c
NTND
98 return 0;
99}
8893fd95 100
3b335762
NTND
101static void commit_pager_choice(void)
102{
4e10738a
JK
103 switch (use_pager) {
104 case 0:
105 setenv("GIT_PAGER", "cat", 1);
106 break;
107 case 1:
108 setup_pager();
109 break;
110 default:
111 break;
112 }
113}
114
033fe3d9
115void setup_auto_pager(const char *cmd, int def)
116{
117 if (use_pager != -1 || pager_in_use())
118 return;
119 use_pager = check_pager_config(cmd);
120 if (use_pager == -1)
121 use_pager = def;
122 commit_pager_choice();
123}
124
4b25d091 125static int handle_options(const char ***argv, int *argc, int *envchanged)
4ab243a9 126{
73546c08 127 const char **orig_argv = *argv;
4ab243a9
JS
128
129 while (*argc > 0) {
130 const char *cmd = (*argv)[0];
131 if (cmd[0] != '-')
132 break;
133
6acbcb92
JS
134 /*
135 * For legacy reasons, the "version" and "help"
136 * commands can be written with "--" prepended
137 * to make them look like flags.
138 */
139 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
140 break;
141
142 /*
143 * Check remaining flags.
144 */
ae021d87 145 if (skip_prefix(cmd, "--exec-path", &cmd)) {
6acbcb92 146 if (*cmd == '=')
226c0ddd 147 git_set_exec_path(cmd + 1);
6acbcb92
JS
148 else {
149 puts(git_exec_path());
150 exit(0);
151 }
89a56bfb
MH
152 } else if (!strcmp(cmd, "--html-path")) {
153 puts(system_path(GIT_HTML_PATH));
154 exit(0);
f2dd8c37
JS
155 } else if (!strcmp(cmd, "--man-path")) {
156 puts(system_path(GIT_MAN_PATH));
157 exit(0);
158 } else if (!strcmp(cmd, "--info-path")) {
159 puts(system_path(GIT_INFO_PATH));
160 exit(0);
6acbcb92 161 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
4e10738a 162 use_pager = 1;
7213c288 163 } else if (!strcmp(cmd, "-P") || !strcmp(cmd, "--no-pager")) {
4e10738a 164 use_pager = 0;
463a849d
MM
165 if (envchanged)
166 *envchanged = 1;
b0fa7ab5 167 } else if (!strcmp(cmd, "--no-replace-objects")) {
6ebd1caf 168 read_replace_refs = 0;
6476b38b
CC
169 setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
170 if (envchanged)
171 *envchanged = 1;
6acbcb92 172 } else if (!strcmp(cmd, "--git-dir")) {
c321f00d 173 if (*argc < 2) {
fc045fe7 174 fprintf(stderr, _("no directory given for --git-dir\n" ));
c321f00d
BG
175 usage(git_usage_string);
176 }
45b09794 177 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
4394efec
ML
178 if (envchanged)
179 *envchanged = 1;
6acbcb92
JS
180 (*argv)++;
181 (*argc)--;
ae021d87
JK
182 } else if (skip_prefix(cmd, "--git-dir=", &cmd)) {
183 setenv(GIT_DIR_ENVIRONMENT, cmd, 1);
4394efec
ML
184 if (envchanged)
185 *envchanged = 1;
a1bea2c1
JT
186 } else if (!strcmp(cmd, "--namespace")) {
187 if (*argc < 2) {
fc045fe7 188 fprintf(stderr, _("no namespace given for --namespace\n" ));
a1bea2c1
JT
189 usage(git_usage_string);
190 }
191 setenv(GIT_NAMESPACE_ENVIRONMENT, (*argv)[1], 1);
192 if (envchanged)
193 *envchanged = 1;
194 (*argv)++;
195 (*argc)--;
ae021d87
JK
196 } else if (skip_prefix(cmd, "--namespace=", &cmd)) {
197 setenv(GIT_NAMESPACE_ENVIRONMENT, cmd, 1);
a1bea2c1
JT
198 if (envchanged)
199 *envchanged = 1;
892c41b9
ML
200 } else if (!strcmp(cmd, "--work-tree")) {
201 if (*argc < 2) {
fc045fe7 202 fprintf(stderr, _("no directory given for --work-tree\n" ));
892c41b9
ML
203 usage(git_usage_string);
204 }
205 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
4394efec
ML
206 if (envchanged)
207 *envchanged = 1;
892c41b9
ML
208 (*argv)++;
209 (*argc)--;
ae021d87
JK
210 } else if (skip_prefix(cmd, "--work-tree=", &cmd)) {
211 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd, 1);
4394efec
ML
212 if (envchanged)
213 *envchanged = 1;
74866d75
BW
214 } else if (!strcmp(cmd, "--super-prefix")) {
215 if (*argc < 2) {
fc045fe7 216 fprintf(stderr, _("no prefix given for --super-prefix\n" ));
74866d75
BW
217 usage(git_usage_string);
218 }
219 setenv(GIT_SUPER_PREFIX_ENVIRONMENT, (*argv)[1], 1);
220 if (envchanged)
221 *envchanged = 1;
222 (*argv)++;
223 (*argc)--;
224 } else if (skip_prefix(cmd, "--super-prefix=", &cmd)) {
225 setenv(GIT_SUPER_PREFIX_ENVIRONMENT, cmd, 1);
226 if (envchanged)
227 *envchanged = 1;
6acbcb92 228 } else if (!strcmp(cmd, "--bare")) {
4d3ab44d 229 char *cwd = xgetcwd();
6adcca3f 230 is_bare_repository_cfg = 1;
4d3ab44d
RS
231 setenv(GIT_DIR_ENVIRONMENT, cwd, 0);
232 free(cwd);
2cd83d10 233 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
4394efec
ML
234 if (envchanged)
235 *envchanged = 1;
8b1fa778
AR
236 } else if (!strcmp(cmd, "-c")) {
237 if (*argc < 2) {
fc045fe7 238 fprintf(stderr, _("-c expects a configuration string\n" ));
8b1fa778
AR
239 usage(git_usage_string);
240 }
2b64fc89 241 git_config_push_parameter((*argv)[1]);
8b1fa778
AR
242 (*argv)++;
243 (*argc)--;
823ab40f
JK
244 } else if (!strcmp(cmd, "--literal-pathspecs")) {
245 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "1", 1);
246 if (envchanged)
247 *envchanged = 1;
248 } else if (!strcmp(cmd, "--no-literal-pathspecs")) {
249 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "0", 1);
250 if (envchanged)
251 *envchanged = 1;
bd30c2e4
NTND
252 } else if (!strcmp(cmd, "--glob-pathspecs")) {
253 setenv(GIT_GLOB_PATHSPECS_ENVIRONMENT, "1", 1);
254 if (envchanged)
255 *envchanged = 1;
256 } else if (!strcmp(cmd, "--noglob-pathspecs")) {
257 setenv(GIT_NOGLOB_PATHSPECS_ENVIRONMENT, "1", 1);
258 if (envchanged)
259 *envchanged = 1;
93d93537
NTND
260 } else if (!strcmp(cmd, "--icase-pathspecs")) {
261 setenv(GIT_ICASE_PATHSPECS_ENVIRONMENT, "1", 1);
262 if (envchanged)
263 *envchanged = 1;
27344d6a
JK
264 } else if (!strcmp(cmd, "--no-optional-locks")) {
265 setenv(GIT_OPTIONAL_LOCKS_ENVIRONMENT, "0", 1);
266 if (envchanged)
267 *envchanged = 1;
6035d6aa
NTND
268 } else if (!strcmp(cmd, "--shallow-file")) {
269 (*argv)++;
270 (*argc)--;
6a2df51c 271 set_alternate_shallow_file(the_repository, (*argv)[0], 1);
6035d6aa
NTND
272 if (envchanged)
273 *envchanged = 1;
44e1e4d6
NR
274 } else if (!strcmp(cmd, "-C")) {
275 if (*argc < 2) {
fc045fe7 276 fprintf(stderr, _("no directory given for -C\n" ));
44e1e4d6
NR
277 usage(git_usage_string);
278 }
6a536e20
KN
279 if ((*argv)[1][0]) {
280 if (chdir((*argv)[1]))
fc045fe7 281 die_errno("cannot change to '%s'", (*argv)[1]);
6a536e20
KN
282 if (envchanged)
283 *envchanged = 1;
284 }
44e1e4d6
NR
285 (*argv)++;
286 (*argc)--;
0089521c
NTND
287 } else if (skip_prefix(cmd, "--list-cmds=", &cmd)) {
288 if (!strcmp(cmd, "parseopt")) {
e5d7a619
NTND
289 struct string_list list = STRING_LIST_INIT_DUP;
290 int i;
291
292 list_builtins(&list, NO_PARSEOPT);
293 for (i = 0; i < list.nr; i++)
294 printf("%s ", list.items[i].string);
295 string_list_clear(&list, 0);
0089521c
NTND
296 exit(0);
297 } else {
298 exit(list_cmds(cmd));
299 }
6acbcb92 300 } else {
fc045fe7 301 fprintf(stderr, _("unknown option: %s\n"), cmd);
822a7d50 302 usage(git_usage_string);
6acbcb92 303 }
4ab243a9
JS
304
305 (*argv)++;
306 (*argc)--;
4ab243a9 307 }
73546c08 308 return (*argv) - orig_argv;
4ab243a9
JS
309}
310
2b11e317
JS
311static int handle_alias(int *argcp, const char ***argv)
312{
af05d679 313 int envchanged = 0, ret = 0, saved_errno = errno;
0347a8c7 314 int count, option_count;
4b25d091 315 const char **new_argv;
94351118
JK
316 const char *alias_command;
317 char *alias_string;
0347a8c7
ML
318
319 alias_command = (*argv)[0];
94351118 320 alias_string = alias_lookup(alias_command);
0347a8c7 321 if (alias_string) {
a9a60b94
RV
322 if (*argcp > 1 && !strcmp((*argv)[1], "-h"))
323 fprintf_ln(stderr, _("'%s' is aliased to '%s'"),
324 alias_command, alias_string);
dfd42a3c 325 if (alias_string[0] == '!') {
850d2fec 326 struct child_process child = CHILD_PROCESS_INIT;
a9bcf658
JS
327 int nongit_ok;
328
329 /* Aliases expect GIT_PREFIX, GIT_DIR etc to be set */
330 setup_git_directory_gently(&nongit_ok);
7f51f8bc 331
030149a4 332 commit_pager_choice();
7f51f8bc 333
850d2fec
JK
334 child.use_shell = 1;
335 argv_array_push(&child.args, alias_string + 1);
336 argv_array_pushv(&child.args, (*argv) + 1);
7f51f8bc 337
850d2fec 338 ret = run_command(&child);
7f51f8bc
EFL
339 if (ret >= 0) /* normal exit */
340 exit(ret);
341
8aa8c140
NTND
342 die_errno(_("while expanding alias '%s': '%s'"),
343 alias_command, alias_string + 1);
dfd42a3c 344 }
0347a8c7 345 count = split_cmdline(alias_string, &new_argv);
dc4179f9 346 if (count < 0)
8aa8c140 347 die(_("bad alias.%s string: %s"), alias_command,
a7412ae1 348 _(split_cmdline_strerror(count)));
4394efec
ML
349 option_count = handle_options(&new_argv, &count, &envchanged);
350 if (envchanged)
8aa8c140
NTND
351 die(_("alias '%s' changes environment variables.\n"
352 "You can use '!git' in the alias to do this"),
353 alias_command);
0347a8c7
ML
354 memmove(new_argv - option_count, new_argv,
355 count * sizeof(char *));
356 new_argv -= option_count;
357
358 if (count < 1)
8aa8c140 359 die(_("empty alias for %s"), alias_command);
0347a8c7
ML
360
361 if (!strcmp(alias_command, new_argv[0]))
8aa8c140 362 die(_("recursive alias: %s"), alias_command);
0347a8c7 363
b319ce4c 364 trace_argv_printf(new_argv,
6ce4e61f
CC
365 "trace: alias expansion: %s =>",
366 alias_command);
575ba9d6 367
2756ca43 368 REALLOC_ARRAY(new_argv, count + *argcp);
0347a8c7 369 /* insert after command name */
4b25d091 370 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
2b11e317 371
0347a8c7
ML
372 *argv = new_argv;
373 *argcp += count - 1;
2b11e317 374
0347a8c7 375 ret = 1;
2b11e317
JS
376 }
377
47e5c0ca
JS
378 errno = saved_errno;
379
2b11e317
JS
380 return ret;
381}
382
f172f334 383static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
47d0b4ff 384{
99caeed0 385 int status, help;
0f157315 386 struct stat st;
47d0b4ff
LT
387 const char *prefix;
388
389 prefix = NULL;
99caeed0
JN
390 help = argc == 2 && !strcmp(argv[1], "-h");
391 if (!help) {
392 if (p->option & RUN_SETUP)
393 prefix = setup_git_directory();
27bd38d4 394 else if (p->option & RUN_SETUP_GENTLY) {
ee38dfb8
NTND
395 int nongit_ok;
396 prefix = setup_git_directory_gently(&nongit_ok);
397 }
99caeed0 398
c409824c
399 if (use_pager == -1 && p->option & (RUN_SETUP | RUN_SETUP_GENTLY) &&
400 !(p->option & DELAY_PAGER_CONFIG))
99caeed0
JN
401 use_pager = check_pager_config(p->cmd);
402 if (use_pager == -1 && p->option & USE_PAGER)
403 use_pager = 1;
a9ca8a85
NTND
404
405 if ((p->option & (RUN_SETUP | RUN_SETUP_GENTLY)) &&
406 startup_info->have_repository) /* get_git_dir() may set up repo, avoid that */
407 trace_repo_setup(prefix);
99caeed0 408 }
4e10738a
JK
409 commit_pager_choice();
410
74866d75
BW
411 if (!help && get_super_prefix()) {
412 if (!(p->option & SUPPORT_SUPER_PREFIX))
8aa8c140 413 die(_("%s doesn't support --super-prefix"), p->cmd);
74866d75
BW
414 }
415
99caeed0 416 if (!help && p->option & NEED_WORK_TREE)
59f0f2f3
MH
417 setup_work_tree();
418
b319ce4c 419 trace_argv_printf(argv, "trace: built-in: git");
47d0b4ff 420
f8adbec9 421 validate_cache_entries(the_repository->index);
0f157315 422 status = p->fn(argc, argv, prefix);
f8adbec9 423 validate_cache_entries(the_repository->index);
8616a2d0 424
0f157315 425 if (status)
47e3de0e 426 return status;
0f157315
LT
427
428 /* Somebody closed stdout? */
429 if (fstat(fileno(stdout), &st))
430 return 0;
431 /* Ignore write errors for pipes and sockets.. */
432 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
433 return 0;
434
435 /* Check for ENOSPC and EIO errors.. */
0227f988 436 if (fflush(stdout))
8aa8c140 437 die_errno(_("write failure on standard output"));
0227f988 438 if (ferror(stdout))
8aa8c140 439 die(_("unknown write failure on standard output"));
0227f988 440 if (fclose(stdout))
8aa8c140 441 die_errno(_("close failed on standard output"));
0f157315 442 return 0;
47d0b4ff
LT
443}
444
c6127fa3
SS
445static struct cmd_struct commands[] = {
446 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
783d7e86 447 { "am", cmd_am, RUN_SETUP | NEED_WORK_TREE },
e9547947 448 { "annotate", cmd_annotate, RUN_SETUP | NO_PARSEOPT },
c6127fa3 449 { "apply", cmd_apply, RUN_SETUP_GENTLY },
eb0224c6 450 { "archive", cmd_archive, RUN_SETUP_GENTLY },
c6127fa3
SS
451 { "bisect--helper", cmd_bisect__helper, RUN_SETUP },
452 { "blame", cmd_blame, RUN_SETUP },
d74b541e 453 { "branch", cmd_branch, RUN_SETUP | DELAY_PAGER_CONFIG },
e9547947 454 { "bundle", cmd_bundle, RUN_SETUP_GENTLY | NO_PARSEOPT },
c6127fa3
SS
455 { "cat-file", cmd_cat_file, RUN_SETUP },
456 { "check-attr", cmd_check_attr, RUN_SETUP },
457 { "check-ignore", cmd_check_ignore, RUN_SETUP | NEED_WORK_TREE },
458 { "check-mailmap", cmd_check_mailmap, RUN_SETUP },
e9547947 459 { "check-ref-format", cmd_check_ref_format, NO_PARSEOPT },
0ca560cb 460 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
c6127fa3
SS
461 { "checkout-index", cmd_checkout_index,
462 RUN_SETUP | NEED_WORK_TREE},
463 { "cherry", cmd_cherry, RUN_SETUP },
464 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
465 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
86d26f24 466 { "clone", cmd_clone },
c6127fa3
SS
467 { "column", cmd_column, RUN_SETUP_GENTLY },
468 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
4ce58ee3 469 { "commit-graph", cmd_commit_graph, RUN_SETUP },
e9547947 470 { "commit-tree", cmd_commit_tree, RUN_SETUP | NO_PARSEOPT },
32888b8f 471 { "config", cmd_config, RUN_SETUP_GENTLY | DELAY_PAGER_CONFIG },
c6127fa3 472 { "count-objects", cmd_count_objects, RUN_SETUP },
e9547947 473 { "credential", cmd_credential, RUN_SETUP_GENTLY | NO_PARSEOPT },
c6127fa3 474 { "describe", cmd_describe, RUN_SETUP },
e9547947
NTND
475 { "diff", cmd_diff, NO_PARSEOPT },
476 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
477 { "diff-index", cmd_diff_index, RUN_SETUP | NO_PARSEOPT },
478 { "diff-tree", cmd_diff_tree, RUN_SETUP | NO_PARSEOPT },
019678d6 479 { "difftool", cmd_difftool, RUN_SETUP | NEED_WORK_TREE },
c6127fa3
SS
480 { "fast-export", cmd_fast_export, RUN_SETUP },
481 { "fetch", cmd_fetch, RUN_SETUP },
e9547947 482 { "fetch-pack", cmd_fetch_pack, RUN_SETUP | NO_PARSEOPT },
c6127fa3
SS
483 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
484 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
485 { "format-patch", cmd_format_patch, RUN_SETUP },
486 { "fsck", cmd_fsck, RUN_SETUP },
487 { "fsck-objects", cmd_fsck, RUN_SETUP },
488 { "gc", cmd_gc, RUN_SETUP },
e9547947 489 { "get-tar-commit-id", cmd_get_tar_commit_id, NO_PARSEOPT },
f9ee2fcd 490 { "grep", cmd_grep, RUN_SETUP_GENTLY },
c6127fa3
SS
491 { "hash-object", cmd_hash_object },
492 { "help", cmd_help },
e9547947 493 { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY | NO_PARSEOPT },
86d26f24
NTND
494 { "init", cmd_init_db },
495 { "init-db", cmd_init_db },
cbd9fc23 496 { "interpret-trailers", cmd_interpret_trailers, RUN_SETUP_GENTLY },
c6127fa3 497 { "log", cmd_log, RUN_SETUP },
188dce13 498 { "ls-files", cmd_ls_files, RUN_SETUP },
c6127fa3
SS
499 { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
500 { "ls-tree", cmd_ls_tree, RUN_SETUP },
e9547947
NTND
501 { "mailinfo", cmd_mailinfo, RUN_SETUP_GENTLY | NO_PARSEOPT },
502 { "mailsplit", cmd_mailsplit, NO_PARSEOPT },
c6127fa3
SS
503 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
504 { "merge-base", cmd_merge_base, RUN_SETUP },
505 { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
e9547947
NTND
506 { "merge-index", cmd_merge_index, RUN_SETUP | NO_PARSEOPT },
507 { "merge-ours", cmd_merge_ours, RUN_SETUP | NO_PARSEOPT },
508 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
509 { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
510 { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
511 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
512 { "merge-tree", cmd_merge_tree, RUN_SETUP | NO_PARSEOPT },
513 { "mktag", cmd_mktag, RUN_SETUP | NO_PARSEOPT },
c6127fa3 514 { "mktree", cmd_mktree, RUN_SETUP },
6a257f03 515 { "multi-pack-index", cmd_multi_pack_index, RUN_SETUP_GENTLY },
c6127fa3
SS
516 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
517 { "name-rev", cmd_name_rev, RUN_SETUP },
518 { "notes", cmd_notes, RUN_SETUP },
519 { "pack-objects", cmd_pack_objects, RUN_SETUP },
e9547947 520 { "pack-redundant", cmd_pack_redundant, RUN_SETUP | NO_PARSEOPT },
c6127fa3 521 { "pack-refs", cmd_pack_refs, RUN_SETUP },
e9547947 522 { "patch-id", cmd_patch_id, RUN_SETUP_GENTLY | NO_PARSEOPT },
c6127fa3
SS
523 { "pickaxe", cmd_blame, RUN_SETUP },
524 { "prune", cmd_prune, RUN_SETUP },
525 { "prune-packed", cmd_prune_packed, RUN_SETUP },
1e1ea69f 526 { "pull", cmd_pull, RUN_SETUP | NEED_WORK_TREE },
c6127fa3 527 { "push", cmd_push, RUN_SETUP },
348ae56c 528 { "range-diff", cmd_range_diff, RUN_SETUP | USE_PAGER },
3d415425 529 { "read-tree", cmd_read_tree, RUN_SETUP | SUPPORT_SUPER_PREFIX},
55071ea2
PK
530 /*
531 * NEEDSWORK: Until the rebase is independent and needs no redirection
532 * to rebase shell script this is kept as is, then should be changed to
533 * RUN_SETUP | NEED_WORK_TREE
534 */
535 { "rebase", cmd_rebase },
cf808208 536 { "rebase--interactive", cmd_rebase__interactive, RUN_SETUP | NEED_WORK_TREE },
c6127fa3
SS
537 { "receive-pack", cmd_receive_pack },
538 { "reflog", cmd_reflog, RUN_SETUP },
539 { "remote", cmd_remote, RUN_SETUP },
e9547947
NTND
540 { "remote-ext", cmd_remote_ext, NO_PARSEOPT },
541 { "remote-fd", cmd_remote_fd, NO_PARSEOPT },
c6127fa3
SS
542 { "repack", cmd_repack, RUN_SETUP },
543 { "replace", cmd_replace, RUN_SETUP },
544 { "rerere", cmd_rerere, RUN_SETUP },
545 { "reset", cmd_reset, RUN_SETUP },
e9547947
NTND
546 { "rev-list", cmd_rev_list, RUN_SETUP | NO_PARSEOPT },
547 { "rev-parse", cmd_rev_parse, NO_PARSEOPT },
c6127fa3
SS
548 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
549 { "rm", cmd_rm, RUN_SETUP },
550 { "send-pack", cmd_send_pack, RUN_SETUP },
ed10cb95 551 { "serve", cmd_serve, RUN_SETUP },
c6127fa3
SS
552 { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
553 { "show", cmd_show, RUN_SETUP },
554 { "show-branch", cmd_show_branch, RUN_SETUP },
ff417260 555 { "show-index", cmd_show_index },
c6127fa3
SS
556 { "show-ref", cmd_show_ref, RUN_SETUP },
557 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
558 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
559 { "stripspace", cmd_stripspace },
e9547947 560 { "submodule--helper", cmd_submodule__helper, RUN_SETUP | SUPPORT_SUPER_PREFIX | NO_PARSEOPT },
c6127fa3 561 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
de121ffe 562 { "tag", cmd_tag, RUN_SETUP | DELAY_PAGER_CONFIG },
e9547947
NTND
563 { "unpack-file", cmd_unpack_file, RUN_SETUP | NO_PARSEOPT },
564 { "unpack-objects", cmd_unpack_objects, RUN_SETUP | NO_PARSEOPT },
c6127fa3
SS
565 { "update-index", cmd_update_index, RUN_SETUP },
566 { "update-ref", cmd_update_ref, RUN_SETUP },
567 { "update-server-info", cmd_update_server_info, RUN_SETUP },
e9547947
NTND
568 { "upload-archive", cmd_upload_archive, NO_PARSEOPT },
569 { "upload-archive--writer", cmd_upload_archive_writer, NO_PARSEOPT },
a3d6b53e 570 { "upload-pack", cmd_upload_pack },
e9547947 571 { "var", cmd_var, RUN_SETUP_GENTLY | NO_PARSEOPT },
d07b00b7 572 { "verify-commit", cmd_verify_commit, RUN_SETUP },
c6127fa3
SS
573 { "verify-pack", cmd_verify_pack },
574 { "verify-tag", cmd_verify_tag, RUN_SETUP },
575 { "version", cmd_version },
576 { "whatchanged", cmd_whatchanged, RUN_SETUP },
e9547947 577 { "worktree", cmd_worktree, RUN_SETUP | NO_PARSEOPT },
c6127fa3
SS
578 { "write-tree", cmd_write_tree, RUN_SETUP },
579};
580
c4f901d1 581static struct cmd_struct *get_builtin(const char *s)
c6127fa3
SS
582{
583 int i;
584 for (i = 0; i < ARRAY_SIZE(commands); i++) {
c4f901d1 585 struct cmd_struct *p = commands + i;
c6127fa3 586 if (!strcmp(s, p->cmd))
c4f901d1 587 return p;
c6127fa3 588 }
c4f901d1
SV
589 return NULL;
590}
591
592int is_builtin(const char *s)
593{
594 return !!get_builtin(s);
c6127fa3
SS
595}
596
e5d7a619 597static void list_builtins(struct string_list *out, unsigned int exclude_option)
8893fd95
JK
598{
599 int i;
e9547947
NTND
600 for (i = 0; i < ARRAY_SIZE(commands); i++) {
601 if (exclude_option &&
602 (commands[i].option & exclude_option))
603 continue;
e5d7a619 604 string_list_append(out, commands[i].cmd);
e9547947 605 }
8893fd95
JK
606}
607
63ca1c09
AK
608#ifdef STRIP_EXTENSION
609static void strip_extension(const char **argv)
610{
611 size_t len;
612
613 if (strip_suffix(argv[0], STRIP_EXTENSION, &len))
614 argv[0] = xmemdupz(argv[0], len);
615}
616#else
617#define strip_extension(cmd)
618#endif
619
3f784a4d 620static void handle_builtin(int argc, const char **argv)
231af832 621{
2c6b6d9f 622 struct argv_array args = ARGV_ARRAY_INIT;
63ca1c09 623 const char *cmd;
c4f901d1 624 struct cmd_struct *builtin;
23326d14 625
63ca1c09
AK
626 strip_extension(argv);
627 cmd = argv[0];
231af832 628
2c6b6d9f 629 /* Turn "git cmd --help" into "git help --exclude-guides cmd" */
1cd95087 630 if (argc > 1 && !strcmp(argv[1], "--help")) {
2c6b6d9f
RT
631 int i;
632
1cd95087
LT
633 argv[1] = argv[0];
634 argv[0] = cmd = "help";
2c6b6d9f
RT
635
636 for (i = 0; i < argc; i++) {
637 argv_array_push(&args, argv[i]);
638 if (!i)
639 argv_array_push(&args, "--exclude-guides");
640 }
641
642 argc++;
643 argv = args.argv;
1cd95087
LT
644 }
645
c4f901d1 646 builtin = get_builtin(cmd);
441981bc
JH
647 if (builtin)
648 exit(run_builtin(builtin, argc, argv));
2c6b6d9f 649 argv_array_clear(&args);
231af832
LT
650}
651
7550be0a
JH
652static void execv_dashed_external(const char **argv)
653{
2b296c93 654 struct child_process cmd = CHILD_PROCESS_INIT;
d8e96fd8 655 int status;
7550be0a 656
74866d75 657 if (get_super_prefix())
8aa8c140 658 die(_("%s doesn't support --super-prefix"), argv[0]);
74866d75 659
595d59e2 660 if (use_pager == -1 && !is_builtin(argv[0]))
92058e4d 661 use_pager = check_pager_config(argv[0]);
030149a4
JN
662 commit_pager_choice();
663
2b296c93
JK
664 argv_array_pushf(&cmd.args, "git-%s", argv[0]);
665 argv_array_pushv(&cmd.args, argv + 1);
666 cmd.clean_on_exit = 1;
46df6906 667 cmd.wait_after_clean = 1;
2b296c93 668 cmd.silent_exec_failure = 1;
7550be0a 669
2b296c93 670 trace_argv_printf(cmd.args.argv, "trace: exec:");
7550be0a 671
d8e96fd8 672 /*
246f0ede
JK
673 * If we fail because the command is not found, it is
674 * OK to return. Otherwise, we just pass along the status code,
675 * or our usual generic code if we were not even able to exec
676 * the program.
d8e96fd8 677 */
2b296c93 678 status = run_command(&cmd);
246f0ede 679 if (status >= 0)
5709e036 680 exit(status);
246f0ede
JK
681 else if (errno != ENOENT)
682 exit(128);
7550be0a
JH
683}
684
a907e1b6
AS
685static int run_argv(int *argcp, const char ***argv)
686{
687 int done_alias = 0;
c6d75bc1 688 struct string_list cmd_list = STRING_LIST_INIT_NODUP;
82f71d9a 689 struct string_list_item *seen;
a907e1b6
AS
690
691 while (1) {
441981bc
JH
692 /*
693 * If we tried alias and futzed with our environment,
694 * it no longer is safe to invoke builtins directly in
695 * general. We have to spawn them as dashed externals.
696 *
697 * NEEDSWORK: if we can figure out cases
698 * where it is safe to do, we can avoid spawning a new
699 * process.
700 */
701 if (!done_alias)
702 handle_builtin(*argcp, *argv);
a907e1b6
AS
703
704 /* .. then try the external ones */
705 execv_dashed_external(*argv);
706
82f71d9a
TS
707 seen = unsorted_string_list_lookup(&cmd_list, *argv[0]);
708 if (seen) {
709 int i;
710 struct strbuf sb = STRBUF_INIT;
711 for (i = 0; i < cmd_list.nr; i++) {
712 struct string_list_item *item = &cmd_list.items[i];
713
714 strbuf_addf(&sb, "\n %s", item->string);
715 if (item == seen)
716 strbuf_addstr(&sb, " <==");
717 else if (i == cmd_list.nr - 1)
718 strbuf_addstr(&sb, " ==>");
719 }
c6d75bc1 720 die(_("alias loop detected: expansion of '%s' does"
82f71d9a 721 " not terminate:%s"), cmd_list.items[0].string, sb.buf);
c6d75bc1
TS
722 }
723
724 string_list_append(&cmd_list, *argv[0]);
725
726 /*
727 * It could be an alias -- this works around the insanity
a907e1b6
AS
728 * of overriding "git log" with "git show" by having
729 * alias.log = show
730 */
c0562611 731 if (!handle_alias(argcp, argv))
a907e1b6
AS
732 break;
733 done_alias = 1;
734 }
735
c6d75bc1
TS
736 string_list_clear(&cmd_list, 0);
737
a907e1b6
AS
738 return done_alias;
739}
740
3f2e2297 741int cmd_main(int argc, const char **argv)
8e49d503 742{
4dd47c3b 743 const char *cmd;
8fa7975b 744 int done_help = 0;
231af832 745
650c4492 746 cmd = argv[0];
2cd72b0b 747 if (!cmd)
4dd47c3b 748 cmd = "git-help";
6854a8f5
JK
749 else {
750 const char *slash = find_last_dir_sep(cmd);
751 if (slash)
752 cmd = slash + 1;
753 }
8e49d503 754
578da039
KB
755 trace_command_performance(argv);
756
231af832
LT
757 /*
758 * "git-xxxx" is the same as "git xxxx", but we obviously:
759 *
760 * - cannot take flags in between the "git" and the "xxxx".
761 * - cannot execute it externally (since it would just do
762 * the same thing over again)
763 *
3f784a4d
SS
764 * So we just directly call the builtin handler, and die if
765 * that one cannot handle it.
231af832 766 */
ae021d87 767 if (skip_prefix(cmd, "git-", &cmd)) {
231af832 768 argv[0] = cmd;
3f784a4d 769 handle_builtin(argc, argv);
8aa8c140 770 die(_("cannot handle %s as a builtin"), cmd);
231af832 771 }
8e49d503 772
231af832 773 /* Look for flags.. */
6acbcb92
JS
774 argv++;
775 argc--;
4394efec 776 handle_options(&argv, &argc, NULL);
6acbcb92 777 if (argc > 0) {
6d877803
JK
778 /* translate --help and --version into commands */
779 skip_prefix(argv[0], "--", &argv[0]);
6acbcb92 780 } else {
3d7e2d85 781 /* The user didn't specify a command; give them help */
73e25e7c 782 commit_pager_choice();
8aa8c140 783 printf(_("usage: %s\n\n"), git_usage_string);
3d7e2d85 784 list_common_cmds_help();
421a9769 785 printf("\n%s\n", _(git_more_info_string));
3d7e2d85 786 exit(1);
97fc6c5f 787 }
6acbcb92 788 cmd = argv[0];
231af832
LT
789
790 /*
511707d4 791 * We use PATH to find git commands, but we prepend some higher
3ea3c215 792 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
511707d4
SP
793 * environment, and the $(gitexecdir) from the Makefile at build
794 * time.
231af832 795 */
e1464ca7 796 setup_path();
8e49d503 797
a025463b 798 while (1) {
8fa7975b 799 int was_alias = run_argv(&argc, &argv);
a907e1b6 800 if (errno != ENOENT)
a025463b 801 break;
a907e1b6 802 if (was_alias) {
fc045fe7
AS
803 fprintf(stderr, _("expansion of alias '%s' failed; "
804 "'%s' is not a git command\n"),
f3dd015c
TT
805 cmd, argv[0]);
806 exit(1);
807 }
a907e1b6
AS
808 if (!done_help) {
809 cmd = argv[0] = help_unknown_cmd(cmd);
810 done_help = 1;
811 } else
812 break;
f3dd015c 813 }
10b15b86 814
fc045fe7 815 fprintf(stderr, _("failed to run command '%s': %s\n"),
33ebb871 816 cmd, strerror(errno));
8e49d503
AE
817
818 return 1;
819}