git.c

   1 #include "builtin.h"
   2 #include "config.h"
   3 #include "environment.h"
   4 #include "exec-cmd.h"
   5 #include "gettext.h"
   6 #include "help.h"
   7 #include "object-file.h"
   8 #include "pager.h"
   9 #include "read-cache-ll.h"
  10 #include "run-command.h"
  11 #include "alias.h"
  12 #include "replace-object.h"
  13 #include "setup.h"
  14 #include "attr.h"
  15 #include "shallow.h"
  16 #include "trace.h"
  17 #include "trace2.h"
  18
  19 #define RUN_SETUP               (1<<0)
  20 #define RUN_SETUP_GENTLY        (1<<1)
  21 #define USE_PAGER               (1<<2)
  22 /*
  23  * require working tree to be present -- anything uses this needs
  24  * RUN_SETUP for reading from the configuration file.
  25  */
  26 #define NEED_WORK_TREE          (1<<3)
  27 #define DELAY_PAGER_CONFIG      (1<<4)
  28 #define NO_PARSEOPT             (1<<5) /* parse-options is not used */
  29
  30 struct cmd_struct {
  31         const char *cmd;
  32         int (*fn)(int, const char **, const char *);
  33         unsigned int option;
  34 };
  35
  36 const char git_usage_string[] =
  37         N_("git [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]\n"
  38            "           [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
  39            "           [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--bare]\n"
  40            "           [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
  41            "           [--config-env=<name>=<envvar>] <command> [<args>]");
  42
  43 const char git_more_info_string[] =
  44         N_("'git help -a' and 'git help -g' list available subcommands and some\n"
  45            "concept guides. See 'git help <command>' or 'git help <concept>'\n"
  46            "to read about a specific subcommand or concept.\n"
  47            "See 'git help git' for an overview of the system.");
  48
  49 static int use_pager = -1;
  50
  51 static void list_builtins(struct string_list *list, unsigned int exclude_option);
  52
  53 static void exclude_helpers_from_list(struct string_list *list)
  54 {
  55         int i = 0;
  56
  57         while (i < list->nr) {
  58                 if (strstr(list->items[i].string, "--"))
  59                         unsorted_string_list_delete_item(list, i, 0);
  60                 else
  61                         i++;
  62         }
  63 }
  64
  65 static int match_token(const char *spec, int len, const char *token)
  66 {
  67         int token_len = strlen(token);
  68
  69         return len == token_len && !strncmp(spec, token, token_len);
  70 }
  71
  72 static int list_cmds(const char *spec)
  73 {
  74         struct string_list list = STRING_LIST_INIT_DUP;
  75         int i;
  76         int nongit;
  77
  78         /*
  79         * Set up the repository so we can pick up any repo-level config (like
  80         * completion.commands).
  81         */
  82         setup_git_directory_gently(&nongit);
  83
  84         while (*spec) {
  85                 const char *sep = strchrnul(spec, ',');
  86                 int len = sep - spec;
  87
  88                 if (match_token(spec, len, "builtins"))
  89                         list_builtins(&list, 0);
  90                 else if (match_token(spec, len, "main"))
  91                         list_all_main_cmds(&list);
  92                 else if (match_token(spec, len, "others"))
  93                         list_all_other_cmds(&list);
  94                 else if (match_token(spec, len, "nohelpers"))
  95                         exclude_helpers_from_list(&list);
  96                 else if (match_token(spec, len, "alias"))
  97                         list_aliases(&list);
  98                 else if (match_token(spec, len, "config"))
  99                         list_cmds_by_config(&list);
 100                 else if (len > 5 && !strncmp(spec, "list-", 5)) {
 101                         struct strbuf sb = STRBUF_INIT;
 102
 103                         strbuf_add(&sb, spec + 5, len - 5);
 104                         list_cmds_by_category(&list, sb.buf);
 105                         strbuf_release(&sb);
 106                 }
 107                 else
 108                         die(_("unsupported command listing type '%s'"), spec);
 109                 spec += len;
 110                 if (*spec == ',')
 111                         spec++;
 112         }
 113         for (i = 0; i < list.nr; i++)
 114                 puts(list.items[i].string);
 115         string_list_clear(&list, 0);
 116         return 0;
 117 }
 118
 119 static void commit_pager_choice(void)
 120 {
 121         switch (use_pager) {
 122         case 0:
 123                 setenv("GIT_PAGER", "cat", 1);
 124                 break;
 125         case 1:
 126                 setup_pager();
 127                 break;
 128         default:
 129                 break;
 130         }
 131 }
 132
 133 void setup_auto_pager(const char *cmd, int def)
 134 {
 135         if (use_pager != -1 || pager_in_use())
 136                 return;
 137         use_pager = check_pager_config(cmd);
 138         if (use_pager == -1)
 139                 use_pager = def;
 140         commit_pager_choice();
 141 }
 142
 143 static int handle_options(const char ***argv, int *argc, int *envchanged)
 144 {
 145         const char **orig_argv = *argv;
 146
 147         while (*argc > 0) {
 148                 const char *cmd = (*argv)[0];
 149                 if (cmd[0] != '-')
 150                         break;
 151
 152                 /*
 153                  * For legacy reasons, the "version" and "help"
 154                  * commands can be written with "--" prepended
 155                  * to make them look like flags.
 156                  */
 157                 if (!strcmp(cmd, "--help") || !strcmp(cmd, "-h") ||
 158                     !strcmp(cmd, "--version") || !strcmp(cmd, "-v"))
 159                         break;
 160
 161                 /*
 162                  * Check remaining flags.
 163                  */
 164                 if (skip_prefix(cmd, "--exec-path", &cmd)) {
 165                         if (*cmd == '=')
 166                                 git_set_exec_path(cmd + 1);
 167                         else {
 168                                 puts(git_exec_path());
 169                                 trace2_cmd_name("_query_");
 170                                 exit(0);
 171                         }
 172                 } else if (!strcmp(cmd, "--html-path")) {
 173                         puts(system_path(GIT_HTML_PATH));
 174                         trace2_cmd_name("_query_");
 175                         exit(0);
 176                 } else if (!strcmp(cmd, "--man-path")) {
 177                         puts(system_path(GIT_MAN_PATH));
 178                         trace2_cmd_name("_query_");
 179                         exit(0);
 180                 } else if (!strcmp(cmd, "--info-path")) {
 181                         puts(system_path(GIT_INFO_PATH));
 182                         trace2_cmd_name("_query_");
 183                         exit(0);
 184                 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
 185                         use_pager = 1;
 186                 } else if (!strcmp(cmd, "-P") || !strcmp(cmd, "--no-pager")) {
 187                         use_pager = 0;
 188                         if (envchanged)
 189                                 *envchanged = 1;
 190                 } else if (!strcmp(cmd, "--no-lazy-fetch")) {
 191                         fetch_if_missing = 0;
 192                         setenv(NO_LAZY_FETCH_ENVIRONMENT, "1", 1);
 193                         if (envchanged)
 194                                 *envchanged = 1;
 195                 } else if (!strcmp(cmd, "--no-replace-objects")) {
 196                         disable_replace_refs();
 197                         setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
 198                         if (envchanged)
 199                                 *envchanged = 1;
 200                 } else if (!strcmp(cmd, "--git-dir")) {
 201                         if (*argc < 2) {
 202                                 fprintf(stderr, _("no directory given for '%s' option\n" ), "--git-dir");
 203                                 usage(git_usage_string);
 204                         }
 205                         setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
 206                         if (envchanged)
 207                                 *envchanged = 1;
 208                         (*argv)++;
 209                         (*argc)--;
 210                 } else if (skip_prefix(cmd, "--git-dir=", &cmd)) {
 211                         setenv(GIT_DIR_ENVIRONMENT, cmd, 1);
 212                         if (envchanged)
 213                                 *envchanged = 1;
 214                 } else if (!strcmp(cmd, "--namespace")) {
 215                         if (*argc < 2) {
 216                                 fprintf(stderr, _("no namespace given for --namespace\n" ));
 217                                 usage(git_usage_string);
 218                         }
 219                         setenv(GIT_NAMESPACE_ENVIRONMENT, (*argv)[1], 1);
 220                         if (envchanged)
 221                                 *envchanged = 1;
 222                         (*argv)++;
 223                         (*argc)--;
 224                 } else if (skip_prefix(cmd, "--namespace=", &cmd)) {
 225                         setenv(GIT_NAMESPACE_ENVIRONMENT, cmd, 1);
 226                         if (envchanged)
 227                                 *envchanged = 1;
 228                 } else if (!strcmp(cmd, "--work-tree")) {
 229                         if (*argc < 2) {
 230                                 fprintf(stderr, _("no directory given for '%s' option\n" ), "--work-tree");
 231                                 usage(git_usage_string);
 232                         }
 233                         setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
 234                         if (envchanged)
 235                                 *envchanged = 1;
 236                         (*argv)++;
 237                         (*argc)--;
 238                 } else if (skip_prefix(cmd, "--work-tree=", &cmd)) {
 239                         setenv(GIT_WORK_TREE_ENVIRONMENT, cmd, 1);
 240                         if (envchanged)
 241                                 *envchanged = 1;
 242                 } else if (!strcmp(cmd, "--bare")) {
 243                         char *cwd = xgetcwd();
 244                         is_bare_repository_cfg = 1;
 245                         setenv(GIT_DIR_ENVIRONMENT, cwd, 0);
 246                         free(cwd);
 247                         setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
 248                         if (envchanged)
 249                                 *envchanged = 1;
 250                 } else if (!strcmp(cmd, "-c")) {
 251                         if (*argc < 2) {
 252                                 fprintf(stderr, _("-c expects a configuration string\n" ));
 253                                 usage(git_usage_string);
 254                         }
 255                         git_config_push_parameter((*argv)[1]);
 256                         (*argv)++;
 257                         (*argc)--;
 258                 } else if (!strcmp(cmd, "--config-env")) {
 259                         if (*argc < 2) {
 260                                 fprintf(stderr, _("no config key given for --config-env\n" ));
 261                                 usage(git_usage_string);
 262                         }
 263                         git_config_push_env((*argv)[1]);
 264                         (*argv)++;
 265                         (*argc)--;
 266                 } else if (skip_prefix(cmd, "--config-env=", &cmd)) {
 267                         git_config_push_env(cmd);
 268                 } else if (!strcmp(cmd, "--literal-pathspecs")) {
 269                         setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "1", 1);
 270                         if (envchanged)
 271                                 *envchanged = 1;
 272                 } else if (!strcmp(cmd, "--no-literal-pathspecs")) {
 273                         setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "0", 1);
 274                         if (envchanged)
 275                                 *envchanged = 1;
 276                 } else if (!strcmp(cmd, "--glob-pathspecs")) {
 277                         setenv(GIT_GLOB_PATHSPECS_ENVIRONMENT, "1", 1);
 278                         if (envchanged)
 279                                 *envchanged = 1;
 280                 } else if (!strcmp(cmd, "--noglob-pathspecs")) {
 281                         setenv(GIT_NOGLOB_PATHSPECS_ENVIRONMENT, "1", 1);
 282                         if (envchanged)
 283                                 *envchanged = 1;
 284                 } else if (!strcmp(cmd, "--icase-pathspecs")) {
 285                         setenv(GIT_ICASE_PATHSPECS_ENVIRONMENT, "1", 1);
 286                         if (envchanged)
 287                                 *envchanged = 1;
 288                 } else if (!strcmp(cmd, "--no-optional-locks")) {
 289                         setenv(GIT_OPTIONAL_LOCKS_ENVIRONMENT, "0", 1);
 290                         if (envchanged)
 291                                 *envchanged = 1;
 292                 } else if (!strcmp(cmd, "--shallow-file")) {
 293                         (*argv)++;
 294                         (*argc)--;
 295                         set_alternate_shallow_file(the_repository, (*argv)[0], 1);
 296                         if (envchanged)
 297                                 *envchanged = 1;
 298                 } else if (!strcmp(cmd, "-C")) {
 299                         if (*argc < 2) {
 300                                 fprintf(stderr, _("no directory given for '%s' option\n" ), "-C");
 301                                 usage(git_usage_string);
 302                         }
 303                         if ((*argv)[1][0]) {
 304                                 if (chdir((*argv)[1]))
 305                                         die_errno("cannot change to '%s'", (*argv)[1]);
 306                                 if (envchanged)
 307                                         *envchanged = 1;
 308                         }
 309                         (*argv)++;
 310                         (*argc)--;
 311                 } else if (skip_prefix(cmd, "--list-cmds=", &cmd)) {
 312                         trace2_cmd_name("_query_");
 313                         if (!strcmp(cmd, "parseopt")) {
 314                                 struct string_list list = STRING_LIST_INIT_DUP;
 315                                 int i;
 316
 317                                 list_builtins(&list, NO_PARSEOPT);
 318                                 for (i = 0; i < list.nr; i++)
 319                                         printf("%s ", list.items[i].string);
 320                                 string_list_clear(&list, 0);
 321                                 exit(0);
 322                         } else {
 323                                 exit(list_cmds(cmd));
 324                         }
 325                 } else if (!strcmp(cmd, "--attr-source")) {
 326                         if (*argc < 2) {
 327                                 fprintf(stderr, _("no attribute source given for --attr-source\n" ));
 328                                 usage(git_usage_string);
 329                         }
 330                         setenv(GIT_ATTR_SOURCE_ENVIRONMENT, (*argv)[1], 1);
 331                         if (envchanged)
 332                                 *envchanged = 1;
 333                         (*argv)++;
 334                         (*argc)--;
 335                 } else if (skip_prefix(cmd, "--attr-source=", &cmd)) {
 336                         set_git_attr_source(cmd);
 337                         setenv(GIT_ATTR_SOURCE_ENVIRONMENT, cmd, 1);
 338                         if (envchanged)
 339                                 *envchanged = 1;
 340                 } else {
 341                         fprintf(stderr, _("unknown option: %s\n"), cmd);
 342                         usage(git_usage_string);
 343                 }
 344
 345                 (*argv)++;
 346                 (*argc)--;
 347         }
 348         return (*argv) - orig_argv;
 349 }
 350
 351 static int handle_alias(int *argcp, const char ***argv)
 352 {
 353         int envchanged = 0, ret = 0, saved_errno = errno;
 354         int count, option_count;
 355         const char **new_argv;
 356         const char *alias_command;
 357         char *alias_string;
 358
 359         alias_command = (*argv)[0];
 360         alias_string = alias_lookup(alias_command);
 361         if (alias_string) {
 362                 if (*argcp > 1 && !strcmp((*argv)[1], "-h"))
 363                         fprintf_ln(stderr, _("'%s' is aliased to '%s'"),
 364                                    alias_command, alias_string);
 365                 if (alias_string[0] == '!') {
 366                         struct child_process child = CHILD_PROCESS_INIT;
 367                         int nongit_ok;
 368
 369                         /* Aliases expect GIT_PREFIX, GIT_DIR etc to be set */
 370                         setup_git_directory_gently(&nongit_ok);
 371
 372                         commit_pager_choice();
 373
 374                         child.use_shell = 1;
 375                         child.clean_on_exit = 1;
 376                         child.wait_after_clean = 1;
 377                         child.trace2_child_class = "shell_alias";
 378                         strvec_push(&child.args, alias_string + 1);
 379                         strvec_pushv(&child.args, (*argv) + 1);
 380
 381                         trace2_cmd_alias(alias_command, child.args.v);
 382                         trace2_cmd_name("_run_shell_alias_");
 383
 384                         ret = run_command(&child);
 385                         if (ret >= 0)   /* normal exit */
 386                                 exit(ret);
 387
 388                         die_errno(_("while expanding alias '%s': '%s'"),
 389                                   alias_command, alias_string + 1);
 390                 }
 391                 count = split_cmdline(alias_string, &new_argv);
 392                 if (count < 0)
 393                         die(_("bad alias.%s string: %s"), alias_command,
 394                             _(split_cmdline_strerror(count)));
 395                 option_count = handle_options(&new_argv, &count, &envchanged);
 396                 if (envchanged)
 397                         die(_("alias '%s' changes environment variables.\n"
 398                               "You can use '!git' in the alias to do this"),
 399                             alias_command);
 400                 MOVE_ARRAY(new_argv - option_count, new_argv, count);
 401                 new_argv -= option_count;
 402
 403                 if (count < 1)
 404                         die(_("empty alias for %s"), alias_command);
 405
 406                 if (!strcmp(alias_command, new_argv[0]))
 407                         die(_("recursive alias: %s"), alias_command);
 408
 409                 trace_argv_printf(new_argv,
 410                                   "trace: alias expansion: %s =>",
 411                                   alias_command);
 412
 413                 REALLOC_ARRAY(new_argv, count + *argcp);
 414                 /* insert after command name */
 415                 COPY_ARRAY(new_argv + count, *argv + 1, *argcp);
 416
 417                 trace2_cmd_alias(alias_command, new_argv);
 418
 419                 *argv = new_argv;
 420                 *argcp += count - 1;
 421
 422                 ret = 1;
 423         }
 424
 425         errno = saved_errno;
 426
 427         return ret;
 428 }
 429
 430 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
 431 {
 432         int status, help;
 433         struct stat st;
 434         const char *prefix;
 435         int run_setup = (p->option & (RUN_SETUP | RUN_SETUP_GENTLY));
 436
 437         help = argc == 2 && !strcmp(argv[1], "-h");
 438         if (help && (run_setup & RUN_SETUP))
 439                 /* demote to GENTLY to allow 'git cmd -h' outside repo */
 440                 run_setup = RUN_SETUP_GENTLY;
 441
 442         if (run_setup & RUN_SETUP) {
 443                 prefix = setup_git_directory();
 444         } else if (run_setup & RUN_SETUP_GENTLY) {
 445                 int nongit_ok;
 446                 prefix = setup_git_directory_gently(&nongit_ok);
 447         } else {
 448                 prefix = NULL;
 449         }
 450         assert(!prefix || *prefix);
 451         precompose_argv_prefix(argc, argv, NULL);
 452         if (use_pager == -1 && run_setup &&
 453                 !(p->option & DELAY_PAGER_CONFIG))
 454                 use_pager = check_pager_config(p->cmd);
 455         if (use_pager == -1 && p->option & USE_PAGER)
 456                 use_pager = 1;
 457         if (run_setup && startup_info->have_repository)
 458                 /* get_git_dir() may set up repo, avoid that */
 459                 trace_repo_setup();
 460         commit_pager_choice();
 461
 462         if (!help && p->option & NEED_WORK_TREE)
 463                 setup_work_tree();
 464
 465         trace_argv_printf(argv, "trace: built-in: git");
 466         trace2_cmd_name(p->cmd);
 467
 468         validate_cache_entries(the_repository->index);
 469         status = p->fn(argc, argv, prefix);
 470         validate_cache_entries(the_repository->index);
 471
 472         if (status)
 473                 return status;
 474
 475         /* Somebody closed stdout? */
 476         if (fstat(fileno(stdout), &st))
 477                 return 0;
 478         /* Ignore write errors for pipes and sockets.. */
 479         if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
 480                 return 0;
 481
 482         /* Check for ENOSPC and EIO errors.. */
 483         if (fflush(stdout))
 484                 die_errno(_("write failure on standard output"));
 485         if (ferror(stdout))
 486                 die(_("unknown write failure on standard output"));
 487         if (fclose(stdout))
 488                 die_errno(_("close failed on standard output"));
 489         return 0;
 490 }
 491
 492 static struct cmd_struct commands[] = {
 493         { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
 494         { "am", cmd_am, RUN_SETUP | NEED_WORK_TREE },
 495         { "annotate", cmd_annotate, RUN_SETUP },
 496         { "apply", cmd_apply, RUN_SETUP_GENTLY },
 497         { "archive", cmd_archive, RUN_SETUP_GENTLY },
 498         { "bisect", cmd_bisect, RUN_SETUP },
 499         { "blame", cmd_blame, RUN_SETUP },
 500         { "branch", cmd_branch, RUN_SETUP | DELAY_PAGER_CONFIG },
 501         { "bugreport", cmd_bugreport, RUN_SETUP_GENTLY },
 502         { "bundle", cmd_bundle, RUN_SETUP_GENTLY },
 503         { "cat-file", cmd_cat_file, RUN_SETUP },
 504         { "check-attr", cmd_check_attr, RUN_SETUP },
 505         { "check-ignore", cmd_check_ignore, RUN_SETUP | NEED_WORK_TREE },
 506         { "check-mailmap", cmd_check_mailmap, RUN_SETUP },
 507         { "check-ref-format", cmd_check_ref_format, NO_PARSEOPT  },
 508         { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
 509         { "checkout--worker", cmd_checkout__worker,
 510                 RUN_SETUP | NEED_WORK_TREE },
 511         { "checkout-index", cmd_checkout_index,
 512                 RUN_SETUP | NEED_WORK_TREE},
 513         { "cherry", cmd_cherry, RUN_SETUP },
 514         { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
 515         { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
 516         { "clone", cmd_clone },
 517         { "column", cmd_column, RUN_SETUP_GENTLY },
 518         { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
 519         { "commit-graph", cmd_commit_graph, RUN_SETUP },
 520         { "commit-tree", cmd_commit_tree, RUN_SETUP },
 521         { "config", cmd_config, RUN_SETUP_GENTLY | DELAY_PAGER_CONFIG },
 522         { "count-objects", cmd_count_objects, RUN_SETUP },
 523         { "credential", cmd_credential, RUN_SETUP_GENTLY | NO_PARSEOPT },
 524         { "credential-cache", cmd_credential_cache },
 525         { "credential-cache--daemon", cmd_credential_cache_daemon },
 526         { "credential-store", cmd_credential_store },
 527         { "describe", cmd_describe, RUN_SETUP },
 528         { "diagnose", cmd_diagnose, RUN_SETUP_GENTLY },
 529         { "diff", cmd_diff, NO_PARSEOPT },
 530         { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
 531         { "diff-index", cmd_diff_index, RUN_SETUP | NO_PARSEOPT },
 532         { "diff-tree", cmd_diff_tree, RUN_SETUP | NO_PARSEOPT },
 533         { "difftool", cmd_difftool, RUN_SETUP_GENTLY },
 534         { "fast-export", cmd_fast_export, RUN_SETUP },
 535         { "fast-import", cmd_fast_import, RUN_SETUP | NO_PARSEOPT },
 536         { "fetch", cmd_fetch, RUN_SETUP },
 537         { "fetch-pack", cmd_fetch_pack, RUN_SETUP | NO_PARSEOPT },
 538         { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
 539         { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
 540         { "for-each-repo", cmd_for_each_repo, RUN_SETUP_GENTLY },
 541         { "format-patch", cmd_format_patch, RUN_SETUP },
 542         { "fsck", cmd_fsck, RUN_SETUP },
 543         { "fsck-objects", cmd_fsck, RUN_SETUP },
 544         { "fsmonitor--daemon", cmd_fsmonitor__daemon, RUN_SETUP },
 545         { "gc", cmd_gc, RUN_SETUP },
 546         { "get-tar-commit-id", cmd_get_tar_commit_id, NO_PARSEOPT },
 547         { "grep", cmd_grep, RUN_SETUP_GENTLY },
 548         { "hash-object", cmd_hash_object },
 549         { "help", cmd_help },
 550         { "hook", cmd_hook, RUN_SETUP },
 551         { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY | NO_PARSEOPT },
 552         { "init", cmd_init_db },
 553         { "init-db", cmd_init_db },
 554         { "interpret-trailers", cmd_interpret_trailers, RUN_SETUP_GENTLY },
 555         { "log", cmd_log, RUN_SETUP },
 556         { "ls-files", cmd_ls_files, RUN_SETUP },
 557         { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
 558         { "ls-tree", cmd_ls_tree, RUN_SETUP },
 559         { "mailinfo", cmd_mailinfo, RUN_SETUP_GENTLY },
 560         { "mailsplit", cmd_mailsplit, NO_PARSEOPT },
 561         { "maintenance", cmd_maintenance, RUN_SETUP },
 562         { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
 563         { "merge-base", cmd_merge_base, RUN_SETUP },
 564         { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
 565         { "merge-index", cmd_merge_index, RUN_SETUP | NO_PARSEOPT },
 566         { "merge-ours", cmd_merge_ours, RUN_SETUP | NO_PARSEOPT },
 567         { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
 568         { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
 569         { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
 570         { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
 571         { "merge-tree", cmd_merge_tree, RUN_SETUP },
 572         { "mktag", cmd_mktag, RUN_SETUP },
 573         { "mktree", cmd_mktree, RUN_SETUP },
 574         { "multi-pack-index", cmd_multi_pack_index, RUN_SETUP },
 575         { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
 576         { "name-rev", cmd_name_rev, RUN_SETUP },
 577         { "notes", cmd_notes, RUN_SETUP },
 578         { "pack-objects", cmd_pack_objects, RUN_SETUP },
 579         { "pack-redundant", cmd_pack_redundant, RUN_SETUP | NO_PARSEOPT },
 580         { "pack-refs", cmd_pack_refs, RUN_SETUP },
 581         { "patch-id", cmd_patch_id, RUN_SETUP_GENTLY | NO_PARSEOPT },
 582         { "pickaxe", cmd_blame, RUN_SETUP },
 583         { "prune", cmd_prune, RUN_SETUP },
 584         { "prune-packed", cmd_prune_packed, RUN_SETUP },
 585         { "pull", cmd_pull, RUN_SETUP | NEED_WORK_TREE },
 586         { "push", cmd_push, RUN_SETUP },
 587         { "range-diff", cmd_range_diff, RUN_SETUP | USE_PAGER },
 588         { "read-tree", cmd_read_tree, RUN_SETUP },
 589         { "rebase", cmd_rebase, RUN_SETUP | NEED_WORK_TREE },
 590         { "receive-pack", cmd_receive_pack },
 591         { "reflog", cmd_reflog, RUN_SETUP },
 592         { "remote", cmd_remote, RUN_SETUP },
 593         { "remote-ext", cmd_remote_ext, NO_PARSEOPT },
 594         { "remote-fd", cmd_remote_fd, NO_PARSEOPT },
 595         { "repack", cmd_repack, RUN_SETUP },
 596         { "replace", cmd_replace, RUN_SETUP },
 597         { "replay", cmd_replay, RUN_SETUP },
 598         { "rerere", cmd_rerere, RUN_SETUP },
 599         { "reset", cmd_reset, RUN_SETUP },
 600         { "restore", cmd_restore, RUN_SETUP | NEED_WORK_TREE },
 601         { "rev-list", cmd_rev_list, RUN_SETUP | NO_PARSEOPT },
 602         { "rev-parse", cmd_rev_parse, NO_PARSEOPT },
 603         { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
 604         { "rm", cmd_rm, RUN_SETUP },
 605         { "send-pack", cmd_send_pack, RUN_SETUP },
 606         { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
 607         { "show", cmd_show, RUN_SETUP },
 608         { "show-branch", cmd_show_branch, RUN_SETUP },
 609         { "show-index", cmd_show_index, RUN_SETUP_GENTLY },
 610         { "show-ref", cmd_show_ref, RUN_SETUP },
 611         { "sparse-checkout", cmd_sparse_checkout, RUN_SETUP },
 612         { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
 613         { "stash", cmd_stash, RUN_SETUP | NEED_WORK_TREE },
 614         { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
 615         { "stripspace", cmd_stripspace },
 616         { "submodule--helper", cmd_submodule__helper, RUN_SETUP },
 617         { "switch", cmd_switch, RUN_SETUP | NEED_WORK_TREE },
 618         { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
 619         { "tag", cmd_tag, RUN_SETUP | DELAY_PAGER_CONFIG },
 620         { "unpack-file", cmd_unpack_file, RUN_SETUP | NO_PARSEOPT },
 621         { "unpack-objects", cmd_unpack_objects, RUN_SETUP | NO_PARSEOPT },
 622         { "update-index", cmd_update_index, RUN_SETUP },
 623         { "update-ref", cmd_update_ref, RUN_SETUP },
 624         { "update-server-info", cmd_update_server_info, RUN_SETUP },
 625         { "upload-archive", cmd_upload_archive, NO_PARSEOPT },
 626         { "upload-archive--writer", cmd_upload_archive_writer, NO_PARSEOPT },
 627         { "upload-pack", cmd_upload_pack },
 628         { "var", cmd_var, RUN_SETUP_GENTLY | NO_PARSEOPT },
 629         { "verify-commit", cmd_verify_commit, RUN_SETUP },
 630         { "verify-pack", cmd_verify_pack },
 631         { "verify-tag", cmd_verify_tag, RUN_SETUP },
 632         { "version", cmd_version },
 633         { "whatchanged", cmd_whatchanged, RUN_SETUP },
 634         { "worktree", cmd_worktree, RUN_SETUP },
 635         { "write-tree", cmd_write_tree, RUN_SETUP },
 636 };
 637
 638 static struct cmd_struct *get_builtin(const char *s)
 639 {
 640         int i;
 641         for (i = 0; i < ARRAY_SIZE(commands); i++) {
 642                 struct cmd_struct *p = commands + i;
 643                 if (!strcmp(s, p->cmd))
 644                         return p;
 645         }
 646         return NULL;
 647 }
 648
 649 int is_builtin(const char *s)
 650 {
 651         return !!get_builtin(s);
 652 }
 653
 654 static void list_builtins(struct string_list *out, unsigned int exclude_option)
 655 {
 656         int i;
 657         for (i = 0; i < ARRAY_SIZE(commands); i++) {
 658                 if (exclude_option &&
 659                     (commands[i].option & exclude_option))
 660                         continue;
 661                 string_list_append(out, commands[i].cmd);
 662         }
 663 }
 664
 665 void load_builtin_commands(const char *prefix, struct cmdnames *cmds)
 666 {
 667         const char *name;
 668         int i;
 669
 670         /*
 671          * Callers can ask for a subset of the commands based on a certain
 672          * prefix, which is then dropped from the added names. The names in
 673          * the `commands[]` array do not have the `git-` prefix, though,
 674          * therefore we must expect the `prefix` to at least start with `git-`.
 675          */
 676         if (!skip_prefix(prefix, "git-", &prefix))
 677                 BUG("prefix '%s' must start with 'git-'", prefix);
 678
 679         for (i = 0; i < ARRAY_SIZE(commands); i++)
 680                 if (skip_prefix(commands[i].cmd, prefix, &name))
 681                         add_cmdname(cmds, name, strlen(name));
 682 }
 683
 684 #ifdef STRIP_EXTENSION
 685 static void strip_extension(const char **argv)
 686 {
 687         size_t len;
 688
 689         if (strip_suffix(argv[0], STRIP_EXTENSION, &len))
 690                 argv[0] = xmemdupz(argv[0], len);
 691 }
 692 #else
 693 #define strip_extension(cmd)
 694 #endif
 695
 696 static void handle_builtin(int argc, const char **argv)
 697 {
 698         struct strvec args = STRVEC_INIT;
 699         const char *cmd;
 700         struct cmd_struct *builtin;
 701
 702         strip_extension(argv);
 703         cmd = argv[0];
 704
 705         /* Turn "git cmd --help" into "git help --exclude-guides cmd" */
 706         if (argc > 1 && !strcmp(argv[1], "--help")) {
 707                 int i;
 708
 709                 argv[1] = argv[0];
 710                 argv[0] = cmd = "help";
 711
 712                 for (i = 0; i < argc; i++) {
 713                         strvec_push(&args, argv[i]);
 714                         if (!i)
 715                                 strvec_push(&args, "--exclude-guides");
 716                 }
 717
 718                 argc++;
 719                 argv = args.v;
 720         }
 721
 722         builtin = get_builtin(cmd);
 723         if (builtin)
 724                 exit(run_builtin(builtin, argc, argv));
 725         strvec_clear(&args);
 726 }
 727
 728 static void execv_dashed_external(const char **argv)
 729 {
 730         struct child_process cmd = CHILD_PROCESS_INIT;
 731         int status;
 732
 733         if (use_pager == -1 && !is_builtin(argv[0]))
 734                 use_pager = check_pager_config(argv[0]);
 735         commit_pager_choice();
 736
 737         strvec_pushf(&cmd.args, "git-%s", argv[0]);
 738         strvec_pushv(&cmd.args, argv + 1);
 739         cmd.clean_on_exit = 1;
 740         cmd.wait_after_clean = 1;
 741         cmd.silent_exec_failure = 1;
 742         cmd.trace2_child_class = "dashed";
 743
 744         trace2_cmd_name("_run_dashed_");
 745
 746         /*
 747          * The code in run_command() logs trace2 child_start/child_exit
 748          * events, so we do not need to report exec/exec_result events here.
 749          */
 750         trace_argv_printf(cmd.args.v, "trace: exec:");
 751
 752         /*
 753          * If we fail because the command is not found, it is
 754          * OK to return. Otherwise, we just pass along the status code,
 755          * or our usual generic code if we were not even able to exec
 756          * the program.
 757          */
 758         status = run_command(&cmd);
 759
 760         /*
 761          * If the child process ran and we are now going to exit, emit a
 762          * generic string as our trace2 command verb to indicate that we
 763          * launched a dashed command.
 764          */
 765         if (status >= 0)
 766                 exit(status);
 767         else if (errno != ENOENT)
 768                 exit(128);
 769 }
 770
 771 static int run_argv(int *argcp, const char ***argv)
 772 {
 773         int done_alias = 0;
 774         struct string_list cmd_list = STRING_LIST_INIT_NODUP;
 775         struct string_list_item *seen;
 776
 777         while (1) {
 778                 /*
 779                  * If we tried alias and futzed with our environment,
 780                  * it no longer is safe to invoke builtins directly in
 781                  * general.  We have to spawn them as dashed externals.
 782                  *
 783                  * NEEDSWORK: if we can figure out cases
 784                  * where it is safe to do, we can avoid spawning a new
 785                  * process.
 786                  */
 787                 if (!done_alias)
 788                         handle_builtin(*argcp, *argv);
 789                 else if (get_builtin(**argv)) {
 790                         struct child_process cmd = CHILD_PROCESS_INIT;
 791                         int i;
 792
 793                         /*
 794                          * The current process is committed to launching a
 795                          * child process to run the command named in (**argv)
 796                          * and exiting.  Log a generic string as the trace2
 797                          * command verb to indicate this.  Note that the child
 798                          * process will log the actual verb when it runs.
 799                          */
 800                         trace2_cmd_name("_run_git_alias_");
 801
 802                         commit_pager_choice();
 803
 804                         strvec_push(&cmd.args, "git");
 805                         for (i = 0; i < *argcp; i++)
 806                                 strvec_push(&cmd.args, (*argv)[i]);
 807
 808                         trace_argv_printf(cmd.args.v, "trace: exec:");
 809
 810                         /*
 811                          * if we fail because the command is not found, it is
 812                          * OK to return. Otherwise, we just pass along the status code.
 813                          */
 814                         cmd.silent_exec_failure = 1;
 815                         cmd.clean_on_exit = 1;
 816                         cmd.wait_after_clean = 1;
 817                         cmd.trace2_child_class = "git_alias";
 818                         i = run_command(&cmd);
 819                         if (i >= 0 || errno != ENOENT)
 820                                 exit(i);
 821                         die("could not execute builtin %s", **argv);
 822                 }
 823
 824                 /* .. then try the external ones */
 825                 execv_dashed_external(*argv);
 826
 827                 seen = unsorted_string_list_lookup(&cmd_list, *argv[0]);
 828                 if (seen) {
 829                         int i;
 830                         struct strbuf sb = STRBUF_INIT;
 831                         for (i = 0; i < cmd_list.nr; i++) {
 832                                 struct string_list_item *item = &cmd_list.items[i];
 833
 834                                 strbuf_addf(&sb, "\n  %s", item->string);
 835                                 if (item == seen)
 836                                         strbuf_addstr(&sb, " <==");
 837                                 else if (i == cmd_list.nr - 1)
 838                                         strbuf_addstr(&sb, " ==>");
 839                         }
 840                         die(_("alias loop detected: expansion of '%s' does"
 841                               " not terminate:%s"), cmd_list.items[0].string, sb.buf);
 842                 }
 843
 844                 string_list_append(&cmd_list, *argv[0]);
 845
 846                 /*
 847                  * It could be an alias -- this works around the insanity
 848                  * of overriding "git log" with "git show" by having
 849                  * alias.log = show
 850                  */
 851                 if (!handle_alias(argcp, argv))
 852                         break;
 853                 done_alias = 1;
 854         }
 855
 856         string_list_clear(&cmd_list, 0);
 857
 858         return done_alias;
 859 }
 860
 861 int cmd_main(int argc, const char **argv)
 862 {
 863         const char *cmd;
 864         int done_help = 0;
 865
 866         cmd = argv[0];
 867         if (!cmd)
 868                 cmd = "git-help";
 869         else {
 870                 const char *slash = find_last_dir_sep(cmd);
 871                 if (slash)
 872                         cmd = slash + 1;
 873         }
 874
 875         trace_command_performance(argv);
 876
 877         /*
 878          * "git-xxxx" is the same as "git xxxx", but we obviously:
 879          *
 880          *  - cannot take flags in between the "git" and the "xxxx".
 881          *  - cannot execute it externally (since it would just do
 882          *    the same thing over again)
 883          *
 884          * So we just directly call the builtin handler, and die if
 885          * that one cannot handle it.
 886          */
 887         if (skip_prefix(cmd, "git-", &cmd)) {
 888                 argv[0] = cmd;
 889                 handle_builtin(argc, argv);
 890                 die(_("cannot handle %s as a builtin"), cmd);
 891         }
 892
 893         /* Look for flags.. */
 894         argv++;
 895         argc--;
 896         handle_options(&argv, &argc, NULL);
 897
 898         if (!argc) {
 899                 /* The user didn't specify a command; give them help */
 900                 commit_pager_choice();
 901                 printf(_("usage: %s\n\n"), git_usage_string);
 902                 list_common_cmds_help();
 903                 printf("\n%s\n", _(git_more_info_string));
 904                 exit(1);
 905         }
 906
 907         if (!strcmp("--version", argv[0]) || !strcmp("-v", argv[0]))
 908                 argv[0] = "version";
 909         else if (!strcmp("--help", argv[0]) || !strcmp("-h", argv[0]))
 910                 argv[0] = "help";
 911
 912         cmd = argv[0];
 913
 914         /*
 915          * We use PATH to find git commands, but we prepend some higher
 916          * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
 917          * environment, and the $(gitexecdir) from the Makefile at build
 918          * time.
 919          */
 920         setup_path();
 921
 922         while (1) {
 923                 int was_alias = run_argv(&argc, &argv);
 924                 if (errno != ENOENT)
 925                         break;
 926                 if (was_alias) {
 927                         fprintf(stderr, _("expansion of alias '%s' failed; "
 928                                           "'%s' is not a git command\n"),
 929                                 cmd, argv[0]);
 930                         exit(1);
 931                 }
 932                 if (!done_help) {
 933                         cmd = argv[0] = help_unknown_cmd(cmd);
 934                         done_help = 1;
 935                 } else
 936                         break;
 937         }
 938
 939         fprintf(stderr, _("failed to run command '%s': %s\n"),
 940                 cmd, strerror(errno));
 941
 942         return 1;
 943 }