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 static int handle_options(const char ***argv, int *argc, int *envchanged)
38 const char **orig_argv = *argv;
41 const char *cmd = (*argv)[0];
46 * For legacy reasons, the "version" and "help"
47 * commands can be written with "--" prepended
48 * to make them look like flags.
50 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
54 * Check remaining flags.
56 if (skip_prefix(cmd, "--exec-path", &cmd)) {
58 git_set_argv_exec_path(cmd + 1);
60 puts(git_exec_path());
63 } else if (!strcmp(cmd, "--html-path")) {
64 puts(system_path(GIT_HTML_PATH));
66 } else if (!strcmp(cmd, "--man-path")) {
67 puts(system_path(GIT_MAN_PATH));
69 } else if (!strcmp(cmd, "--info-path")) {
70 puts(system_path(GIT_INFO_PATH));
72 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
74 } else if (!strcmp(cmd, "--no-pager")) {
78 } else if (!strcmp(cmd, "--no-replace-objects")) {
79 check_replace_refs = 0;
80 setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
83 } else if (!strcmp(cmd, "--git-dir")) {
85 fprintf(stderr, "No directory given for --git-dir.\n" );
86 usage(git_usage_string);
88 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
93 } else if (skip_prefix(cmd, "--git-dir=", &cmd)) {
94 setenv(GIT_DIR_ENVIRONMENT, cmd, 1);
97 } else if (!strcmp(cmd, "--namespace")) {
99 fprintf(stderr, "No namespace given for --namespace.\n" );
100 usage(git_usage_string);
102 setenv(GIT_NAMESPACE_ENVIRONMENT, (*argv)[1], 1);
107 } else if (skip_prefix(cmd, "--namespace=", &cmd)) {
108 setenv(GIT_NAMESPACE_ENVIRONMENT, cmd, 1);
111 } else if (!strcmp(cmd, "--work-tree")) {
113 fprintf(stderr, "No directory given for --work-tree.\n" );
114 usage(git_usage_string);
116 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
121 } else if (skip_prefix(cmd, "--work-tree=", &cmd)) {
122 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd, 1);
125 } else if (!strcmp(cmd, "--super-prefix")) {
127 fprintf(stderr, "No prefix given for --super-prefix.\n" );
128 usage(git_usage_string);
130 setenv(GIT_SUPER_PREFIX_ENVIRONMENT, (*argv)[1], 1);
135 } else if (skip_prefix(cmd, "--super-prefix=", &cmd)) {
136 setenv(GIT_SUPER_PREFIX_ENVIRONMENT, cmd, 1);
139 } else if (!strcmp(cmd, "--bare")) {
140 char *cwd = xgetcwd();
141 is_bare_repository_cfg = 1;
142 setenv(GIT_DIR_ENVIRONMENT, cwd, 0);
144 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
147 } else if (!strcmp(cmd, "-c")) {
149 fprintf(stderr, "-c expects a configuration string\n" );
150 usage(git_usage_string);
152 git_config_push_parameter((*argv)[1]);
155 } else if (!strcmp(cmd, "--literal-pathspecs")) {
156 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "1", 1);
159 } else if (!strcmp(cmd, "--no-literal-pathspecs")) {
160 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "0", 1);
163 } else if (!strcmp(cmd, "--glob-pathspecs")) {
164 setenv(GIT_GLOB_PATHSPECS_ENVIRONMENT, "1", 1);
167 } else if (!strcmp(cmd, "--noglob-pathspecs")) {
168 setenv(GIT_NOGLOB_PATHSPECS_ENVIRONMENT, "1", 1);
171 } else if (!strcmp(cmd, "--icase-pathspecs")) {
172 setenv(GIT_ICASE_PATHSPECS_ENVIRONMENT, "1", 1);
175 } else if (!strcmp(cmd, "--shallow-file")) {
178 set_alternate_shallow_file((*argv)[0], 1);
181 } else if (!strcmp(cmd, "-C")) {
183 fprintf(stderr, "No directory given for -C.\n" );
184 usage(git_usage_string);
187 if (chdir((*argv)[1]))
188 die_errno("Cannot change to '%s'", (*argv)[1]);
194 } else if (!strcmp(cmd, "--list-builtins")) {
198 fprintf(stderr, "Unknown option: %s\n", cmd);
199 usage(git_usage_string);
205 return (*argv) - orig_argv;
208 static int handle_alias(int *argcp, const char ***argv)
210 int envchanged = 0, ret = 0, saved_errno = errno;
211 int count, option_count;
212 const char **new_argv;
213 const char *alias_command;
216 alias_command = (*argv)[0];
217 alias_string = alias_lookup(alias_command);
219 if (alias_string[0] == '!') {
220 struct child_process child = CHILD_PROCESS_INIT;
223 /* Aliases expect GIT_PREFIX, GIT_DIR etc to be set */
224 setup_git_directory_gently(&nongit_ok);
226 commit_pager_choice();
229 argv_array_push(&child.args, alias_string + 1);
230 argv_array_pushv(&child.args, (*argv) + 1);
232 ret = run_command(&child);
233 if (ret >= 0) /* normal exit */
236 die_errno("While expanding alias '%s': '%s'",
237 alias_command, alias_string + 1);
239 count = split_cmdline(alias_string, &new_argv);
241 die("Bad alias.%s string: %s", alias_command,
242 split_cmdline_strerror(count));
243 option_count = handle_options(&new_argv, &count, &envchanged);
245 die("alias '%s' changes environment variables\n"
246 "You can use '!git' in the alias to do this.",
248 memmove(new_argv - option_count, new_argv,
249 count * sizeof(char *));
250 new_argv -= option_count;
253 die("empty alias for %s", alias_command);
255 if (!strcmp(alias_command, new_argv[0]))
256 die("recursive alias: %s", alias_command);
258 trace_argv_printf(new_argv,
259 "trace: alias expansion: %s =>",
262 REALLOC_ARRAY(new_argv, count + *argcp);
263 /* insert after command name */
264 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
277 #define RUN_SETUP (1<<0)
278 #define RUN_SETUP_GENTLY (1<<1)
279 #define USE_PAGER (1<<2)
281 * require working tree to be present -- anything uses this needs
282 * RUN_SETUP for reading from the configuration file.
284 #define NEED_WORK_TREE (1<<3)
285 #define SUPPORT_SUPER_PREFIX (1<<4)
286 #define DELAY_PAGER_CONFIG (1<<5)
290 int (*fn)(int, const char **, const char *);
294 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
301 help = argc == 2 && !strcmp(argv[1], "-h");
303 if (p->option & RUN_SETUP)
304 prefix = setup_git_directory();
305 else if (p->option & RUN_SETUP_GENTLY) {
307 prefix = setup_git_directory_gently(&nongit_ok);
310 if (use_pager == -1 && p->option & (RUN_SETUP | RUN_SETUP_GENTLY) &&
311 !(p->option & DELAY_PAGER_CONFIG))
312 use_pager = check_pager_config(p->cmd);
313 if (use_pager == -1 && p->option & USE_PAGER)
316 if ((p->option & (RUN_SETUP | RUN_SETUP_GENTLY)) &&
317 startup_info->have_repository) /* get_git_dir() may set up repo, avoid that */
318 trace_repo_setup(prefix);
320 commit_pager_choice();
322 if (!help && get_super_prefix()) {
323 if (!(p->option & SUPPORT_SUPER_PREFIX))
324 die("%s doesn't support --super-prefix", p->cmd);
327 if (!help && p->option & NEED_WORK_TREE)
330 trace_argv_printf(argv, "trace: built-in: git");
332 status = p->fn(argc, argv, prefix);
336 /* Somebody closed stdout? */
337 if (fstat(fileno(stdout), &st))
339 /* Ignore write errors for pipes and sockets.. */
340 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
343 /* Check for ENOSPC and EIO errors.. */
345 die_errno("write failure on standard output");
347 die("unknown write failure on standard output");
349 die_errno("close failed on standard output");
353 static struct cmd_struct commands[] = {
354 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
355 { "am", cmd_am, RUN_SETUP | NEED_WORK_TREE },
356 { "annotate", cmd_annotate, RUN_SETUP },
357 { "apply", cmd_apply, RUN_SETUP_GENTLY },
358 { "archive", cmd_archive, RUN_SETUP_GENTLY },
359 { "bisect--helper", cmd_bisect__helper, RUN_SETUP },
360 { "blame", cmd_blame, RUN_SETUP },
361 { "branch", cmd_branch, RUN_SETUP },
362 { "bundle", cmd_bundle, RUN_SETUP_GENTLY },
363 { "cat-file", cmd_cat_file, RUN_SETUP },
364 { "check-attr", cmd_check_attr, RUN_SETUP },
365 { "check-ignore", cmd_check_ignore, RUN_SETUP | NEED_WORK_TREE },
366 { "check-mailmap", cmd_check_mailmap, RUN_SETUP },
367 { "check-ref-format", cmd_check_ref_format },
368 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
369 { "checkout-index", cmd_checkout_index,
370 RUN_SETUP | NEED_WORK_TREE},
371 { "cherry", cmd_cherry, RUN_SETUP },
372 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
373 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
374 { "clone", cmd_clone },
375 { "column", cmd_column, RUN_SETUP_GENTLY },
376 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
377 { "commit-tree", cmd_commit_tree, RUN_SETUP },
378 { "config", cmd_config, RUN_SETUP_GENTLY },
379 { "count-objects", cmd_count_objects, RUN_SETUP },
380 { "credential", cmd_credential, RUN_SETUP_GENTLY },
381 { "describe", cmd_describe, RUN_SETUP },
382 { "diff", cmd_diff },
383 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE },
384 { "diff-index", cmd_diff_index, RUN_SETUP },
385 { "diff-tree", cmd_diff_tree, RUN_SETUP },
386 { "difftool", cmd_difftool, RUN_SETUP | NEED_WORK_TREE },
387 { "fast-export", cmd_fast_export, RUN_SETUP },
388 { "fetch", cmd_fetch, RUN_SETUP },
389 { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
390 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
391 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
392 { "format-patch", cmd_format_patch, RUN_SETUP },
393 { "fsck", cmd_fsck, RUN_SETUP },
394 { "fsck-objects", cmd_fsck, RUN_SETUP },
395 { "gc", cmd_gc, RUN_SETUP },
396 { "get-tar-commit-id", cmd_get_tar_commit_id },
397 { "grep", cmd_grep, RUN_SETUP_GENTLY | SUPPORT_SUPER_PREFIX },
398 { "hash-object", cmd_hash_object },
399 { "help", cmd_help },
400 { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY },
401 { "init", cmd_init_db },
402 { "init-db", cmd_init_db },
403 { "interpret-trailers", cmd_interpret_trailers, RUN_SETUP_GENTLY },
404 { "log", cmd_log, RUN_SETUP },
405 { "ls-files", cmd_ls_files, RUN_SETUP },
406 { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
407 { "ls-tree", cmd_ls_tree, RUN_SETUP },
408 { "mailinfo", cmd_mailinfo, RUN_SETUP_GENTLY },
409 { "mailsplit", cmd_mailsplit },
410 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
411 { "merge-base", cmd_merge_base, RUN_SETUP },
412 { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
413 { "merge-index", cmd_merge_index, RUN_SETUP },
414 { "merge-ours", cmd_merge_ours, RUN_SETUP },
415 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
416 { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
417 { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
418 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
419 { "merge-tree", cmd_merge_tree, RUN_SETUP },
420 { "mktag", cmd_mktag, RUN_SETUP },
421 { "mktree", cmd_mktree, RUN_SETUP },
422 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
423 { "name-rev", cmd_name_rev, RUN_SETUP },
424 { "notes", cmd_notes, RUN_SETUP },
425 { "pack-objects", cmd_pack_objects, RUN_SETUP },
426 { "pack-redundant", cmd_pack_redundant, RUN_SETUP },
427 { "pack-refs", cmd_pack_refs, RUN_SETUP },
428 { "patch-id", cmd_patch_id, RUN_SETUP_GENTLY },
429 { "pickaxe", cmd_blame, RUN_SETUP },
430 { "prune", cmd_prune, RUN_SETUP },
431 { "prune-packed", cmd_prune_packed, RUN_SETUP },
432 { "pull", cmd_pull, RUN_SETUP | NEED_WORK_TREE },
433 { "push", cmd_push, RUN_SETUP },
434 { "read-tree", cmd_read_tree, RUN_SETUP | SUPPORT_SUPER_PREFIX},
435 { "rebase--helper", cmd_rebase__helper, RUN_SETUP | NEED_WORK_TREE },
436 { "receive-pack", cmd_receive_pack },
437 { "reflog", cmd_reflog, RUN_SETUP },
438 { "remote", cmd_remote, RUN_SETUP },
439 { "remote-ext", cmd_remote_ext },
440 { "remote-fd", cmd_remote_fd },
441 { "repack", cmd_repack, RUN_SETUP },
442 { "replace", cmd_replace, RUN_SETUP },
443 { "rerere", cmd_rerere, RUN_SETUP },
444 { "reset", cmd_reset, RUN_SETUP },
445 { "rev-list", cmd_rev_list, RUN_SETUP },
446 { "rev-parse", cmd_rev_parse },
447 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
448 { "rm", cmd_rm, RUN_SETUP },
449 { "send-pack", cmd_send_pack, RUN_SETUP },
450 { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
451 { "show", cmd_show, RUN_SETUP },
452 { "show-branch", cmd_show_branch, RUN_SETUP },
453 { "show-ref", cmd_show_ref, RUN_SETUP },
454 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
455 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
456 { "stripspace", cmd_stripspace },
457 { "submodule--helper", cmd_submodule__helper, RUN_SETUP | SUPPORT_SUPER_PREFIX},
458 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
459 { "tag", cmd_tag, RUN_SETUP },
460 { "unpack-file", cmd_unpack_file, RUN_SETUP },
461 { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
462 { "update-index", cmd_update_index, RUN_SETUP },
463 { "update-ref", cmd_update_ref, RUN_SETUP },
464 { "update-server-info", cmd_update_server_info, RUN_SETUP },
465 { "upload-archive", cmd_upload_archive },
466 { "upload-archive--writer", cmd_upload_archive_writer },
467 { "var", cmd_var, RUN_SETUP_GENTLY },
468 { "verify-commit", cmd_verify_commit, RUN_SETUP },
469 { "verify-pack", cmd_verify_pack },
470 { "verify-tag", cmd_verify_tag, RUN_SETUP },
471 { "version", cmd_version },
472 { "whatchanged", cmd_whatchanged, RUN_SETUP },
473 { "worktree", cmd_worktree, RUN_SETUP },
474 { "write-tree", cmd_write_tree, RUN_SETUP },
477 static struct cmd_struct *get_builtin(const char *s)
480 for (i = 0; i < ARRAY_SIZE(commands); i++) {
481 struct cmd_struct *p = commands + i;
482 if (!strcmp(s, p->cmd))
488 int is_builtin(const char *s)
490 return !!get_builtin(s);
493 static void list_builtins(void)
496 for (i = 0; i < ARRAY_SIZE(commands); i++)
497 printf("%s\n", commands[i].cmd);
500 #ifdef STRIP_EXTENSION
501 static void strip_extension(const char **argv)
505 if (strip_suffix(argv[0], STRIP_EXTENSION, &len))
506 argv[0] = xmemdupz(argv[0], len);
509 #define strip_extension(cmd)
512 static void handle_builtin(int argc, const char **argv)
514 struct argv_array args = ARGV_ARRAY_INIT;
516 struct cmd_struct *builtin;
518 strip_extension(argv);
521 /* Turn "git cmd --help" into "git help --exclude-guides cmd" */
522 if (argc > 1 && !strcmp(argv[1], "--help")) {
526 argv[0] = cmd = "help";
528 for (i = 0; i < argc; i++) {
529 argv_array_push(&args, argv[i]);
531 argv_array_push(&args, "--exclude-guides");
538 builtin = get_builtin(cmd);
540 exit(run_builtin(builtin, argc, argv));
541 argv_array_clear(&args);
544 static void execv_dashed_external(const char **argv)
546 struct child_process cmd = CHILD_PROCESS_INIT;
549 if (get_super_prefix())
550 die("%s doesn't support --super-prefix", argv[0]);
553 use_pager = check_pager_config(argv[0]);
554 commit_pager_choice();
556 argv_array_pushf(&cmd.args, "git-%s", argv[0]);
557 argv_array_pushv(&cmd.args, argv + 1);
558 cmd.clean_on_exit = 1;
559 cmd.wait_after_clean = 1;
560 cmd.silent_exec_failure = 1;
562 trace_argv_printf(cmd.args.argv, "trace: exec:");
565 * If we fail because the command is not found, it is
566 * OK to return. Otherwise, we just pass along the status code,
567 * or our usual generic code if we were not even able to exec
570 status = run_command(&cmd);
573 else if (errno != ENOENT)
577 static int run_argv(int *argcp, const char ***argv)
583 * If we tried alias and futzed with our environment,
584 * it no longer is safe to invoke builtins directly in
585 * general. We have to spawn them as dashed externals.
587 * NEEDSWORK: if we can figure out cases
588 * where it is safe to do, we can avoid spawning a new
592 handle_builtin(*argcp, *argv);
594 /* .. then try the external ones */
595 execv_dashed_external(*argv);
597 /* It could be an alias -- this works around the insanity
598 * of overriding "git log" with "git show" by having
603 if (!handle_alias(argcp, argv))
611 int cmd_main(int argc, const char **argv)
620 const char *slash = find_last_dir_sep(cmd);
625 trace_command_performance(argv);
628 * "git-xxxx" is the same as "git xxxx", but we obviously:
630 * - cannot take flags in between the "git" and the "xxxx".
631 * - cannot execute it externally (since it would just do
632 * the same thing over again)
634 * So we just directly call the builtin handler, and die if
635 * that one cannot handle it.
637 if (skip_prefix(cmd, "git-", &cmd)) {
639 handle_builtin(argc, argv);
640 die("cannot handle %s as a builtin", cmd);
643 /* Look for flags.. */
646 handle_options(&argv, &argc, NULL);
648 /* translate --help and --version into commands */
649 skip_prefix(argv[0], "--", &argv[0]);
651 /* The user didn't specify a command; give them help */
652 commit_pager_choice();
653 printf("usage: %s\n\n", git_usage_string);
654 list_common_cmds_help();
655 printf("\n%s\n", _(git_more_info_string));
661 * We use PATH to find git commands, but we prepend some higher
662 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
663 * environment, and the $(gitexecdir) from the Makefile at build
669 int was_alias = run_argv(&argc, &argv);
673 fprintf(stderr, "Expansion of alias '%s' failed; "
674 "'%s' is not a git command\n",
679 cmd = argv[0] = help_unknown_cmd(cmd);
685 fprintf(stderr, "Failed to run command '%s': %s\n",
686 cmd, strerror(errno));