Extend documentation of core.askpass and GIT_ASKPASS.
[alt-git.git] / git.c
blob19a93fb9a2b5a95750154ebe352a43435ad1b47c
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]\n"
9 " [-p|--paginate|--no-pager] [--no-replace-objects]\n"
10 " [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE]\n"
11 " [-c name=value\n"
12 " [--help] COMMAND [ARGS]";
14 const char git_more_info_string[] =
15 "See 'git help COMMAND' for more information on a specific command.";
17 static int use_pager = -1;
18 struct pager_config {
19 const char *cmd;
20 int val;
23 static int pager_command_config(const char *var, const char *value, void *data)
25 struct pager_config *c = data;
26 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd))
27 c->val = git_config_bool(var, value);
28 return 0;
31 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
32 int check_pager_config(const char *cmd)
34 struct pager_config c;
35 c.cmd = cmd;
36 c.val = -1;
37 git_config(pager_command_config, &c);
38 return c.val;
41 static void commit_pager_choice(void) {
42 switch (use_pager) {
43 case 0:
44 setenv("GIT_PAGER", "cat", 1);
45 break;
46 case 1:
47 setup_pager();
48 break;
49 default:
50 break;
54 static int handle_options(const char ***argv, int *argc, int *envchanged)
56 int handled = 0;
58 while (*argc > 0) {
59 const char *cmd = (*argv)[0];
60 if (cmd[0] != '-')
61 break;
64 * For legacy reasons, the "version" and "help"
65 * commands can be written with "--" prepended
66 * to make them look like flags.
68 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
69 break;
72 * Check remaining flags.
74 if (!prefixcmp(cmd, "--exec-path")) {
75 cmd += 11;
76 if (*cmd == '=')
77 git_set_argv_exec_path(cmd + 1);
78 else {
79 puts(git_exec_path());
80 exit(0);
82 } else if (!strcmp(cmd, "--html-path")) {
83 puts(system_path(GIT_HTML_PATH));
84 exit(0);
85 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
86 use_pager = 1;
87 } else if (!strcmp(cmd, "--no-pager")) {
88 use_pager = 0;
89 if (envchanged)
90 *envchanged = 1;
91 } else if (!strcmp(cmd, "--no-replace-objects")) {
92 read_replace_refs = 0;
93 setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
94 if (envchanged)
95 *envchanged = 1;
96 } else if (!strcmp(cmd, "--git-dir")) {
97 if (*argc < 2) {
98 fprintf(stderr, "No directory given for --git-dir.\n" );
99 usage(git_usage_string);
101 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
102 if (envchanged)
103 *envchanged = 1;
104 (*argv)++;
105 (*argc)--;
106 handled++;
107 } else if (!prefixcmp(cmd, "--git-dir=")) {
108 setenv(GIT_DIR_ENVIRONMENT, cmd + 10, 1);
109 if (envchanged)
110 *envchanged = 1;
111 } else if (!strcmp(cmd, "--work-tree")) {
112 if (*argc < 2) {
113 fprintf(stderr, "No directory given for --work-tree.\n" );
114 usage(git_usage_string);
116 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
117 if (envchanged)
118 *envchanged = 1;
119 (*argv)++;
120 (*argc)--;
121 } else if (!prefixcmp(cmd, "--work-tree=")) {
122 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd + 12, 1);
123 if (envchanged)
124 *envchanged = 1;
125 } else if (!strcmp(cmd, "--bare")) {
126 static char git_dir[PATH_MAX+1];
127 is_bare_repository_cfg = 1;
128 setenv(GIT_DIR_ENVIRONMENT, getcwd(git_dir, sizeof(git_dir)), 0);
129 if (envchanged)
130 *envchanged = 1;
131 } else if (!strcmp(cmd, "-c")) {
132 if (*argc < 2) {
133 fprintf(stderr, "-c expects a configuration string\n" );
134 usage(git_usage_string);
136 git_config_parse_parameter((*argv)[1]);
137 (*argv)++;
138 (*argc)--;
139 } else {
140 fprintf(stderr, "Unknown option: %s\n", cmd);
141 usage(git_usage_string);
144 (*argv)++;
145 (*argc)--;
146 handled++;
148 return handled;
151 static int handle_alias(int *argcp, const char ***argv)
153 int envchanged = 0, ret = 0, saved_errno = errno;
154 const char *subdir;
155 int count, option_count;
156 const char **new_argv;
157 const char *alias_command;
158 char *alias_string;
159 int unused_nongit;
161 subdir = setup_git_directory_gently(&unused_nongit);
163 alias_command = (*argv)[0];
164 alias_string = alias_lookup(alias_command);
165 if (alias_string) {
166 if (alias_string[0] == '!') {
167 commit_pager_choice();
168 if (*argcp > 1) {
169 struct strbuf buf;
171 strbuf_init(&buf, PATH_MAX);
172 strbuf_addstr(&buf, alias_string);
173 sq_quote_argv(&buf, (*argv) + 1, PATH_MAX);
174 free(alias_string);
175 alias_string = buf.buf;
177 trace_printf("trace: alias to shell cmd: %s => %s\n",
178 alias_command, alias_string + 1);
179 ret = system(alias_string + 1);
180 if (ret >= 0 && WIFEXITED(ret) &&
181 WEXITSTATUS(ret) != 127)
182 exit(WEXITSTATUS(ret));
183 die("Failed to run '%s' when expanding alias '%s'",
184 alias_string + 1, alias_command);
186 count = split_cmdline(alias_string, &new_argv);
187 if (count < 0)
188 die("Bad alias.%s string", alias_command);
189 option_count = handle_options(&new_argv, &count, &envchanged);
190 if (envchanged)
191 die("alias '%s' changes environment variables\n"
192 "You can use '!git' in the alias to do this.",
193 alias_command);
194 memmove(new_argv - option_count, new_argv,
195 count * sizeof(char *));
196 new_argv -= option_count;
198 if (count < 1)
199 die("empty alias for %s", alias_command);
201 if (!strcmp(alias_command, new_argv[0]))
202 die("recursive alias: %s", alias_command);
204 trace_argv_printf(new_argv,
205 "trace: alias expansion: %s =>",
206 alias_command);
208 new_argv = xrealloc(new_argv, sizeof(char *) *
209 (count + *argcp));
210 /* insert after command name */
211 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
213 *argv = new_argv;
214 *argcp += count - 1;
216 ret = 1;
219 if (subdir && chdir(subdir))
220 die_errno("Cannot change to '%s'", subdir);
222 errno = saved_errno;
224 return ret;
227 const char git_version_string[] = GIT_VERSION;
229 #define RUN_SETUP (1<<0)
230 #define USE_PAGER (1<<1)
232 * require working tree to be present -- anything uses this needs
233 * RUN_SETUP for reading from the configuration file.
235 #define NEED_WORK_TREE (1<<2)
237 struct cmd_struct {
238 const char *cmd;
239 int (*fn)(int, const char **, const char *);
240 int option;
243 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
245 int status, help;
246 struct stat st;
247 const char *prefix;
249 prefix = NULL;
250 help = argc == 2 && !strcmp(argv[1], "-h");
251 if (!help) {
252 if (p->option & RUN_SETUP)
253 prefix = setup_git_directory();
255 if (use_pager == -1 && p->option & RUN_SETUP)
256 use_pager = check_pager_config(p->cmd);
257 if (use_pager == -1 && p->option & USE_PAGER)
258 use_pager = 1;
260 commit_pager_choice();
262 if (!help && p->option & NEED_WORK_TREE)
263 setup_work_tree();
265 trace_argv_printf(argv, "trace: built-in: git");
267 status = p->fn(argc, argv, prefix);
268 if (status)
269 return status;
271 /* Somebody closed stdout? */
272 if (fstat(fileno(stdout), &st))
273 return 0;
274 /* Ignore write errors for pipes and sockets.. */
275 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
276 return 0;
278 /* Check for ENOSPC and EIO errors.. */
279 if (fflush(stdout))
280 die_errno("write failure on standard output");
281 if (ferror(stdout))
282 die("unknown write failure on standard output");
283 if (fclose(stdout))
284 die_errno("close failed on standard output");
285 return 0;
288 static void handle_internal_command(int argc, const char **argv)
290 const char *cmd = argv[0];
291 static struct cmd_struct commands[] = {
292 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
293 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
294 { "annotate", cmd_annotate, RUN_SETUP },
295 { "apply", cmd_apply },
296 { "archive", cmd_archive },
297 { "bisect--helper", cmd_bisect__helper, RUN_SETUP | NEED_WORK_TREE },
298 { "blame", cmd_blame, RUN_SETUP },
299 { "branch", cmd_branch, RUN_SETUP },
300 { "bundle", cmd_bundle },
301 { "cat-file", cmd_cat_file, RUN_SETUP },
302 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
303 { "checkout-index", cmd_checkout_index,
304 RUN_SETUP | NEED_WORK_TREE},
305 { "check-ref-format", cmd_check_ref_format },
306 { "check-attr", cmd_check_attr, RUN_SETUP },
307 { "cherry", cmd_cherry, RUN_SETUP },
308 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
309 { "clone", cmd_clone },
310 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
311 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
312 { "commit-tree", cmd_commit_tree, RUN_SETUP },
313 { "config", cmd_config },
314 { "count-objects", cmd_count_objects, RUN_SETUP },
315 { "describe", cmd_describe, RUN_SETUP },
316 { "diff", cmd_diff },
317 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE },
318 { "diff-index", cmd_diff_index, RUN_SETUP },
319 { "diff-tree", cmd_diff_tree, RUN_SETUP },
320 { "fast-export", cmd_fast_export, RUN_SETUP },
321 { "fetch", cmd_fetch, RUN_SETUP },
322 { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
323 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
324 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
325 { "format-patch", cmd_format_patch, RUN_SETUP },
326 { "fsck", cmd_fsck, RUN_SETUP },
327 { "fsck-objects", cmd_fsck, RUN_SETUP },
328 { "gc", cmd_gc, RUN_SETUP },
329 { "get-tar-commit-id", cmd_get_tar_commit_id },
330 { "grep", cmd_grep },
331 { "hash-object", cmd_hash_object },
332 { "help", cmd_help },
333 { "index-pack", cmd_index_pack },
334 { "init", cmd_init_db },
335 { "init-db", cmd_init_db },
336 { "log", cmd_log, RUN_SETUP | USE_PAGER },
337 { "ls-files", cmd_ls_files, RUN_SETUP },
338 { "ls-tree", cmd_ls_tree, RUN_SETUP },
339 { "ls-remote", cmd_ls_remote },
340 { "mailinfo", cmd_mailinfo },
341 { "mailsplit", cmd_mailsplit },
342 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
343 { "merge-base", cmd_merge_base, RUN_SETUP },
344 { "merge-file", cmd_merge_file },
345 { "merge-index", cmd_merge_index, RUN_SETUP },
346 { "merge-ours", cmd_merge_ours, RUN_SETUP },
347 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
348 { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
349 { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
350 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
351 { "merge-tree", cmd_merge_tree, RUN_SETUP },
352 { "mktag", cmd_mktag, RUN_SETUP },
353 { "mktree", cmd_mktree, RUN_SETUP },
354 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
355 { "name-rev", cmd_name_rev, RUN_SETUP },
356 { "notes", cmd_notes, RUN_SETUP },
357 { "pack-objects", cmd_pack_objects, RUN_SETUP },
358 { "pack-redundant", cmd_pack_redundant, RUN_SETUP },
359 { "patch-id", cmd_patch_id },
360 { "peek-remote", cmd_ls_remote },
361 { "pickaxe", cmd_blame, RUN_SETUP },
362 { "prune", cmd_prune, RUN_SETUP },
363 { "prune-packed", cmd_prune_packed, RUN_SETUP },
364 { "push", cmd_push, RUN_SETUP },
365 { "read-tree", cmd_read_tree, RUN_SETUP },
366 { "receive-pack", cmd_receive_pack },
367 { "reflog", cmd_reflog, RUN_SETUP },
368 { "remote", cmd_remote, RUN_SETUP },
369 { "replace", cmd_replace, RUN_SETUP },
370 { "repo-config", cmd_config },
371 { "rerere", cmd_rerere, RUN_SETUP },
372 { "reset", cmd_reset, RUN_SETUP },
373 { "rev-list", cmd_rev_list, RUN_SETUP },
374 { "rev-parse", cmd_rev_parse },
375 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
376 { "rm", cmd_rm, RUN_SETUP },
377 { "send-pack", cmd_send_pack, RUN_SETUP },
378 { "shortlog", cmd_shortlog, USE_PAGER },
379 { "show-branch", cmd_show_branch, RUN_SETUP },
380 { "show", cmd_show, RUN_SETUP | USE_PAGER },
381 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
382 { "stripspace", cmd_stripspace },
383 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
384 { "tag", cmd_tag, RUN_SETUP },
385 { "tar-tree", cmd_tar_tree },
386 { "unpack-file", cmd_unpack_file, RUN_SETUP },
387 { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
388 { "update-index", cmd_update_index, RUN_SETUP },
389 { "update-ref", cmd_update_ref, RUN_SETUP },
390 { "update-server-info", cmd_update_server_info, RUN_SETUP },
391 { "upload-archive", cmd_upload_archive },
392 { "var", cmd_var },
393 { "verify-tag", cmd_verify_tag, RUN_SETUP },
394 { "version", cmd_version },
395 { "whatchanged", cmd_whatchanged, RUN_SETUP | USE_PAGER },
396 { "write-tree", cmd_write_tree, RUN_SETUP },
397 { "verify-pack", cmd_verify_pack },
398 { "show-ref", cmd_show_ref, RUN_SETUP },
399 { "pack-refs", cmd_pack_refs, RUN_SETUP },
401 int i;
402 static const char ext[] = STRIP_EXTENSION;
404 if (sizeof(ext) > 1) {
405 i = strlen(argv[0]) - strlen(ext);
406 if (i > 0 && !strcmp(argv[0] + i, ext)) {
407 char *argv0 = xstrdup(argv[0]);
408 argv[0] = cmd = argv0;
409 argv0[i] = '\0';
413 /* Turn "git cmd --help" into "git help cmd" */
414 if (argc > 1 && !strcmp(argv[1], "--help")) {
415 argv[1] = argv[0];
416 argv[0] = cmd = "help";
419 for (i = 0; i < ARRAY_SIZE(commands); i++) {
420 struct cmd_struct *p = commands+i;
421 if (strcmp(p->cmd, cmd))
422 continue;
423 exit(run_builtin(p, argc, argv));
427 static void execv_dashed_external(const char **argv)
429 struct strbuf cmd = STRBUF_INIT;
430 const char *tmp;
431 int status;
433 commit_pager_choice();
435 strbuf_addf(&cmd, "git-%s", argv[0]);
438 * argv[0] must be the git command, but the argv array
439 * belongs to the caller, and may be reused in
440 * subsequent loop iterations. Save argv[0] and
441 * restore it on error.
443 tmp = argv[0];
444 argv[0] = cmd.buf;
446 trace_argv_printf(argv, "trace: exec:");
449 * if we fail because the command is not found, it is
450 * OK to return. Otherwise, we just pass along the status code.
452 status = run_command_v_opt(argv, RUN_SILENT_EXEC_FAILURE);
453 if (status >= 0 || errno != ENOENT)
454 exit(status);
456 argv[0] = tmp;
458 strbuf_release(&cmd);
461 static int run_argv(int *argcp, const char ***argv)
463 int done_alias = 0;
465 while (1) {
466 /* See if it's an internal command */
467 handle_internal_command(*argcp, *argv);
469 /* .. then try the external ones */
470 execv_dashed_external(*argv);
472 /* It could be an alias -- this works around the insanity
473 * of overriding "git log" with "git show" by having
474 * alias.log = show
476 if (done_alias || !handle_alias(argcp, argv))
477 break;
478 done_alias = 1;
481 return done_alias;
485 int main(int argc, const char **argv)
487 const char *cmd;
489 cmd = git_extract_argv0_path(argv[0]);
490 if (!cmd)
491 cmd = "git-help";
494 * "git-xxxx" is the same as "git xxxx", but we obviously:
496 * - cannot take flags in between the "git" and the "xxxx".
497 * - cannot execute it externally (since it would just do
498 * the same thing over again)
500 * So we just directly call the internal command handler, and
501 * die if that one cannot handle it.
503 if (!prefixcmp(cmd, "git-")) {
504 cmd += 4;
505 argv[0] = cmd;
506 handle_internal_command(argc, argv);
507 die("cannot handle %s internally", cmd);
510 /* Look for flags.. */
511 argv++;
512 argc--;
513 handle_options(&argv, &argc, NULL);
514 if (argc > 0) {
515 if (!prefixcmp(argv[0], "--"))
516 argv[0] += 2;
517 } else {
518 /* The user didn't specify a command; give them help */
519 commit_pager_choice();
520 printf("usage: %s\n\n", git_usage_string);
521 list_common_cmds_help();
522 printf("\n%s\n", git_more_info_string);
523 exit(1);
525 cmd = argv[0];
528 * We use PATH to find git commands, but we prepend some higher
529 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
530 * environment, and the $(gitexecdir) from the Makefile at build
531 * time.
533 setup_path();
535 while (1) {
536 static int done_help = 0;
537 static int was_alias = 0;
538 was_alias = run_argv(&argc, &argv);
539 if (errno != ENOENT)
540 break;
541 if (was_alias) {
542 fprintf(stderr, "Expansion of alias '%s' failed; "
543 "'%s' is not a git command\n",
544 cmd, argv[0]);
545 exit(1);
547 if (!done_help) {
548 cmd = argv[0] = help_unknown_cmd(cmd);
549 done_help = 1;
550 } else
551 break;
554 fprintf(stderr, "Failed to run command '%s': %s\n",
555 cmd, strerror(errno));
557 return 1;