5 #include "run-command.h"
7 const char git_usage_string[] =
8 "git [--version] [--help] [-C <path>] [-c name=value]\n"
9 " [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
10 " [-p | --paginate | --no-pager] [--no-replace-objects] [--bare]\n"
11 " [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
12 " <command> [<args>]";
14 const char git_more_info_string[] =
15 N_("'git help -a' and 'git help -g' list available subcommands and some\n"
16 "concept guides. See 'git help <command>' or 'git help <concept>'\n"
17 "to read about a specific subcommand or concept.");
19 static int use_pager = -1;
21 static void list_builtins(void);
23 static void commit_pager_choice(void) {
26 setenv("GIT_PAGER", "cat", 1);
36 void setup_auto_pager(const char *cmd, int def)
38 if (use_pager != -1 || pager_in_use())
40 use_pager = check_pager_config(cmd);
43 commit_pager_choice();
46 static int handle_options(const char ***argv, int *argc, int *envchanged)
48 const char **orig_argv = *argv;
51 const char *cmd = (*argv)[0];
56 * For legacy reasons, the "version" and "help"
57 * commands can be written with "--" prepended
58 * to make them look like flags.
60 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
64 * Check remaining flags.
66 if (skip_prefix(cmd, "--exec-path", &cmd)) {
68 git_set_argv_exec_path(cmd + 1);
70 puts(git_exec_path());
73 } else if (!strcmp(cmd, "--html-path")) {
74 puts(system_path(GIT_HTML_PATH));
76 } else if (!strcmp(cmd, "--man-path")) {
77 puts(system_path(GIT_MAN_PATH));
79 } else if (!strcmp(cmd, "--info-path")) {
80 puts(system_path(GIT_INFO_PATH));
82 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
84 } else if (!strcmp(cmd, "--no-pager")) {
88 } else if (!strcmp(cmd, "--no-replace-objects")) {
89 check_replace_refs = 0;
90 setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
93 } else if (!strcmp(cmd, "--git-dir")) {
95 fprintf(stderr, "No directory given for --git-dir.\n" );
96 usage(git_usage_string);
98 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
103 } else if (skip_prefix(cmd, "--git-dir=", &cmd)) {
104 setenv(GIT_DIR_ENVIRONMENT, cmd, 1);
107 } else if (!strcmp(cmd, "--namespace")) {
109 fprintf(stderr, "No namespace given for --namespace.\n" );
110 usage(git_usage_string);
112 setenv(GIT_NAMESPACE_ENVIRONMENT, (*argv)[1], 1);
117 } else if (skip_prefix(cmd, "--namespace=", &cmd)) {
118 setenv(GIT_NAMESPACE_ENVIRONMENT, cmd, 1);
121 } else if (!strcmp(cmd, "--work-tree")) {
123 fprintf(stderr, "No directory given for --work-tree.\n" );
124 usage(git_usage_string);
126 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
131 } else if (skip_prefix(cmd, "--work-tree=", &cmd)) {
132 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd, 1);
135 } else if (!strcmp(cmd, "--super-prefix")) {
137 fprintf(stderr, "No prefix given for --super-prefix.\n" );
138 usage(git_usage_string);
140 setenv(GIT_SUPER_PREFIX_ENVIRONMENT, (*argv)[1], 1);
145 } else if (skip_prefix(cmd, "--super-prefix=", &cmd)) {
146 setenv(GIT_SUPER_PREFIX_ENVIRONMENT, cmd, 1);
149 } else if (!strcmp(cmd, "--bare")) {
150 char *cwd = xgetcwd();
151 is_bare_repository_cfg = 1;
152 setenv(GIT_DIR_ENVIRONMENT, cwd, 0);
154 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
157 } else if (!strcmp(cmd, "-c")) {
159 fprintf(stderr, "-c expects a configuration string\n" );
160 usage(git_usage_string);
162 git_config_push_parameter((*argv)[1]);
165 } else if (!strcmp(cmd, "--literal-pathspecs")) {
166 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "1", 1);
169 } else if (!strcmp(cmd, "--no-literal-pathspecs")) {
170 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "0", 1);
173 } else if (!strcmp(cmd, "--glob-pathspecs")) {
174 setenv(GIT_GLOB_PATHSPECS_ENVIRONMENT, "1", 1);
177 } else if (!strcmp(cmd, "--noglob-pathspecs")) {
178 setenv(GIT_NOGLOB_PATHSPECS_ENVIRONMENT, "1", 1);
181 } else if (!strcmp(cmd, "--icase-pathspecs")) {
182 setenv(GIT_ICASE_PATHSPECS_ENVIRONMENT, "1", 1);
185 } else if (!strcmp(cmd, "--no-optional-locks")) {
186 setenv(GIT_OPTIONAL_LOCKS_ENVIRONMENT, "0", 1);
189 } else if (!strcmp(cmd, "--shallow-file")) {
192 set_alternate_shallow_file((*argv)[0], 1);
195 } else if (!strcmp(cmd, "-C")) {
197 fprintf(stderr, "No directory given for -C.\n" );
198 usage(git_usage_string);
201 if (chdir((*argv)[1]))
202 die_errno("Cannot change to '%s'", (*argv)[1]);
208 } else if (!strcmp(cmd, "--list-builtins")) {
212 fprintf(stderr, "Unknown option: %s\n", cmd);
213 usage(git_usage_string);
219 return (*argv) - orig_argv;
222 static int handle_alias(int *argcp, const char ***argv)
224 int envchanged = 0, ret = 0, saved_errno = errno;
225 int count, option_count;
226 const char **new_argv;
227 const char *alias_command;
230 alias_command = (*argv)[0];
231 alias_string = alias_lookup(alias_command);
233 if (alias_string[0] == '!') {
234 struct child_process child = CHILD_PROCESS_INIT;
237 /* Aliases expect GIT_PREFIX, GIT_DIR etc to be set */
238 setup_git_directory_gently(&nongit_ok);
240 commit_pager_choice();
243 argv_array_push(&child.args, alias_string + 1);
244 argv_array_pushv(&child.args, (*argv) + 1);
246 ret = run_command(&child);
247 if (ret >= 0) /* normal exit */
250 die_errno("While expanding alias '%s': '%s'",
251 alias_command, alias_string + 1);
253 count = split_cmdline(alias_string, &new_argv);
255 die("Bad alias.%s string: %s", alias_command,
256 split_cmdline_strerror(count));
257 option_count = handle_options(&new_argv, &count, &envchanged);
259 die("alias '%s' changes environment variables\n"
260 "You can use '!git' in the alias to do this.",
262 memmove(new_argv - option_count, new_argv,
263 count * sizeof(char *));
264 new_argv -= option_count;
267 die("empty alias for %s", alias_command);
269 if (!strcmp(alias_command, new_argv[0]))
270 die("recursive alias: %s", alias_command);
272 trace_argv_printf(new_argv,
273 "trace: alias expansion: %s =>",
276 REALLOC_ARRAY(new_argv, count + *argcp);
277 /* insert after command name */
278 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
291 #define RUN_SETUP (1<<0)
292 #define RUN_SETUP_GENTLY (1<<1)
293 #define USE_PAGER (1<<2)
295 * require working tree to be present -- anything uses this needs
296 * RUN_SETUP for reading from the configuration file.
298 #define NEED_WORK_TREE (1<<3)
299 #define SUPPORT_SUPER_PREFIX (1<<4)
300 #define DELAY_PAGER_CONFIG (1<<5)
304 int (*fn)(int, const char **, const char *);
308 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
315 help = argc == 2 && !strcmp(argv[1], "-h");
317 if (p->option & RUN_SETUP)
318 prefix = setup_git_directory();
319 else if (p->option & RUN_SETUP_GENTLY) {
321 prefix = setup_git_directory_gently(&nongit_ok);
324 if (use_pager == -1 && p->option & (RUN_SETUP | RUN_SETUP_GENTLY) &&
325 !(p->option & DELAY_PAGER_CONFIG))
326 use_pager = check_pager_config(p->cmd);
327 if (use_pager == -1 && p->option & USE_PAGER)
330 if ((p->option & (RUN_SETUP | RUN_SETUP_GENTLY)) &&
331 startup_info->have_repository) /* get_git_dir() may set up repo, avoid that */
332 trace_repo_setup(prefix);
334 commit_pager_choice();
336 if (!help && get_super_prefix()) {
337 if (!(p->option & SUPPORT_SUPER_PREFIX))
338 die("%s doesn't support --super-prefix", p->cmd);
341 if (!help && p->option & NEED_WORK_TREE)
344 trace_argv_printf(argv, "trace: built-in: git");
346 status = p->fn(argc, argv, prefix);
350 /* Somebody closed stdout? */
351 if (fstat(fileno(stdout), &st))
353 /* Ignore write errors for pipes and sockets.. */
354 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
357 /* Check for ENOSPC and EIO errors.. */
359 die_errno("write failure on standard output");
361 die("unknown write failure on standard output");
363 die_errno("close failed on standard output");
367 static struct cmd_struct commands[] = {
368 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
369 { "am", cmd_am, RUN_SETUP | NEED_WORK_TREE },
370 { "annotate", cmd_annotate, RUN_SETUP },
371 { "apply", cmd_apply, RUN_SETUP_GENTLY },
372 { "archive", cmd_archive, RUN_SETUP_GENTLY },
373 { "bisect--helper", cmd_bisect__helper, RUN_SETUP },
374 { "blame", cmd_blame, RUN_SETUP },
375 { "branch", cmd_branch, RUN_SETUP | DELAY_PAGER_CONFIG },
376 { "bundle", cmd_bundle, RUN_SETUP_GENTLY },
377 { "cat-file", cmd_cat_file, RUN_SETUP },
378 { "check-attr", cmd_check_attr, RUN_SETUP },
379 { "check-ignore", cmd_check_ignore, RUN_SETUP | NEED_WORK_TREE },
380 { "check-mailmap", cmd_check_mailmap, RUN_SETUP },
381 { "check-ref-format", cmd_check_ref_format },
382 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
383 { "checkout-index", cmd_checkout_index,
384 RUN_SETUP | NEED_WORK_TREE},
385 { "cherry", cmd_cherry, RUN_SETUP },
386 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
387 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
388 { "clone", cmd_clone },
389 { "column", cmd_column, RUN_SETUP_GENTLY },
390 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
391 { "commit-tree", cmd_commit_tree, RUN_SETUP },
392 { "config", cmd_config, RUN_SETUP_GENTLY },
393 { "count-objects", cmd_count_objects, RUN_SETUP },
394 { "credential", cmd_credential, RUN_SETUP_GENTLY },
395 { "describe", cmd_describe, RUN_SETUP },
396 { "diff", cmd_diff },
397 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE },
398 { "diff-index", cmd_diff_index, RUN_SETUP },
399 { "diff-tree", cmd_diff_tree, RUN_SETUP },
400 { "difftool", cmd_difftool, RUN_SETUP | NEED_WORK_TREE },
401 { "fast-export", cmd_fast_export, RUN_SETUP },
402 { "fetch", cmd_fetch, RUN_SETUP },
403 { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
404 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
405 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
406 { "format-patch", cmd_format_patch, RUN_SETUP },
407 { "fsck", cmd_fsck, RUN_SETUP },
408 { "fsck-objects", cmd_fsck, RUN_SETUP },
409 { "gc", cmd_gc, RUN_SETUP },
410 { "get-tar-commit-id", cmd_get_tar_commit_id },
411 { "grep", cmd_grep, RUN_SETUP_GENTLY },
412 { "hash-object", cmd_hash_object },
413 { "help", cmd_help },
414 { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY },
415 { "init", cmd_init_db },
416 { "init-db", cmd_init_db },
417 { "interpret-trailers", cmd_interpret_trailers, RUN_SETUP_GENTLY },
418 { "log", cmd_log, RUN_SETUP },
419 { "ls-files", cmd_ls_files, RUN_SETUP },
420 { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
421 { "ls-tree", cmd_ls_tree, RUN_SETUP },
422 { "mailinfo", cmd_mailinfo, RUN_SETUP_GENTLY },
423 { "mailsplit", cmd_mailsplit },
424 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
425 { "merge-base", cmd_merge_base, RUN_SETUP },
426 { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
427 { "merge-index", cmd_merge_index, RUN_SETUP },
428 { "merge-ours", cmd_merge_ours, RUN_SETUP },
429 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
430 { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
431 { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
432 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
433 { "merge-tree", cmd_merge_tree, RUN_SETUP },
434 { "mktag", cmd_mktag, RUN_SETUP },
435 { "mktree", cmd_mktree, RUN_SETUP },
436 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
437 { "name-rev", cmd_name_rev, RUN_SETUP },
438 { "notes", cmd_notes, RUN_SETUP },
439 { "pack-objects", cmd_pack_objects, RUN_SETUP },
440 { "pack-redundant", cmd_pack_redundant, RUN_SETUP },
441 { "pack-refs", cmd_pack_refs, RUN_SETUP },
442 { "patch-id", cmd_patch_id, RUN_SETUP_GENTLY },
443 { "pickaxe", cmd_blame, RUN_SETUP },
444 { "prune", cmd_prune, RUN_SETUP },
445 { "prune-packed", cmd_prune_packed, RUN_SETUP },
446 { "pull", cmd_pull, RUN_SETUP | NEED_WORK_TREE },
447 { "push", cmd_push, RUN_SETUP },
448 { "read-tree", cmd_read_tree, RUN_SETUP | SUPPORT_SUPER_PREFIX},
449 { "rebase--helper", cmd_rebase__helper, RUN_SETUP | NEED_WORK_TREE },
450 { "receive-pack", cmd_receive_pack },
451 { "reflog", cmd_reflog, RUN_SETUP },
452 { "remote", cmd_remote, RUN_SETUP },
453 { "remote-ext", cmd_remote_ext },
454 { "remote-fd", cmd_remote_fd },
455 { "repack", cmd_repack, RUN_SETUP },
456 { "replace", cmd_replace, RUN_SETUP },
457 { "rerere", cmd_rerere, RUN_SETUP },
458 { "reset", cmd_reset, RUN_SETUP },
459 { "rev-list", cmd_rev_list, RUN_SETUP },
460 { "rev-parse", cmd_rev_parse },
461 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
462 { "rm", cmd_rm, RUN_SETUP },
463 { "send-pack", cmd_send_pack, RUN_SETUP },
464 { "serve", cmd_serve, RUN_SETUP },
465 { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
466 { "show", cmd_show, RUN_SETUP },
467 { "show-branch", cmd_show_branch, RUN_SETUP },
468 { "show-ref", cmd_show_ref, RUN_SETUP },
469 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
470 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
471 { "stripspace", cmd_stripspace },
472 { "submodule--helper", cmd_submodule__helper, RUN_SETUP | SUPPORT_SUPER_PREFIX},
473 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
474 { "tag", cmd_tag, RUN_SETUP | DELAY_PAGER_CONFIG },
475 { "unpack-file", cmd_unpack_file, RUN_SETUP },
476 { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
477 { "update-index", cmd_update_index, RUN_SETUP },
478 { "update-ref", cmd_update_ref, RUN_SETUP },
479 { "update-server-info", cmd_update_server_info, RUN_SETUP },
480 { "upload-archive", cmd_upload_archive },
481 { "upload-archive--writer", cmd_upload_archive_writer },
482 { "upload-pack", cmd_upload_pack },
483 { "var", cmd_var, RUN_SETUP_GENTLY },
484 { "verify-commit", cmd_verify_commit, RUN_SETUP },
485 { "verify-pack", cmd_verify_pack },
486 { "verify-tag", cmd_verify_tag, RUN_SETUP },
487 { "version", cmd_version },
488 { "whatchanged", cmd_whatchanged, RUN_SETUP },
489 { "worktree", cmd_worktree, RUN_SETUP },
490 { "write-tree", cmd_write_tree, RUN_SETUP },
493 static struct cmd_struct *get_builtin(const char *s)
496 for (i = 0; i < ARRAY_SIZE(commands); i++) {
497 struct cmd_struct *p = commands + i;
498 if (!strcmp(s, p->cmd))
504 int is_builtin(const char *s)
506 return !!get_builtin(s);
509 static void list_builtins(void)
512 for (i = 0; i < ARRAY_SIZE(commands); i++)
513 printf("%s\n", commands[i].cmd);
516 #ifdef STRIP_EXTENSION
517 static void strip_extension(const char **argv)
521 if (strip_suffix(argv[0], STRIP_EXTENSION, &len))
522 argv[0] = xmemdupz(argv[0], len);
525 #define strip_extension(cmd)
528 static void handle_builtin(int argc, const char **argv)
530 struct argv_array args = ARGV_ARRAY_INIT;
532 struct cmd_struct *builtin;
534 strip_extension(argv);
537 /* Turn "git cmd --help" into "git help --exclude-guides cmd" */
538 if (argc > 1 && !strcmp(argv[1], "--help")) {
542 argv[0] = cmd = "help";
544 for (i = 0; i < argc; i++) {
545 argv_array_push(&args, argv[i]);
547 argv_array_push(&args, "--exclude-guides");
554 builtin = get_builtin(cmd);
556 exit(run_builtin(builtin, argc, argv));
557 argv_array_clear(&args);
560 static void execv_dashed_external(const char **argv)
562 struct child_process cmd = CHILD_PROCESS_INIT;
565 if (get_super_prefix())
566 die("%s doesn't support --super-prefix", argv[0]);
568 if (use_pager == -1 && !is_builtin(argv[0]))
569 use_pager = check_pager_config(argv[0]);
570 commit_pager_choice();
572 argv_array_pushf(&cmd.args, "git-%s", argv[0]);
573 argv_array_pushv(&cmd.args, argv + 1);
574 cmd.clean_on_exit = 1;
575 cmd.wait_after_clean = 1;
576 cmd.silent_exec_failure = 1;
578 trace_argv_printf(cmd.args.argv, "trace: exec:");
581 * If we fail because the command is not found, it is
582 * OK to return. Otherwise, we just pass along the status code,
583 * or our usual generic code if we were not even able to exec
586 status = run_command(&cmd);
589 else if (errno != ENOENT)
593 static int run_argv(int *argcp, const char ***argv)
599 * If we tried alias and futzed with our environment,
600 * it no longer is safe to invoke builtins directly in
601 * general. We have to spawn them as dashed externals.
603 * NEEDSWORK: if we can figure out cases
604 * where it is safe to do, we can avoid spawning a new
608 handle_builtin(*argcp, *argv);
610 /* .. then try the external ones */
611 execv_dashed_external(*argv);
613 /* It could be an alias -- this works around the insanity
614 * of overriding "git log" with "git show" by having
619 if (!handle_alias(argcp, argv))
627 int cmd_main(int argc, const char **argv)
636 const char *slash = find_last_dir_sep(cmd);
641 trace_command_performance(argv);
644 * "git-xxxx" is the same as "git xxxx", but we obviously:
646 * - cannot take flags in between the "git" and the "xxxx".
647 * - cannot execute it externally (since it would just do
648 * the same thing over again)
650 * So we just directly call the builtin handler, and die if
651 * that one cannot handle it.
653 if (skip_prefix(cmd, "git-", &cmd)) {
655 handle_builtin(argc, argv);
656 die("cannot handle %s as a builtin", cmd);
659 /* Look for flags.. */
662 handle_options(&argv, &argc, NULL);
664 /* translate --help and --version into commands */
665 skip_prefix(argv[0], "--", &argv[0]);
667 /* The user didn't specify a command; give them help */
668 commit_pager_choice();
669 printf("usage: %s\n\n", git_usage_string);
670 list_common_cmds_help();
671 printf("\n%s\n", _(git_more_info_string));
677 * We use PATH to find git commands, but we prepend some higher
678 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
679 * environment, and the $(gitexecdir) from the Makefile at build
685 int was_alias = run_argv(&argc, &argv);
689 fprintf(stderr, "Expansion of alias '%s' failed; "
690 "'%s' is not a git command\n",
695 cmd = argv[0] = help_unknown_cmd(cmd);
701 fprintf(stderr, "Failed to run command '%s': %s\n",
702 cmd, strerror(errno));