git-read-tree.txt: correct sparse-checkout and skip-worktree description
[git/dscho.git] / git.c
blob89721d420a09bfc8eb6a2d4010f86f5685cfd255
1 #include "builtin.h"
2 #include "cache.h"
3 #include "exec_cmd.h"
4 #include "help.h"
5 #include "quote.h"
6 #include "run-command.h"
8 const char git_usage_string[] =
9 "git [--version] [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]\n"
10 " [-p|--paginate|--no-pager] [--no-replace-objects]\n"
11 " [--bare] [--git-dir=<path>] [--work-tree=<path>]\n"
12 " [-c name=value] [--help]\n"
13 " <command> [<args>]";
15 const char git_more_info_string[] =
16 "See 'git help <command>' for more information on a specific command.";
18 static struct startup_info git_startup_info;
19 static int use_pager = -1;
20 struct pager_config {
21 const char *cmd;
22 int want;
23 char *value;
26 static int pager_command_config(const char *var, const char *value, void *data)
28 struct pager_config *c = data;
29 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd)) {
30 int b = git_config_maybe_bool(var, value);
31 if (b >= 0)
32 c->want = b;
33 else {
34 c->want = 1;
35 c->value = xstrdup(value);
38 return 0;
41 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
42 int check_pager_config(const char *cmd)
44 struct pager_config c;
45 c.cmd = cmd;
46 c.want = -1;
47 c.value = NULL;
48 git_config(pager_command_config, &c);
49 if (c.value)
50 pager_program = c.value;
51 return c.want;
54 static void commit_pager_choice(void) {
55 switch (use_pager) {
56 case 0:
57 setenv("GIT_PAGER", "cat", 1);
58 break;
59 case 1:
60 setup_pager();
61 break;
62 default:
63 break;
67 static int handle_options(const char ***argv, int *argc, int *envchanged)
69 const char **orig_argv = *argv;
71 while (*argc > 0) {
72 const char *cmd = (*argv)[0];
73 if (cmd[0] != '-')
74 break;
77 * For legacy reasons, the "version" and "help"
78 * commands can be written with "--" prepended
79 * to make them look like flags.
81 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
82 break;
85 * Check remaining flags.
87 if (!prefixcmp(cmd, "--exec-path")) {
88 cmd += 11;
89 if (*cmd == '=')
90 git_set_argv_exec_path(cmd + 1);
91 else {
92 puts(git_exec_path());
93 exit(0);
95 } else if (!strcmp(cmd, "--html-path")) {
96 puts(system_path(GIT_HTML_PATH));
97 exit(0);
98 } else if (!strcmp(cmd, "--man-path")) {
99 puts(system_path(GIT_MAN_PATH));
100 exit(0);
101 } else if (!strcmp(cmd, "--info-path")) {
102 puts(system_path(GIT_INFO_PATH));
103 exit(0);
104 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
105 use_pager = 1;
106 } else if (!strcmp(cmd, "--no-pager")) {
107 use_pager = 0;
108 if (envchanged)
109 *envchanged = 1;
110 } else if (!strcmp(cmd, "--no-replace-objects")) {
111 read_replace_refs = 0;
112 setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
113 if (envchanged)
114 *envchanged = 1;
115 } else if (!strcmp(cmd, "--git-dir")) {
116 if (*argc < 2) {
117 fprintf(stderr, "No directory given for --git-dir.\n" );
118 usage(git_usage_string);
120 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
121 if (envchanged)
122 *envchanged = 1;
123 (*argv)++;
124 (*argc)--;
125 } else if (!prefixcmp(cmd, "--git-dir=")) {
126 setenv(GIT_DIR_ENVIRONMENT, cmd + 10, 1);
127 if (envchanged)
128 *envchanged = 1;
129 } else if (!strcmp(cmd, "--work-tree")) {
130 if (*argc < 2) {
131 fprintf(stderr, "No directory given for --work-tree.\n" );
132 usage(git_usage_string);
134 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
135 if (envchanged)
136 *envchanged = 1;
137 (*argv)++;
138 (*argc)--;
139 } else if (!prefixcmp(cmd, "--work-tree=")) {
140 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd + 12, 1);
141 if (envchanged)
142 *envchanged = 1;
143 } else if (!strcmp(cmd, "--bare")) {
144 static char git_dir[PATH_MAX+1];
145 is_bare_repository_cfg = 1;
146 setenv(GIT_DIR_ENVIRONMENT, getcwd(git_dir, sizeof(git_dir)), 0);
147 if (envchanged)
148 *envchanged = 1;
149 } else if (!strcmp(cmd, "-c")) {
150 if (*argc < 2) {
151 fprintf(stderr, "-c expects a configuration string\n" );
152 usage(git_usage_string);
154 git_config_push_parameter((*argv)[1]);
155 (*argv)++;
156 (*argc)--;
157 } else {
158 fprintf(stderr, "Unknown option: %s\n", cmd);
159 usage(git_usage_string);
162 (*argv)++;
163 (*argc)--;
165 return (*argv) - orig_argv;
168 static int handle_alias(int *argcp, const char ***argv)
170 int envchanged = 0, ret = 0, saved_errno = errno;
171 const char *subdir;
172 int count, option_count;
173 const char **new_argv;
174 const char *alias_command;
175 char *alias_string;
176 int unused_nongit;
178 subdir = setup_git_directory_gently(&unused_nongit);
180 alias_command = (*argv)[0];
181 alias_string = alias_lookup(alias_command);
182 if (alias_string) {
183 if (alias_string[0] == '!') {
184 const char **alias_argv;
185 int argc = *argcp, i;
186 struct strbuf sb = STRBUF_INIT;
187 const char *env[2];
189 commit_pager_choice();
191 /* build alias_argv */
192 alias_argv = xmalloc(sizeof(*alias_argv) * (argc + 1));
193 alias_argv[0] = alias_string + 1;
194 for (i = 1; i < argc; ++i)
195 alias_argv[i] = (*argv)[i];
196 alias_argv[argc] = NULL;
198 strbuf_addstr(&sb, "GIT_PREFIX=");
199 if (subdir)
200 strbuf_addstr(&sb, subdir);
201 env[0] = sb.buf;
202 env[1] = NULL;
203 ret = run_command_v_opt_cd_env(alias_argv, RUN_USING_SHELL, NULL, env);
204 strbuf_release(&sb);
205 if (ret >= 0) /* normal exit */
206 exit(ret);
208 die_errno("While expanding alias '%s': '%s'",
209 alias_command, alias_string + 1);
211 count = split_cmdline(alias_string, &new_argv);
212 if (count < 0)
213 die("Bad alias.%s string: %s", alias_command,
214 split_cmdline_strerror(count));
215 option_count = handle_options(&new_argv, &count, &envchanged);
216 if (envchanged)
217 die("alias '%s' changes environment variables\n"
218 "You can use '!git' in the alias to do this.",
219 alias_command);
220 memmove(new_argv - option_count, new_argv,
221 count * sizeof(char *));
222 new_argv -= option_count;
224 if (count < 1)
225 die("empty alias for %s", alias_command);
227 if (!strcmp(alias_command, new_argv[0]))
228 die("recursive alias: %s", alias_command);
230 trace_argv_printf(new_argv,
231 "trace: alias expansion: %s =>",
232 alias_command);
234 new_argv = xrealloc(new_argv, sizeof(char *) *
235 (count + *argcp));
236 /* insert after command name */
237 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
239 *argv = new_argv;
240 *argcp += count - 1;
242 ret = 1;
245 if (subdir && chdir(subdir))
246 die_errno("Cannot change to '%s'", subdir);
248 errno = saved_errno;
250 return ret;
253 const char git_version_string[] = GIT_VERSION;
255 #define RUN_SETUP (1<<0)
256 #define RUN_SETUP_GENTLY (1<<1)
257 #define USE_PAGER (1<<2)
259 * require working tree to be present -- anything uses this needs
260 * RUN_SETUP for reading from the configuration file.
262 #define NEED_WORK_TREE (1<<3)
264 struct cmd_struct {
265 const char *cmd;
266 int (*fn)(int, const char **, const char *);
267 int option;
270 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
272 int status, help;
273 struct stat st;
274 const char *prefix;
276 prefix = NULL;
277 help = argc == 2 && !strcmp(argv[1], "-h");
278 if (!help) {
279 if (p->option & RUN_SETUP)
280 prefix = setup_git_directory();
281 if (p->option & RUN_SETUP_GENTLY) {
282 int nongit_ok;
283 prefix = setup_git_directory_gently(&nongit_ok);
286 if (use_pager == -1 && p->option & (RUN_SETUP | RUN_SETUP_GENTLY))
287 use_pager = check_pager_config(p->cmd);
288 if (use_pager == -1 && p->option & USE_PAGER)
289 use_pager = 1;
291 if ((p->option & (RUN_SETUP | RUN_SETUP_GENTLY)) &&
292 startup_info->have_repository) /* get_git_dir() may set up repo, avoid that */
293 trace_repo_setup(prefix);
295 commit_pager_choice();
297 if (!help && p->option & NEED_WORK_TREE)
298 setup_work_tree();
300 trace_argv_printf(argv, "trace: built-in: git");
302 status = p->fn(argc, argv, prefix);
303 if (status)
304 return status;
306 /* Somebody closed stdout? */
307 if (fstat(fileno(stdout), &st))
308 return 0;
309 /* Ignore write errors for pipes and sockets.. */
310 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
311 return 0;
313 /* Check for ENOSPC and EIO errors.. */
314 if (fflush(stdout))
315 die_errno("write failure on standard output");
316 if (ferror(stdout))
317 die("unknown write failure on standard output");
318 if (fclose(stdout))
319 die_errno("close failed on standard output");
320 return 0;
323 static void handle_internal_command(int argc, const char **argv)
325 const char *cmd = argv[0];
326 static struct cmd_struct commands[] = {
327 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
328 { "annotate", cmd_annotate, RUN_SETUP },
329 { "apply", cmd_apply, RUN_SETUP_GENTLY },
330 { "archive", cmd_archive },
331 { "bisect--helper", cmd_bisect__helper, RUN_SETUP | NEED_WORK_TREE },
332 { "blame", cmd_blame, RUN_SETUP },
333 { "branch", cmd_branch, RUN_SETUP },
334 { "bundle", cmd_bundle, RUN_SETUP_GENTLY },
335 { "cat-file", cmd_cat_file, RUN_SETUP },
336 { "check-attr", cmd_check_attr, RUN_SETUP },
337 { "check-ref-format", cmd_check_ref_format },
338 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
339 { "checkout-index", cmd_checkout_index,
340 RUN_SETUP | NEED_WORK_TREE},
341 { "cherry", cmd_cherry, RUN_SETUP },
342 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
343 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
344 { "clone", cmd_clone },
345 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
346 { "commit-tree", cmd_commit_tree, RUN_SETUP },
347 { "config", cmd_config, RUN_SETUP_GENTLY },
348 { "count-objects", cmd_count_objects, RUN_SETUP },
349 { "describe", cmd_describe, RUN_SETUP },
350 { "diff", cmd_diff },
351 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE },
352 { "diff-index", cmd_diff_index, RUN_SETUP },
353 { "diff-tree", cmd_diff_tree, RUN_SETUP },
354 { "fast-export", cmd_fast_export, RUN_SETUP },
355 { "fetch", cmd_fetch, RUN_SETUP },
356 { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
357 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
358 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
359 { "format-patch", cmd_format_patch, RUN_SETUP },
360 { "fsck", cmd_fsck, RUN_SETUP },
361 { "fsck-objects", cmd_fsck, RUN_SETUP },
362 { "gc", cmd_gc, RUN_SETUP },
363 { "get-tar-commit-id", cmd_get_tar_commit_id },
364 { "grep", cmd_grep, RUN_SETUP_GENTLY },
365 { "hash-object", cmd_hash_object },
366 { "help", cmd_help },
367 { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY },
368 { "init", cmd_init_db },
369 { "init-db", cmd_init_db },
370 { "log", cmd_log, RUN_SETUP },
371 { "ls-files", cmd_ls_files, RUN_SETUP },
372 { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
373 { "ls-tree", cmd_ls_tree, RUN_SETUP },
374 { "mailinfo", cmd_mailinfo },
375 { "mailsplit", cmd_mailsplit },
376 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
377 { "merge-base", cmd_merge_base, RUN_SETUP },
378 { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
379 { "merge-index", cmd_merge_index, RUN_SETUP },
380 { "merge-ours", cmd_merge_ours, RUN_SETUP },
381 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
382 { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
383 { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
384 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
385 { "merge-tree", cmd_merge_tree, RUN_SETUP },
386 { "mktag", cmd_mktag, RUN_SETUP },
387 { "mktree", cmd_mktree, RUN_SETUP },
388 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
389 { "name-rev", cmd_name_rev, RUN_SETUP },
390 { "notes", cmd_notes, RUN_SETUP },
391 { "pack-objects", cmd_pack_objects, RUN_SETUP },
392 { "pack-redundant", cmd_pack_redundant, RUN_SETUP },
393 { "pack-refs", cmd_pack_refs, RUN_SETUP },
394 { "patch-id", cmd_patch_id },
395 { "peek-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
396 { "pickaxe", cmd_blame, RUN_SETUP },
397 { "prune", cmd_prune, RUN_SETUP },
398 { "prune-packed", cmd_prune_packed, RUN_SETUP },
399 { "push", cmd_push, RUN_SETUP },
400 { "read-tree", cmd_read_tree, RUN_SETUP },
401 { "receive-pack", cmd_receive_pack },
402 { "reflog", cmd_reflog, RUN_SETUP },
403 { "remote", cmd_remote, RUN_SETUP },
404 { "remote-ext", cmd_remote_ext },
405 { "remote-fd", cmd_remote_fd },
406 { "replace", cmd_replace, RUN_SETUP },
407 { "repo-config", cmd_repo_config, RUN_SETUP_GENTLY },
408 { "rerere", cmd_rerere, RUN_SETUP },
409 { "reset", cmd_reset, RUN_SETUP },
410 { "rev-list", cmd_rev_list, RUN_SETUP },
411 { "rev-parse", cmd_rev_parse },
412 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
413 { "rm", cmd_rm, RUN_SETUP },
414 { "send-pack", cmd_send_pack, RUN_SETUP },
415 { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
416 { "show", cmd_show, RUN_SETUP },
417 { "show-branch", cmd_show_branch, RUN_SETUP },
418 { "show-ref", cmd_show_ref, RUN_SETUP },
419 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
420 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
421 { "stripspace", cmd_stripspace },
422 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
423 { "tag", cmd_tag, RUN_SETUP },
424 { "tar-tree", cmd_tar_tree },
425 { "unpack-file", cmd_unpack_file, RUN_SETUP },
426 { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
427 { "update-index", cmd_update_index, RUN_SETUP },
428 { "update-ref", cmd_update_ref, RUN_SETUP },
429 { "update-server-info", cmd_update_server_info, RUN_SETUP },
430 { "upload-archive", cmd_upload_archive },
431 { "var", cmd_var, RUN_SETUP_GENTLY },
432 { "verify-pack", cmd_verify_pack },
433 { "verify-tag", cmd_verify_tag, RUN_SETUP },
434 { "version", cmd_version },
435 { "whatchanged", cmd_whatchanged, RUN_SETUP },
436 { "write-tree", cmd_write_tree, RUN_SETUP },
438 int i;
439 static const char ext[] = STRIP_EXTENSION;
441 if (sizeof(ext) > 1) {
442 i = strlen(argv[0]) - strlen(ext);
443 if (i > 0 && !strcmp(argv[0] + i, ext)) {
444 char *argv0 = xstrdup(argv[0]);
445 argv[0] = cmd = argv0;
446 argv0[i] = '\0';
450 /* Turn "git cmd --help" into "git help cmd" */
451 if (argc > 1 && !strcmp(argv[1], "--help")) {
452 argv[1] = argv[0];
453 argv[0] = cmd = "help";
456 for (i = 0; i < ARRAY_SIZE(commands); i++) {
457 struct cmd_struct *p = commands+i;
458 if (strcmp(p->cmd, cmd))
459 continue;
460 exit(run_builtin(p, argc, argv));
464 static void execv_dashed_external(const char **argv)
466 struct strbuf cmd = STRBUF_INIT;
467 const char *tmp;
468 int status;
470 commit_pager_choice();
472 strbuf_addf(&cmd, "git-%s", argv[0]);
475 * argv[0] must be the git command, but the argv array
476 * belongs to the caller, and may be reused in
477 * subsequent loop iterations. Save argv[0] and
478 * restore it on error.
480 tmp = argv[0];
481 argv[0] = cmd.buf;
483 trace_argv_printf(argv, "trace: exec:");
486 * if we fail because the command is not found, it is
487 * OK to return. Otherwise, we just pass along the status code.
489 status = run_command_v_opt(argv, RUN_SILENT_EXEC_FAILURE);
490 if (status >= 0 || errno != ENOENT)
491 exit(status);
493 argv[0] = tmp;
495 strbuf_release(&cmd);
498 static int run_argv(int *argcp, const char ***argv)
500 int done_alias = 0;
502 while (1) {
503 /* See if it's an internal command */
504 handle_internal_command(*argcp, *argv);
506 /* .. then try the external ones */
507 execv_dashed_external(*argv);
509 /* It could be an alias -- this works around the insanity
510 * of overriding "git log" with "git show" by having
511 * alias.log = show
513 if (done_alias || !handle_alias(argcp, argv))
514 break;
515 done_alias = 1;
518 return done_alias;
522 int main(int argc, const char **argv)
524 const char *cmd;
526 startup_info = &git_startup_info;
528 cmd = git_extract_argv0_path(argv[0]);
529 if (!cmd)
530 cmd = "git-help";
533 * "git-xxxx" is the same as "git xxxx", but we obviously:
535 * - cannot take flags in between the "git" and the "xxxx".
536 * - cannot execute it externally (since it would just do
537 * the same thing over again)
539 * So we just directly call the internal command handler, and
540 * die if that one cannot handle it.
542 if (!prefixcmp(cmd, "git-")) {
543 cmd += 4;
544 argv[0] = cmd;
545 handle_internal_command(argc, argv);
546 die("cannot handle %s internally", cmd);
549 /* Look for flags.. */
550 argv++;
551 argc--;
552 handle_options(&argv, &argc, NULL);
553 if (argc > 0) {
554 if (!prefixcmp(argv[0], "--"))
555 argv[0] += 2;
556 } else {
557 /* The user didn't specify a command; give them help */
558 commit_pager_choice();
559 printf("usage: %s\n\n", git_usage_string);
560 list_common_cmds_help();
561 printf("\n%s\n", git_more_info_string);
562 exit(1);
564 cmd = argv[0];
567 * We use PATH to find git commands, but we prepend some higher
568 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
569 * environment, and the $(gitexecdir) from the Makefile at build
570 * time.
572 setup_path();
574 while (1) {
575 static int done_help = 0;
576 static int was_alias = 0;
577 was_alias = run_argv(&argc, &argv);
578 if (errno != ENOENT)
579 break;
580 if (was_alias) {
581 fprintf(stderr, "Expansion of alias '%s' failed; "
582 "'%s' is not a git command\n",
583 cmd, argv[0]);
584 exit(1);
586 if (!done_help) {
587 cmd = argv[0] = help_unknown_cmd(cmd);
588 done_help = 1;
589 } else
590 break;
593 fprintf(stderr, "Failed to run command '%s': %s\n",
594 cmd, strerror(errno));
596 return 1;