git-relink: use a lowercase "usage:" string
[git/mjg.git] / git.c
blobb10c18b0419904631d7e8fa4a1fd11e8533b3034
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] [--bare]\n"
11 " [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]\n"
12 " [-c name=value] [--help]\n"
13 " <command> [<args>]";
15 const char git_more_info_string[] =
16 N_("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;
21 static void commit_pager_choice(void) {
22 switch (use_pager) {
23 case 0:
24 setenv("GIT_PAGER", "cat", 1);
25 break;
26 case 1:
27 setup_pager();
28 break;
29 default:
30 break;
34 static int handle_options(const char ***argv, int *argc, int *envchanged)
36 const char **orig_argv = *argv;
38 while (*argc > 0) {
39 const char *cmd = (*argv)[0];
40 if (cmd[0] != '-')
41 break;
44 * For legacy reasons, the "version" and "help"
45 * commands can be written with "--" prepended
46 * to make them look like flags.
48 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
49 break;
52 * Check remaining flags.
54 if (!prefixcmp(cmd, "--exec-path")) {
55 cmd += 11;
56 if (*cmd == '=')
57 git_set_argv_exec_path(cmd + 1);
58 else {
59 puts(git_exec_path());
60 exit(0);
62 } else if (!strcmp(cmd, "--html-path")) {
63 puts(system_path(GIT_HTML_PATH));
64 exit(0);
65 } else if (!strcmp(cmd, "--man-path")) {
66 puts(system_path(GIT_MAN_PATH));
67 exit(0);
68 } else if (!strcmp(cmd, "--info-path")) {
69 puts(system_path(GIT_INFO_PATH));
70 exit(0);
71 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
72 use_pager = 1;
73 } else if (!strcmp(cmd, "--no-pager")) {
74 use_pager = 0;
75 if (envchanged)
76 *envchanged = 1;
77 } else if (!strcmp(cmd, "--no-replace-objects")) {
78 read_replace_refs = 0;
79 setenv(NO_REPLACE_OBJECTS_ENVIRONMENT, "1", 1);
80 if (envchanged)
81 *envchanged = 1;
82 } else if (!strcmp(cmd, "--git-dir")) {
83 if (*argc < 2) {
84 fprintf(stderr, "No directory given for --git-dir.\n" );
85 usage(git_usage_string);
87 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
88 if (envchanged)
89 *envchanged = 1;
90 (*argv)++;
91 (*argc)--;
92 } else if (!prefixcmp(cmd, "--git-dir=")) {
93 setenv(GIT_DIR_ENVIRONMENT, cmd + 10, 1);
94 if (envchanged)
95 *envchanged = 1;
96 } else if (!strcmp(cmd, "--namespace")) {
97 if (*argc < 2) {
98 fprintf(stderr, "No namespace given for --namespace.\n" );
99 usage(git_usage_string);
101 setenv(GIT_NAMESPACE_ENVIRONMENT, (*argv)[1], 1);
102 if (envchanged)
103 *envchanged = 1;
104 (*argv)++;
105 (*argc)--;
106 } else if (!prefixcmp(cmd, "--namespace=")) {
107 setenv(GIT_NAMESPACE_ENVIRONMENT, cmd + 12, 1);
108 if (envchanged)
109 *envchanged = 1;
110 } else if (!strcmp(cmd, "--work-tree")) {
111 if (*argc < 2) {
112 fprintf(stderr, "No directory given for --work-tree.\n" );
113 usage(git_usage_string);
115 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
116 if (envchanged)
117 *envchanged = 1;
118 (*argv)++;
119 (*argc)--;
120 } else if (!prefixcmp(cmd, "--work-tree=")) {
121 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd + 12, 1);
122 if (envchanged)
123 *envchanged = 1;
124 } else if (!strcmp(cmd, "--bare")) {
125 static char git_dir[PATH_MAX+1];
126 is_bare_repository_cfg = 1;
127 setenv(GIT_DIR_ENVIRONMENT, getcwd(git_dir, sizeof(git_dir)), 0);
128 if (envchanged)
129 *envchanged = 1;
130 } else if (!strcmp(cmd, "-c")) {
131 if (*argc < 2) {
132 fprintf(stderr, "-c expects a configuration string\n" );
133 usage(git_usage_string);
135 git_config_push_parameter((*argv)[1]);
136 (*argv)++;
137 (*argc)--;
138 } else if (!strcmp(cmd, "--literal-pathspecs")) {
139 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "1", 1);
140 if (envchanged)
141 *envchanged = 1;
142 } else if (!strcmp(cmd, "--no-literal-pathspecs")) {
143 setenv(GIT_LITERAL_PATHSPECS_ENVIRONMENT, "0", 1);
144 if (envchanged)
145 *envchanged = 1;
146 } else {
147 fprintf(stderr, "Unknown option: %s\n", cmd);
148 usage(git_usage_string);
151 (*argv)++;
152 (*argc)--;
154 return (*argv) - orig_argv;
157 static int handle_alias(int *argcp, const char ***argv)
159 int envchanged = 0, ret = 0, saved_errno = errno;
160 const char *subdir;
161 int count, option_count;
162 const char **new_argv;
163 const char *alias_command;
164 char *alias_string;
165 int unused_nongit;
167 subdir = setup_git_directory_gently(&unused_nongit);
169 alias_command = (*argv)[0];
170 alias_string = alias_lookup(alias_command);
171 if (alias_string) {
172 if (alias_string[0] == '!') {
173 const char **alias_argv;
174 int argc = *argcp, i;
176 commit_pager_choice();
178 /* build alias_argv */
179 alias_argv = xmalloc(sizeof(*alias_argv) * (argc + 1));
180 alias_argv[0] = alias_string + 1;
181 for (i = 1; i < argc; ++i)
182 alias_argv[i] = (*argv)[i];
183 alias_argv[argc] = NULL;
185 ret = run_command_v_opt(alias_argv, RUN_USING_SHELL);
186 if (ret >= 0) /* normal exit */
187 exit(ret);
189 die_errno("While expanding alias '%s': '%s'",
190 alias_command, alias_string + 1);
192 count = split_cmdline(alias_string, &new_argv);
193 if (count < 0)
194 die("Bad alias.%s string: %s", alias_command,
195 split_cmdline_strerror(count));
196 option_count = handle_options(&new_argv, &count, &envchanged);
197 if (envchanged)
198 die("alias '%s' changes environment variables\n"
199 "You can use '!git' in the alias to do this.",
200 alias_command);
201 memmove(new_argv - option_count, new_argv,
202 count * sizeof(char *));
203 new_argv -= option_count;
205 if (count < 1)
206 die("empty alias for %s", alias_command);
208 if (!strcmp(alias_command, new_argv[0]))
209 die("recursive alias: %s", alias_command);
211 trace_argv_printf(new_argv,
212 "trace: alias expansion: %s =>",
213 alias_command);
215 new_argv = xrealloc(new_argv, sizeof(char *) *
216 (count + *argcp));
217 /* insert after command name */
218 memcpy(new_argv + count, *argv + 1, sizeof(char *) * *argcp);
220 *argv = new_argv;
221 *argcp += count - 1;
223 ret = 1;
226 if (subdir && chdir(subdir))
227 die_errno("Cannot change to '%s'", subdir);
229 errno = saved_errno;
231 return ret;
234 #define RUN_SETUP (1<<0)
235 #define RUN_SETUP_GENTLY (1<<1)
236 #define USE_PAGER (1<<2)
238 * require working tree to be present -- anything uses this needs
239 * RUN_SETUP for reading from the configuration file.
241 #define NEED_WORK_TREE (1<<3)
243 struct cmd_struct {
244 const char *cmd;
245 int (*fn)(int, const char **, const char *);
246 int option;
249 static int run_builtin(struct cmd_struct *p, int argc, const char **argv)
251 int status, help;
252 struct stat st;
253 const char *prefix;
255 prefix = NULL;
256 help = argc == 2 && !strcmp(argv[1], "-h");
257 if (!help) {
258 if (p->option & RUN_SETUP)
259 prefix = setup_git_directory();
260 if (p->option & RUN_SETUP_GENTLY) {
261 int nongit_ok;
262 prefix = setup_git_directory_gently(&nongit_ok);
265 if (use_pager == -1 && p->option & (RUN_SETUP | RUN_SETUP_GENTLY))
266 use_pager = check_pager_config(p->cmd);
267 if (use_pager == -1 && p->option & USE_PAGER)
268 use_pager = 1;
270 if ((p->option & (RUN_SETUP | RUN_SETUP_GENTLY)) &&
271 startup_info->have_repository) /* get_git_dir() may set up repo, avoid that */
272 trace_repo_setup(prefix);
274 commit_pager_choice();
276 if (!help && p->option & NEED_WORK_TREE)
277 setup_work_tree();
279 trace_argv_printf(argv, "trace: built-in: git");
281 status = p->fn(argc, argv, prefix);
282 if (status)
283 return status;
285 /* Somebody closed stdout? */
286 if (fstat(fileno(stdout), &st))
287 return 0;
288 /* Ignore write errors for pipes and sockets.. */
289 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
290 return 0;
292 /* Check for ENOSPC and EIO errors.. */
293 if (fflush(stdout))
294 die_errno("write failure on standard output");
295 if (ferror(stdout))
296 die("unknown write failure on standard output");
297 if (fclose(stdout))
298 die_errno("close failed on standard output");
299 return 0;
302 static void handle_internal_command(int argc, const char **argv)
304 const char *cmd = argv[0];
305 static struct cmd_struct commands[] = {
306 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
307 { "annotate", cmd_annotate, RUN_SETUP },
308 { "apply", cmd_apply, RUN_SETUP_GENTLY },
309 { "archive", cmd_archive },
310 { "bisect--helper", cmd_bisect__helper, RUN_SETUP },
311 { "blame", cmd_blame, RUN_SETUP },
312 { "branch", cmd_branch, RUN_SETUP },
313 { "bundle", cmd_bundle, RUN_SETUP_GENTLY },
314 { "cat-file", cmd_cat_file, RUN_SETUP },
315 { "check-attr", cmd_check_attr, RUN_SETUP },
316 { "check-ignore", cmd_check_ignore, RUN_SETUP | NEED_WORK_TREE },
317 { "check-ref-format", cmd_check_ref_format },
318 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
319 { "checkout-index", cmd_checkout_index,
320 RUN_SETUP | NEED_WORK_TREE},
321 { "cherry", cmd_cherry, RUN_SETUP },
322 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
323 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
324 { "clone", cmd_clone },
325 { "column", cmd_column, RUN_SETUP_GENTLY },
326 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
327 { "commit-tree", cmd_commit_tree, RUN_SETUP },
328 { "config", cmd_config, RUN_SETUP_GENTLY },
329 { "count-objects", cmd_count_objects, RUN_SETUP },
330 { "credential", cmd_credential, RUN_SETUP_GENTLY },
331 { "describe", cmd_describe, RUN_SETUP },
332 { "diff", cmd_diff },
333 { "diff-files", cmd_diff_files, RUN_SETUP | NEED_WORK_TREE },
334 { "diff-index", cmd_diff_index, RUN_SETUP },
335 { "diff-tree", cmd_diff_tree, RUN_SETUP },
336 { "fast-export", cmd_fast_export, RUN_SETUP },
337 { "fetch", cmd_fetch, RUN_SETUP },
338 { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
339 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
340 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
341 { "format-patch", cmd_format_patch, RUN_SETUP },
342 { "fsck", cmd_fsck, RUN_SETUP },
343 { "fsck-objects", cmd_fsck, RUN_SETUP },
344 { "gc", cmd_gc, RUN_SETUP },
345 { "get-tar-commit-id", cmd_get_tar_commit_id },
346 { "grep", cmd_grep, RUN_SETUP_GENTLY },
347 { "hash-object", cmd_hash_object },
348 { "help", cmd_help },
349 { "index-pack", cmd_index_pack, RUN_SETUP_GENTLY },
350 { "init", cmd_init_db },
351 { "init-db", cmd_init_db },
352 { "log", cmd_log, RUN_SETUP },
353 { "ls-files", cmd_ls_files, RUN_SETUP },
354 { "ls-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
355 { "ls-tree", cmd_ls_tree, RUN_SETUP },
356 { "mailinfo", cmd_mailinfo },
357 { "mailsplit", cmd_mailsplit },
358 { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
359 { "merge-base", cmd_merge_base, RUN_SETUP },
360 { "merge-file", cmd_merge_file, RUN_SETUP_GENTLY },
361 { "merge-index", cmd_merge_index, RUN_SETUP },
362 { "merge-ours", cmd_merge_ours, RUN_SETUP },
363 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
364 { "merge-recursive-ours", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
365 { "merge-recursive-theirs", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
366 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
367 { "merge-tree", cmd_merge_tree, RUN_SETUP },
368 { "mktag", cmd_mktag, RUN_SETUP },
369 { "mktree", cmd_mktree, RUN_SETUP },
370 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
371 { "name-rev", cmd_name_rev, RUN_SETUP },
372 { "notes", cmd_notes, RUN_SETUP },
373 { "pack-objects", cmd_pack_objects, RUN_SETUP },
374 { "pack-redundant", cmd_pack_redundant, RUN_SETUP },
375 { "pack-refs", cmd_pack_refs, RUN_SETUP },
376 { "patch-id", cmd_patch_id },
377 { "peek-remote", cmd_ls_remote, RUN_SETUP_GENTLY },
378 { "pickaxe", cmd_blame, RUN_SETUP },
379 { "prune", cmd_prune, RUN_SETUP },
380 { "prune-packed", cmd_prune_packed, RUN_SETUP },
381 { "push", cmd_push, RUN_SETUP },
382 { "read-tree", cmd_read_tree, RUN_SETUP },
383 { "receive-pack", cmd_receive_pack },
384 { "reflog", cmd_reflog, RUN_SETUP },
385 { "remote", cmd_remote, RUN_SETUP },
386 { "remote-ext", cmd_remote_ext },
387 { "remote-fd", cmd_remote_fd },
388 { "replace", cmd_replace, RUN_SETUP },
389 { "repo-config", cmd_repo_config, RUN_SETUP_GENTLY },
390 { "rerere", cmd_rerere, RUN_SETUP },
391 { "reset", cmd_reset, RUN_SETUP },
392 { "rev-list", cmd_rev_list, RUN_SETUP },
393 { "rev-parse", cmd_rev_parse },
394 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
395 { "rm", cmd_rm, RUN_SETUP },
396 { "send-pack", cmd_send_pack, RUN_SETUP },
397 { "shortlog", cmd_shortlog, RUN_SETUP_GENTLY | USE_PAGER },
398 { "show", cmd_show, RUN_SETUP },
399 { "show-branch", cmd_show_branch, RUN_SETUP },
400 { "show-ref", cmd_show_ref, RUN_SETUP },
401 { "stage", cmd_add, RUN_SETUP | NEED_WORK_TREE },
402 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
403 { "stripspace", cmd_stripspace },
404 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
405 { "tag", cmd_tag, RUN_SETUP },
406 { "tar-tree", cmd_tar_tree },
407 { "unpack-file", cmd_unpack_file, RUN_SETUP },
408 { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
409 { "update-index", cmd_update_index, RUN_SETUP },
410 { "update-ref", cmd_update_ref, RUN_SETUP },
411 { "update-server-info", cmd_update_server_info, RUN_SETUP },
412 { "upload-archive", cmd_upload_archive },
413 { "upload-archive--writer", cmd_upload_archive_writer },
414 { "var", cmd_var, RUN_SETUP_GENTLY },
415 { "verify-pack", cmd_verify_pack },
416 { "verify-tag", cmd_verify_tag, RUN_SETUP },
417 { "version", cmd_version },
418 { "whatchanged", cmd_whatchanged, RUN_SETUP },
419 { "write-tree", cmd_write_tree, RUN_SETUP },
421 int i;
422 static const char ext[] = STRIP_EXTENSION;
424 if (sizeof(ext) > 1) {
425 i = strlen(argv[0]) - strlen(ext);
426 if (i > 0 && !strcmp(argv[0] + i, ext)) {
427 char *argv0 = xstrdup(argv[0]);
428 argv[0] = cmd = argv0;
429 argv0[i] = '\0';
433 /* Turn "git cmd --help" into "git help cmd" */
434 if (argc > 1 && !strcmp(argv[1], "--help")) {
435 argv[1] = argv[0];
436 argv[0] = cmd = "help";
439 for (i = 0; i < ARRAY_SIZE(commands); i++) {
440 struct cmd_struct *p = commands+i;
441 if (strcmp(p->cmd, cmd))
442 continue;
443 exit(run_builtin(p, argc, argv));
447 static void execv_dashed_external(const char **argv)
449 struct strbuf cmd = STRBUF_INIT;
450 const char *tmp;
451 int status;
453 if (use_pager == -1)
454 use_pager = check_pager_config(argv[0]);
455 commit_pager_choice();
457 strbuf_addf(&cmd, "git-%s", argv[0]);
460 * argv[0] must be the git command, but the argv array
461 * belongs to the caller, and may be reused in
462 * subsequent loop iterations. Save argv[0] and
463 * restore it on error.
465 tmp = argv[0];
466 argv[0] = cmd.buf;
468 trace_argv_printf(argv, "trace: exec:");
471 * if we fail because the command is not found, it is
472 * OK to return. Otherwise, we just pass along the status code.
474 status = run_command_v_opt(argv, RUN_SILENT_EXEC_FAILURE | RUN_CLEAN_ON_EXIT);
475 if (status >= 0 || errno != ENOENT)
476 exit(status);
478 argv[0] = tmp;
480 strbuf_release(&cmd);
483 static int run_argv(int *argcp, const char ***argv)
485 int done_alias = 0;
487 while (1) {
488 /* See if it's an internal command */
489 handle_internal_command(*argcp, *argv);
491 /* .. then try the external ones */
492 execv_dashed_external(*argv);
494 /* It could be an alias -- this works around the insanity
495 * of overriding "git log" with "git show" by having
496 * alias.log = show
498 if (done_alias || !handle_alias(argcp, argv))
499 break;
500 done_alias = 1;
503 return done_alias;
507 int main(int argc, const char **argv)
509 const char *cmd;
511 startup_info = &git_startup_info;
513 cmd = git_extract_argv0_path(argv[0]);
514 if (!cmd)
515 cmd = "git-help";
517 git_setup_gettext();
520 * "git-xxxx" is the same as "git xxxx", but we obviously:
522 * - cannot take flags in between the "git" and the "xxxx".
523 * - cannot execute it externally (since it would just do
524 * the same thing over again)
526 * So we just directly call the internal command handler, and
527 * die if that one cannot handle it.
529 if (!prefixcmp(cmd, "git-")) {
530 cmd += 4;
531 argv[0] = cmd;
532 handle_internal_command(argc, argv);
533 die("cannot handle %s internally", cmd);
536 /* Look for flags.. */
537 argv++;
538 argc--;
539 handle_options(&argv, &argc, NULL);
540 if (argc > 0) {
541 if (!prefixcmp(argv[0], "--"))
542 argv[0] += 2;
543 } else {
544 /* The user didn't specify a command; give them help */
545 commit_pager_choice();
546 printf("usage: %s\n\n", git_usage_string);
547 list_common_cmds_help();
548 printf("\n%s\n", git_more_info_string);
549 exit(1);
551 cmd = argv[0];
554 * We use PATH to find git commands, but we prepend some higher
555 * precedence paths: the "--exec-path" option, the GIT_EXEC_PATH
556 * environment, and the $(gitexecdir) from the Makefile at build
557 * time.
559 setup_path();
561 while (1) {
562 static int done_help = 0;
563 static int was_alias = 0;
564 was_alias = run_argv(&argc, &argv);
565 if (errno != ENOENT)
566 break;
567 if (was_alias) {
568 fprintf(stderr, "Expansion of alias '%s' failed; "
569 "'%s' is not a git command\n",
570 cmd, argv[0]);
571 exit(1);
573 if (!done_help) {
574 cmd = argv[0] = help_unknown_cmd(cmd);
575 done_help = 1;
576 } else
577 break;
580 fprintf(stderr, "Failed to run command '%s': %s\n",
581 cmd, strerror(errno));
583 return 1;