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