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