6 #include "run-command.h"
9 const char git_usage_string[] =
10 "git [--version] [--help] [-C <path>] [-c name=value]\n"
11 " [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
12 " [-p|--paginate|--no-pager] [--no-replace-objects] [--bare]\n"
13 " [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
14 " <command> [<args>]";
16 const char git_more_info_string[] =
17 N_("'git help -a' and 'git help -g' lists available subcommands and some\n"
18 "concept guides. See 'git help <command>' or 'git help <concept>'\n"
19 "to read about a specific subcommand or concept.");
21 static struct startup_info git_startup_info;
22 static int use_pager = -1;
23 static char *orig_cwd;
24 static const char *env_names[] = {
26 GIT_WORK_TREE_ENVIRONMENT,
27 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT,
28 GIT_PREFIX_ENVIRONMENT
30 static char *orig_env[4];
31 static int saved_environment;
33 static void save_env(void)
36 if (saved_environment)
38 saved_environment = 1;
40 for (i = 0; i < ARRAY_SIZE(env_names); i++) {
41 orig_env[i] = getenv(env_names[i]);
43 orig_env[i] = xstrdup(orig_env[i]);
47 static void restore_env(void)
50 if (orig_cwd && chdir(orig_cwd))
51 die_errno("could not move to %s", orig_cwd);
53 for (i = 0; i < ARRAY_SIZE(env_names); i++) {
55 setenv(env_names[i], orig_env[i], 1);
57 unsetenv(env_names[i]);
61 static void commit_pager_choice(void) {
64 setenv("GIT_PAGER", "cat", 1);
74 static int handle_options(const char ***argv, int *argc, int *envchanged)
76 const char **orig_argv = *argv;
79 const char *cmd = (*argv)[0];
84 * For legacy reasons, the "version" and "help"
85 * commands can be written with "--" prepended
86 * to make them look like flags.
88 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
92 * Check remaining flags.
94 if (skip_prefix(cmd, "--exec-path", &cmd)) {
96 git_set_argv_exec_path(cmd + 1);
98 puts(git_exec_path());
101 } else if (!strcmp(cmd, "--html-path")) {
102 puts(system_path(GIT_HTML_PATH));
104 } else if (!strcmp(cmd, "--man-path")) {
105 puts(system_path(GIT_MAN_PATH));
107 } else if (!strcmp(cmd, "--info-path")) {
108 puts(system_path(GIT_INFO_PATH));
110 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
112 } else if (!strcmp(cmd, "--no-pager")) {
116 } else if (!strcmp(cmd, "--no-replace-objects")) {
117 check_replace_refs = 0;
118 setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
121 } else if (!strcmp(cmd, "--git-dir")) {
123 fprintf(stderr, "No directory given for --git-dir.\n" );
124 usage(git_usage_string);
126 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
131 } else if (skip_prefix(cmd, "--git-dir=", &cmd)) {
132 setenv(GIT_DIR_ENVIRONMENT, cmd, 1);
135 } else if (!strcmp(cmd, "--namespace")) {
137 fprintf(stderr, "No namespace given for --namespace.\n" );
138 usage(git_usage_string);
140 setenv(GIT_NAMESPACE_ENVIRONMENT, (*argv)[1], 1);
145 } else if (skip_prefix(cmd, "--namespace=", &cmd)) {
146 setenv(GIT_NAMESPACE_ENVIRONMENT, cmd, 1);
149 } else if (!strcmp(cmd, "--work-tree")) {
151 fprintf(stderr, "No directory given for --work-tree.\n" );
152 usage(git_usage_string);
154 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
159 } else if (skip_prefix(cmd, "--work-tree=", &cmd)) {
160 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd, 1);
163 } else if (!strcmp(cmd, "--bare")) {
164 char *cwd = xgetcwd();
165 is_bare_repository_cfg = 1;
166 setenv(GIT_DIR_ENVIRONMENT, cwd, 0);
168 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
171 } else if (!strcmp(cmd, "-c")) {
173 fprintf(stderr, "-c expects a configuration string\n" );
174 usage(git_usage_string);
176 git_config_push_parameter((*argv)[1]);
179 } else if (!strcmp(cmd, "--literal-pathspecs")) {
180 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "1", 1);
183 } else if (!strcmp(cmd, "--no-literal-pathspecs")) {
184 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "0", 1);
187 } else if (!strcmp(cmd, "--glob-pathspecs")) {
188 setenv(GIT_GLOB_PATHSPECS_ENVIRONMENT, "1", 1);
191 } else if (!strcmp(cmd, "--noglob-pathspecs")) {
192 setenv(GIT_NOGLOB_PATHSPECS_ENVIRONMENT, "1", 1);
195 } else if (!strcmp(cmd, "--icase-pathspecs")) {
196 setenv(GIT_ICASE_PATHSPECS_ENVIRONMENT, "1", 1);
199 } else if (!strcmp(cmd, "--shallow-file")) {
202 set_alternate_shallow_file((*argv)[0], 1);
205 } else if (!strcmp(cmd, "-C")) {
207 fprintf(stderr, "No directory given for -C.\n" );
208 usage(git_usage_string);
210 if (chdir((*argv)[1]))
211 die_errno("Cannot change to '%s'", (*argv)[1]);
217 fprintf(stderr, "Unknown option: %s\n", cmd);
218 usage(git_usage_string);
224 return (*argv) - orig_argv;
227 static int handle_alias(int *argcp, const char ***argv)
229 int envchanged = 0, ret = 0, saved_errno = errno;
231 int count, option_count;
232 const char **new_argv;
233 const char *alias_command;
237 subdir = setup_git_directory_gently(&unused_nongit);
239 alias_command = (*argv)[0];
240 alias_string = alias_lookup(alias_command);
242 if (alias_string[0] == '!') {
243 const char **alias_argv;
244 int argc = *argcp, i;
246 commit_pager_choice();
248 /* build alias_argv */
249 alias_argv = xmalloc(sizeof(*alias_argv) * (argc + 1));
250 alias_argv[0] = alias_string + 1;
251 for (i = 1; i < argc; ++i)
252 alias_argv[i] = (*argv)[i];
253 alias_argv[argc] = NULL;
255 ret = run_command_v_opt(alias_argv, RUN_USING_SHELL);
256 if (ret >= 0) /* normal exit */
259 die_errno("While expanding alias '%s': '%s'",
260 alias_command, alias_string + 1);
262 count = split_cmdline(alias_string, &new_argv);
264 die("Bad alias.%s string: %s", alias_command,
265 split_cmdline_strerror(count));
266 option_count = handle_options(&new_argv, &count, &envchanged);
268 die("alias '%s' changes environment variables\n"
269 "You can use '!git' in the alias to do this.",
271 memmove(new_argv - option_count, new_argv,
272 count * sizeof(char *));
273 new_argv -= option_count;
276 die("empty alias for %s", alias_command);
278 if (!strcmp(alias_command, new_argv[0]))
279 die("recursive alias: %s", alias_command);
281 trace_argv_printf(new_argv,
282 "trace: alias expansion: %s =>",
285 new_argv = xrealloc(new_argv, sizeof(char *) *
287 /* insert after command name */
288 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
296 if (subdir && chdir(subdir))
297 die_errno("Cannot change to '%s'", subdir);
304 #define RUN_SETUP (1<<0)
305 #define RUN_SETUP_GENTLY (1<<1)
306 #define USE_PAGER (1<<2)
308 * require working tree to be present -- anything uses this needs
309 * RUN_SETUP for reading from the configuration file.
311 #define NEED_WORK_TREE (1<<3)
312 #define NO_SETUP (1<<4)
316 int (*fn)(int, const char **, const char *);
320 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
327 help = argc == 2 && !strcmp(argv[1], "-h");
329 if (p->option & RUN_SETUP)
330 prefix = setup_git_directory();
331 else if (p->option & RUN_SETUP_GENTLY) {
333 prefix = setup_git_directory_gently(&nongit_ok);
336 if (use_pager == -1 && p->option & (RUN_SETUP | RUN_SETUP_GENTLY))
337 use_pager = check_pager_config(p->cmd);
338 if (use_pager == -1 && p->option & USE_PAGER)
341 if ((p->option & (RUN_SETUP | RUN_SETUP_GENTLY)) &&
342 startup_info->have_repository) /* get_git_dir() may set up repo, avoid that */
343 trace_repo_setup(prefix);
345 commit_pager_choice();
347 if (!help && p->option & NEED_WORK_TREE)
350 trace_argv_printf(argv, "trace: built-in: git");
352 status = p->fn(argc, argv, prefix);
356 /* Somebody closed stdout? */
357 if (fstat(fileno(stdout), &st))
359 /* Ignore write errors for pipes and sockets.. */
360 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
363 /* Check for ENOSPC and EIO errors.. */
365 die_errno("write failure on standard output");
367 die("unknown write failure on standard output");
369 die_errno("close failed on standard output");
373 static struct cmd_struct commands[] = {
374 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
375 { "annotate", cmd_annotate, RUN_SETUP },
376 { "apply", cmd_apply, RUN_SETUP_GENTLY },
377 { "archive", cmd_archive },
378 { "bisect--helper", cmd_bisect__helper, RUN_SETUP },
379 { "blame", cmd_blame, RUN_SETUP },
380 { "branch", cmd_branch, RUN_SETUP },
381 { "bundle", cmd_bundle, RUN_SETUP_GENTLY },
382 { "cat-file", cmd_cat_file, RUN_SETUP },
383 { "check-attr", cmd_check_attr, RUN_SETUP },
384 { "check-ignore", cmd_check_ignore, RUN_SETUP | NEED_WORK_TREE },
385 { "check-mailmap", cmd_check_mailmap, RUN_SETUP },
386 { "check-ref-format", cmd_check_ref_format },
387 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
388 { "checkout-index", cmd_checkout_index,
389 RUN_SETUP | NEED_WORK_TREE},
390 { "cherry", cmd_cherry, RUN_SETUP },
391 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
392 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
393 { "clone", cmd_clone, NO_SETUP },
394 { "column", cmd_column, RUN_SETUP_GENTLY },
395 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
396 { "commit-tree", cmd_commit_tree, RUN_SETUP },
397 { "config", cmd_config, RUN_SETUP_GENTLY },
398 { "count-objects", cmd_count_objects, RUN_SETUP },
399 { "credential", cmd_credential, RUN_SETUP_GENTLY },
400 { "describe", cmd_describe, RUN_SETUP },
401 { "diff", cmd_diff },
402 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE },
403 { "diff-index", cmd_diff_index, RUN_SETUP },
404 { "diff-tree", cmd_diff_tree, RUN_SETUP },
405 { "fast-export", cmd_fast_export, RUN_SETUP },
406 { "fetch", cmd_fetch, RUN_SETUP },
407 { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
408 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
409 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
410 { "format-patch", cmd_format_patch, RUN_SETUP },
411 { "fsck", cmd_fsck, RUN_SETUP },
412 { "fsck-objects", cmd_fsck, RUN_SETUP },
413 { "gc", cmd_gc, RUN_SETUP },
414 { "get-tar-commit-id", cmd_get_tar_commit_id },
415 { "grep", cmd_grep, RUN_SETUP_GENTLY },
416 { "hash-object", cmd_hash_object },
417 { "help", cmd_help },
418 { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY },
419 { "init", cmd_init_db, NO_SETUP },
420 { "init-db", cmd_init_db, NO_SETUP },
421 { "log", cmd_log, RUN_SETUP },
422 { "ls-files", cmd_ls_files, RUN_SETUP },
423 { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
424 { "ls-tree", cmd_ls_tree, RUN_SETUP },
425 { "mailinfo", cmd_mailinfo },
426 { "mailsplit", cmd_mailsplit },
427 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
428 { "merge-base", cmd_merge_base, RUN_SETUP },
429 { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
430 { "merge-index", cmd_merge_index, RUN_SETUP },
431 { "merge-ours", cmd_merge_ours, RUN_SETUP },
432 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
433 { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
434 { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
435 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
436 { "merge-tree", cmd_merge_tree, RUN_SETUP },
437 { "mktag", cmd_mktag, RUN_SETUP },
438 { "mktree", cmd_mktree, RUN_SETUP },
439 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
440 { "name-rev", cmd_name_rev, RUN_SETUP },
441 { "notes", cmd_notes, RUN_SETUP },
442 { "pack-objects", cmd_pack_objects, RUN_SETUP },
443 { "pack-redundant", cmd_pack_redundant, RUN_SETUP },
444 { "pack-refs", cmd_pack_refs, RUN_SETUP },
445 { "patch-id", cmd_patch_id },
446 { "pickaxe", cmd_blame, RUN_SETUP },
447 { "prune", cmd_prune, RUN_SETUP },
448 { "prune-packed", cmd_prune_packed, RUN_SETUP },
449 { "push", cmd_push, RUN_SETUP },
450 { "read-tree", cmd_read_tree, RUN_SETUP },
451 { "receive-pack", cmd_receive_pack },
452 { "reflog", cmd_reflog, RUN_SETUP },
453 { "remote", cmd_remote, RUN_SETUP },
454 { "remote-ext", cmd_remote_ext },
455 { "remote-fd", cmd_remote_fd },
456 { "repack", cmd_repack, RUN_SETUP },
457 { "replace", cmd_replace, RUN_SETUP },
458 { "rerere", cmd_rerere, RUN_SETUP },
459 { "reset", cmd_reset, RUN_SETUP },
460 { "rev-list", cmd_rev_list, RUN_SETUP },
461 { "rev-parse", cmd_rev_parse },
462 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
463 { "rm", cmd_rm, RUN_SETUP },
464 { "send-pack", cmd_send_pack, 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 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
473 { "tag", cmd_tag, RUN_SETUP },
474 { "unpack-file", cmd_unpack_file, RUN_SETUP },
475 { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
476 { "update-index", cmd_update_index, RUN_SETUP },
477 { "update-ref", cmd_update_ref, RUN_SETUP },
478 { "update-server-info", cmd_update_server_info, RUN_SETUP },
479 { "upload-archive", cmd_upload_archive },
480 { "upload-archive--writer", cmd_upload_archive_writer },
481 { "var", cmd_var, RUN_SETUP_GENTLY },
482 { "verify-commit", cmd_verify_commit, RUN_SETUP },
483 { "verify-pack", cmd_verify_pack },
484 { "verify-tag", cmd_verify_tag, RUN_SETUP },
485 { "version", cmd_version },
486 { "whatchanged", cmd_whatchanged, RUN_SETUP },
487 { "write-tree", cmd_write_tree, RUN_SETUP },
490 int is_builtin(const char *s)
493 for (i = 0; i < ARRAY_SIZE(commands); i++) {
494 struct cmd_struct *p = commands+i;
495 if (!strcmp(s, p->cmd))
501 static void handle_builtin(int argc, const char **argv)
503 const char *cmd = argv[0];
505 static const char ext[] = STRIP_EXTENSION;
507 if (sizeof(ext) > 1) {
508 i = strlen(argv[0]) - strlen(ext);
509 if (i > 0 && !strcmp(argv[0] + i, ext)) {
510 char *argv0 = xstrdup(argv[0]);
511 argv[0] = cmd = argv0;
516 /* Turn "git cmd --help" into "git help cmd" */
517 if (argc > 1 && !strcmp(argv[1], "--help")) {
519 argv[0] = cmd = "help";
522 for (i = 0; i < ARRAY_SIZE(commands); i++) {
523 struct cmd_struct *p = commands+i;
524 if (strcmp(p->cmd, cmd))
526 if (saved_environment && (p->option & NO_SETUP)) {
530 exit(run_builtin(p, argc, argv));
534 static void execv_dashed_external(const char **argv)
536 struct strbuf cmd = STRBUF_INIT;
541 use_pager = check_pager_config(argv[0]);
542 commit_pager_choice();
544 strbuf_addf(&cmd, "git-%s", argv[0]);
547 * argv[0] must be the git command, but the argv array
548 * belongs to the caller, and may be reused in
549 * subsequent loop iterations. Save argv[0] and
550 * restore it on error.
555 trace_argv_printf(argv, "trace: exec:");
558 * if we fail because the command is not found, it is
559 * OK to return. Otherwise, we just pass along the status code.
561 status = run_command_v_opt(argv, RUN_SILENT_EXEC_FAILURE | RUN_CLEAN_ON_EXIT);
562 if (status >= 0 || errno != ENOENT)
567 strbuf_release(&cmd);
570 static int run_argv(int *argcp, const char ***argv)
575 /* See if it's a builtin */
576 handle_builtin(*argcp, *argv);
578 /* .. then try the external ones */
579 execv_dashed_external(*argv);
581 /* It could be an alias -- this works around the insanity
582 * of overriding "git log" with "git show" by having
588 if (!handle_alias(argcp, argv))
597 int main(int argc, char **av)
599 const char **argv = (const char **) av;
602 startup_info = &git_startup_info;
604 cmd = git_extract_argv0_path(argv[0]);
609 * Always open file descriptors 0/1/2 to avoid clobbering files
610 * in die(). It also avoids messing up when the pipes are dup'ed
611 * onto stdin/stdout/stderr in the child processes we spawn.
617 trace_command_performance(argv);
620 * "git-xxxx" is the same as "git xxxx", but we obviously:
622 * - cannot take flags in between the "git" and the "xxxx".
623 * - cannot execute it externally (since it would just do
624 * the same thing over again)
626 * So we just directly call the builtin handler, and die if
627 * that one cannot handle it.
629 if (skip_prefix(cmd, "git-", &cmd)) {
631 handle_builtin(argc, argv);
632 die("cannot handle %s as a builtin", cmd);
635 /* Look for flags.. */
638 handle_options(&argv, &argc, NULL);
640 /* translate --help and --version into commands */
641 skip_prefix(argv[0], "--", &argv[0]);
643 /* The user didn't specify a command; give them help */
644 commit_pager_choice();
645 printf("usage: %s\n\n", git_usage_string);
646 list_common_cmds_help();
647 printf("\n%s\n", _(git_more_info_string));
653 * We use PATH to find git commands, but we prepend some higher
654 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
655 * environment, and the $(gitexecdir) from the Makefile at build
661 static int done_help = 0;
662 static int was_alias = 0;
663 was_alias = run_argv(&argc, &argv);
667 fprintf(stderr, "Expansion of alias '%s' failed; "
668 "'%s' is not a git command\n",
673 cmd = argv[0] = help_unknown_cmd(cmd);
679 fprintf(stderr, "Failed to run command '%s': %s\n",
680 cmd, strerror(errno));