Merge branch 'jh/partial-clone-doc'
[git/git-svn.git] / git.c
blobc27c38738b2a9d9d61460b150d5ab4d36bb9cf5b
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"
8 #define RUN_SETUP (1<<0)
9 #define RUN_SETUP_GENTLY (1<<1)
10 #define USE_PAGER (1<<2)
12 * require working tree to be present -- anything uses this needs
13 * RUN_SETUP for reading from the configuration file.
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 */
20 struct cmd_struct {
21 const char *cmd;
22 int (*fn)(int, const char **, const char *);
23 unsigned int option;
26 const char git_usage_string[] =
27 N_("git [--version] [--help] [-C <path>] [-c <name>=<value>]\n"
28 " [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
29 " [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--bare]\n"
30 " [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
31 " <command> [<args>]");
33 const char git_more_info_string[] =
34 N_("'git help -a' and 'git help -g' list available subcommands and some\n"
35 "concept guides. See 'git help <command>' or 'git help <concept>'\n"
36 "to read about a specific subcommand or concept.");
38 static int use_pager = -1;
40 static void list_builtins(struct string_list *list, unsigned int exclude_option);
42 static void exclude_helpers_from_list(struct string_list *list)
44 int i = 0;
46 while (i < list->nr) {
47 if (strstr(list->items[i].string, "--"))
48 unsorted_string_list_delete_item(list, i, 0);
49 else
50 i++;
54 static int match_token(const char *spec, int len, const char *token)
56 int token_len = strlen(token);
58 return len == token_len && !strncmp(spec, token, token_len);
61 static int list_cmds(const char *spec)
63 struct string_list list = STRING_LIST_INIT_DUP;
64 int i;
66 while (*spec) {
67 const char *sep = strchrnul(spec, ',');
68 int len = sep - spec;
70 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;
85 strbuf_add(&sb, spec + 5, len - 5);
86 list_cmds_by_category(&list, sb.buf);
87 strbuf_release(&sb);
89 else
90 die(_("unsupported command listing type '%s'"), spec);
91 spec += len;
92 if (*spec == ',')
93 spec++;
95 for (i = 0; i < list.nr; i++)
96 puts(list.items[i].string);
97 string_list_clear(&list, 0);
98 return 0;
101 static void commit_pager_choice(void) {
102 switch (use_pager) {
103 case 0:
104 setenv("GIT_PAGER", "cat", 1);
105 break;
106 case 1:
107 setup_pager();
108 break;
109 default:
110 break;
114 void setup_auto_pager(const char *cmd, int def)
116 if (use_pager != -1 || pager_in_use())
117 return;
118 use_pager = check_pager_config(cmd);
119 if (use_pager == -1)
120 use_pager = def;
121 commit_pager_choice();
124 static int handle_options(const char ***argv, int *argc, int *envchanged)
126 const char **orig_argv = *argv;
128 while (*argc > 0) {
129 const char *cmd = (*argv)[0];
130 if (cmd[0] != '-')
131 break;
134 * For legacy reasons, the "version" and "help"
135 * commands can be written with "--" prepended
136 * to make them look like flags.
138 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
139 break;
142 * Check remaining flags.
144 if (skip_prefix(cmd, "--exec-path", &cmd)) {
145 if (*cmd == '=')
146 git_set_exec_path(cmd + 1);
147 else {
148 puts(git_exec_path());
149 exit(0);
151 } else if (!strcmp(cmd, "--html-path")) {
152 puts(system_path(GIT_HTML_PATH));
153 exit(0);
154 } else if (!strcmp(cmd, "--man-path")) {
155 puts(system_path(GIT_MAN_PATH));
156 exit(0);
157 } else if (!strcmp(cmd, "--info-path")) {
158 puts(system_path(GIT_INFO_PATH));
159 exit(0);
160 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
161 use_pager = 1;
162 } else if (!strcmp(cmd, "-P") || !strcmp(cmd, "--no-pager")) {
163 use_pager = 0;
164 if (envchanged)
165 *envchanged = 1;
166 } else if (!strcmp(cmd, "--no-replace-objects")) {
167 read_replace_refs = 0;
168 setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
169 if (envchanged)
170 *envchanged = 1;
171 } else if (!strcmp(cmd, "--git-dir")) {
172 if (*argc < 2) {
173 fprintf(stderr, _("no directory given for --git-dir\n" ));
174 usage(git_usage_string);
176 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
177 if (envchanged)
178 *envchanged = 1;
179 (*argv)++;
180 (*argc)--;
181 } else if (skip_prefix(cmd, "--git-dir=", &cmd)) {
182 setenv(GIT_DIR_ENVIRONMENT, cmd, 1);
183 if (envchanged)
184 *envchanged = 1;
185 } else if (!strcmp(cmd, "--namespace")) {
186 if (*argc < 2) {
187 fprintf(stderr, _("no namespace given for --namespace\n" ));
188 usage(git_usage_string);
190 setenv(GIT_NAMESPACE_ENVIRONMENT, (*argv)[1], 1);
191 if (envchanged)
192 *envchanged = 1;
193 (*argv)++;
194 (*argc)--;
195 } else if (skip_prefix(cmd, "--namespace=", &cmd)) {
196 setenv(GIT_NAMESPACE_ENVIRONMENT, cmd, 1);
197 if (envchanged)
198 *envchanged = 1;
199 } else if (!strcmp(cmd, "--work-tree")) {
200 if (*argc < 2) {
201 fprintf(stderr, _("no directory given for --work-tree\n" ));
202 usage(git_usage_string);
204 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
205 if (envchanged)
206 *envchanged = 1;
207 (*argv)++;
208 (*argc)--;
209 } else if (skip_prefix(cmd, "--work-tree=", &cmd)) {
210 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd, 1);
211 if (envchanged)
212 *envchanged = 1;
213 } else if (!strcmp(cmd, "--super-prefix")) {
214 if (*argc < 2) {
215 fprintf(stderr, _("no prefix given for --super-prefix\n" ));
216 usage(git_usage_string);
218 setenv(GIT_SUPER_PREFIX_ENVIRONMENT, (*argv)[1], 1);
219 if (envchanged)
220 *envchanged = 1;
221 (*argv)++;
222 (*argc)--;
223 } else if (skip_prefix(cmd, "--super-prefix=", &cmd)) {
224 setenv(GIT_SUPER_PREFIX_ENVIRONMENT, cmd, 1);
225 if (envchanged)
226 *envchanged = 1;
227 } else if (!strcmp(cmd, "--bare")) {
228 char *cwd = xgetcwd();
229 is_bare_repository_cfg = 1;
230 setenv(GIT_DIR_ENVIRONMENT, cwd, 0);
231 free(cwd);
232 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT, "0", 1);
233 if (envchanged)
234 *envchanged = 1;
235 } else if (!strcmp(cmd, "-c")) {
236 if (*argc < 2) {
237 fprintf(stderr, _("-c expects a configuration string\n" ));
238 usage(git_usage_string);
240 git_config_push_parameter((*argv)[1]);
241 (*argv)++;
242 (*argc)--;
243 } else if (!strcmp(cmd, "--literal-pathspecs")) {
244 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "1", 1);
245 if (envchanged)
246 *envchanged = 1;
247 } else if (!strcmp(cmd, "--no-literal-pathspecs")) {
248 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "0", 1);
249 if (envchanged)
250 *envchanged = 1;
251 } else if (!strcmp(cmd, "--glob-pathspecs")) {
252 setenv(GIT_GLOB_PATHSPECS_ENVIRONMENT, "1", 1);
253 if (envchanged)
254 *envchanged = 1;
255 } else if (!strcmp(cmd, "--noglob-pathspecs")) {
256 setenv(GIT_NOGLOB_PATHSPECS_ENVIRONMENT, "1", 1);
257 if (envchanged)
258 *envchanged = 1;
259 } else if (!strcmp(cmd, "--icase-pathspecs")) {
260 setenv(GIT_ICASE_PATHSPECS_ENVIRONMENT, "1", 1);
261 if (envchanged)
262 *envchanged = 1;
263 } else if (!strcmp(cmd, "--no-optional-locks")) {
264 setenv(GIT_OPTIONAL_LOCKS_ENVIRONMENT, "0", 1);
265 if (envchanged)
266 *envchanged = 1;
267 } else if (!strcmp(cmd, "--shallow-file")) {
268 (*argv)++;
269 (*argc)--;
270 set_alternate_shallow_file(the_repository, (*argv)[0], 1);
271 if (envchanged)
272 *envchanged = 1;
273 } else if (!strcmp(cmd, "-C")) {
274 if (*argc < 2) {
275 fprintf(stderr, _("no directory given for -C\n" ));
276 usage(git_usage_string);
278 if ((*argv)[1][0]) {
279 if (chdir((*argv)[1]))
280 die_errno("cannot change to '%s'", (*argv)[1]);
281 if (envchanged)
282 *envchanged = 1;
284 (*argv)++;
285 (*argc)--;
286 } else if (skip_prefix(cmd, "--list-cmds=", &cmd)) {
287 if (!strcmp(cmd, "parseopt")) {
288 struct string_list list = STRING_LIST_INIT_DUP;
289 int i;
291 list_builtins(&list, NO_PARSEOPT);
292 for (i = 0; i < list.nr; i++)
293 printf("%s ", list.items[i].string);
294 string_list_clear(&list, 0);
295 exit(0);
296 } else {
297 exit(list_cmds(cmd));
299 } else {
300 fprintf(stderr, _("unknown option: %s\n"), cmd);
301 usage(git_usage_string);
304 (*argv)++;
305 (*argc)--;
307 return (*argv) - orig_argv;
310 static int handle_alias(int *argcp, const char ***argv)
312 int envchanged = 0, ret = 0, saved_errno = errno;
313 int count, option_count;
314 const char **new_argv;
315 const char *alias_command;
316 char *alias_string;
318 alias_command = (*argv)[0];
319 alias_string = alias_lookup(alias_command);
320 if (alias_string) {
321 if (alias_string[0] == '!') {
322 struct child_process child = CHILD_PROCESS_INIT;
323 int nongit_ok;
325 /* Aliases expect GIT_PREFIX, GIT_DIR etc to be set */
326 setup_git_directory_gently(&nongit_ok);
328 commit_pager_choice();
330 child.use_shell = 1;
331 argv_array_push(&child.args, alias_string + 1);
332 argv_array_pushv(&child.args, (*argv) + 1);
334 ret = run_command(&child);
335 if (ret >= 0) /* normal exit */
336 exit(ret);
338 die_errno("while expanding alias '%s': '%s'",
339 alias_command, alias_string + 1);
341 count = split_cmdline(alias_string, &new_argv);
342 if (count < 0)
343 die("Bad alias.%s string: %s", alias_command,
344 split_cmdline_strerror(count));
345 option_count = handle_options(&new_argv, &count, &envchanged);
346 if (envchanged)
347 die("alias '%s' changes environment variables.\n"
348 "You can use '!git' in the alias to do this",
349 alias_command);
350 memmove(new_argv - option_count, new_argv,
351 count * sizeof(char *));
352 new_argv -= option_count;
354 if (count < 1)
355 die("empty alias for %s", alias_command);
357 if (!strcmp(alias_command, new_argv[0]))
358 die("recursive alias: %s", alias_command);
360 trace_argv_printf(new_argv,
361 "trace: alias expansion: %s =>",
362 alias_command);
364 REALLOC_ARRAY(new_argv, count + *argcp);
365 /* insert after command name */
366 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
368 *argv = new_argv;
369 *argcp += count - 1;
371 ret = 1;
374 errno = saved_errno;
376 return ret;
379 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
381 int status, help;
382 struct stat st;
383 const char *prefix;
385 prefix = NULL;
386 help = argc == 2 && !strcmp(argv[1], "-h");
387 if (!help) {
388 if (p->option & RUN_SETUP)
389 prefix = setup_git_directory();
390 else if (p->option & RUN_SETUP_GENTLY) {
391 int nongit_ok;
392 prefix = setup_git_directory_gently(&nongit_ok);
395 if (use_pager == -1 && p->option & (RUN_SETUP | RUN_SETUP_GENTLY) &&
396 !(p->option & DELAY_PAGER_CONFIG))
397 use_pager = check_pager_config(p->cmd);
398 if (use_pager == -1 && p->option & USE_PAGER)
399 use_pager = 1;
401 if ((p->option & (RUN_SETUP | RUN_SETUP_GENTLY)) &&
402 startup_info->have_repository) /* get_git_dir() may set up repo, avoid that */
403 trace_repo_setup(prefix);
405 commit_pager_choice();
407 if (!help && get_super_prefix()) {
408 if (!(p->option & SUPPORT_SUPER_PREFIX))
409 die("%s doesn't support --super-prefix", p->cmd);
412 if (!help && p->option & NEED_WORK_TREE)
413 setup_work_tree();
415 trace_argv_printf(argv, "trace: built-in: git");
417 validate_cache_entries(&the_index);
418 status = p->fn(argc, argv, prefix);
419 validate_cache_entries(&the_index);
421 if (status)
422 return status;
424 /* Somebody closed stdout? */
425 if (fstat(fileno(stdout), &st))
426 return 0;
427 /* Ignore write errors for pipes and sockets.. */
428 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
429 return 0;
431 /* Check for ENOSPC and EIO errors.. */
432 if (fflush(stdout))
433 die_errno("write failure on standard output");
434 if (ferror(stdout))
435 die("unknown write failure on standard output");
436 if (fclose(stdout))
437 die_errno("close failed on standard output");
438 return 0;
441 static struct cmd_struct commands[] = {
442 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
443 { "am", cmd_am, RUN_SETUP | NEED_WORK_TREE },
444 { "annotate", cmd_annotate, RUN_SETUP | NO_PARSEOPT },
445 { "apply", cmd_apply, RUN_SETUP_GENTLY },
446 { "archive", cmd_archive, RUN_SETUP_GENTLY },
447 { "bisect--helper", cmd_bisect__helper, RUN_SETUP },
448 { "blame", cmd_blame, RUN_SETUP },
449 { "branch", cmd_branch, RUN_SETUP | DELAY_PAGER_CONFIG },
450 { "bundle", cmd_bundle, RUN_SETUP_GENTLY | NO_PARSEOPT },
451 { "cat-file", cmd_cat_file, RUN_SETUP },
452 { "check-attr", cmd_check_attr, RUN_SETUP },
453 { "check-ignore", cmd_check_ignore, RUN_SETUP | NEED_WORK_TREE },
454 { "check-mailmap", cmd_check_mailmap, RUN_SETUP },
455 { "check-ref-format", cmd_check_ref_format, NO_PARSEOPT },
456 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
457 { "checkout-index", cmd_checkout_index,
458 RUN_SETUP | NEED_WORK_TREE},
459 { "cherry", cmd_cherry, RUN_SETUP },
460 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
461 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
462 { "clone", cmd_clone },
463 { "column", cmd_column, RUN_SETUP_GENTLY },
464 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
465 { "commit-graph", cmd_commit_graph, RUN_SETUP },
466 { "commit-tree", cmd_commit_tree, RUN_SETUP | NO_PARSEOPT },
467 { "config", cmd_config, RUN_SETUP_GENTLY | DELAY_PAGER_CONFIG },
468 { "count-objects", cmd_count_objects, RUN_SETUP },
469 { "credential", cmd_credential, RUN_SETUP_GENTLY | NO_PARSEOPT },
470 { "describe", cmd_describe, RUN_SETUP },
471 { "diff", cmd_diff, NO_PARSEOPT },
472 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
473 { "diff-index", cmd_diff_index, RUN_SETUP | NO_PARSEOPT },
474 { "diff-tree", cmd_diff_tree, RUN_SETUP | NO_PARSEOPT },
475 { "difftool", cmd_difftool, RUN_SETUP | NEED_WORK_TREE },
476 { "fast-export", cmd_fast_export, RUN_SETUP },
477 { "fetch", cmd_fetch, RUN_SETUP },
478 { "fetch-pack", cmd_fetch_pack, RUN_SETUP | NO_PARSEOPT },
479 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
480 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
481 { "format-patch", cmd_format_patch, RUN_SETUP },
482 { "fsck", cmd_fsck, RUN_SETUP },
483 { "fsck-objects", cmd_fsck, RUN_SETUP },
484 { "gc", cmd_gc, RUN_SETUP },
485 { "get-tar-commit-id", cmd_get_tar_commit_id, NO_PARSEOPT },
486 { "grep", cmd_grep, RUN_SETUP_GENTLY },
487 { "hash-object", cmd_hash_object },
488 { "help", cmd_help },
489 { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY | NO_PARSEOPT },
490 { "init", cmd_init_db },
491 { "init-db", cmd_init_db },
492 { "interpret-trailers", cmd_interpret_trailers, RUN_SETUP_GENTLY },
493 { "log", cmd_log, RUN_SETUP },
494 { "ls-files", cmd_ls_files, RUN_SETUP },
495 { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
496 { "ls-tree", cmd_ls_tree, RUN_SETUP },
497 { "mailinfo", cmd_mailinfo, RUN_SETUP_GENTLY | NO_PARSEOPT },
498 { "mailsplit", cmd_mailsplit, NO_PARSEOPT },
499 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
500 { "merge-base", cmd_merge_base, RUN_SETUP },
501 { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
502 { "merge-index", cmd_merge_index, RUN_SETUP | NO_PARSEOPT },
503 { "merge-ours", cmd_merge_ours, RUN_SETUP | NO_PARSEOPT },
504 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
505 { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
506 { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
507 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE | NO_PARSEOPT },
508 { "merge-tree", cmd_merge_tree, RUN_SETUP | NO_PARSEOPT },
509 { "mktag", cmd_mktag, RUN_SETUP | NO_PARSEOPT },
510 { "mktree", cmd_mktree, RUN_SETUP },
511 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
512 { "name-rev", cmd_name_rev, RUN_SETUP },
513 { "notes", cmd_notes, RUN_SETUP },
514 { "pack-objects", cmd_pack_objects, RUN_SETUP },
515 { "pack-redundant", cmd_pack_redundant, RUN_SETUP | NO_PARSEOPT },
516 { "pack-refs", cmd_pack_refs, RUN_SETUP },
517 { "patch-id", cmd_patch_id, RUN_SETUP_GENTLY | NO_PARSEOPT },
518 { "pickaxe", cmd_blame, RUN_SETUP },
519 { "prune", cmd_prune, RUN_SETUP },
520 { "prune-packed", cmd_prune_packed, RUN_SETUP },
521 { "pull", cmd_pull, RUN_SETUP | NEED_WORK_TREE },
522 { "push", cmd_push, RUN_SETUP },
523 { "range-diff", cmd_range_diff, RUN_SETUP | USE_PAGER },
524 { "read-tree", cmd_read_tree, RUN_SETUP | SUPPORT_SUPER_PREFIX},
525 { "rebase--helper", cmd_rebase__helper, RUN_SETUP | NEED_WORK_TREE },
526 { "receive-pack", cmd_receive_pack },
527 { "reflog", cmd_reflog, RUN_SETUP },
528 { "remote", cmd_remote, RUN_SETUP },
529 { "remote-ext", cmd_remote_ext, NO_PARSEOPT },
530 { "remote-fd", cmd_remote_fd, NO_PARSEOPT },
531 { "repack", cmd_repack, RUN_SETUP },
532 { "replace", cmd_replace, RUN_SETUP },
533 { "rerere", cmd_rerere, RUN_SETUP },
534 { "reset", cmd_reset, RUN_SETUP },
535 { "rev-list", cmd_rev_list, RUN_SETUP | NO_PARSEOPT },
536 { "rev-parse", cmd_rev_parse, NO_PARSEOPT },
537 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
538 { "rm", cmd_rm, RUN_SETUP },
539 { "send-pack", cmd_send_pack, RUN_SETUP },
540 { "serve", cmd_serve, RUN_SETUP },
541 { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
542 { "show", cmd_show, RUN_SETUP },
543 { "show-branch", cmd_show_branch, RUN_SETUP },
544 { "show-index", cmd_show_index },
545 { "show-ref", cmd_show_ref, RUN_SETUP },
546 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
547 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
548 { "stripspace", cmd_stripspace },
549 { "submodule--helper", cmd_submodule__helper, RUN_SETUP | SUPPORT_SUPER_PREFIX | NO_PARSEOPT },
550 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
551 { "tag", cmd_tag, RUN_SETUP | DELAY_PAGER_CONFIG },
552 { "unpack-file", cmd_unpack_file, RUN_SETUP | NO_PARSEOPT },
553 { "unpack-objects", cmd_unpack_objects, RUN_SETUP | NO_PARSEOPT },
554 { "update-index", cmd_update_index, RUN_SETUP },
555 { "update-ref", cmd_update_ref, RUN_SETUP },
556 { "update-server-info", cmd_update_server_info, RUN_SETUP },
557 { "upload-archive", cmd_upload_archive, NO_PARSEOPT },
558 { "upload-archive--writer", cmd_upload_archive_writer, NO_PARSEOPT },
559 { "upload-pack", cmd_upload_pack },
560 { "var", cmd_var, RUN_SETUP_GENTLY | NO_PARSEOPT },
561 { "verify-commit", cmd_verify_commit, RUN_SETUP },
562 { "verify-pack", cmd_verify_pack },
563 { "verify-tag", cmd_verify_tag, RUN_SETUP },
564 { "version", cmd_version },
565 { "whatchanged", cmd_whatchanged, RUN_SETUP },
566 { "worktree", cmd_worktree, RUN_SETUP | NO_PARSEOPT },
567 { "write-tree", cmd_write_tree, RUN_SETUP },
570 static struct cmd_struct *get_builtin(const char *s)
572 int i;
573 for (i = 0; i < ARRAY_SIZE(commands); i++) {
574 struct cmd_struct *p = commands + i;
575 if (!strcmp(s, p->cmd))
576 return p;
578 return NULL;
581 int is_builtin(const char *s)
583 return !!get_builtin(s);
586 static void list_builtins(struct string_list *out, unsigned int exclude_option)
588 int i;
589 for (i = 0; i < ARRAY_SIZE(commands); i++) {
590 if (exclude_option &&
591 (commands[i].option & exclude_option))
592 continue;
593 string_list_append(out, commands[i].cmd);
597 #ifdef STRIP_EXTENSION
598 static void strip_extension(const char **argv)
600 size_t len;
602 if (strip_suffix(argv[0], STRIP_EXTENSION, &len))
603 argv[0] = xmemdupz(argv[0], len);
605 #else
606 #define strip_extension(cmd)
607 #endif
609 static void handle_builtin(int argc, const char **argv)
611 struct argv_array args = ARGV_ARRAY_INIT;
612 const char *cmd;
613 struct cmd_struct *builtin;
615 strip_extension(argv);
616 cmd = argv[0];
618 /* Turn "git cmd --help" into "git help --exclude-guides cmd" */
619 if (argc > 1 && !strcmp(argv[1], "--help")) {
620 int i;
622 argv[1] = argv[0];
623 argv[0] = cmd = "help";
625 for (i = 0; i < argc; i++) {
626 argv_array_push(&args, argv[i]);
627 if (!i)
628 argv_array_push(&args, "--exclude-guides");
631 argc++;
632 argv = args.argv;
635 builtin = get_builtin(cmd);
636 if (builtin)
637 exit(run_builtin(builtin, argc, argv));
638 argv_array_clear(&args);
641 static void execv_dashed_external(const char **argv)
643 struct child_process cmd = CHILD_PROCESS_INIT;
644 int status;
646 if (get_super_prefix())
647 die("%s doesn't support --super-prefix", argv[0]);
649 if (use_pager == -1 && !is_builtin(argv[0]))
650 use_pager = check_pager_config(argv[0]);
651 commit_pager_choice();
653 argv_array_pushf(&cmd.args, "git-%s", argv[0]);
654 argv_array_pushv(&cmd.args, argv + 1);
655 cmd.clean_on_exit = 1;
656 cmd.wait_after_clean = 1;
657 cmd.silent_exec_failure = 1;
659 trace_argv_printf(cmd.args.argv, "trace: exec:");
662 * If we fail because the command is not found, it is
663 * OK to return. Otherwise, we just pass along the status code,
664 * or our usual generic code if we were not even able to exec
665 * the program.
667 status = run_command(&cmd);
668 if (status >= 0)
669 exit(status);
670 else if (errno != ENOENT)
671 exit(128);
674 static int run_argv(int *argcp, const char ***argv)
676 int done_alias = 0;
678 while (1) {
680 * If we tried alias and futzed with our environment,
681 * it no longer is safe to invoke builtins directly in
682 * general. We have to spawn them as dashed externals.
684 * NEEDSWORK: if we can figure out cases
685 * where it is safe to do, we can avoid spawning a new
686 * process.
688 if (!done_alias)
689 handle_builtin(*argcp, *argv);
691 /* .. then try the external ones */
692 execv_dashed_external(*argv);
694 /* It could be an alias -- this works around the insanity
695 * of overriding "git log" with "git show" by having
696 * alias.log = show
698 if (done_alias)
699 break;
700 if (!handle_alias(argcp, argv))
701 break;
702 done_alias = 1;
705 return done_alias;
708 int cmd_main(int argc, const char **argv)
710 const char *cmd;
711 int done_help = 0;
713 cmd = argv[0];
714 if (!cmd)
715 cmd = "git-help";
716 else {
717 const char *slash = find_last_dir_sep(cmd);
718 if (slash)
719 cmd = slash + 1;
722 trace_command_performance(argv);
725 * "git-xxxx" is the same as "git xxxx", but we obviously:
727 * - cannot take flags in between the "git" and the "xxxx".
728 * - cannot execute it externally (since it would just do
729 * the same thing over again)
731 * So we just directly call the builtin handler, and die if
732 * that one cannot handle it.
734 if (skip_prefix(cmd, "git-", &cmd)) {
735 argv[0] = cmd;
736 handle_builtin(argc, argv);
737 die("cannot handle %s as a builtin", cmd);
740 /* Look for flags.. */
741 argv++;
742 argc--;
743 handle_options(&argv, &argc, NULL);
744 if (argc > 0) {
745 /* translate --help and --version into commands */
746 skip_prefix(argv[0], "--", &argv[0]);
747 } else {
748 /* The user didn't specify a command; give them help */
749 commit_pager_choice();
750 printf("usage: %s\n\n", git_usage_string);
751 list_common_cmds_help();
752 printf("\n%s\n", _(git_more_info_string));
753 exit(1);
755 cmd = argv[0];
758 * We use PATH to find git commands, but we prepend some higher
759 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
760 * environment, and the $(gitexecdir) from the Makefile at build
761 * time.
763 setup_path();
765 while (1) {
766 int was_alias = run_argv(&argc, &argv);
767 if (errno != ENOENT)
768 break;
769 if (was_alias) {
770 fprintf(stderr, _("expansion of alias '%s' failed; "
771 "'%s' is not a git command\n"),
772 cmd, argv[0]);
773 exit(1);
775 if (!done_help) {
776 cmd = argv[0] = help_unknown_cmd(cmd);
777 done_help = 1;
778 } else
779 break;
782 fprintf(stderr, _("failed to run command '%s': %s\n"),
783 cmd, strerror(errno));
785 return 1;