5 #include "run-command.h"
9 #define RUN_SETUP (1<<0)
10 #define RUN_SETUP_GENTLY (1<<1)
11 #define USE_PAGER (1<<2)
13 * require working tree to be present -- anything uses this needs
14 * RUN_SETUP for reading from the configuration file.
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 */
23 int (*fn
)(int, const char **, const char *);
27 const char git_usage_string
[] =
28 N_("git [--version] [--help] [-C <path>] [-c <name>=<value>]\n"
29 " [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
30 " [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--bare]\n"
31 " [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
32 " [--super-prefix=<path>] [--config-env=<name>=<envvar>]\n"
33 " <command> [<args>]");
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.");
41 static int use_pager
= -1;
43 static void list_builtins(struct string_list
*list
, unsigned int exclude_option
);
45 static void exclude_helpers_from_list(struct string_list
*list
)
49 while (i
< list
->nr
) {
50 if (strstr(list
->items
[i
].string
, "--"))
51 unsorted_string_list_delete_item(list
, i
, 0);
57 static int match_token(const char *spec
, int len
, const char *token
)
59 int token_len
= strlen(token
);
61 return len
== token_len
&& !strncmp(spec
, token
, token_len
);
64 static int list_cmds(const char *spec
)
66 struct string_list list
= STRING_LIST_INIT_DUP
;
71 * Set up the repository so we can pick up any repo-level config (like
72 * completion.commands).
74 setup_git_directory_gently(&nongit
);
77 const char *sep
= strchrnul(spec
, ',');
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"))
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
;
95 strbuf_add(&sb
, spec
+ 5, len
- 5);
96 list_cmds_by_category(&list
, sb
.buf
);
100 die(_("unsupported command listing type '%s'"), spec
);
105 for (i
= 0; i
< list
.nr
; i
++)
106 puts(list
.items
[i
].string
);
107 string_list_clear(&list
, 0);
111 static void commit_pager_choice(void)
115 setenv("GIT_PAGER", "cat", 1);
125 void setup_auto_pager(const char *cmd
, int def
)
127 if (use_pager
!= -1 || pager_in_use())
129 use_pager
= check_pager_config(cmd
);
132 commit_pager_choice();
135 static int handle_options(const char ***argv
, int *argc
, int *envchanged
)
137 const char **orig_argv
= *argv
;
140 const char *cmd
= (*argv
)[0];
145 * For legacy reasons, the "version" and "help"
146 * commands can be written with "--" prepended
147 * to make them look like flags.
149 if (!strcmp(cmd
, "--help") || !strcmp(cmd
, "--version"))
153 * Check remaining flags.
155 if (skip_prefix(cmd
, "--exec-path", &cmd
)) {
157 git_set_exec_path(cmd
+ 1);
159 puts(git_exec_path());
160 trace2_cmd_name("_query_");
163 } else if (!strcmp(cmd
, "--html-path")) {
164 puts(system_path(GIT_HTML_PATH
));
165 trace2_cmd_name("_query_");
167 } else if (!strcmp(cmd
, "--man-path")) {
168 puts(system_path(GIT_MAN_PATH
));
169 trace2_cmd_name("_query_");
171 } else if (!strcmp(cmd
, "--info-path")) {
172 puts(system_path(GIT_INFO_PATH
));
173 trace2_cmd_name("_query_");
175 } else if (!strcmp(cmd
, "-p") || !strcmp(cmd
, "--paginate")) {
177 } else if (!strcmp(cmd
, "-P") || !strcmp(cmd
, "--no-pager")) {
181 } else if (!strcmp(cmd
, "--no-replace-objects")) {
182 read_replace_refs
= 0;
183 setenv(NO_REPLACE_OBJECTS_ENVIRONMENT
, "1", 1);
186 } else if (!strcmp(cmd
, "--git-dir")) {
188 fprintf(stderr
, _("no directory given for --git-dir\n" ));
189 usage(git_usage_string
);
191 setenv(GIT_DIR_ENVIRONMENT
, (*argv
)[1], 1);
196 } else if (skip_prefix(cmd
, "--git-dir=", &cmd
)) {
197 setenv(GIT_DIR_ENVIRONMENT
, cmd
, 1);
200 } else if (!strcmp(cmd
, "--namespace")) {
202 fprintf(stderr
, _("no namespace given for --namespace\n" ));
203 usage(git_usage_string
);
205 setenv(GIT_NAMESPACE_ENVIRONMENT
, (*argv
)[1], 1);
210 } else if (skip_prefix(cmd
, "--namespace=", &cmd
)) {
211 setenv(GIT_NAMESPACE_ENVIRONMENT
, cmd
, 1);
214 } else if (!strcmp(cmd
, "--work-tree")) {
216 fprintf(stderr
, _("no directory given for --work-tree\n" ));
217 usage(git_usage_string
);
219 setenv(GIT_WORK_TREE_ENVIRONMENT
, (*argv
)[1], 1);
224 } else if (skip_prefix(cmd
, "--work-tree=", &cmd
)) {
225 setenv(GIT_WORK_TREE_ENVIRONMENT
, cmd
, 1);
228 } else if (!strcmp(cmd
, "--super-prefix")) {
230 fprintf(stderr
, _("no prefix given for --super-prefix\n" ));
231 usage(git_usage_string
);
233 setenv(GIT_SUPER_PREFIX_ENVIRONMENT
, (*argv
)[1], 1);
238 } else if (skip_prefix(cmd
, "--super-prefix=", &cmd
)) {
239 setenv(GIT_SUPER_PREFIX_ENVIRONMENT
, cmd
, 1);
242 } else if (!strcmp(cmd
, "--bare")) {
243 char *cwd
= xgetcwd();
244 is_bare_repository_cfg
= 1;
245 setenv(GIT_DIR_ENVIRONMENT
, cwd
, 0);
247 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, "0", 1);
250 } else if (!strcmp(cmd
, "-c")) {
252 fprintf(stderr
, _("-c expects a configuration string\n" ));
253 usage(git_usage_string
);
255 git_config_push_parameter((*argv
)[1]);
258 } else if (skip_prefix(cmd
, "--config-env=", &cmd
)) {
259 git_config_push_env(cmd
);
260 } else if (!strcmp(cmd
, "--literal-pathspecs")) {
261 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT
, "1", 1);
264 } else if (!strcmp(cmd
, "--no-literal-pathspecs")) {
265 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT
, "0", 1);
268 } else if (!strcmp(cmd
, "--glob-pathspecs")) {
269 setenv(GIT_GLOB_PATHSPECS_ENVIRONMENT
, "1", 1);
272 } else if (!strcmp(cmd
, "--noglob-pathspecs")) {
273 setenv(GIT_NOGLOB_PATHSPECS_ENVIRONMENT
, "1", 1);
276 } else if (!strcmp(cmd
, "--icase-pathspecs")) {
277 setenv(GIT_ICASE_PATHSPECS_ENVIRONMENT
, "1", 1);
280 } else if (!strcmp(cmd
, "--no-optional-locks")) {
281 setenv(GIT_OPTIONAL_LOCKS_ENVIRONMENT
, "0", 1);
284 } else if (!strcmp(cmd
, "--shallow-file")) {
287 set_alternate_shallow_file(the_repository
, (*argv
)[0], 1);
290 } else if (!strcmp(cmd
, "-C")) {
292 fprintf(stderr
, _("no directory given for -C\n" ));
293 usage(git_usage_string
);
296 if (chdir((*argv
)[1]))
297 die_errno("cannot change to '%s'", (*argv
)[1]);
303 } else if (skip_prefix(cmd
, "--list-cmds=", &cmd
)) {
304 trace2_cmd_name("_query_");
305 if (!strcmp(cmd
, "parseopt")) {
306 struct string_list list
= STRING_LIST_INIT_DUP
;
309 list_builtins(&list
, NO_PARSEOPT
);
310 for (i
= 0; i
< list
.nr
; i
++)
311 printf("%s ", list
.items
[i
].string
);
312 string_list_clear(&list
, 0);
315 exit(list_cmds(cmd
));
318 fprintf(stderr
, _("unknown option: %s\n"), cmd
);
319 usage(git_usage_string
);
325 return (*argv
) - orig_argv
;
328 static int handle_alias(int *argcp
, const char ***argv
)
330 int envchanged
= 0, ret
= 0, saved_errno
= errno
;
331 int count
, option_count
;
332 const char **new_argv
;
333 const char *alias_command
;
336 alias_command
= (*argv
)[0];
337 alias_string
= alias_lookup(alias_command
);
339 if (*argcp
> 1 && !strcmp((*argv
)[1], "-h"))
340 fprintf_ln(stderr
, _("'%s' is aliased to '%s'"),
341 alias_command
, alias_string
);
342 if (alias_string
[0] == '!') {
343 struct child_process child
= CHILD_PROCESS_INIT
;
346 /* Aliases expect GIT_PREFIX, GIT_DIR etc to be set */
347 setup_git_directory_gently(&nongit_ok
);
349 commit_pager_choice();
352 child
.clean_on_exit
= 1;
353 child
.wait_after_clean
= 1;
354 child
.trace2_child_class
= "shell_alias";
355 strvec_push(&child
.args
, alias_string
+ 1);
356 strvec_pushv(&child
.args
, (*argv
) + 1);
358 trace2_cmd_alias(alias_command
, child
.args
.v
);
359 trace2_cmd_list_config();
360 trace2_cmd_list_env_vars();
361 trace2_cmd_name("_run_shell_alias_");
363 ret
= run_command(&child
);
364 if (ret
>= 0) /* normal exit */
367 die_errno(_("while expanding alias '%s': '%s'"),
368 alias_command
, alias_string
+ 1);
370 count
= split_cmdline(alias_string
, &new_argv
);
372 die(_("bad alias.%s string: %s"), alias_command
,
373 _(split_cmdline_strerror(count
)));
374 option_count
= handle_options(&new_argv
, &count
, &envchanged
);
376 die(_("alias '%s' changes environment variables.\n"
377 "You can use '!git' in the alias to do this"),
379 MOVE_ARRAY(new_argv
- option_count
, new_argv
, count
);
380 new_argv
-= option_count
;
383 die(_("empty alias for %s"), alias_command
);
385 if (!strcmp(alias_command
, new_argv
[0]))
386 die(_("recursive alias: %s"), alias_command
);
388 trace_argv_printf(new_argv
,
389 "trace: alias expansion: %s =>",
392 REALLOC_ARRAY(new_argv
, count
+ *argcp
);
393 /* insert after command name */
394 COPY_ARRAY(new_argv
+ count
, *argv
+ 1, *argcp
);
396 trace2_cmd_alias(alias_command
, new_argv
);
397 trace2_cmd_list_config();
398 trace2_cmd_list_env_vars();
411 static int run_builtin(struct cmd_struct
*p
, int argc
, const char **argv
)
418 help
= argc
== 2 && !strcmp(argv
[1], "-h");
420 if (p
->option
& RUN_SETUP
)
421 prefix
= setup_git_directory();
422 else if (p
->option
& RUN_SETUP_GENTLY
) {
424 prefix
= setup_git_directory_gently(&nongit_ok
);
426 precompose_argv_prefix(argc
, argv
, NULL
);
427 if (use_pager
== -1 && p
->option
& (RUN_SETUP
| RUN_SETUP_GENTLY
) &&
428 !(p
->option
& DELAY_PAGER_CONFIG
))
429 use_pager
= check_pager_config(p
->cmd
);
430 if (use_pager
== -1 && p
->option
& USE_PAGER
)
433 if ((p
->option
& (RUN_SETUP
| RUN_SETUP_GENTLY
)) &&
434 startup_info
->have_repository
) /* get_git_dir() may set up repo, avoid that */
435 trace_repo_setup(prefix
);
437 commit_pager_choice();
439 if (!help
&& get_super_prefix()) {
440 if (!(p
->option
& SUPPORT_SUPER_PREFIX
))
441 die(_("%s doesn't support --super-prefix"), p
->cmd
);
444 if (!help
&& p
->option
& NEED_WORK_TREE
)
447 trace_argv_printf(argv
, "trace: built-in: git");
448 trace2_cmd_name(p
->cmd
);
449 trace2_cmd_list_config();
450 trace2_cmd_list_env_vars();
452 validate_cache_entries(the_repository
->index
);
453 status
= p
->fn(argc
, argv
, prefix
);
454 validate_cache_entries(the_repository
->index
);
459 /* Somebody closed stdout? */
460 if (fstat(fileno(stdout
), &st
))
462 /* Ignore write errors for pipes and sockets.. */
463 if (S_ISFIFO(st
.st_mode
) || S_ISSOCK(st
.st_mode
))
466 /* Check for ENOSPC and EIO errors.. */
468 die_errno(_("write failure on standard output"));
470 die(_("unknown write failure on standard output"));
472 die_errno(_("close failed on standard output"));
476 static struct cmd_struct commands
[] = {
477 { "add", cmd_add
, RUN_SETUP
| NEED_WORK_TREE
},
478 { "am", cmd_am
, RUN_SETUP
| NEED_WORK_TREE
},
479 { "annotate", cmd_annotate
, RUN_SETUP
| NO_PARSEOPT
},
480 { "apply", cmd_apply
, RUN_SETUP_GENTLY
},
481 { "archive", cmd_archive
, RUN_SETUP_GENTLY
},
482 { "bisect--helper", cmd_bisect__helper
, RUN_SETUP
},
483 { "blame", cmd_blame
, RUN_SETUP
},
484 { "branch", cmd_branch
, RUN_SETUP
| DELAY_PAGER_CONFIG
},
485 { "bugreport", cmd_bugreport
, RUN_SETUP_GENTLY
},
486 { "bundle", cmd_bundle
, RUN_SETUP_GENTLY
| NO_PARSEOPT
},
487 { "cat-file", cmd_cat_file
, RUN_SETUP
},
488 { "check-attr", cmd_check_attr
, RUN_SETUP
},
489 { "check-ignore", cmd_check_ignore
, RUN_SETUP
| NEED_WORK_TREE
},
490 { "check-mailmap", cmd_check_mailmap
, RUN_SETUP
},
491 { "check-ref-format", cmd_check_ref_format
, NO_PARSEOPT
},
492 { "checkout", cmd_checkout
, RUN_SETUP
| NEED_WORK_TREE
},
493 { "checkout--worker", cmd_checkout__worker
,
494 RUN_SETUP
| NEED_WORK_TREE
| SUPPORT_SUPER_PREFIX
},
495 { "checkout-index", cmd_checkout_index
,
496 RUN_SETUP
| NEED_WORK_TREE
},
497 { "cherry", cmd_cherry
, RUN_SETUP
},
498 { "cherry-pick", cmd_cherry_pick
, RUN_SETUP
| NEED_WORK_TREE
},
499 { "clean", cmd_clean
, RUN_SETUP
| NEED_WORK_TREE
},
500 { "clone", cmd_clone
},
501 { "column", cmd_column
, RUN_SETUP_GENTLY
},
502 { "commit", cmd_commit
, RUN_SETUP
| NEED_WORK_TREE
},
503 { "commit-graph", cmd_commit_graph
, RUN_SETUP
},
504 { "commit-tree", cmd_commit_tree
, RUN_SETUP
| NO_PARSEOPT
},
505 { "config", cmd_config
, RUN_SETUP_GENTLY
| DELAY_PAGER_CONFIG
},
506 { "count-objects", cmd_count_objects
, RUN_SETUP
},
507 { "credential", cmd_credential
, RUN_SETUP_GENTLY
| NO_PARSEOPT
},
508 { "credential-cache", cmd_credential_cache
},
509 { "credential-cache--daemon", cmd_credential_cache_daemon
},
510 { "credential-store", cmd_credential_store
},
511 { "describe", cmd_describe
, RUN_SETUP
},
512 { "diff", cmd_diff
, NO_PARSEOPT
},
513 { "diff-files", cmd_diff_files
, RUN_SETUP
| NEED_WORK_TREE
| NO_PARSEOPT
},
514 { "diff-index", cmd_diff_index
, RUN_SETUP
| NO_PARSEOPT
},
515 { "diff-tree", cmd_diff_tree
, RUN_SETUP
| NO_PARSEOPT
},
516 { "difftool", cmd_difftool
, RUN_SETUP_GENTLY
},
517 { "env--helper", cmd_env__helper
},
518 { "fast-export", cmd_fast_export
, RUN_SETUP
},
519 { "fast-import", cmd_fast_import
, RUN_SETUP
| NO_PARSEOPT
},
520 { "fetch", cmd_fetch
, RUN_SETUP
},
521 { "fetch-pack", cmd_fetch_pack
, RUN_SETUP
| NO_PARSEOPT
},
522 { "fmt-merge-msg", cmd_fmt_merge_msg
, RUN_SETUP
},
523 { "for-each-ref", cmd_for_each_ref
, RUN_SETUP
},
524 { "for-each-repo", cmd_for_each_repo
, RUN_SETUP_GENTLY
},
525 { "format-patch", cmd_format_patch
, RUN_SETUP
},
526 { "fsck", cmd_fsck
, RUN_SETUP
},
527 { "fsck-objects", cmd_fsck
, RUN_SETUP
},
528 { "gc", cmd_gc
, RUN_SETUP
},
529 { "get-tar-commit-id", cmd_get_tar_commit_id
, NO_PARSEOPT
},
530 { "grep", cmd_grep
, RUN_SETUP_GENTLY
},
531 { "hash-object", cmd_hash_object
},
532 { "help", cmd_help
},
533 { "index-pack", cmd_index_pack
, RUN_SETUP_GENTLY
| NO_PARSEOPT
},
534 { "init", cmd_init_db
},
535 { "init-db", cmd_init_db
},
536 { "interpret-trailers", cmd_interpret_trailers
, RUN_SETUP_GENTLY
},
537 { "log", cmd_log
, RUN_SETUP
},
538 { "ls-files", cmd_ls_files
, RUN_SETUP
},
539 { "ls-remote", cmd_ls_remote
, RUN_SETUP_GENTLY
},
540 { "ls-tree", cmd_ls_tree
, RUN_SETUP
},
541 { "mailinfo", cmd_mailinfo
, RUN_SETUP_GENTLY
| NO_PARSEOPT
},
542 { "mailsplit", cmd_mailsplit
, NO_PARSEOPT
},
543 { "maintenance", cmd_maintenance
, RUN_SETUP
| NO_PARSEOPT
},
544 { "merge", cmd_merge
, RUN_SETUP
| NEED_WORK_TREE
},
545 { "merge-base", cmd_merge_base
, RUN_SETUP
},
546 { "merge-file", cmd_merge_file
, RUN_SETUP_GENTLY
},
547 { "merge-index", cmd_merge_index
, RUN_SETUP
| NO_PARSEOPT
},
548 { "merge-ours", cmd_merge_ours
, RUN_SETUP
| NO_PARSEOPT
},
549 { "merge-recursive", cmd_merge_recursive
, RUN_SETUP
| NEED_WORK_TREE
| NO_PARSEOPT
},
550 { "merge-recursive-ours", cmd_merge_recursive
, RUN_SETUP
| NEED_WORK_TREE
| NO_PARSEOPT
},
551 { "merge-recursive-theirs", cmd_merge_recursive
, RUN_SETUP
| NEED_WORK_TREE
| NO_PARSEOPT
},
552 { "merge-subtree", cmd_merge_recursive
, RUN_SETUP
| NEED_WORK_TREE
| NO_PARSEOPT
},
553 { "merge-tree", cmd_merge_tree
, RUN_SETUP
| NO_PARSEOPT
},
554 { "mktag", cmd_mktag
, RUN_SETUP
| NO_PARSEOPT
},
555 { "mktree", cmd_mktree
, RUN_SETUP
},
556 { "multi-pack-index", cmd_multi_pack_index
, RUN_SETUP_GENTLY
},
557 { "mv", cmd_mv
, RUN_SETUP
| NEED_WORK_TREE
},
558 { "name-rev", cmd_name_rev
, RUN_SETUP
},
559 { "notes", cmd_notes
, RUN_SETUP
},
560 { "pack-objects", cmd_pack_objects
, RUN_SETUP
},
561 { "pack-redundant", cmd_pack_redundant
, RUN_SETUP
| NO_PARSEOPT
},
562 { "pack-refs", cmd_pack_refs
, RUN_SETUP
},
563 { "patch-id", cmd_patch_id
, RUN_SETUP_GENTLY
| NO_PARSEOPT
},
564 { "pickaxe", cmd_blame
, RUN_SETUP
},
565 { "prune", cmd_prune
, RUN_SETUP
},
566 { "prune-packed", cmd_prune_packed
, RUN_SETUP
},
567 { "pull", cmd_pull
, RUN_SETUP
| NEED_WORK_TREE
},
568 { "push", cmd_push
, RUN_SETUP
},
569 { "range-diff", cmd_range_diff
, RUN_SETUP
| USE_PAGER
},
570 { "read-tree", cmd_read_tree
, RUN_SETUP
| SUPPORT_SUPER_PREFIX
},
571 { "rebase", cmd_rebase
, RUN_SETUP
| NEED_WORK_TREE
},
572 { "rebase--interactive", cmd_rebase__interactive
, RUN_SETUP
| NEED_WORK_TREE
},
573 { "receive-pack", cmd_receive_pack
},
574 { "reflog", cmd_reflog
, RUN_SETUP
},
575 { "remote", cmd_remote
, RUN_SETUP
},
576 { "remote-ext", cmd_remote_ext
, NO_PARSEOPT
},
577 { "remote-fd", cmd_remote_fd
, NO_PARSEOPT
},
578 { "repack", cmd_repack
, RUN_SETUP
},
579 { "replace", cmd_replace
, RUN_SETUP
},
580 { "rerere", cmd_rerere
, RUN_SETUP
},
581 { "reset", cmd_reset
, RUN_SETUP
},
582 { "restore", cmd_restore
, RUN_SETUP
| NEED_WORK_TREE
},
583 { "rev-list", cmd_rev_list
, RUN_SETUP
| NO_PARSEOPT
},
584 { "rev-parse", cmd_rev_parse
, NO_PARSEOPT
},
585 { "revert", cmd_revert
, RUN_SETUP
| NEED_WORK_TREE
},
586 { "rm", cmd_rm
, RUN_SETUP
},
587 { "send-pack", cmd_send_pack
, RUN_SETUP
},
588 { "shortlog", cmd_shortlog
, RUN_SETUP_GENTLY
| USE_PAGER
},
589 { "show", cmd_show
, RUN_SETUP
},
590 { "show-branch", cmd_show_branch
, RUN_SETUP
},
591 { "show-index", cmd_show_index
, RUN_SETUP_GENTLY
},
592 { "show-ref", cmd_show_ref
, RUN_SETUP
},
593 { "sparse-checkout", cmd_sparse_checkout
, RUN_SETUP
| NEED_WORK_TREE
},
594 { "stage", cmd_add
, RUN_SETUP
| NEED_WORK_TREE
},
595 { "stash", cmd_stash
, RUN_SETUP
| NEED_WORK_TREE
},
596 { "status", cmd_status
, RUN_SETUP
| NEED_WORK_TREE
},
597 { "stripspace", cmd_stripspace
},
598 { "submodule--helper", cmd_submodule__helper
, RUN_SETUP
| SUPPORT_SUPER_PREFIX
| NO_PARSEOPT
},
599 { "switch", cmd_switch
, RUN_SETUP
| NEED_WORK_TREE
},
600 { "symbolic-ref", cmd_symbolic_ref
, RUN_SETUP
},
601 { "tag", cmd_tag
, RUN_SETUP
| DELAY_PAGER_CONFIG
},
602 { "unpack-file", cmd_unpack_file
, RUN_SETUP
| NO_PARSEOPT
},
603 { "unpack-objects", cmd_unpack_objects
, RUN_SETUP
| NO_PARSEOPT
},
604 { "update-index", cmd_update_index
, RUN_SETUP
},
605 { "update-ref", cmd_update_ref
, RUN_SETUP
},
606 { "update-server-info", cmd_update_server_info
, RUN_SETUP
},
607 { "upload-archive", cmd_upload_archive
, NO_PARSEOPT
},
608 { "upload-archive--writer", cmd_upload_archive_writer
, NO_PARSEOPT
},
609 { "upload-pack", cmd_upload_pack
},
610 { "var", cmd_var
, RUN_SETUP_GENTLY
| NO_PARSEOPT
},
611 { "verify-commit", cmd_verify_commit
, RUN_SETUP
},
612 { "verify-pack", cmd_verify_pack
},
613 { "verify-tag", cmd_verify_tag
, RUN_SETUP
},
614 { "version", cmd_version
},
615 { "whatchanged", cmd_whatchanged
, RUN_SETUP
},
616 { "worktree", cmd_worktree
, RUN_SETUP
| NO_PARSEOPT
},
617 { "write-tree", cmd_write_tree
, RUN_SETUP
},
620 static struct cmd_struct
*get_builtin(const char *s
)
623 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++) {
624 struct cmd_struct
*p
= commands
+ i
;
625 if (!strcmp(s
, p
->cmd
))
631 int is_builtin(const char *s
)
633 return !!get_builtin(s
);
636 static void list_builtins(struct string_list
*out
, unsigned int exclude_option
)
639 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++) {
640 if (exclude_option
&&
641 (commands
[i
].option
& exclude_option
))
643 string_list_append(out
, commands
[i
].cmd
);
647 void load_builtin_commands(const char *prefix
, struct cmdnames
*cmds
)
653 * Callers can ask for a subset of the commands based on a certain
654 * prefix, which is then dropped from the added names. The names in
655 * the `commands[]` array do not have the `git-` prefix, though,
656 * therefore we must expect the `prefix` to at least start with `git-`.
658 if (!skip_prefix(prefix
, "git-", &prefix
))
659 BUG("prefix '%s' must start with 'git-'", prefix
);
661 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++)
662 if (skip_prefix(commands
[i
].cmd
, prefix
, &name
))
663 add_cmdname(cmds
, name
, strlen(name
));
666 #ifdef STRIP_EXTENSION
667 static void strip_extension(const char **argv
)
671 if (strip_suffix(argv
[0], STRIP_EXTENSION
, &len
))
672 argv
[0] = xmemdupz(argv
[0], len
);
675 #define strip_extension(cmd)
678 static void handle_builtin(int argc
, const char **argv
)
680 struct strvec args
= STRVEC_INIT
;
682 struct cmd_struct
*builtin
;
684 strip_extension(argv
);
687 /* Turn "git cmd --help" into "git help --exclude-guides cmd" */
688 if (argc
> 1 && !strcmp(argv
[1], "--help")) {
692 argv
[0] = cmd
= "help";
694 for (i
= 0; i
< argc
; i
++) {
695 strvec_push(&args
, argv
[i
]);
697 strvec_push(&args
, "--exclude-guides");
704 builtin
= get_builtin(cmd
);
706 exit(run_builtin(builtin
, argc
, argv
));
710 static void execv_dashed_external(const char **argv
)
712 struct child_process cmd
= CHILD_PROCESS_INIT
;
715 if (get_super_prefix())
716 die(_("%s doesn't support --super-prefix"), argv
[0]);
718 if (use_pager
== -1 && !is_builtin(argv
[0]))
719 use_pager
= check_pager_config(argv
[0]);
720 commit_pager_choice();
722 strvec_pushf(&cmd
.args
, "git-%s", argv
[0]);
723 strvec_pushv(&cmd
.args
, argv
+ 1);
724 cmd
.clean_on_exit
= 1;
725 cmd
.wait_after_clean
= 1;
726 cmd
.silent_exec_failure
= 1;
727 cmd
.trace2_child_class
= "dashed";
729 trace2_cmd_name("_run_dashed_");
732 * The code in run_command() logs trace2 child_start/child_exit
733 * events, so we do not need to report exec/exec_result events here.
735 trace_argv_printf(cmd
.args
.v
, "trace: exec:");
738 * If we fail because the command is not found, it is
739 * OK to return. Otherwise, we just pass along the status code,
740 * or our usual generic code if we were not even able to exec
743 status
= run_command(&cmd
);
746 * If the child process ran and we are now going to exit, emit a
747 * generic string as our trace2 command verb to indicate that we
748 * launched a dashed command.
752 else if (errno
!= ENOENT
)
756 static int run_argv(int *argcp
, const char ***argv
)
759 struct string_list cmd_list
= STRING_LIST_INIT_NODUP
;
760 struct string_list_item
*seen
;
764 * If we tried alias and futzed with our environment,
765 * it no longer is safe to invoke builtins directly in
766 * general. We have to spawn them as dashed externals.
768 * NEEDSWORK: if we can figure out cases
769 * where it is safe to do, we can avoid spawning a new
773 handle_builtin(*argcp
, *argv
);
774 else if (get_builtin(**argv
)) {
775 struct strvec args
= STRVEC_INIT
;
779 * The current process is committed to launching a
780 * child process to run the command named in (**argv)
781 * and exiting. Log a generic string as the trace2
782 * command verb to indicate this. Note that the child
783 * process will log the actual verb when it runs.
785 trace2_cmd_name("_run_git_alias_");
787 if (get_super_prefix())
788 die("%s doesn't support --super-prefix", **argv
);
790 commit_pager_choice();
792 strvec_push(&args
, "git");
793 for (i
= 0; i
< *argcp
; i
++)
794 strvec_push(&args
, (*argv
)[i
]);
796 trace_argv_printf(args
.v
, "trace: exec:");
799 * if we fail because the command is not found, it is
800 * OK to return. Otherwise, we just pass along the status code.
802 i
= run_command_v_opt_tr2(args
.v
, RUN_SILENT_EXEC_FAILURE
|
803 RUN_CLEAN_ON_EXIT
| RUN_WAIT_AFTER_CLEAN
, "git_alias");
804 if (i
>= 0 || errno
!= ENOENT
)
806 die("could not execute builtin %s", **argv
);
809 /* .. then try the external ones */
810 execv_dashed_external(*argv
);
812 seen
= unsorted_string_list_lookup(&cmd_list
, *argv
[0]);
815 struct strbuf sb
= STRBUF_INIT
;
816 for (i
= 0; i
< cmd_list
.nr
; i
++) {
817 struct string_list_item
*item
= &cmd_list
.items
[i
];
819 strbuf_addf(&sb
, "\n %s", item
->string
);
821 strbuf_addstr(&sb
, " <==");
822 else if (i
== cmd_list
.nr
- 1)
823 strbuf_addstr(&sb
, " ==>");
825 die(_("alias loop detected: expansion of '%s' does"
826 " not terminate:%s"), cmd_list
.items
[0].string
, sb
.buf
);
829 string_list_append(&cmd_list
, *argv
[0]);
832 * It could be an alias -- this works around the insanity
833 * of overriding "git log" with "git show" by having
836 if (!handle_alias(argcp
, argv
))
841 string_list_clear(&cmd_list
, 0);
846 int cmd_main(int argc
, const char **argv
)
855 const char *slash
= find_last_dir_sep(cmd
);
860 trace_command_performance(argv
);
863 * "git-xxxx" is the same as "git xxxx", but we obviously:
865 * - cannot take flags in between the "git" and the "xxxx".
866 * - cannot execute it externally (since it would just do
867 * the same thing over again)
869 * So we just directly call the builtin handler, and die if
870 * that one cannot handle it.
872 if (skip_prefix(cmd
, "git-", &cmd
)) {
874 handle_builtin(argc
, argv
);
875 die(_("cannot handle %s as a builtin"), cmd
);
878 /* Look for flags.. */
881 handle_options(&argv
, &argc
, NULL
);
883 /* translate --help and --version into commands */
884 skip_prefix(argv
[0], "--", &argv
[0]);
886 /* The user didn't specify a command; give them help */
887 commit_pager_choice();
888 printf(_("usage: %s\n\n"), git_usage_string
);
889 list_common_cmds_help();
890 printf("\n%s\n", _(git_more_info_string
));
896 * We use PATH to find git commands, but we prepend some higher
897 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
898 * environment, and the $(gitexecdir) from the Makefile at build
904 int was_alias
= run_argv(&argc
, &argv
);
908 fprintf(stderr
, _("expansion of alias '%s' failed; "
909 "'%s' is not a git command\n"),
914 cmd
= argv
[0] = help_unknown_cmd(cmd
);
920 fprintf(stderr
, _("failed to run command '%s': %s\n"),
921 cmd
, strerror(errno
));