git.c

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