run_command(): help callers distinguish errors
[git/git.git] / git.c
CommitLineData
85023577 1#include "builtin.h"
77cb17e9 2#include "exec_cmd.h"
2b11e317 3#include "cache.h"
575ba9d6 4#include "quote.h"
8e49d503 5
822a7d50 6const char git_usage_string[] =
463a849d 7 "git [--version] [--exec-path[=GIT_EXEC_PATH]] [-p|--paginate|--no-pager] [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE] [--help] COMMAND [ARGS]";
822a7d50 8
b7d96819
TL
9const char git_more_info_string[] =
10 "See 'git help COMMAND' for more information on a specific command.";
11
4e10738a
JK
12static int use_pager = -1;
13struct pager_config {
14 const char *cmd;
15 int val;
16};
17
18static int pager_command_config(const char *var, const char *value, void *data)
19{
20 struct pager_config *c = data;
21 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd))
22 c->val = git_config_bool(var, value);
23 return 0;
24}
25
26/* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
27int check_pager_config(const char *cmd)
28{
29 struct pager_config c;
30 c.cmd = cmd;
31 c.val = -1;
32 git_config(pager_command_config, &c);
33 return c.val;
34}
35
36static void commit_pager_choice(void) {
37 switch (use_pager) {
38 case 0:
39 setenv("GIT_PAGER", "cat", 1);
40 break;
41 case 1:
42 setup_pager();
43 break;
44 default:
45 break;
46 }
47}
48
4394efec 49static int handle_options(const char*** argv, int* argc, int* envchanged)
4ab243a9
JS
50{
51 int handled = 0;
52
53 while (*argc > 0) {
54 const char *cmd = (*argv)[0];
55 if (cmd[0] != '-')
56 break;
57
6acbcb92
JS
58 /*
59 * For legacy reasons, the "version" and "help"
60 * commands can be written with "--" prepended
61 * to make them look like flags.
62 */
63 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
64 break;
65
66 /*
67 * Check remaining flags.
68 */
cc44c765 69 if (!prefixcmp(cmd, "--exec-path")) {
6acbcb92
JS
70 cmd += 11;
71 if (*cmd == '=')
384df833 72 git_set_argv_exec_path(cmd + 1);
6acbcb92
JS
73 else {
74 puts(git_exec_path());
75 exit(0);
76 }
77 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
4e10738a 78 use_pager = 1;
463a849d 79 } else if (!strcmp(cmd, "--no-pager")) {
4e10738a 80 use_pager = 0;
463a849d
MM
81 if (envchanged)
82 *envchanged = 1;
6acbcb92 83 } else if (!strcmp(cmd, "--git-dir")) {
c321f00d
BG
84 if (*argc < 2) {
85 fprintf(stderr, "No directory given for --git-dir.\n" );
86 usage(git_usage_string);
87 }
45b09794 88 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
4394efec
ML
89 if (envchanged)
90 *envchanged = 1;
6acbcb92
JS
91 (*argv)++;
92 (*argc)--;
e4b02333 93 handled++;
cc44c765 94 } else if (!prefixcmp(cmd, "--git-dir=")) {
45b09794 95 setenv(GIT_DIR_ENVIRONMENT, cmd + 10, 1);
4394efec
ML
96 if (envchanged)
97 *envchanged = 1;
892c41b9
ML
98 } else if (!strcmp(cmd, "--work-tree")) {
99 if (*argc < 2) {
100 fprintf(stderr, "No directory given for --work-tree.\n" );
101 usage(git_usage_string);
102 }
103 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
4394efec
ML
104 if (envchanged)
105 *envchanged = 1;
892c41b9
ML
106 (*argv)++;
107 (*argc)--;
108 } else if (!prefixcmp(cmd, "--work-tree=")) {
109 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd + 12, 1);
4394efec
ML
110 if (envchanged)
111 *envchanged = 1;
6acbcb92 112 } else if (!strcmp(cmd, "--bare")) {
ef5ddb2f 113 static char git_dir[PATH_MAX+1];
6adcca3f 114 is_bare_repository_cfg = 1;
9277d602 115 setenv(GIT_DIR_ENVIRONMENT, getcwd(git_dir, sizeof(git_dir)), 0);
4394efec
ML
116 if (envchanged)
117 *envchanged = 1;
6acbcb92
JS
118 } else {
119 fprintf(stderr, "Unknown option: %s\n", cmd);
822a7d50 120 usage(git_usage_string);
6acbcb92 121 }
4ab243a9
JS
122
123 (*argv)++;
124 (*argc)--;
125 handled++;
126 }
127 return handled;
128}
129
2b11e317
JS
130static int handle_alias(int *argcp, const char ***argv)
131{
af05d679 132 int envchanged = 0, ret = 0, saved_errno = errno;
2b11e317 133 const char *subdir;
0347a8c7
ML
134 int count, option_count;
135 const char** new_argv;
94351118
JK
136 const char *alias_command;
137 char *alias_string;
e85dc0a3 138 int unused_nongit;
2b11e317 139
e85dc0a3 140 subdir = setup_git_directory_gently(&unused_nongit);
0347a8c7
ML
141
142 alias_command = (*argv)[0];
94351118 143 alias_string = alias_lookup(alias_command);
0347a8c7 144 if (alias_string) {
dfd42a3c 145 if (alias_string[0] == '!') {
a2f8028d 146 if (*argcp > 1) {
7a33bcbe 147 struct strbuf buf;
a2f8028d 148
7a33bcbe
PH
149 strbuf_init(&buf, PATH_MAX);
150 strbuf_addstr(&buf, alias_string);
b319ce4c 151 sq_quote_argv(&buf, (*argv) + 1, PATH_MAX);
a2f8028d 152 free(alias_string);
7a33bcbe 153 alias_string = buf.buf;
a2f8028d 154 }
dfd42a3c
TT
155 trace_printf("trace: alias to shell cmd: %s => %s\n",
156 alias_command, alias_string + 1);
157 ret = system(alias_string + 1);
158 if (ret >= 0 && WIFEXITED(ret) &&
159 WEXITSTATUS(ret) != 127)
160 exit(WEXITSTATUS(ret));
161 die("Failed to run '%s' when expanding alias '%s'\n",
162 alias_string + 1, alias_command);
163 }
0347a8c7 164 count = split_cmdline(alias_string, &new_argv);
dc4179f9
DM
165 if (count < 0)
166 die("Bad alias.%s string", alias_command);
4394efec
ML
167 option_count = handle_options(&new_argv, &count, &envchanged);
168 if (envchanged)
169 die("alias '%s' changes environment variables\n"
170 "You can use '!git' in the alias to do this.",
171 alias_command);
0347a8c7
ML
172 memmove(new_argv - option_count, new_argv,
173 count * sizeof(char *));
174 new_argv -= option_count;
175
176 if (count < 1)
177 die("empty alias for %s", alias_command);
178
179 if (!strcmp(alias_command, new_argv[0]))
180 die("recursive alias: %s", alias_command);
181
b319ce4c 182 trace_argv_printf(new_argv,
6ce4e61f
CC
183 "trace: alias expansion: %s =>",
184 alias_command);
575ba9d6 185
83572c1a
JF
186 new_argv = xrealloc(new_argv, sizeof(char*) *
187 (count + *argcp + 1));
0347a8c7
ML
188 /* insert after command name */
189 memcpy(new_argv + count, *argv + 1, sizeof(char*) * *argcp);
190 new_argv[count+*argcp] = NULL;
2b11e317 191
0347a8c7
ML
192 *argv = new_argv;
193 *argcp += count - 1;
2b11e317 194
0347a8c7 195 ret = 1;
2b11e317
JS
196 }
197
7be77de2
AR
198 if (subdir && chdir(subdir))
199 die("Cannot change to %s: %s", subdir, strerror(errno));
2b11e317 200
47e5c0ca
JS
201 errno = saved_errno;
202
2b11e317
JS
203 return ret;
204}
205
70827b15 206const char git_version_string[] = GIT_VERSION;
5b84f4d8 207
efffea03
JH
208#define RUN_SETUP (1<<0)
209#define USE_PAGER (1<<1)
7eff28a9
SP
210/*
211 * require working tree to be present -- anything uses this needs
212 * RUN_SETUP for reading from the configuration file.
213 */
7ae3df8c 214#define NEED_WORK_TREE (1<<2)
a633fca0 215
47d0b4ff
LT
216struct cmd_struct {
217 const char *cmd;
218 int (*fn)(int, const char **, const char *);
219 int option;
220};
221
f172f334 222static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
47d0b4ff 223{
0f157315
LT
224 int status;
225 struct stat st;
47d0b4ff
LT
226 const char *prefix;
227
228 prefix = NULL;
229 if (p->option & RUN_SETUP)
230 prefix = setup_git_directory();
4e10738a
JK
231
232 if (use_pager == -1 && p->option & RUN_SETUP)
233 use_pager = check_pager_config(p->cmd);
234 if (use_pager == -1 && p->option & USE_PAGER)
235 use_pager = 1;
236 commit_pager_choice();
237
59f0f2f3
MH
238 if (p->option & NEED_WORK_TREE)
239 setup_work_tree();
240
b319ce4c 241 trace_argv_printf(argv, "trace: built-in: git");
47d0b4ff 242
0f157315
LT
243 status = p->fn(argc, argv, prefix);
244 if (status)
2488df84 245 return status & 0xff;
0f157315
LT
246
247 /* Somebody closed stdout? */
248 if (fstat(fileno(stdout), &st))
249 return 0;
250 /* Ignore write errors for pipes and sockets.. */
251 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
252 return 0;
253
254 /* Check for ENOSPC and EIO errors.. */
0227f988 255 if (fflush(stdout))
0f157315 256 die("write failure on standard output: %s", strerror(errno));
0227f988
LT
257 if (ferror(stdout))
258 die("unknown write failure on standard output");
259 if (fclose(stdout))
260 die("close failed on standard output: %s", strerror(errno));
0f157315 261 return 0;
47d0b4ff
LT
262}
263
264static void handle_internal_command(int argc, const char **argv)
231af832
LT
265{
266 const char *cmd = argv[0];
47d0b4ff 267 static struct cmd_struct commands[] = {
7ae3df8c 268 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
11920d28 269 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
d97bc5de 270 { "annotate", cmd_annotate, RUN_SETUP },
f754fa9c 271 { "apply", cmd_apply },
265d5280 272 { "archive", cmd_archive },
4f0219a4 273 { "blame", cmd_blame, RUN_SETUP },
1da1b3a3 274 { "branch", cmd_branch, RUN_SETUP },
2e0afafe 275 { "bundle", cmd_bundle },
efffea03 276 { "cat-file", cmd_cat_file, RUN_SETUP },
782c2d65 277 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
4465f410
JS
278 { "checkout-index", cmd_checkout_index,
279 RUN_SETUP | NEED_WORK_TREE},
0864f264 280 { "check-ref-format", cmd_check_ref_format },
2d35d556 281 { "check-attr", cmd_check_attr, RUN_SETUP },
e827633a 282 { "cherry", cmd_cherry, RUN_SETUP },
7ae3df8c 283 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
8434c2f1 284 { "clone", cmd_clone },
113f10f2 285 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
f5bbc322 286 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
efffea03 287 { "commit-tree", cmd_commit_tree, RUN_SETUP },
e0d10e1c 288 { "config", cmd_config },
8112894d 289 { "count-objects", cmd_count_objects, RUN_SETUP },
9a0eaf83 290 { "describe", cmd_describe, RUN_SETUP },
89d07f75 291 { "diff", cmd_diff },
4f38f6b5 292 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE },
efffea03 293 { "diff-index", cmd_diff_index, RUN_SETUP },
efffea03 294 { "diff-tree", cmd_diff_tree, RUN_SETUP },
f2dc849e 295 { "fast-export", cmd_fast_export, RUN_SETUP },
b888d61c 296 { "fetch", cmd_fetch, RUN_SETUP },
2d4177c0 297 { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
d4289fff 298 { "fetch--tool", cmd_fetch__tool, RUN_SETUP },
efffea03 299 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
9f613ddd 300 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
efffea03 301 { "format-patch", cmd_format_patch, RUN_SETUP },
b4dfefe0
MW
302 { "fsck", cmd_fsck, RUN_SETUP },
303 { "fsck-objects", cmd_fsck, RUN_SETUP },
6757ada4 304 { "gc", cmd_gc, RUN_SETUP },
f754fa9c 305 { "get-tar-commit-id", cmd_get_tar_commit_id },
34c6a82b 306 { "grep", cmd_grep, RUN_SETUP | USE_PAGER },
f754fa9c 307 { "help", cmd_help },
30ae764b
DB
308#ifndef NO_CURL
309 { "http-fetch", cmd_http_fetch, RUN_SETUP },
310#endif
515377ea 311 { "init", cmd_init_db },
f754fa9c 312 { "init-db", cmd_init_db },
efffea03
JH
313 { "log", cmd_log, RUN_SETUP | USE_PAGER },
314 { "ls-files", cmd_ls_files, RUN_SETUP },
315 { "ls-tree", cmd_ls_tree, RUN_SETUP },
8951d7c1 316 { "ls-remote", cmd_ls_remote },
f754fa9c
JH
317 { "mailinfo", cmd_mailinfo },
318 { "mailsplit", cmd_mailsplit },
1c7b76be 319 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
71dfbf22 320 { "merge-base", cmd_merge_base, RUN_SETUP },
ba1f5f35 321 { "merge-file", cmd_merge_file },
a00a42ae 322 { "merge-ours", cmd_merge_ours, RUN_SETUP },
e1b3a2ca 323 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
1736855c 324 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
7ae3df8c 325 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
efffea03
JH
326 { "name-rev", cmd_name_rev, RUN_SETUP },
327 { "pack-objects", cmd_pack_objects, RUN_SETUP },
8951d7c1 328 { "peek-remote", cmd_ls_remote },
d97bc5de 329 { "pickaxe", cmd_blame, RUN_SETUP },
efffea03
JH
330 { "prune", cmd_prune, RUN_SETUP },
331 { "prune-packed", cmd_prune_packed, RUN_SETUP },
102cb085 332 { "push", cmd_push, RUN_SETUP },
efffea03 333 { "read-tree", cmd_read_tree, RUN_SETUP },
be5908ae 334 { "receive-pack", cmd_receive_pack },
4264dc15 335 { "reflog", cmd_reflog, RUN_SETUP },
211c8968 336 { "remote", cmd_remote, RUN_SETUP },
e0d10e1c 337 { "repo-config", cmd_config },
658f3650 338 { "rerere", cmd_rerere, RUN_SETUP },
0e5a7faa 339 { "reset", cmd_reset, RUN_SETUP },
efffea03 340 { "rev-list", cmd_rev_list, RUN_SETUP },
5410a02a 341 { "rev-parse", cmd_rev_parse },
7ae3df8c 342 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
271bb087 343 { "rm", cmd_rm, RUN_SETUP },
96249c04 344 { "send-pack", cmd_send_pack, RUN_SETUP },
abe549e1 345 { "shortlog", cmd_shortlog, USE_PAGER },
efffea03
JH
346 { "show-branch", cmd_show_branch, RUN_SETUP },
347 { "show", cmd_show, RUN_SETUP | USE_PAGER },
10762323 348 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
f754fa9c 349 { "stripspace", cmd_stripspace },
efffea03 350 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
62e09ce9 351 { "tag", cmd_tag, RUN_SETUP },
9cb90b80 352 { "tar-tree", cmd_tar_tree },
efffea03
JH
353 { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
354 { "update-index", cmd_update_index, RUN_SETUP },
355 { "update-ref", cmd_update_ref, RUN_SETUP },
39345a21 356 { "upload-archive", cmd_upload_archive },
2ae68fcb 357 { "verify-tag", cmd_verify_tag, RUN_SETUP },
f754fa9c 358 { "version", cmd_version },
efffea03
JH
359 { "whatchanged", cmd_whatchanged, RUN_SETUP | USE_PAGER },
360 { "write-tree", cmd_write_tree, RUN_SETUP },
2e3ed670 361 { "verify-pack", cmd_verify_pack },
358ddb62 362 { "show-ref", cmd_show_ref, RUN_SETUP },
e1e22e37 363 { "pack-refs", cmd_pack_refs, RUN_SETUP },
231af832
LT
364 };
365 int i;
23326d14
JS
366 static const char ext[] = STRIP_EXTENSION;
367
368 if (sizeof(ext) > 1) {
369 i = strlen(argv[0]) - strlen(ext);
370 if (i > 0 && !strcmp(argv[0] + i, ext)) {
e8eec71d 371 char *argv0 = xstrdup(argv[0]);
23326d14
JS
372 argv[0] = cmd = argv0;
373 argv0[i] = '\0';
374 }
375 }
231af832 376
1cd95087
LT
377 /* Turn "git cmd --help" into "git help cmd" */
378 if (argc > 1 && !strcmp(argv[1], "--help")) {
379 argv[1] = argv[0];
380 argv[0] = cmd = "help";
381 }
382
231af832
LT
383 for (i = 0; i < ARRAY_SIZE(commands); i++) {
384 struct cmd_struct *p = commands+i;
385 if (strcmp(p->cmd, cmd))
386 continue;
f172f334 387 exit(run_builtin(p, argc, argv));
231af832
LT
388 }
389}
390
7550be0a
JH
391static void execv_dashed_external(const char **argv)
392{
f285a2d7 393 struct strbuf cmd = STRBUF_INIT;
7550be0a
JH
394 const char *tmp;
395
7550be0a
JH
396 strbuf_addf(&cmd, "git-%s", argv[0]);
397
398 /*
399 * argv[0] must be the git command, but the argv array
400 * belongs to the caller, and may be reused in
401 * subsequent loop iterations. Save argv[0] and
402 * restore it on error.
403 */
404 tmp = argv[0];
405 argv[0] = cmd.buf;
406
407 trace_argv_printf(argv, "trace: exec:");
408
409 /* execvp() can only ever return if it fails */
410 execvp(cmd.buf, (char **)argv);
411
412 trace_printf("trace: exec failed: %s\n", strerror(errno));
413
414 argv[0] = tmp;
415
416 strbuf_release(&cmd);
417}
418
419
47d0b4ff 420int main(int argc, const char **argv)
8e49d503 421{
23326d14
JS
422 const char *cmd = argv[0] && *argv[0] ? argv[0] : "git-help";
423 char *slash = (char *)cmd + strlen(cmd);
a025463b 424 int done_alias = 0;
231af832
LT
425
426 /*
427 * Take the basename of argv[0] as the command
428 * name, and the dirname as the default exec_path
43db492a 429 * if we don't have anything better.
231af832 430 */
23326d14
JS
431 do
432 --slash;
433 while (cmd <= slash && !is_dir_sep(*slash));
434 if (cmd <= slash) {
231af832 435 *slash++ = 0;
e1464ca7 436 git_set_argv0_path(cmd);
231af832
LT
437 cmd = slash;
438 }
8e49d503 439
231af832
LT
440 /*
441 * "git-xxxx" is the same as "git xxxx", but we obviously:
442 *
443 * - cannot take flags in between the "git" and the "xxxx".
444 * - cannot execute it externally (since it would just do
445 * the same thing over again)
446 *
447 * So we just directly call the internal command handler, and
448 * die if that one cannot handle it.
449 */
cc44c765 450 if (!prefixcmp(cmd, "git-")) {
231af832
LT
451 cmd += 4;
452 argv[0] = cmd;
47d0b4ff 453 handle_internal_command(argc, argv);
231af832
LT
454 die("cannot handle %s internally", cmd);
455 }
8e49d503 456
231af832 457 /* Look for flags.. */
6acbcb92
JS
458 argv++;
459 argc--;
4394efec 460 handle_options(&argv, &argc, NULL);
4e10738a 461 commit_pager_choice();
6acbcb92 462 if (argc > 0) {
cc44c765 463 if (!prefixcmp(argv[0], "--"))
6acbcb92
JS
464 argv[0] += 2;
465 } else {
3d7e2d85
SP
466 /* The user didn't specify a command; give them help */
467 printf("usage: %s\n\n", git_usage_string);
468 list_common_cmds_help();
b7d96819 469 printf("\n%s\n", git_more_info_string);
3d7e2d85 470 exit(1);
97fc6c5f 471 }
6acbcb92 472 cmd = argv[0];
231af832
LT
473
474 /*
511707d4
SP
475 * We use PATH to find git commands, but we prepend some higher
476 * precidence paths: the "--exec-path" option, the GIT_EXEC_PATH
477 * environment, and the $(gitexecdir) from the Makefile at build
478 * time.
231af832 479 */
e1464ca7 480 setup_path();
8e49d503 481
a025463b
JH
482 while (1) {
483 /* See if it's an internal command */
47d0b4ff 484 handle_internal_command(argc, argv);
2b11e317 485
a025463b 486 /* .. then try the external ones */
7550be0a 487 execv_dashed_external(argv);
231af832 488
a025463b
JH
489 /* It could be an alias -- this works around the insanity
490 * of overriding "git log" with "git show" by having
491 * alias.log = show
492 */
493 if (done_alias || !handle_alias(&argc, &argv))
494 break;
495 done_alias = 1;
496 }
10b15b86 497
f3dd015c
TT
498 if (errno == ENOENT) {
499 if (done_alias) {
500 fprintf(stderr, "Expansion of alias '%s' failed; "
501 "'%s' is not a git-command\n",
502 cmd, argv[0]);
503 exit(1);
504 }
8af84dad
JS
505 argv[0] = help_unknown_cmd(cmd);
506 handle_internal_command(argc, argv);
507 execv_dashed_external(argv);
f3dd015c 508 }
10b15b86
AR
509
510 fprintf(stderr, "Failed to run command '%s': %s\n",
33ebb871 511 cmd, strerror(errno));
8e49d503
AE
512
513 return 1;
514}