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