5 #include "run-command.h"
7 #define RUN_SETUP (1<<0)
8 #define RUN_SETUP_GENTLY (1<<1)
9 #define USE_PAGER (1<<2)
11 * require working tree to be present -- anything uses this needs
12 * RUN_SETUP for reading from the configuration file.
14 #define NEED_WORK_TREE (1<<3)
15 #define SUPPORT_SUPER_PREFIX (1<<4)
16 #define DELAY_PAGER_CONFIG (1<<5)
17 #define NO_PARSEOPT (1<<6) /* parse-options is not used */
21 int (*fn)(int, const char **, const char *);
25 const char git_usage_string[] =
26 N_("git [--version] [--help] [-C <path>] [-c <name>=<value>]\n"
27 " [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
28 " [-p | --paginate | --no-pager] [--no-replace-objects] [--bare]\n"
29 " [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
30 " <command> [<args>]");
32 const char git_more_info_string[] =
33 N_("'git help -a' and 'git help -g' list available subcommands and some\n"
34 "concept guides. See 'git help <command>' or 'git help <concept>'\n"
35 "to read about a specific subcommand or concept.");
37 static int use_pager = -1;
39 static void list_builtins(unsigned int exclude_option, char sep);
41 static void commit_pager_choice(void) {
44 setenv("GIT_PAGER", "cat", 1);
54 void setup_auto_pager(const char *cmd, int def)
56 if (use_pager != -1 || pager_in_use())
58 use_pager = check_pager_config(cmd);
61 commit_pager_choice();
64 static int handle_options(const char ***argv, int *argc, int *envchanged)
66 const char **orig_argv = *argv;
69 const char *cmd = (*argv)[0];
74 * For legacy reasons, the "version" and "help"
75 * commands can be written with "--" prepended
76 * to make them look like flags.
78 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
82 * Check remaining flags.
84 if (skip_prefix(cmd, "--exec-path", &cmd)) {
86 git_set_exec_path(cmd + 1);
88 puts(git_exec_path());
91 } else if (!strcmp(cmd, "--html-path")) {
92 puts(system_path(GIT_HTML_PATH));
94 } else if (!strcmp(cmd, "--man-path")) {
95 puts(system_path(GIT_MAN_PATH));
97 } else if (!strcmp(cmd, "--info-path")) {
98 puts(system_path(GIT_INFO_PATH));
100 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
102 } else if (!strcmp(cmd, "--no-pager")) {
106 } else if (!strcmp(cmd, "--no-replace-objects")) {
107 check_replace_refs = 0;
108 setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
111 } else if (!strcmp(cmd, "--git-dir")) {
113 fprintf(stderr, _("no directory given for --git-dir\n" ));
114 usage(git_usage_string);
116 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
121 } else if (skip_prefix(cmd, "--git-dir=", &cmd)) {
122 setenv(GIT_DIR_ENVIRONMENT, cmd, 1);
125 } else if (!strcmp(cmd, "--namespace")) {
127 fprintf(stderr, _("no namespace given for --namespace\n" ));
128 usage(git_usage_string);
130 setenv(GIT_NAMESPACE_ENVIRONMENT, (*argv)[1], 1);
135 } else if (skip_prefix(cmd, "--namespace=", &cmd)) {
136 setenv(GIT_NAMESPACE_ENVIRONMENT, cmd, 1);
139 } else if (!strcmp(cmd, "--work-tree")) {
141 fprintf(stderr, _("no directory given for --work-tree\n" ));
142 usage(git_usage_string);
144 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
149 } else if (skip_prefix(cmd, "--work-tree=", &cmd)) {
150 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd, 1);
153 } else if (!strcmp(cmd, "--super-prefix")) {
155 fprintf(stderr, _("no prefix given for --super-prefix\n" ));
156 usage(git_usage_string);
158 setenv(GIT_SUPER_PREFIX_ENVIRONMENT, (*argv)[1], 1);
163 } else if (skip_prefix(cmd, "--super-prefix=", &cmd)) {
164 setenv(GIT_SUPER_PREFIX_ENVIRONMENT, cmd, 1);
167 } else if (!strcmp(cmd, "--bare")) {
168 char *cwd = xgetcwd();
169 is_bare_repository_cfg = 1;
170 setenv(GIT_DIR_ENVIRONMENT, cwd, 0);
172 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
175 } else if (!strcmp(cmd, "-c")) {
177 fprintf(stderr, _("-c expects a configuration string\n" ));
178 usage(git_usage_string);
180 git_config_push_parameter((*argv)[1]);
183 } else if (!strcmp(cmd, "--literal-pathspecs")) {
184 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "1", 1);
187 } else if (!strcmp(cmd, "--no-literal-pathspecs")) {
188 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "0", 1);
191 } else if (!strcmp(cmd, "--glob-pathspecs")) {
192 setenv(GIT_GLOB_PATHSPECS_ENVIRONMENT, "1", 1);
195 } else if (!strcmp(cmd, "--noglob-pathspecs")) {
196 setenv(GIT_NOGLOB_PATHSPECS_ENVIRONMENT, "1", 1);
199 } else if (!strcmp(cmd, "--icase-pathspecs")) {
200 setenv(GIT_ICASE_PATHSPECS_ENVIRONMENT, "1", 1);
203 } else if (!strcmp(cmd, "--no-optional-locks")) {
204 setenv(GIT_OPTIONAL_LOCKS_ENVIRONMENT, "0", 1);
207 } else if (!strcmp(cmd, "--shallow-file")) {
210 set_alternate_shallow_file((*argv)[0], 1);
213 } else if (!strcmp(cmd, "-C")) {
215 fprintf(stderr, _("no directory given for -C\n" ));
216 usage(git_usage_string);
219 if (chdir((*argv)[1]))
220 die_errno("cannot change to '%s'", (*argv)[1]);
226 } else if (!strcmp(cmd, "--list-builtins")) {
227 list_builtins(0, '\n');
229 } else if (!strcmp(cmd, "--list-parseopt-builtins")) {
230 list_builtins(NO_PARSEOPT, ' ');
233 fprintf(stderr, _("unknown option: %s\n"), cmd);
234 usage(git_usage_string);
240 return (*argv) - orig_argv;
243 static int handle_alias(int *argcp, const char ***argv)
245 int envchanged = 0, ret = 0, saved_errno = errno;
246 int count, option_count;
247 const char **new_argv;
248 const char *alias_command;
251 alias_command = (*argv)[0];
252 alias_string = alias_lookup(alias_command);
254 if (alias_string[0] == '!') {
255 struct child_process child = CHILD_PROCESS_INIT;
258 /* Aliases expect GIT_PREFIX, GIT_DIR etc to be set */
259 setup_git_directory_gently(&nongit_ok);
261 commit_pager_choice();
264 argv_array_push(&child.args, alias_string + 1);
265 argv_array_pushv(&child.args, (*argv) + 1);
267 ret = run_command(&child);
268 if (ret >= 0) /* normal exit */
271 die_errno("while expanding alias '%s': '%s'",
272 alias_command, alias_string + 1);
274 count = split_cmdline(alias_string, &new_argv);
276 die("Bad alias.%s string: %s", alias_command,
277 split_cmdline_strerror(count));
278 option_count = handle_options(&new_argv, &count, &envchanged);
280 die("alias '%s' changes environment variables.\n"
281 "You can use '!git' in the alias to do this",
283 memmove(new_argv - option_count, new_argv,
284 count * sizeof(char *));
285 new_argv -= option_count;
288 die("empty alias for %s", alias_command);
290 if (!strcmp(alias_command, new_argv[0]))
291 die("recursive alias: %s", alias_command);
293 trace_argv_printf(new_argv,
294 "trace: alias expansion: %s =>",
297 REALLOC_ARRAY(new_argv, count + *argcp);
298 /* insert after command name */
299 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
312 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
319 help = argc == 2 && !strcmp(argv[1], "-h");
321 if (p->option & RUN_SETUP)
322 prefix = setup_git_directory();
323 else if (p->option & RUN_SETUP_GENTLY) {
325 prefix = setup_git_directory_gently(&nongit_ok);
328 if (use_pager == -1 && p->option & (RUN_SETUP | RUN_SETUP_GENTLY) &&
329 !(p->option & DELAY_PAGER_CONFIG))
330 use_pager = check_pager_config(p->cmd);
331 if (use_pager == -1 && p->option & USE_PAGER)
334 if ((p->option & (RUN_SETUP | RUN_SETUP_GENTLY)) &&
335 startup_info->have_repository) /* get_git_dir() may set up repo, avoid that */
336 trace_repo_setup(prefix);
338 commit_pager_choice();
340 if (!help && get_super_prefix()) {
341 if (!(p->option & SUPPORT_SUPER_PREFIX))
342 die("%s doesn't support --super-prefix", p->cmd);
345 if (!help && p->option & NEED_WORK_TREE)
348 trace_argv_printf(argv, "trace: built-in: git");
350 status = p->fn(argc, argv, prefix);
354 /* Somebody closed stdout? */
355 if (fstat(fileno(stdout), &st))
357 /* Ignore write errors for pipes and sockets.. */
358 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
361 /* Check for ENOSPC and EIO errors.. */
363 die_errno("write failure on standard output");
365 die("unknown write failure on standard output");
367 die_errno("close failed on standard output");
371 static struct cmd_struct commands[] = {
372 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
373 { "am", cmd_am, RUN_SETUP | NEED_WORK_TREE },
374 { "annotate", cmd_annotate, RUN_SETUP | NO_PARSEOPT },
375 { "apply", cmd_apply, RUN_SETUP_GENTLY },
376 { "archive", cmd_archive, RUN_SETUP_GENTLY },
377 { "bisect--helper", cmd_bisect__helper, RUN_SETUP },
378 { "blame", cmd_blame, RUN_SETUP },
379 { "branch", cmd_branch, RUN_SETUP | DELAY_PAGER_CONFIG },
380 { "bundle", cmd_bundle, RUN_SETUP_GENTLY | NO_PARSEOPT },
381 { "cat-file", cmd_cat_file, RUN_SETUP },
382 { "check-attr", cmd_check_attr, RUN_SETUP },
383 { "check-ignore", cmd_check_ignore, RUN_SETUP | NEED_WORK_TREE },
384 { "check-mailmap", cmd_check_mailmap, RUN_SETUP },
385 { "check-ref-format", cmd_check_ref_format, NO_PARSEOPT },
386 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
387 { "checkout-index", cmd_checkout_index,
388 RUN_SETUP | NEED_WORK_TREE},
389 { "cherry", cmd_cherry, RUN_SETUP },
390 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
391 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
392 { "clone", cmd_clone },
393 { "column", cmd_column, RUN_SETUP_GENTLY },
394 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
395 { "commit-graph", cmd_commit_graph, RUN_SETUP },
396 { "commit-tree", cmd_commit_tree, RUN_SETUP | NO_PARSEOPT },
397 { "config", cmd_config, RUN_SETUP_GENTLY | DELAY_PAGER_CONFIG },
398 { "count-objects", cmd_count_objects, RUN_SETUP },
399 { "credential", cmd_credential, RUN_SETUP_GENTLY | NO_PARSEOPT },
400 { "describe", cmd_describe, RUN_SETUP },
401 { "diff", cmd_diff, NO_PARSEOPT },
402 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
403 { "diff-index", cmd_diff_index, RUN_SETUP | NO_PARSEOPT },
404 { "diff-tree", cmd_diff_tree, RUN_SETUP | NO_PARSEOPT },
405 { "difftool", cmd_difftool, RUN_SETUP | NEED_WORK_TREE },
406 { "fast-export", cmd_fast_export, RUN_SETUP },
407 { "fetch", cmd_fetch, RUN_SETUP },
408 { "fetch-pack", cmd_fetch_pack, RUN_SETUP | NO_PARSEOPT },
409 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
410 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
411 { "format-patch", cmd_format_patch, RUN_SETUP },
412 { "fsck", cmd_fsck, RUN_SETUP },
413 { "fsck-objects", cmd_fsck, RUN_SETUP },
414 { "gc", cmd_gc, RUN_SETUP },
415 { "get-tar-commit-id", cmd_get_tar_commit_id, NO_PARSEOPT },
416 { "grep", cmd_grep, RUN_SETUP_GENTLY },
417 { "hash-object", cmd_hash_object },
418 { "help", cmd_help },
419 { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY | NO_PARSEOPT },
420 { "init", cmd_init_db },
421 { "init-db", cmd_init_db },
422 { "interpret-trailers", cmd_interpret_trailers, RUN_SETUP_GENTLY },
423 { "log", cmd_log, RUN_SETUP },
424 { "ls-files", cmd_ls_files, RUN_SETUP },
425 { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
426 { "ls-tree", cmd_ls_tree, RUN_SETUP },
427 { "mailinfo", cmd_mailinfo, RUN_SETUP_GENTLY | NO_PARSEOPT },
428 { "mailsplit", cmd_mailsplit, NO_PARSEOPT },
429 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
430 { "merge-base", cmd_merge_base, RUN_SETUP },
431 { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
432 { "merge-index", cmd_merge_index, RUN_SETUP | NO_PARSEOPT },
433 { "merge-ours", cmd_merge_ours, RUN_SETUP | NO_PARSEOPT },
434 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
435 { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
436 { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
437 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
438 { "merge-tree", cmd_merge_tree, RUN_SETUP | NO_PARSEOPT },
439 { "mktag", cmd_mktag, RUN_SETUP | NO_PARSEOPT },
440 { "mktree", cmd_mktree, RUN_SETUP },
441 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
442 { "name-rev", cmd_name_rev, RUN_SETUP },
443 { "notes", cmd_notes, RUN_SETUP },
444 { "pack-objects", cmd_pack_objects, RUN_SETUP },
445 { "pack-redundant", cmd_pack_redundant, RUN_SETUP | NO_PARSEOPT },
446 { "pack-refs", cmd_pack_refs, RUN_SETUP },
447 { "patch-id", cmd_patch_id, RUN_SETUP_GENTLY | NO_PARSEOPT },
448 { "pickaxe", cmd_blame, RUN_SETUP },
449 { "prune", cmd_prune, RUN_SETUP },
450 { "prune-packed", cmd_prune_packed, RUN_SETUP },
451 { "pull", cmd_pull, RUN_SETUP | NEED_WORK_TREE },
452 { "push", cmd_push, RUN_SETUP },
453 { "read-tree", cmd_read_tree, RUN_SETUP | SUPPORT_SUPER_PREFIX},
454 { "rebase--helper", cmd_rebase__helper, RUN_SETUP | NEED_WORK_TREE },
455 { "receive-pack", cmd_receive_pack },
456 { "reflog", cmd_reflog, RUN_SETUP },
457 { "remote", cmd_remote, RUN_SETUP },
458 { "remote-ext", cmd_remote_ext, NO_PARSEOPT },
459 { "remote-fd", cmd_remote_fd, NO_PARSEOPT },
460 { "repack", cmd_repack, RUN_SETUP },
461 { "replace", cmd_replace, RUN_SETUP },
462 { "rerere", cmd_rerere, RUN_SETUP },
463 { "reset", cmd_reset, RUN_SETUP },
464 { "rev-list", cmd_rev_list, RUN_SETUP | NO_PARSEOPT },
465 { "rev-parse", cmd_rev_parse, NO_PARSEOPT },
466 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
467 { "rm", cmd_rm, RUN_SETUP },
468 { "send-pack", cmd_send_pack, RUN_SETUP },
469 { "serve", cmd_serve, RUN_SETUP },
470 { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
471 { "show", cmd_show, RUN_SETUP },
472 { "show-branch", cmd_show_branch, RUN_SETUP },
473 { "show-ref", cmd_show_ref, RUN_SETUP },
474 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
475 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
476 { "stripspace", cmd_stripspace },
477 { "submodule--helper", cmd_submodule__helper, RUN_SETUP | SUPPORT_SUPER_PREFIX | NO_PARSEOPT },
478 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
479 { "tag", cmd_tag, RUN_SETUP | DELAY_PAGER_CONFIG },
480 { "unpack-file", cmd_unpack_file, RUN_SETUP | NO_PARSEOPT },
481 { "unpack-objects", cmd_unpack_objects, RUN_SETUP | NO_PARSEOPT },
482 { "update-index", cmd_update_index, RUN_SETUP },
483 { "update-ref", cmd_update_ref, RUN_SETUP },
484 { "update-server-info", cmd_update_server_info, RUN_SETUP },
485 { "upload-archive", cmd_upload_archive, NO_PARSEOPT },
486 { "upload-archive--writer", cmd_upload_archive_writer, NO_PARSEOPT },
487 { "upload-pack", cmd_upload_pack },
488 { "var", cmd_var, RUN_SETUP_GENTLY | NO_PARSEOPT },
489 { "verify-commit", cmd_verify_commit, RUN_SETUP },
490 { "verify-pack", cmd_verify_pack },
491 { "verify-tag", cmd_verify_tag, RUN_SETUP },
492 { "version", cmd_version },
493 { "whatchanged", cmd_whatchanged, RUN_SETUP },
494 { "worktree", cmd_worktree, RUN_SETUP | NO_PARSEOPT },
495 { "write-tree", cmd_write_tree, RUN_SETUP },
498 static struct cmd_struct *get_builtin(const char *s)
501 for (i = 0; i < ARRAY_SIZE(commands); i++) {
502 struct cmd_struct *p = commands + i;
503 if (!strcmp(s, p->cmd))
509 int is_builtin(const char *s)
511 return !!get_builtin(s);
514 static void list_builtins(unsigned int exclude_option, char sep)
517 for (i = 0; i < ARRAY_SIZE(commands); i++) {
518 if (exclude_option &&
519 (commands[i].option & exclude_option))
521 printf("%s%c", commands[i].cmd, sep);
525 #ifdef STRIP_EXTENSION
526 static void strip_extension(const char **argv)
530 if (strip_suffix(argv[0], STRIP_EXTENSION, &len))
531 argv[0] = xmemdupz(argv[0], len);
534 #define strip_extension(cmd)
537 static void handle_builtin(int argc, const char **argv)
539 struct argv_array args = ARGV_ARRAY_INIT;
541 struct cmd_struct *builtin;
543 strip_extension(argv);
546 /* Turn "git cmd --help" into "git help --exclude-guides cmd" */
547 if (argc > 1 && !strcmp(argv[1], "--help")) {
551 argv[0] = cmd = "help";
553 for (i = 0; i < argc; i++) {
554 argv_array_push(&args, argv[i]);
556 argv_array_push(&args, "--exclude-guides");
563 builtin = get_builtin(cmd);
565 exit(run_builtin(builtin, argc, argv));
566 argv_array_clear(&args);
569 static void execv_dashed_external(const char **argv)
571 struct child_process cmd = CHILD_PROCESS_INIT;
574 if (get_super_prefix())
575 die("%s doesn't support --super-prefix", argv[0]);
577 if (use_pager == -1 && !is_builtin(argv[0]))
578 use_pager = check_pager_config(argv[0]);
579 commit_pager_choice();
581 argv_array_pushf(&cmd.args, "git-%s", argv[0]);
582 argv_array_pushv(&cmd.args, argv + 1);
583 cmd.clean_on_exit = 1;
584 cmd.wait_after_clean = 1;
585 cmd.silent_exec_failure = 1;
587 trace_argv_printf(cmd.args.argv, "trace: exec:");
590 * If we fail because the command is not found, it is
591 * OK to return. Otherwise, we just pass along the status code,
592 * or our usual generic code if we were not even able to exec
595 status = run_command(&cmd);
598 else if (errno != ENOENT)
602 static int run_argv(int *argcp, const char ***argv)
608 * If we tried alias and futzed with our environment,
609 * it no longer is safe to invoke builtins directly in
610 * general. We have to spawn them as dashed externals.
612 * NEEDSWORK: if we can figure out cases
613 * where it is safe to do, we can avoid spawning a new
617 handle_builtin(*argcp, *argv);
619 /* .. then try the external ones */
620 execv_dashed_external(*argv);
622 /* It could be an alias -- this works around the insanity
623 * of overriding "git log" with "git show" by having
628 if (!handle_alias(argcp, argv))
636 int cmd_main(int argc, const char **argv)
645 const char *slash = find_last_dir_sep(cmd);
650 trace_command_performance(argv);
653 * "git-xxxx" is the same as "git xxxx", but we obviously:
655 * - cannot take flags in between the "git" and the "xxxx".
656 * - cannot execute it externally (since it would just do
657 * the same thing over again)
659 * So we just directly call the builtin handler, and die if
660 * that one cannot handle it.
662 if (skip_prefix(cmd, "git-", &cmd)) {
664 handle_builtin(argc, argv);
665 die("cannot handle %s as a builtin", cmd);
668 /* Look for flags.. */
671 handle_options(&argv, &argc, NULL);
673 /* translate --help and --version into commands */
674 skip_prefix(argv[0], "--", &argv[0]);
676 /* The user didn't specify a command; give them help */
677 commit_pager_choice();
678 printf("usage: %s\n\n", git_usage_string);
679 list_common_cmds_help();
680 printf("\n%s\n", _(git_more_info_string));
686 * We use PATH to find git commands, but we prepend some higher
687 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
688 * environment, and the $(gitexecdir) from the Makefile at build
694 int was_alias = run_argv(&argc, &argv);
698 fprintf(stderr, _("expansion of alias '%s' failed; "
699 "'%s' is not a git command\n"),
704 cmd = argv[0] = help_unknown_cmd(cmd);
710 fprintf(stderr, _("failed to run command '%s': %s\n"),
711 cmd, strerror(errno));