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