4 #include "run-command.h"
6 const char git_usage_string
[] =
7 "git [--version] [--help] [-C <path>] [-c name=value]\n"
8 " [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
9 " [-p | --paginate | --no-pager] [--no-replace-objects] [--bare]\n"
10 " [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
11 " <command> [<args>]";
13 const char git_more_info_string
[] =
14 N_("'git help -a' and 'git help -g' list available subcommands and some\n"
15 "concept guides. See 'git help <command>' or 'git help <concept>'\n"
16 "to read about a specific subcommand or concept.");
18 static int use_pager
= -1;
19 static char *orig_cwd
;
20 static const char *env_names
[] = {
22 GIT_WORK_TREE_ENVIRONMENT
,
23 GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
,
24 GIT_PREFIX_ENVIRONMENT
26 static char *orig_env
[4];
27 static int save_restore_env_balance
;
29 static void save_env_before_alias(void)
33 assert(save_restore_env_balance
== 0);
34 save_restore_env_balance
= 1;
36 for (i
= 0; i
< ARRAY_SIZE(env_names
); i
++) {
37 orig_env
[i
] = getenv(env_names
[i
]);
38 orig_env
[i
] = xstrdup_or_null(orig_env
[i
]);
42 static void restore_env(int external_alias
)
46 assert(save_restore_env_balance
== 1);
47 save_restore_env_balance
= 0;
48 if (!external_alias
&& orig_cwd
&& chdir(orig_cwd
))
49 die_errno("could not move to %s", orig_cwd
);
51 for (i
= 0; i
< ARRAY_SIZE(env_names
); i
++) {
53 !strcmp(env_names
[i
], GIT_PREFIX_ENVIRONMENT
))
56 setenv(env_names
[i
], orig_env
[i
], 1);
59 unsetenv(env_names
[i
]);
64 static void commit_pager_choice(void) {
67 setenv("GIT_PAGER", "cat", 1);
77 static int handle_options(const char ***argv
, int *argc
, int *envchanged
)
79 const char **orig_argv
= *argv
;
82 const char *cmd
= (*argv
)[0];
87 * For legacy reasons, the "version" and "help"
88 * commands can be written with "--" prepended
89 * to make them look like flags.
91 if (!strcmp(cmd
, "--help") || !strcmp(cmd
, "--version"))
95 * Check remaining flags.
97 if (skip_prefix(cmd
, "--exec-path", &cmd
)) {
99 git_set_argv_exec_path(cmd
+ 1);
101 puts(git_exec_path());
104 } else if (!strcmp(cmd
, "--html-path")) {
105 puts(system_path(GIT_HTML_PATH
));
107 } else if (!strcmp(cmd
, "--man-path")) {
108 puts(system_path(GIT_MAN_PATH
));
110 } else if (!strcmp(cmd
, "--info-path")) {
111 puts(system_path(GIT_INFO_PATH
));
113 } else if (!strcmp(cmd
, "-p") || !strcmp(cmd
, "--paginate")) {
115 } else if (!strcmp(cmd
, "--no-pager")) {
119 } else if (!strcmp(cmd
, "--no-replace-objects")) {
120 check_replace_refs
= 0;
121 setenv(NO_REPLACE_OBJECTS_ENVIRONMENT
, "1", 1);
124 } else if (!strcmp(cmd
, "--git-dir")) {
126 fprintf(stderr
, "No directory given for --git-dir.\n" );
127 usage(git_usage_string
);
129 setenv(GIT_DIR_ENVIRONMENT
, (*argv
)[1], 1);
134 } else if (skip_prefix(cmd
, "--git-dir=", &cmd
)) {
135 setenv(GIT_DIR_ENVIRONMENT
, cmd
, 1);
138 } else if (!strcmp(cmd
, "--namespace")) {
140 fprintf(stderr
, "No namespace given for --namespace.\n" );
141 usage(git_usage_string
);
143 setenv(GIT_NAMESPACE_ENVIRONMENT
, (*argv
)[1], 1);
148 } else if (skip_prefix(cmd
, "--namespace=", &cmd
)) {
149 setenv(GIT_NAMESPACE_ENVIRONMENT
, cmd
, 1);
152 } else if (!strcmp(cmd
, "--work-tree")) {
154 fprintf(stderr
, "No directory given for --work-tree.\n" );
155 usage(git_usage_string
);
157 setenv(GIT_WORK_TREE_ENVIRONMENT
, (*argv
)[1], 1);
162 } else if (skip_prefix(cmd
, "--work-tree=", &cmd
)) {
163 setenv(GIT_WORK_TREE_ENVIRONMENT
, cmd
, 1);
166 } else if (!strcmp(cmd
, "--bare")) {
167 char *cwd
= xgetcwd();
168 is_bare_repository_cfg
= 1;
169 setenv(GIT_DIR_ENVIRONMENT
, cwd
, 0);
171 setenv(GIT_IMPLICIT_WORK_TREE_ENVIRONMENT
, "0", 1);
174 } else if (!strcmp(cmd
, "-c")) {
176 fprintf(stderr
, "-c expects a configuration string\n" );
177 usage(git_usage_string
);
179 git_config_push_parameter((*argv
)[1]);
182 } else if (!strcmp(cmd
, "--literal-pathspecs")) {
183 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT
, "1", 1);
186 } else if (!strcmp(cmd
, "--no-literal-pathspecs")) {
187 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT
, "0", 1);
190 } else if (!strcmp(cmd
, "--glob-pathspecs")) {
191 setenv(GIT_GLOB_PATHSPECS_ENVIRONMENT
, "1", 1);
194 } else if (!strcmp(cmd
, "--noglob-pathspecs")) {
195 setenv(GIT_NOGLOB_PATHSPECS_ENVIRONMENT
, "1", 1);
198 } else if (!strcmp(cmd
, "--icase-pathspecs")) {
199 setenv(GIT_ICASE_PATHSPECS_ENVIRONMENT
, "1", 1);
202 } else if (!strcmp(cmd
, "--shallow-file")) {
205 set_alternate_shallow_file((*argv
)[0], 1);
208 } else if (!strcmp(cmd
, "-C")) {
210 fprintf(stderr
, "No directory given for -C.\n" );
211 usage(git_usage_string
);
214 if (chdir((*argv
)[1]))
215 die_errno("Cannot change to '%s'", (*argv
)[1]);
222 fprintf(stderr
, "Unknown option: %s\n", cmd
);
223 usage(git_usage_string
);
229 return (*argv
) - orig_argv
;
232 static int handle_alias(int *argcp
, const char ***argv
)
234 int envchanged
= 0, ret
= 0, saved_errno
= errno
;
235 int count
, option_count
;
236 const char **new_argv
;
237 const char *alias_command
;
241 save_env_before_alias();
242 setup_git_directory_gently(&unused_nongit
);
244 alias_command
= (*argv
)[0];
245 alias_string
= alias_lookup(alias_command
);
247 if (alias_string
[0] == '!') {
248 struct child_process child
= CHILD_PROCESS_INIT
;
250 commit_pager_choice();
254 argv_array_push(&child
.args
, alias_string
+ 1);
255 argv_array_pushv(&child
.args
, (*argv
) + 1);
257 ret
= run_command(&child
);
258 if (ret
>= 0) /* normal exit */
261 die_errno("While expanding alias '%s': '%s'",
262 alias_command
, alias_string
+ 1);
264 count
= split_cmdline(alias_string
, &new_argv
);
266 die("Bad alias.%s string: %s", alias_command
,
267 split_cmdline_strerror(count
));
268 option_count
= handle_options(&new_argv
, &count
, &envchanged
);
270 die("alias '%s' changes environment variables\n"
271 "You can use '!git' in the alias to do this.",
273 memmove(new_argv
- option_count
, new_argv
,
274 count
* sizeof(char *));
275 new_argv
-= option_count
;
278 die("empty alias for %s", alias_command
);
280 if (!strcmp(alias_command
, new_argv
[0]))
281 die("recursive alias: %s", alias_command
);
283 trace_argv_printf(new_argv
,
284 "trace: alias expansion: %s =>",
287 REALLOC_ARRAY(new_argv
, count
+ *argcp
);
288 /* insert after command name */
289 memcpy(new_argv
+ count
, *argv
+ 1, sizeof(char *) * *argcp
);
304 #define RUN_SETUP (1<<0)
305 #define RUN_SETUP_GENTLY (1<<1)
306 #define USE_PAGER (1<<2)
308 * require working tree to be present -- anything uses this needs
309 * RUN_SETUP for reading from the configuration file.
311 #define NEED_WORK_TREE (1<<3)
315 int (*fn
)(int, const char **, const char *);
319 static int run_builtin(struct cmd_struct
*p
, int argc
, const char **argv
)
326 help
= argc
== 2 && !strcmp(argv
[1], "-h");
328 if (p
->option
& RUN_SETUP
)
329 prefix
= setup_git_directory();
330 else if (p
->option
& RUN_SETUP_GENTLY
) {
332 prefix
= setup_git_directory_gently(&nongit_ok
);
335 if (use_pager
== -1 && p
->option
& (RUN_SETUP
| RUN_SETUP_GENTLY
))
336 use_pager
= check_pager_config(p
->cmd
);
337 if (use_pager
== -1 && p
->option
& USE_PAGER
)
340 if ((p
->option
& (RUN_SETUP
| RUN_SETUP_GENTLY
)) &&
341 startup_info
->have_repository
) /* get_git_dir() may set up repo, avoid that */
342 trace_repo_setup(prefix
);
344 commit_pager_choice();
346 if (!help
&& p
->option
& NEED_WORK_TREE
)
349 trace_argv_printf(argv
, "trace: built-in: git");
351 status
= p
->fn(argc
, argv
, prefix
);
355 /* Somebody closed stdout? */
356 if (fstat(fileno(stdout
), &st
))
358 /* Ignore write errors for pipes and sockets.. */
359 if (S_ISFIFO(st
.st_mode
) || S_ISSOCK(st
.st_mode
))
362 /* Check for ENOSPC and EIO errors.. */
364 die_errno("write failure on standard output");
366 die("unknown write failure on standard output");
368 die_errno("close failed on standard output");
372 static struct cmd_struct commands
[] = {
373 { "add", cmd_add
, RUN_SETUP
| NEED_WORK_TREE
},
374 { "am", cmd_am
, RUN_SETUP
| NEED_WORK_TREE
},
375 { "annotate", cmd_annotate
, RUN_SETUP
},
376 { "apply", cmd_apply
, RUN_SETUP_GENTLY
},
377 { "archive", cmd_archive
},
378 { "bisect--helper", cmd_bisect__helper
, RUN_SETUP
},
379 { "blame", cmd_blame
, RUN_SETUP
},
380 { "branch", cmd_branch
, RUN_SETUP
},
381 { "bundle", cmd_bundle
, RUN_SETUP_GENTLY
},
382 { "cat-file", cmd_cat_file
, RUN_SETUP
},
383 { "check-attr", cmd_check_attr
, RUN_SETUP
},
384 { "check-ignore", cmd_check_ignore
, RUN_SETUP
| NEED_WORK_TREE
},
385 { "check-mailmap", cmd_check_mailmap
, RUN_SETUP
},
386 { "check-ref-format", cmd_check_ref_format
},
387 { "checkout", cmd_checkout
, RUN_SETUP
| NEED_WORK_TREE
},
388 { "checkout-index", cmd_checkout_index
,
389 RUN_SETUP
| NEED_WORK_TREE
},
390 { "cherry", cmd_cherry
, RUN_SETUP
},
391 { "cherry-pick", cmd_cherry_pick
, RUN_SETUP
| NEED_WORK_TREE
},
392 { "clean", cmd_clean
, RUN_SETUP
| NEED_WORK_TREE
},
393 { "clone", cmd_clone
},
394 { "column", cmd_column
, RUN_SETUP_GENTLY
},
395 { "commit", cmd_commit
, RUN_SETUP
| NEED_WORK_TREE
},
396 { "commit-tree", cmd_commit_tree
, RUN_SETUP
},
397 { "config", cmd_config
, RUN_SETUP_GENTLY
},
398 { "count-objects", cmd_count_objects
, RUN_SETUP
},
399 { "credential", cmd_credential
, RUN_SETUP_GENTLY
},
400 { "describe", cmd_describe
, RUN_SETUP
},
401 { "diff", cmd_diff
},
402 { "diff-files", cmd_diff_files
, RUN_SETUP
| NEED_WORK_TREE
},
403 { "diff-index", cmd_diff_index
, RUN_SETUP
},
404 { "diff-tree", cmd_diff_tree
, RUN_SETUP
},
405 { "fast-export", cmd_fast_export
, RUN_SETUP
},
406 { "fetch", cmd_fetch
, RUN_SETUP
},
407 { "fetch-pack", cmd_fetch_pack
, RUN_SETUP
},
408 { "fmt-merge-msg", cmd_fmt_merge_msg
, RUN_SETUP
},
409 { "for-each-ref", cmd_for_each_ref
, RUN_SETUP
},
410 { "format-patch", cmd_format_patch
, RUN_SETUP
},
411 { "fsck", cmd_fsck
, RUN_SETUP
},
412 { "fsck-objects", cmd_fsck
, RUN_SETUP
},
413 { "gc", cmd_gc
, RUN_SETUP
},
414 { "get-tar-commit-id", cmd_get_tar_commit_id
},
415 { "grep", cmd_grep
, RUN_SETUP_GENTLY
},
416 { "hash-object", cmd_hash_object
},
417 { "help", cmd_help
},
418 { "index-pack", cmd_index_pack
, RUN_SETUP_GENTLY
},
419 { "init", cmd_init_db
},
420 { "init-db", cmd_init_db
},
421 { "interpret-trailers", cmd_interpret_trailers
, RUN_SETUP_GENTLY
},
422 { "log", cmd_log
, RUN_SETUP
},
423 { "ls-files", cmd_ls_files
, RUN_SETUP
},
424 { "ls-remote", cmd_ls_remote
, RUN_SETUP_GENTLY
},
425 { "ls-tree", cmd_ls_tree
, RUN_SETUP
},
426 { "mailinfo", cmd_mailinfo
},
427 { "mailsplit", cmd_mailsplit
},
428 { "merge", cmd_merge
, RUN_SETUP
| NEED_WORK_TREE
},
429 { "merge-base", cmd_merge_base
, RUN_SETUP
},
430 { "merge-file", cmd_merge_file
, RUN_SETUP_GENTLY
},
431 { "merge-index", cmd_merge_index
, RUN_SETUP
},
432 { "merge-ours", cmd_merge_ours
, RUN_SETUP
},
433 { "merge-recursive", cmd_merge_recursive
, RUN_SETUP
| NEED_WORK_TREE
},
434 { "merge-recursive-ours", cmd_merge_recursive
, RUN_SETUP
| NEED_WORK_TREE
},
435 { "merge-recursive-theirs", cmd_merge_recursive
, RUN_SETUP
| NEED_WORK_TREE
},
436 { "merge-subtree", cmd_merge_recursive
, RUN_SETUP
| NEED_WORK_TREE
},
437 { "merge-tree", cmd_merge_tree
, RUN_SETUP
},
438 { "mktag", cmd_mktag
, RUN_SETUP
},
439 { "mktree", cmd_mktree
, RUN_SETUP
},
440 { "mv", cmd_mv
, RUN_SETUP
| NEED_WORK_TREE
},
441 { "name-rev", cmd_name_rev
, RUN_SETUP
},
442 { "notes", cmd_notes
, RUN_SETUP
},
443 { "pack-objects", cmd_pack_objects
, RUN_SETUP
},
444 { "pack-redundant", cmd_pack_redundant
, RUN_SETUP
},
445 { "pack-refs", cmd_pack_refs
, RUN_SETUP
},
446 { "patch-id", cmd_patch_id
},
447 { "pickaxe", cmd_blame
, RUN_SETUP
},
448 { "prune", cmd_prune
, RUN_SETUP
},
449 { "prune-packed", cmd_prune_packed
, RUN_SETUP
},
450 { "pull", cmd_pull
, RUN_SETUP
| NEED_WORK_TREE
},
451 { "push", cmd_push
, RUN_SETUP
},
452 { "read-tree", cmd_read_tree
, RUN_SETUP
},
453 { "receive-pack", cmd_receive_pack
},
454 { "reflog", cmd_reflog
, RUN_SETUP
},
455 { "remote", cmd_remote
, RUN_SETUP
},
456 { "remote-ext", cmd_remote_ext
},
457 { "remote-fd", cmd_remote_fd
},
458 { "repack", cmd_repack
, RUN_SETUP
},
459 { "replace", cmd_replace
, RUN_SETUP
},
460 { "rerere", cmd_rerere
, RUN_SETUP
},
461 { "reset", cmd_reset
, RUN_SETUP
},
462 { "rev-list", cmd_rev_list
, RUN_SETUP
},
463 { "rev-parse", cmd_rev_parse
},
464 { "revert", cmd_revert
, RUN_SETUP
| NEED_WORK_TREE
},
465 { "rm", cmd_rm
, RUN_SETUP
},
466 { "send-pack", cmd_send_pack
, RUN_SETUP
},
467 { "shortlog", cmd_shortlog
, RUN_SETUP_GENTLY
| USE_PAGER
},
468 { "show", cmd_show
, RUN_SETUP
},
469 { "show-branch", cmd_show_branch
, RUN_SETUP
},
470 { "show-ref", cmd_show_ref
, RUN_SETUP
},
471 { "stage", cmd_add
, RUN_SETUP
| NEED_WORK_TREE
},
472 { "status", cmd_status
, RUN_SETUP
| NEED_WORK_TREE
},
473 { "stripspace", cmd_stripspace
},
474 { "submodule--helper", cmd_submodule__helper
, RUN_SETUP
},
475 { "symbolic-ref", cmd_symbolic_ref
, RUN_SETUP
},
476 { "tag", cmd_tag
, RUN_SETUP
},
477 { "unpack-file", cmd_unpack_file
, RUN_SETUP
},
478 { "unpack-objects", cmd_unpack_objects
, RUN_SETUP
},
479 { "update-index", cmd_update_index
, RUN_SETUP
},
480 { "update-ref", cmd_update_ref
, RUN_SETUP
},
481 { "update-server-info", cmd_update_server_info
, RUN_SETUP
},
482 { "upload-archive", cmd_upload_archive
},
483 { "upload-archive--writer", cmd_upload_archive_writer
},
484 { "var", cmd_var
, RUN_SETUP_GENTLY
},
485 { "verify-commit", cmd_verify_commit
, RUN_SETUP
},
486 { "verify-pack", cmd_verify_pack
},
487 { "verify-tag", cmd_verify_tag
, RUN_SETUP
},
488 { "version", cmd_version
},
489 { "whatchanged", cmd_whatchanged
, RUN_SETUP
},
490 { "worktree", cmd_worktree
, RUN_SETUP
},
491 { "write-tree", cmd_write_tree
, RUN_SETUP
},
494 static struct cmd_struct
*get_builtin(const char *s
)
497 for (i
= 0; i
< ARRAY_SIZE(commands
); i
++) {
498 struct cmd_struct
*p
= commands
+ i
;
499 if (!strcmp(s
, p
->cmd
))
505 int is_builtin(const char *s
)
507 return !!get_builtin(s
);
510 #ifdef STRIP_EXTENSION
511 static void strip_extension(const char **argv
)
515 if (strip_suffix(argv
[0], STRIP_EXTENSION
, &len
))
516 argv
[0] = xmemdupz(argv
[0], len
);
519 #define strip_extension(cmd)
522 static void handle_builtin(int argc
, const char **argv
)
525 struct cmd_struct
*builtin
;
527 strip_extension(argv
);
530 /* Turn "git cmd --help" into "git help cmd" */
531 if (argc
> 1 && !strcmp(argv
[1], "--help")) {
533 argv
[0] = cmd
= "help";
536 builtin
= get_builtin(cmd
);
538 exit(run_builtin(builtin
, argc
, argv
));
541 static void execv_dashed_external(const char **argv
)
543 struct strbuf cmd
= STRBUF_INIT
;
548 use_pager
= check_pager_config(argv
[0]);
549 commit_pager_choice();
551 strbuf_addf(&cmd
, "git-%s", argv
[0]);
554 * argv[0] must be the git command, but the argv array
555 * belongs to the caller, and may be reused in
556 * subsequent loop iterations. Save argv[0] and
557 * restore it on error.
562 trace_argv_printf(argv
, "trace: exec:");
565 * if we fail because the command is not found, it is
566 * OK to return. Otherwise, we just pass along the status code.
568 status
= run_command_v_opt(argv
, RUN_SILENT_EXEC_FAILURE
| RUN_CLEAN_ON_EXIT
);
569 if (status
>= 0 || errno
!= ENOENT
)
574 strbuf_release(&cmd
);
577 static int run_argv(int *argcp
, const char ***argv
)
583 * If we tried alias and futzed with our environment,
584 * it no longer is safe to invoke builtins directly in
585 * general. We have to spawn them as dashed externals.
587 * NEEDSWORK: if we can figure out cases
588 * where it is safe to do, we can avoid spawning a new
592 handle_builtin(*argcp
, *argv
);
594 /* .. then try the external ones */
595 execv_dashed_external(*argv
);
597 /* It could be an alias -- this works around the insanity
598 * of overriding "git log" with "git show" by having
603 if (!handle_alias(argcp
, argv
))
611 int cmd_main(int argc
, const char **argv
)
620 trace_command_performance(argv
);
623 * "git-xxxx" is the same as "git xxxx", but we obviously:
625 * - cannot take flags in between the "git" and the "xxxx".
626 * - cannot execute it externally (since it would just do
627 * the same thing over again)
629 * So we just directly call the builtin handler, and die if
630 * that one cannot handle it.
632 if (skip_prefix(cmd
, "git-", &cmd
)) {
634 handle_builtin(argc
, argv
);
635 die("cannot handle %s as a builtin", cmd
);
638 /* Look for flags.. */
641 handle_options(&argv
, &argc
, NULL
);
643 /* translate --help and --version into commands */
644 skip_prefix(argv
[0], "--", &argv
[0]);
646 /* The user didn't specify a command; give them help */
647 commit_pager_choice();
648 printf("usage: %s\n\n", git_usage_string
);
649 list_common_cmds_help();
650 printf("\n%s\n", _(git_more_info_string
));
656 * We use PATH to find git commands, but we prepend some higher
657 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
658 * environment, and the $(gitexecdir) from the Makefile at build
664 int was_alias
= run_argv(&argc
, &argv
);
668 fprintf(stderr
, "Expansion of alias '%s' failed; "
669 "'%s' is not a git command\n",
674 cmd
= argv
[0] = help_unknown_cmd(cmd
);
680 fprintf(stderr
, "Failed to run command '%s': %s\n",
681 cmd
, strerror(errno
));