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 [-v | --version] [-h | --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, "-h") ||
 150                     !strcmp(cmd, "--version") || !strcmp(cmd, "-v"))
 151                         break;
 152
 153                 /*
 154                  * Check remaining flags.
 155                  */
 156                 if (skip_prefix(cmd, "--exec-path", &cmd)) {
 157                         if (*cmd == '=')
 158                                 git_set_exec_path(cmd + 1);
 159                         else {
 160                                 puts(git_exec_path());
 161                                 trace2_cmd_name("_query_");
 162                                 exit(0);
 163                         }
 164                 } else if (!strcmp(cmd, "--html-path")) {
 165                         puts(system_path(GIT_HTML_PATH));
 166                         trace2_cmd_name("_query_");
 167                         exit(0);
 168                 } else if (!strcmp(cmd, "--man-path")) {
 169                         puts(system_path(GIT_MAN_PATH));
 170                         trace2_cmd_name("_query_");
 171                         exit(0);
 172                 } else if (!strcmp(cmd, "--info-path")) {
 173                         puts(system_path(GIT_INFO_PATH));
 174                         trace2_cmd_name("_query_");
 175                         exit(0);
 176                 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
 177                         use_pager = 1;
 178                 } else if (!strcmp(cmd, "-P") || !strcmp(cmd, "--no-pager")) {
 179                         use_pager = 0;
 180                         if (envchanged)
 181                                 *envchanged = 1;
 182                 } else if (!strcmp(cmd, "--no-replace-objects")) {
 183                         read_replace_refs = 0;
 184                         setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
 185                         if (envchanged)
 186                                 *envchanged = 1;
 187                 } else if (!strcmp(cmd, "--git-dir")) {
 188                         if (*argc < 2) {
 189                                 fprintf(stderr, _("no directory given for '%s' option\n" ), "--git-dir");
 190                                 usage(git_usage_string);
 191                         }
 192                         setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
 193                         if (envchanged)
 194                                 *envchanged = 1;
 195                         (*argv)++;
 196                         (*argc)--;
 197                 } else if (skip_prefix(cmd, "--git-dir=", &cmd)) {
 198                         setenv(GIT_DIR_ENVIRONMENT, cmd, 1);
 199                         if (envchanged)
 200                                 *envchanged = 1;
 201                 } else if (!strcmp(cmd, "--namespace")) {
 202                         if (*argc < 2) {
 203                                 fprintf(stderr, _("no namespace given for --namespace\n" ));
 204                                 usage(git_usage_string);
 205                         }
 206                         setenv(GIT_NAMESPACE_ENVIRONMENT, (*argv)[1], 1);
 207                         if (envchanged)
 208                                 *envchanged = 1;
 209                         (*argv)++;
 210                         (*argc)--;
 211                 } else if (skip_prefix(cmd, "--namespace=", &cmd)) {
 212                         setenv(GIT_NAMESPACE_ENVIRONMENT, cmd, 1);
 213                         if (envchanged)
 214                                 *envchanged = 1;
 215                 } else if (!strcmp(cmd, "--work-tree")) {
 216                         if (*argc < 2) {
 217                                 fprintf(stderr, _("no directory given for '%s' option\n" ), "--work-tree");
 218                                 usage(git_usage_string);
 219                         }
 220                         setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
 221                         if (envchanged)
 222                                 *envchanged = 1;
 223                         (*argv)++;
 224                         (*argc)--;
 225                 } else if (skip_prefix(cmd, "--work-tree=", &cmd)) {
 226                         setenv(GIT_WORK_TREE_ENVIRONMENT, cmd, 1);
 227                         if (envchanged)
 228                                 *envchanged = 1;
 229                 } else if (!strcmp(cmd, "--super-prefix")) {
 230                         if (*argc < 2) {
 231                                 fprintf(stderr, _("no prefix given for --super-prefix\n" ));
 232                                 usage(git_usage_string);
 233                         }
 234                         setenv(GIT_SUPER_PREFIX_ENVIRONMENT, (*argv)[1], 1);
 235                         if (envchanged)
 236                                 *envchanged = 1;
 237                         (*argv)++;
 238                         (*argc)--;
 239                 } else if (skip_prefix(cmd, "--super-prefix=", &cmd)) {
 240                         setenv(GIT_SUPER_PREFIX_ENVIRONMENT, cmd, 1);
 241                         if (envchanged)
 242                                 *envchanged = 1;
 243                 } else if (!strcmp(cmd, "--bare")) {
 244                         char *cwd = xgetcwd();
 245                         is_bare_repository_cfg = 1;
 246                         setenv(GIT_DIR_ENVIRONMENT, cwd, 0);
 247                         free(cwd);
 248                         setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
 249                         if (envchanged)
 250                                 *envchanged = 1;
 251                 } else if (!strcmp(cmd, "-c")) {
 252                         if (*argc < 2) {
 253                                 fprintf(stderr, _("-c expects a configuration string\n" ));
 254                                 usage(git_usage_string);
 255                         }
 256                         git_config_push_parameter((*argv)[1]);
 257                         (*argv)++;
 258                         (*argc)--;
 259                 } else if (!strcmp(cmd, "--config-env")) {
 260                         if (*argc < 2) {
 261                                 fprintf(stderr, _("no config key given for --config-env\n" ));
 262                                 usage(git_usage_string);
 263                         }
 264                         git_config_push_env((*argv)[1]);
 265                         (*argv)++;
 266                         (*argc)--;
 267                 } else if (skip_prefix(cmd, "--config-env=", &cmd)) {
 268                         git_config_push_env(cmd);
 269                 } else if (!strcmp(cmd, "--literal-pathspecs")) {
 270                         setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "1", 1);
 271                         if (envchanged)
 272                                 *envchanged = 1;
 273                 } else if (!strcmp(cmd, "--no-literal-pathspecs")) {
 274                         setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "0", 1);
 275                         if (envchanged)
 276                                 *envchanged = 1;
 277                 } else if (!strcmp(cmd, "--glob-pathspecs")) {
 278                         setenv(GIT_GLOB_PATHSPECS_ENVIRONMENT, "1", 1);
 279                         if (envchanged)
 280                                 *envchanged = 1;
 281                 } else if (!strcmp(cmd, "--noglob-pathspecs")) {
 282                         setenv(GIT_NOGLOB_PATHSPECS_ENVIRONMENT, "1", 1);
 283                         if (envchanged)
 284                                 *envchanged = 1;
 285                 } else if (!strcmp(cmd, "--icase-pathspecs")) {
 286                         setenv(GIT_ICASE_PATHSPECS_ENVIRONMENT, "1", 1);
 287                         if (envchanged)
 288                                 *envchanged = 1;
 289                 } else if (!strcmp(cmd, "--no-optional-locks")) {
 290                         setenv(GIT_OPTIONAL_LOCKS_ENVIRONMENT, "0", 1);
 291                         if (envchanged)
 292                                 *envchanged = 1;
 293                 } else if (!strcmp(cmd, "--shallow-file")) {
 294                         (*argv)++;
 295                         (*argc)--;
 296                         set_alternate_shallow_file(the_repository, (*argv)[0], 1);
 297                         if (envchanged)
 298                                 *envchanged = 1;
 299                 } else if (!strcmp(cmd, "-C")) {
 300                         if (*argc < 2) {
 301                                 fprintf(stderr, _("no directory given for '%s' option\n" ), "-C");
 302                                 usage(git_usage_string);
 303                         }
 304                         if ((*argv)[1][0]) {
 305                                 if (chdir((*argv)[1]))
 306                                         die_errno("cannot change to '%s'", (*argv)[1]);
 307                                 if (envchanged)
 308                                         *envchanged = 1;
 309                         }
 310                         (*argv)++;
 311                         (*argc)--;
 312                 } else if (skip_prefix(cmd, "--list-cmds=", &cmd)) {
 313                         trace2_cmd_name("_query_");
 314                         if (!strcmp(cmd, "parseopt")) {
 315                                 struct string_list list = STRING_LIST_INIT_DUP;
 316                                 int i;
 317
 318                                 list_builtins(&list, NO_PARSEOPT);
 319                                 for (i = 0; i < list.nr; i++)
 320                                         printf("%s ", list.items[i].string);
 321                                 string_list_clear(&list, 0);
 322                                 exit(0);
 323                         } else {
 324                                 exit(list_cmds(cmd));
 325                         }
 326                 } else {
 327                         fprintf(stderr, _("unknown option: %s\n"), cmd);
 328                         usage(git_usage_string);
 329                 }
 330
 331                 (*argv)++;
 332                 (*argc)--;
 333         }
 334         return (*argv) - orig_argv;
 335 }
 336
 337 static int handle_alias(int *argcp, const char ***argv)
 338 {
 339         int envchanged = 0, ret = 0, saved_errno = errno;
 340         int count, option_count;
 341         const char **new_argv;
 342         const char *alias_command;
 343         char *alias_string;
 344
 345         alias_command = (*argv)[0];
 346         alias_string = alias_lookup(alias_command);
 347         if (alias_string) {
 348                 if (*argcp > 1 && !strcmp((*argv)[1], "-h"))
 349                         fprintf_ln(stderr, _("'%s' is aliased to '%s'"),
 350                                    alias_command, alias_string);
 351                 if (alias_string[0] == '!') {
 352                         struct child_process child = CHILD_PROCESS_INIT;
 353                         int nongit_ok;
 354
 355                         /* Aliases expect GIT_PREFIX, GIT_DIR etc to be set */
 356                         setup_git_directory_gently(&nongit_ok);
 357
 358                         commit_pager_choice();
 359
 360                         child.use_shell = 1;
 361                         child.clean_on_exit = 1;
 362                         child.wait_after_clean = 1;
 363                         child.trace2_child_class = "shell_alias";
 364                         strvec_push(&child.args, alias_string + 1);
 365                         strvec_pushv(&child.args, (*argv) + 1);
 366
 367                         trace2_cmd_alias(alias_command, child.args.v);
 368                         trace2_cmd_list_config();
 369                         trace2_cmd_list_env_vars();
 370                         trace2_cmd_name("_run_shell_alias_");
 371
 372                         ret = run_command(&child);
 373                         if (ret >= 0)   /* normal exit */
 374                                 exit(ret);
 375
 376                         die_errno(_("while expanding alias '%s': '%s'"),
 377                                   alias_command, alias_string + 1);
 378                 }
 379                 count = split_cmdline(alias_string, &new_argv);
 380                 if (count < 0)
 381                         die(_("bad alias.%s string: %s"), alias_command,
 382                             _(split_cmdline_strerror(count)));
 383                 option_count = handle_options(&new_argv, &count, &envchanged);
 384                 if (envchanged)
 385                         die(_("alias '%s' changes environment variables.\n"
 386                               "You can use '!git' in the alias to do this"),
 387                             alias_command);
 388                 MOVE_ARRAY(new_argv - option_count, new_argv, count);
 389                 new_argv -= option_count;
 390
 391                 if (count < 1)
 392                         die(_("empty alias for %s"), alias_command);
 393
 394                 if (!strcmp(alias_command, new_argv[0]))
 395                         die(_("recursive alias: %s"), alias_command);
 396
 397                 trace_argv_printf(new_argv,
 398                                   "trace: alias expansion: %s =>",
 399                                   alias_command);
 400
 401                 REALLOC_ARRAY(new_argv, count + *argcp);
 402                 /* insert after command name */
 403                 COPY_ARRAY(new_argv + count, *argv + 1, *argcp);
 404
 405                 trace2_cmd_alias(alias_command, new_argv);
 406                 trace2_cmd_list_config();
 407                 trace2_cmd_list_env_vars();
 408
 409                 *argv = new_argv;
 410                 *argcp += count - 1;
 411
 412                 ret = 1;
 413         }
 414
 415         errno = saved_errno;
 416
 417         return ret;
 418 }
 419
 420 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
 421 {
 422         int status, help;
 423         struct stat st;
 424         const char *prefix;
 425         int run_setup = (p->option & (RUN_SETUP | RUN_SETUP_GENTLY));
 426
 427         help = argc == 2 && !strcmp(argv[1], "-h");
 428         if (help && (run_setup & RUN_SETUP))
 429                 /* demote to GENTLY to allow 'git cmd -h' outside repo */
 430                 run_setup = RUN_SETUP_GENTLY;
 431
 432         if (run_setup & RUN_SETUP) {
 433                 prefix = setup_git_directory();
 434         } else if (run_setup & RUN_SETUP_GENTLY) {
 435                 int nongit_ok;
 436                 prefix = setup_git_directory_gently(&nongit_ok);
 437         } else {
 438                 prefix = NULL;
 439         }
 440         assert(!prefix || *prefix);
 441         precompose_argv_prefix(argc, argv, NULL);
 442         if (use_pager == -1 && run_setup &&
 443                 !(p->option & DELAY_PAGER_CONFIG))
 444                 use_pager = check_pager_config(p->cmd);
 445         if (use_pager == -1 && p->option & USE_PAGER)
 446                 use_pager = 1;
 447         if (run_setup && startup_info->have_repository)
 448                 /* get_git_dir() may set up repo, avoid that */
 449                 trace_repo_setup(prefix);
 450         commit_pager_choice();
 451
 452         if (!help && get_super_prefix()) {
 453                 if (!(p->option & SUPPORT_SUPER_PREFIX))
 454                         die(_("%s doesn't support --super-prefix"), p->cmd);
 455         }
 456
 457         if (!help && p->option & NEED_WORK_TREE)
 458                 setup_work_tree();
 459
 460         trace_argv_printf(argv, "trace: built-in: git");
 461         trace2_cmd_name(p->cmd);
 462         trace2_cmd_list_config();
 463         trace2_cmd_list_env_vars();
 464
 465         validate_cache_entries(the_repository->index);
 466         status = p->fn(argc, argv, prefix);
 467         validate_cache_entries(the_repository->index);
 468
 469         if (status)
 470                 return status;
 471
 472         /* Somebody closed stdout? */
 473         if (fstat(fileno(stdout), &st))
 474                 return 0;
 475         /* Ignore write errors for pipes and sockets.. */
 476         if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
 477                 return 0;
 478
 479         /* Check for ENOSPC and EIO errors.. */
 480         if (fflush(stdout))
 481                 die_errno(_("write failure on standard output"));
 482         if (ferror(stdout))
 483                 die(_("unknown write failure on standard output"));
 484         if (fclose(stdout))
 485                 die_errno(_("close failed on standard output"));
 486         return 0;
 487 }
 488
 489 static struct cmd_struct commands[] = {
 490         { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
 491         { "am", cmd_am, RUN_SETUP | NEED_WORK_TREE },
 492         { "annotate", cmd_annotate, RUN_SETUP },
 493         { "apply", cmd_apply, RUN_SETUP_GENTLY },
 494         { "archive", cmd_archive, RUN_SETUP_GENTLY },
 495         { "bisect--helper", cmd_bisect__helper, RUN_SETUP },
 496         { "blame", cmd_blame, RUN_SETUP },
 497         { "branch", cmd_branch, RUN_SETUP | DELAY_PAGER_CONFIG },
 498         { "bugreport", cmd_bugreport, RUN_SETUP_GENTLY },
 499         { "bundle", cmd_bundle, RUN_SETUP_GENTLY },
 500         { "cat-file", cmd_cat_file, RUN_SETUP },
 501         { "check-attr", cmd_check_attr, RUN_SETUP },
 502         { "check-ignore", cmd_check_ignore, RUN_SETUP | NEED_WORK_TREE },
 503         { "check-mailmap", cmd_check_mailmap, RUN_SETUP },
 504         { "check-ref-format", cmd_check_ref_format, NO_PARSEOPT  },
 505         { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
 506         { "checkout--worker", cmd_checkout__worker,
 507                 RUN_SETUP | NEED_WORK_TREE | SUPPORT_SUPER_PREFIX },
 508         { "checkout-index", cmd_checkout_index,
 509                 RUN_SETUP | NEED_WORK_TREE},
 510         { "cherry", cmd_cherry, RUN_SETUP },
 511         { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
 512         { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
 513         { "clone", cmd_clone },
 514         { "column", cmd_column, RUN_SETUP_GENTLY },
 515         { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
 516         { "commit-graph", cmd_commit_graph, RUN_SETUP },
 517         { "commit-tree", cmd_commit_tree, RUN_SETUP },
 518         { "config", cmd_config, RUN_SETUP_GENTLY | DELAY_PAGER_CONFIG },
 519         { "count-objects", cmd_count_objects, RUN_SETUP },
 520         { "credential", cmd_credential, RUN_SETUP_GENTLY | NO_PARSEOPT },
 521         { "credential-cache", cmd_credential_cache },
 522         { "credential-cache--daemon", cmd_credential_cache_daemon },
 523         { "credential-store", cmd_credential_store },
 524         { "describe", cmd_describe, RUN_SETUP },
 525         { "diagnose", cmd_diagnose, RUN_SETUP_GENTLY },
 526         { "diff", cmd_diff, NO_PARSEOPT },
 527         { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
 528         { "diff-index", cmd_diff_index, RUN_SETUP | NO_PARSEOPT },
 529         { "diff-tree", cmd_diff_tree, RUN_SETUP | NO_PARSEOPT },
 530         { "difftool", cmd_difftool, RUN_SETUP_GENTLY },
 531         { "env--helper", cmd_env__helper },
 532         { "fast-export", cmd_fast_export, RUN_SETUP },
 533         { "fast-import", cmd_fast_import, RUN_SETUP | NO_PARSEOPT },
 534         { "fetch", cmd_fetch, RUN_SETUP },
 535         { "fetch-pack", cmd_fetch_pack, RUN_SETUP | NO_PARSEOPT },
 536         { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
 537         { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
 538         { "for-each-repo", cmd_for_each_repo, RUN_SETUP_GENTLY },
 539         { "format-patch", cmd_format_patch, RUN_SETUP },
 540         { "fsck", cmd_fsck, RUN_SETUP },
 541         { "fsck-objects", cmd_fsck, RUN_SETUP },
 542         { "fsmonitor--daemon", cmd_fsmonitor__daemon, SUPPORT_SUPER_PREFIX | RUN_SETUP },
 543         { "gc", cmd_gc, RUN_SETUP },
 544         { "get-tar-commit-id", cmd_get_tar_commit_id, NO_PARSEOPT },
 545         { "grep", cmd_grep, RUN_SETUP_GENTLY },
 546         { "hash-object", cmd_hash_object },
 547         { "help", cmd_help },
 548         { "hook", cmd_hook, RUN_SETUP },
 549         { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY | NO_PARSEOPT },
 550         { "init", cmd_init_db },
 551         { "init-db", cmd_init_db },
 552         { "interpret-trailers", cmd_interpret_trailers, RUN_SETUP_GENTLY },
 553         { "log", cmd_log, RUN_SETUP },
 554         { "ls-files", cmd_ls_files, RUN_SETUP },
 555         { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
 556         { "ls-tree", cmd_ls_tree, RUN_SETUP },
 557         { "mailinfo", cmd_mailinfo, RUN_SETUP_GENTLY },
 558         { "mailsplit", cmd_mailsplit, NO_PARSEOPT },
 559         { "maintenance", cmd_maintenance, RUN_SETUP },
 560         { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
 561         { "merge-base", cmd_merge_base, RUN_SETUP },
 562         { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
 563         { "merge-index", cmd_merge_index, RUN_SETUP | NO_PARSEOPT },
 564         { "merge-ours", cmd_merge_ours, RUN_SETUP | NO_PARSEOPT },
 565         { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
 566         { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
 567         { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
 568         { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
 569         { "merge-tree", cmd_merge_tree, RUN_SETUP },
 570         { "mktag", cmd_mktag, RUN_SETUP },
 571         { "mktree", cmd_mktree, RUN_SETUP },
 572         { "multi-pack-index", cmd_multi_pack_index, RUN_SETUP },
 573         { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
 574         { "name-rev", cmd_name_rev, RUN_SETUP },
 575         { "notes", cmd_notes, RUN_SETUP },
 576         { "pack-objects", cmd_pack_objects, RUN_SETUP },
 577         { "pack-redundant", cmd_pack_redundant, RUN_SETUP | NO_PARSEOPT },
 578         { "pack-refs", cmd_pack_refs, RUN_SETUP },
 579         { "patch-id", cmd_patch_id, RUN_SETUP_GENTLY | NO_PARSEOPT },
 580         { "pickaxe", cmd_blame, RUN_SETUP },
 581         { "prune", cmd_prune, RUN_SETUP },
 582         { "prune-packed", cmd_prune_packed, RUN_SETUP },
 583         { "pull", cmd_pull, RUN_SETUP | NEED_WORK_TREE },
 584         { "push", cmd_push, RUN_SETUP },
 585         { "range-diff", cmd_range_diff, RUN_SETUP | USE_PAGER },
 586         { "read-tree", cmd_read_tree, RUN_SETUP | SUPPORT_SUPER_PREFIX},
 587         { "rebase", cmd_rebase, RUN_SETUP | NEED_WORK_TREE },
 588         { "receive-pack", cmd_receive_pack },
 589         { "reflog", cmd_reflog, RUN_SETUP },
 590         { "remote", cmd_remote, RUN_SETUP },
 591         { "remote-ext", cmd_remote_ext, NO_PARSEOPT },
 592         { "remote-fd", cmd_remote_fd, NO_PARSEOPT },
 593         { "repack", cmd_repack, RUN_SETUP },
 594         { "replace", cmd_replace, RUN_SETUP },
 595         { "rerere", cmd_rerere, RUN_SETUP },
 596         { "reset", cmd_reset, RUN_SETUP },
 597         { "restore", cmd_restore, RUN_SETUP | NEED_WORK_TREE },
 598         { "rev-list", cmd_rev_list, RUN_SETUP | NO_PARSEOPT },
 599         { "rev-parse", cmd_rev_parse, NO_PARSEOPT },
 600         { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
 601         { "rm", cmd_rm, RUN_SETUP },
 602         { "send-pack", cmd_send_pack, RUN_SETUP },
 603         { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
 604         { "show", cmd_show, RUN_SETUP },
 605         { "show-branch", cmd_show_branch, RUN_SETUP },
 606         { "show-index", cmd_show_index, RUN_SETUP_GENTLY },
 607         { "show-ref", cmd_show_ref, RUN_SETUP },
 608         { "sparse-checkout", cmd_sparse_checkout, RUN_SETUP | NEED_WORK_TREE },
 609         { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
 610         { "stash", cmd_stash, RUN_SETUP | NEED_WORK_TREE },
 611         { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
 612         { "stripspace", cmd_stripspace },
 613         { "submodule--helper", cmd_submodule__helper, RUN_SETUP | SUPPORT_SUPER_PREFIX | NO_PARSEOPT },
 614         { "switch", cmd_switch, RUN_SETUP | NEED_WORK_TREE },
 615         { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
 616         { "tag", cmd_tag, RUN_SETUP | DELAY_PAGER_CONFIG },
 617         { "unpack-file", cmd_unpack_file, RUN_SETUP | NO_PARSEOPT },
 618         { "unpack-objects", cmd_unpack_objects, RUN_SETUP | NO_PARSEOPT },
 619         { "update-index", cmd_update_index, RUN_SETUP },
 620         { "update-ref", cmd_update_ref, RUN_SETUP },
 621         { "update-server-info", cmd_update_server_info, RUN_SETUP },
 622         { "upload-archive", cmd_upload_archive, NO_PARSEOPT },
 623         { "upload-archive--writer", cmd_upload_archive_writer, NO_PARSEOPT },
 624         { "upload-pack", cmd_upload_pack },
 625         { "var", cmd_var, RUN_SETUP_GENTLY | NO_PARSEOPT },
 626         { "verify-commit", cmd_verify_commit, RUN_SETUP },
 627         { "verify-pack", cmd_verify_pack },
 628         { "verify-tag", cmd_verify_tag, RUN_SETUP },
 629         { "version", cmd_version },
 630         { "whatchanged", cmd_whatchanged, RUN_SETUP },
 631         { "worktree", cmd_worktree, RUN_SETUP },
 632         { "write-tree", cmd_write_tree, RUN_SETUP },
 633 };
 634
 635 static struct cmd_struct *get_builtin(const char *s)
 636 {
 637         int i;
 638         for (i = 0; i < ARRAY_SIZE(commands); i++) {
 639                 struct cmd_struct *p = commands + i;
 640                 if (!strcmp(s, p->cmd))
 641                         return p;
 642         }
 643         return NULL;
 644 }
 645
 646 int is_builtin(const char *s)
 647 {
 648         return !!get_builtin(s);
 649 }
 650
 651 static void list_builtins(struct string_list *out, unsigned int exclude_option)
 652 {
 653         int i;
 654         for (i = 0; i < ARRAY_SIZE(commands); i++) {
 655                 if (exclude_option &&
 656                     (commands[i].option & exclude_option))
 657                         continue;
 658                 string_list_append(out, commands[i].cmd);
 659         }
 660 }
 661
 662 void load_builtin_commands(const char *prefix, struct cmdnames *cmds)
 663 {
 664         const char *name;
 665         int i;
 666
 667         /*
 668          * Callers can ask for a subset of the commands based on a certain
 669          * prefix, which is then dropped from the added names. The names in
 670          * the `commands[]` array do not have the `git-` prefix, though,
 671          * therefore we must expect the `prefix` to at least start with `git-`.
 672          */
 673         if (!skip_prefix(prefix, "git-", &prefix))
 674                 BUG("prefix '%s' must start with 'git-'", prefix);
 675
 676         for (i = 0; i < ARRAY_SIZE(commands); i++)
 677                 if (skip_prefix(commands[i].cmd, prefix, &name))
 678                         add_cmdname(cmds, name, strlen(name));
 679 }
 680
 681 #ifdef STRIP_EXTENSION
 682 static void strip_extension(const char **argv)
 683 {
 684         size_t len;
 685
 686         if (strip_suffix(argv[0], STRIP_EXTENSION, &len))
 687                 argv[0] = xmemdupz(argv[0], len);
 688 }
 689 #else
 690 #define strip_extension(cmd)
 691 #endif
 692
 693 static void handle_builtin(int argc, const char **argv)
 694 {
 695         struct strvec args = STRVEC_INIT;
 696         const char *cmd;
 697         struct cmd_struct *builtin;
 698
 699         strip_extension(argv);
 700         cmd = argv[0];
 701
 702         /* Turn "git cmd --help" into "git help --exclude-guides cmd" */
 703         if (argc > 1 && !strcmp(argv[1], "--help")) {
 704                 int i;
 705
 706                 argv[1] = argv[0];
 707                 argv[0] = cmd = "help";
 708
 709                 for (i = 0; i < argc; i++) {
 710                         strvec_push(&args, argv[i]);
 711                         if (!i)
 712                                 strvec_push(&args, "--exclude-guides");
 713                 }
 714
 715                 argc++;
 716                 argv = args.v;
 717         }
 718
 719         builtin = get_builtin(cmd);
 720         if (builtin)
 721                 exit(run_builtin(builtin, argc, argv));
 722         strvec_clear(&args);
 723 }
 724
 725 static void execv_dashed_external(const char **argv)
 726 {
 727         struct child_process cmd = CHILD_PROCESS_INIT;
 728         int status;
 729
 730         if (get_super_prefix())
 731                 die(_("%s doesn't support --super-prefix"), argv[0]);
 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                         if (get_super_prefix())
 803                                 die("%s doesn't support --super-prefix", **argv);
 804
 805                         commit_pager_choice();
 806
 807                         strvec_push(&cmd.args, "git");
 808                         for (i = 0; i < *argcp; i++)
 809                                 strvec_push(&cmd.args, (*argv)[i]);
 810
 811                         trace_argv_printf(cmd.args.v, "trace: exec:");
 812
 813                         /*
 814                          * if we fail because the command is not found, it is
 815                          * OK to return. Otherwise, we just pass along the status code.
 816                          */
 817                         cmd.silent_exec_failure = 1;
 818                         cmd.clean_on_exit = 1;
 819                         cmd.wait_after_clean = 1;
 820                         cmd.trace2_child_class = "git_alias";
 821                         i = run_command(&cmd);
 822                         if (i >= 0 || errno != ENOENT)
 823                                 exit(i);
 824                         die("could not execute builtin %s", **argv);
 825                 }
 826
 827                 /* .. then try the external ones */
 828                 execv_dashed_external(*argv);
 829
 830                 seen = unsorted_string_list_lookup(&cmd_list, *argv[0]);
 831                 if (seen) {
 832                         int i;
 833                         struct strbuf sb = STRBUF_INIT;
 834                         for (i = 0; i < cmd_list.nr; i++) {
 835                                 struct string_list_item *item = &cmd_list.items[i];
 836
 837                                 strbuf_addf(&sb, "\n  %s", item->string);
 838                                 if (item == seen)
 839                                         strbuf_addstr(&sb, " <==");
 840                                 else if (i == cmd_list.nr - 1)
 841                                         strbuf_addstr(&sb, " ==>");
 842                         }
 843                         die(_("alias loop detected: expansion of '%s' does"
 844                               " not terminate:%s"), cmd_list.items[0].string, sb.buf);
 845                 }
 846
 847                 string_list_append(&cmd_list, *argv[0]);
 848
 849                 /*
 850                  * It could be an alias -- this works around the insanity
 851                  * of overriding "git log" with "git show" by having
 852                  * alias.log = show
 853                  */
 854                 if (!handle_alias(argcp, argv))
 855                         break;
 856                 done_alias = 1;
 857         }
 858
 859         string_list_clear(&cmd_list, 0);
 860
 861         return done_alias;
 862 }
 863
 864 int cmd_main(int argc, const char **argv)
 865 {
 866         const char *cmd;
 867         int done_help = 0;
 868
 869         cmd = argv[0];
 870         if (!cmd)
 871                 cmd = "git-help";
 872         else {
 873                 const char *slash = find_last_dir_sep(cmd);
 874                 if (slash)
 875                         cmd = slash + 1;
 876         }
 877
 878         trace_command_performance(argv);
 879
 880         /*
 881          * "git-xxxx" is the same as "git xxxx", but we obviously:
 882          *
 883          *  - cannot take flags in between the "git" and the "xxxx".
 884          *  - cannot execute it externally (since it would just do
 885          *    the same thing over again)
 886          *
 887          * So we just directly call the builtin handler, and die if
 888          * that one cannot handle it.
 889          */
 890         if (skip_prefix(cmd, "git-", &cmd)) {
 891                 argv[0] = cmd;
 892                 handle_builtin(argc, argv);
 893                 die(_("cannot handle %s as a builtin"), cmd);
 894         }
 895
 896         /* Look for flags.. */
 897         argv++;
 898         argc--;
 899         handle_options(&argv, &argc, NULL);
 900
 901         if (!argc) {
 902                 /* The user didn't specify a command; give them help */
 903                 commit_pager_choice();
 904                 printf(_("usage: %s\n\n"), git_usage_string);
 905                 list_common_cmds_help();
 906                 printf("\n%s\n", _(git_more_info_string));
 907                 exit(1);
 908         }
 909
 910         if (!strcmp("--version", argv[0]) || !strcmp("-v", argv[0]))
 911                 argv[0] = "version";
 912         else if (!strcmp("--help", argv[0]) || !strcmp("-h", argv[0]))
 913                 argv[0] = "help";
 914
 915         cmd = argv[0];
 916
 917         /*
 918          * We use PATH to find git commands, but we prepend some higher
 919          * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
 920          * environment, and the $(gitexecdir) from the Makefile at build
 921          * time.
 922          */
 923         setup_path();
 924
 925         while (1) {
 926                 int was_alias = run_argv(&argc, &argv);
 927                 if (errno != ENOENT)
 928                         break;
 929                 if (was_alias) {
 930                         fprintf(stderr, _("expansion of alias '%s' failed; "
 931                                           "'%s' is not a git command\n"),
 932                                 cmd, argv[0]);
 933                         exit(1);
 934                 }
 935                 if (!done_help) {
 936                         cmd = argv[0] = help_unknown_cmd(cmd);
 937                         done_help = 1;
 938                 } else
 939                         break;
 940         }
 941
 942         fprintf(stderr, _("failed to run command '%s': %s\n"),
 943                 cmd, strerror(errno));
 944
 945         return 1;
 946 }