git-rerere.txt: Clarify ambiguity of the config variable
[git/spearce.git] / git.c
blob807d875ae06ce7bbf61bb846c5b4cb5a51855eba
1 #include "builtin.h"
2 #include "exec_cmd.h"
3 #include "cache.h"
4 #include "quote.h"
5 #include "run-command.h"
7 const char git_usage_string[] =
8 "git [--version] [--exec-path[=GIT_EXEC_PATH]] [--html-path] [-p|--paginate|--no-pager] [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE] [--help] COMMAND [ARGS]";
10 const char git_more_info_string[] =
11 "See 'git help COMMAND' for more information on a specific command.";
13 static int use_pager = -1;
14 struct pager_config {
15 const char *cmd;
16 int val;
19 static int pager_command_config(const char *var, const char *value, void *data)
21 struct pager_config *c = data;
22 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd))
23 c->val = git_config_bool(var, value);
24 return 0;
27 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
28 int check_pager_config(const char *cmd)
30 struct pager_config c;
31 c.cmd = cmd;
32 c.val = -1;
33 git_config(pager_command_config, &c);
34 return c.val;
37 static void commit_pager_choice(void) {
38 switch (use_pager) {
39 case 0:
40 setenv("GIT_PAGER", "cat", 1);
41 break;
42 case 1:
43 setup_pager();
44 break;
45 default:
46 break;
50 static int handle_options(const char ***argv, int *argc, int *envchanged)
52 int handled = 0;
54 while (*argc > 0) {
55 const char *cmd = (*argv)[0];
56 if (cmd[0] != '-')
57 break;
60 * For legacy reasons, the "version" and "help"
61 * commands can be written with "--" prepended
62 * to make them look like flags.
64 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
65 break;
68 * Check remaining flags.
70 if (!prefixcmp(cmd, "--exec-path")) {
71 cmd += 11;
72 if (*cmd == '=')
73 git_set_argv_exec_path(cmd + 1);
74 else {
75 puts(git_exec_path());
76 exit(0);
78 } else if (!strcmp(cmd, "--html-path")) {
79 puts(system_path(GIT_HTML_PATH));
80 exit(0);
81 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
82 use_pager = 1;
83 } else if (!strcmp(cmd, "--no-pager")) {
84 use_pager = 0;
85 if (envchanged)
86 *envchanged = 1;
87 } else if (!strcmp(cmd, "--git-dir")) {
88 if (*argc < 2) {
89 fprintf(stderr, "No directory given for --git-dir.\n" );
90 usage(git_usage_string);
92 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
93 if (envchanged)
94 *envchanged = 1;
95 (*argv)++;
96 (*argc)--;
97 handled++;
98 } else if (!prefixcmp(cmd, "--git-dir=")) {
99 setenv(GIT_DIR_ENVIRONMENT, cmd + 10, 1);
100 if (envchanged)
101 *envchanged = 1;
102 } else if (!strcmp(cmd, "--work-tree")) {
103 if (*argc < 2) {
104 fprintf(stderr, "No directory given for --work-tree.\n" );
105 usage(git_usage_string);
107 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
108 if (envchanged)
109 *envchanged = 1;
110 (*argv)++;
111 (*argc)--;
112 } else if (!prefixcmp(cmd, "--work-tree=")) {
113 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd + 12, 1);
114 if (envchanged)
115 *envchanged = 1;
116 } else if (!strcmp(cmd, "--bare")) {
117 static char git_dir[PATH_MAX+1];
118 is_bare_repository_cfg = 1;
119 setenv(GIT_DIR_ENVIRONMENT, getcwd(git_dir, sizeof(git_dir)), 0);
120 if (envchanged)
121 *envchanged = 1;
122 } else {
123 fprintf(stderr, "Unknown option: %s\n", cmd);
124 usage(git_usage_string);
127 (*argv)++;
128 (*argc)--;
129 handled++;
131 return handled;
134 static int handle_alias(int *argcp, const char ***argv)
136 int envchanged = 0, ret = 0, saved_errno = errno;
137 const char *subdir;
138 int count, option_count;
139 const char **new_argv;
140 const char *alias_command;
141 char *alias_string;
142 int unused_nongit;
144 subdir = setup_git_directory_gently(&unused_nongit);
146 alias_command = (*argv)[0];
147 alias_string = alias_lookup(alias_command);
148 if (alias_string) {
149 if (alias_string[0] == '!') {
150 if (*argcp > 1) {
151 struct strbuf buf;
153 strbuf_init(&buf, PATH_MAX);
154 strbuf_addstr(&buf, alias_string);
155 sq_quote_argv(&buf, (*argv) + 1, PATH_MAX);
156 free(alias_string);
157 alias_string = buf.buf;
159 trace_printf("trace: alias to shell cmd: %s => %s\n",
160 alias_command, alias_string + 1);
161 ret = system(alias_string + 1);
162 if (ret >= 0 && WIFEXITED(ret) &&
163 WEXITSTATUS(ret) != 127)
164 exit(WEXITSTATUS(ret));
165 die("Failed to run '%s' when expanding alias '%s'",
166 alias_string + 1, alias_command);
168 count = split_cmdline(alias_string, &new_argv);
169 if (count < 0)
170 die("Bad alias.%s string", alias_command);
171 option_count = handle_options(&new_argv, &count, &envchanged);
172 if (envchanged)
173 die("alias '%s' changes environment variables\n"
174 "You can use '!git' in the alias to do this.",
175 alias_command);
176 memmove(new_argv - option_count, new_argv,
177 count * sizeof(char *));
178 new_argv -= option_count;
180 if (count < 1)
181 die("empty alias for %s", alias_command);
183 if (!strcmp(alias_command, new_argv[0]))
184 die("recursive alias: %s", alias_command);
186 trace_argv_printf(new_argv,
187 "trace: alias expansion: %s =>",
188 alias_command);
190 new_argv = xrealloc(new_argv, sizeof(char *) *
191 (count + *argcp));
192 /* insert after command name */
193 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
195 *argv = new_argv;
196 *argcp += count - 1;
198 ret = 1;
201 if (subdir && chdir(subdir))
202 die_errno("Cannot change to '%s'", subdir);
204 errno = saved_errno;
206 return ret;
209 const char git_version_string[] = GIT_VERSION;
211 #define RUN_SETUP (1<<0)
212 #define USE_PAGER (1<<1)
214 * require working tree to be present -- anything uses this needs
215 * RUN_SETUP for reading from the configuration file.
217 #define NEED_WORK_TREE (1<<2)
219 struct cmd_struct {
220 const char *cmd;
221 int (*fn)(int, const char **, const char *);
222 int option;
225 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
227 int status;
228 struct stat st;
229 const char *prefix;
231 prefix = NULL;
232 if (p->option & RUN_SETUP)
233 prefix = setup_git_directory();
235 if (use_pager == -1 && p->option & RUN_SETUP)
236 use_pager = check_pager_config(p->cmd);
237 if (use_pager == -1 && p->option & USE_PAGER)
238 use_pager = 1;
239 commit_pager_choice();
241 if (p->option & NEED_WORK_TREE)
242 setup_work_tree();
244 trace_argv_printf(argv, "trace: built-in: git");
246 status = p->fn(argc, argv, prefix);
247 if (status)
248 return status;
250 /* Somebody closed stdout? */
251 if (fstat(fileno(stdout), &st))
252 return 0;
253 /* Ignore write errors for pipes and sockets.. */
254 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
255 return 0;
257 /* Check for ENOSPC and EIO errors.. */
258 if (fflush(stdout))
259 die_errno("write failure on standard output");
260 if (ferror(stdout))
261 die("unknown write failure on standard output");
262 if (fclose(stdout))
263 die_errno("close failed on standard output");
264 return 0;
267 static void handle_internal_command(int argc, const char **argv)
269 const char *cmd = argv[0];
270 static struct cmd_struct commands[] = {
271 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
272 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
273 { "annotate", cmd_annotate, RUN_SETUP },
274 { "apply", cmd_apply },
275 { "archive", cmd_archive },
276 { "bisect--helper", cmd_bisect__helper, RUN_SETUP | NEED_WORK_TREE },
277 { "blame", cmd_blame, RUN_SETUP },
278 { "branch", cmd_branch, RUN_SETUP },
279 { "bundle", cmd_bundle },
280 { "cat-file", cmd_cat_file, RUN_SETUP },
281 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
282 { "checkout-index", cmd_checkout_index,
283 RUN_SETUP | NEED_WORK_TREE},
284 { "check-ref-format", cmd_check_ref_format },
285 { "check-attr", cmd_check_attr, RUN_SETUP },
286 { "cherry", cmd_cherry, RUN_SETUP },
287 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
288 { "clone", cmd_clone },
289 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
290 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
291 { "commit-tree", cmd_commit_tree, RUN_SETUP },
292 { "config", cmd_config },
293 { "count-objects", cmd_count_objects, RUN_SETUP },
294 { "describe", cmd_describe, RUN_SETUP },
295 { "diff", cmd_diff },
296 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE },
297 { "diff-index", cmd_diff_index, RUN_SETUP },
298 { "diff-tree", cmd_diff_tree, RUN_SETUP },
299 { "fast-export", cmd_fast_export, RUN_SETUP },
300 { "fetch", cmd_fetch, RUN_SETUP },
301 { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
302 { "fetch--tool", cmd_fetch__tool, RUN_SETUP },
303 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
304 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
305 { "format-patch", cmd_format_patch, RUN_SETUP },
306 { "fsck", cmd_fsck, RUN_SETUP },
307 { "fsck-objects", cmd_fsck, RUN_SETUP },
308 { "gc", cmd_gc, RUN_SETUP },
309 { "get-tar-commit-id", cmd_get_tar_commit_id },
310 { "grep", cmd_grep, RUN_SETUP | USE_PAGER },
311 { "help", cmd_help },
312 #ifndef NO_CURL
313 { "http-fetch", cmd_http_fetch, RUN_SETUP },
314 #endif
315 { "init", cmd_init_db },
316 { "init-db", cmd_init_db },
317 { "log", cmd_log, RUN_SETUP | USE_PAGER },
318 { "ls-files", cmd_ls_files, RUN_SETUP },
319 { "ls-tree", cmd_ls_tree, RUN_SETUP },
320 { "ls-remote", cmd_ls_remote },
321 { "mailinfo", cmd_mailinfo },
322 { "mailsplit", cmd_mailsplit },
323 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
324 { "merge-base", cmd_merge_base, RUN_SETUP },
325 { "merge-file", cmd_merge_file },
326 { "merge-ours", cmd_merge_ours, RUN_SETUP },
327 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
328 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
329 { "mktree", cmd_mktree, RUN_SETUP },
330 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
331 { "name-rev", cmd_name_rev, RUN_SETUP },
332 { "pack-objects", cmd_pack_objects, RUN_SETUP },
333 { "peek-remote", cmd_ls_remote },
334 { "pickaxe", cmd_blame, RUN_SETUP },
335 { "prune", cmd_prune, RUN_SETUP },
336 { "prune-packed", cmd_prune_packed, RUN_SETUP },
337 { "push", cmd_push, RUN_SETUP },
338 { "read-tree", cmd_read_tree, RUN_SETUP },
339 { "receive-pack", cmd_receive_pack },
340 { "reflog", cmd_reflog, RUN_SETUP },
341 { "remote", cmd_remote, RUN_SETUP },
342 { "repo-config", cmd_config },
343 { "rerere", cmd_rerere, RUN_SETUP },
344 { "reset", cmd_reset, RUN_SETUP },
345 { "rev-list", cmd_rev_list, RUN_SETUP },
346 { "rev-parse", cmd_rev_parse },
347 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
348 { "rm", cmd_rm, RUN_SETUP },
349 { "send-pack", cmd_send_pack, RUN_SETUP },
350 { "shortlog", cmd_shortlog, USE_PAGER },
351 { "show-branch", cmd_show_branch, RUN_SETUP },
352 { "show", cmd_show, RUN_SETUP | USE_PAGER },
353 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
354 { "stripspace", cmd_stripspace },
355 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
356 { "tag", cmd_tag, RUN_SETUP },
357 { "tar-tree", cmd_tar_tree },
358 { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
359 { "update-index", cmd_update_index, RUN_SETUP },
360 { "update-ref", cmd_update_ref, RUN_SETUP },
361 { "upload-archive", cmd_upload_archive },
362 { "verify-tag", cmd_verify_tag, RUN_SETUP },
363 { "version", cmd_version },
364 { "whatchanged", cmd_whatchanged, RUN_SETUP | USE_PAGER },
365 { "write-tree", cmd_write_tree, RUN_SETUP },
366 { "verify-pack", cmd_verify_pack },
367 { "show-ref", cmd_show_ref, RUN_SETUP },
368 { "pack-refs", cmd_pack_refs, RUN_SETUP },
370 int i;
371 static const char ext[] = STRIP_EXTENSION;
373 if (sizeof(ext) > 1) {
374 i = strlen(argv[0]) - strlen(ext);
375 if (i > 0 && !strcmp(argv[0] + i, ext)) {
376 char *argv0 = xstrdup(argv[0]);
377 argv[0] = cmd = argv0;
378 argv0[i] = '\0';
382 /* Turn "git cmd --help" into "git help cmd" */
383 if (argc > 1 && !strcmp(argv[1], "--help")) {
384 argv[1] = argv[0];
385 argv[0] = cmd = "help";
388 for (i = 0; i < ARRAY_SIZE(commands); i++) {
389 struct cmd_struct *p = commands+i;
390 if (strcmp(p->cmd, cmd))
391 continue;
392 exit(run_builtin(p, argc, argv));
396 static void execv_dashed_external(const char **argv)
398 struct strbuf cmd = STRBUF_INIT;
399 const char *tmp;
400 int status;
402 strbuf_addf(&cmd, "git-%s", argv[0]);
405 * argv[0] must be the git command, but the argv array
406 * belongs to the caller, and may be reused in
407 * subsequent loop iterations. Save argv[0] and
408 * restore it on error.
410 tmp = argv[0];
411 argv[0] = cmd.buf;
413 trace_argv_printf(argv, "trace: exec:");
416 * if we fail because the command is not found, it is
417 * OK to return. Otherwise, we just pass along the status code.
419 status = run_command_v_opt(argv, 0);
420 if (status != -ERR_RUN_COMMAND_EXEC) {
421 if (IS_RUN_COMMAND_ERR(status))
422 die("unable to run '%s'", argv[0]);
423 exit(-status);
425 errno = ENOENT; /* as if we called execvp */
427 argv[0] = tmp;
429 strbuf_release(&cmd);
432 static int run_argv(int *argcp, const char ***argv)
434 int done_alias = 0;
436 while (1) {
437 /* See if it's an internal command */
438 handle_internal_command(*argcp, *argv);
440 /* .. then try the external ones */
441 execv_dashed_external(*argv);
443 /* It could be an alias -- this works around the insanity
444 * of overriding "git log" with "git show" by having
445 * alias.log = show
447 if (done_alias || !handle_alias(argcp, argv))
448 break;
449 done_alias = 1;
452 return done_alias;
456 int main(int argc, const char **argv)
458 const char *cmd;
460 cmd = git_extract_argv0_path(argv[0]);
461 if (!cmd)
462 cmd = "git-help";
465 * "git-xxxx" is the same as "git xxxx", but we obviously:
467 * - cannot take flags in between the "git" and the "xxxx".
468 * - cannot execute it externally (since it would just do
469 * the same thing over again)
471 * So we just directly call the internal command handler, and
472 * die if that one cannot handle it.
474 if (!prefixcmp(cmd, "git-")) {
475 cmd += 4;
476 argv[0] = cmd;
477 handle_internal_command(argc, argv);
478 die("cannot handle %s internally", cmd);
481 /* Look for flags.. */
482 argv++;
483 argc--;
484 handle_options(&argv, &argc, NULL);
485 commit_pager_choice();
486 if (argc > 0) {
487 if (!prefixcmp(argv[0], "--"))
488 argv[0] += 2;
489 } else {
490 /* The user didn't specify a command; give them help */
491 printf("usage: %s\n\n", git_usage_string);
492 list_common_cmds_help();
493 printf("\n%s\n", git_more_info_string);
494 exit(1);
496 cmd = argv[0];
499 * We use PATH to find git commands, but we prepend some higher
500 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
501 * environment, and the $(gitexecdir) from the Makefile at build
502 * time.
504 setup_path();
506 while (1) {
507 static int done_help = 0;
508 static int was_alias = 0;
509 was_alias = run_argv(&argc, &argv);
510 if (errno != ENOENT)
511 break;
512 if (was_alias) {
513 fprintf(stderr, "Expansion of alias '%s' failed; "
514 "'%s' is not a git-command\n",
515 cmd, argv[0]);
516 exit(1);
518 if (!done_help) {
519 cmd = argv[0] = help_unknown_cmd(cmd);
520 done_help = 1;
521 } else
522 break;
525 fprintf(stderr, "Failed to run command '%s': %s\n",
526 cmd, strerror(errno));
528 return 1;