Make usage strings dash-less
[alt-git.git] / git.c
blob7075533aa7243abacf100cb8a8987284d5d144de
1 #include "builtin.h"
2 #include "exec_cmd.h"
3 #include "cache.h"
4 #include "quote.h"
6 const char git_usage_string[] =
7 "git [--version] [--exec-path[=GIT_EXEC_PATH]] [-p|--paginate|--no-pager] [--bare] [--git-dir=GIT_DIR] [--work-tree=GIT_WORK_TREE] [--help] COMMAND [ARGS]";
9 const char git_more_info_string[] =
10 "See 'git help COMMAND' for more information on a specific command.";
12 static int use_pager = -1;
13 struct pager_config {
14 const char *cmd;
15 int val;
18 static int pager_command_config(const char *var, const char *value, void *data)
20 struct pager_config *c = data;
21 if (!prefixcmp(var, "pager.") && !strcmp(var + 6, c->cmd))
22 c->val = git_config_bool(var, value);
23 return 0;
26 /* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
27 int check_pager_config(const char *cmd)
29 struct pager_config c;
30 c.cmd = cmd;
31 c.val = -1;
32 git_config(pager_command_config, &c);
33 return c.val;
36 static void commit_pager_choice(void) {
37 switch (use_pager) {
38 case 0:
39 setenv("GIT_PAGER", "cat", 1);
40 break;
41 case 1:
42 setup_pager();
43 break;
44 default:
45 break;
49 static int handle_options(const char*** argv, int* argc, int* envchanged)
51 int handled = 0;
53 while (*argc > 0) {
54 const char *cmd = (*argv)[0];
55 if (cmd[0] != '-')
56 break;
59 * For legacy reasons, the "version" and "help"
60 * commands can be written with "--" prepended
61 * to make them look like flags.
63 if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
64 break;
67 * Check remaining flags.
69 if (!prefixcmp(cmd, "--exec-path")) {
70 cmd += 11;
71 if (*cmd == '=')
72 git_set_argv_exec_path(cmd + 1);
73 else {
74 puts(git_exec_path());
75 exit(0);
77 } else if (!strcmp(cmd, "-p") || !strcmp(cmd, "--paginate")) {
78 use_pager = 1;
79 } else if (!strcmp(cmd, "--no-pager")) {
80 use_pager = 0;
81 if (envchanged)
82 *envchanged = 1;
83 } else if (!strcmp(cmd, "--git-dir")) {
84 if (*argc < 2) {
85 fprintf(stderr, "No directory given for --git-dir.\n" );
86 usage(git_usage_string);
88 setenv(GIT_DIR_ENVIRONMENT, (*argv)[1], 1);
89 if (envchanged)
90 *envchanged = 1;
91 (*argv)++;
92 (*argc)--;
93 handled++;
94 } else if (!prefixcmp(cmd, "--git-dir=")) {
95 setenv(GIT_DIR_ENVIRONMENT, cmd + 10, 1);
96 if (envchanged)
97 *envchanged = 1;
98 } else if (!strcmp(cmd, "--work-tree")) {
99 if (*argc < 2) {
100 fprintf(stderr, "No directory given for --work-tree.\n" );
101 usage(git_usage_string);
103 setenv(GIT_WORK_TREE_ENVIRONMENT, (*argv)[1], 1);
104 if (envchanged)
105 *envchanged = 1;
106 (*argv)++;
107 (*argc)--;
108 } else if (!prefixcmp(cmd, "--work-tree=")) {
109 setenv(GIT_WORK_TREE_ENVIRONMENT, cmd + 12, 1);
110 if (envchanged)
111 *envchanged = 1;
112 } else if (!strcmp(cmd, "--bare")) {
113 static char git_dir[PATH_MAX+1];
114 is_bare_repository_cfg = 1;
115 setenv(GIT_DIR_ENVIRONMENT, getcwd(git_dir, sizeof(git_dir)), 0);
116 if (envchanged)
117 *envchanged = 1;
118 } else {
119 fprintf(stderr, "Unknown option: %s\n", cmd);
120 usage(git_usage_string);
123 (*argv)++;
124 (*argc)--;
125 handled++;
127 return handled;
130 static int split_cmdline(char *cmdline, const char ***argv)
132 int src, dst, count = 0, size = 16;
133 char quoted = 0;
135 *argv = xmalloc(sizeof(char*) * size);
137 /* split alias_string */
138 (*argv)[count++] = cmdline;
139 for (src = dst = 0; cmdline[src];) {
140 char c = cmdline[src];
141 if (!quoted && isspace(c)) {
142 cmdline[dst++] = 0;
143 while (cmdline[++src]
144 && isspace(cmdline[src]))
145 ; /* skip */
146 if (count >= size) {
147 size += 16;
148 *argv = xrealloc(*argv, sizeof(char*) * size);
150 (*argv)[count++] = cmdline + dst;
151 } else if(!quoted && (c == '\'' || c == '"')) {
152 quoted = c;
153 src++;
154 } else if (c == quoted) {
155 quoted = 0;
156 src++;
157 } else {
158 if (c == '\\' && quoted != '\'') {
159 src++;
160 c = cmdline[src];
161 if (!c) {
162 free(*argv);
163 *argv = NULL;
164 return error("cmdline ends with \\");
167 cmdline[dst++] = c;
168 src++;
172 cmdline[dst] = 0;
174 if (quoted) {
175 free(*argv);
176 *argv = NULL;
177 return error("unclosed quote");
180 return count;
183 static int handle_alias(int *argcp, const char ***argv)
185 int envchanged = 0, ret = 0, saved_errno = errno;
186 const char *subdir;
187 int count, option_count;
188 const char** new_argv;
189 const char *alias_command;
190 char *alias_string;
191 int unused_nongit;
193 subdir = setup_git_directory_gently(&unused_nongit);
195 alias_command = (*argv)[0];
196 alias_string = alias_lookup(alias_command);
197 if (alias_string) {
198 if (alias_string[0] == '!') {
199 if (*argcp > 1) {
200 struct strbuf buf;
202 strbuf_init(&buf, PATH_MAX);
203 strbuf_addstr(&buf, alias_string);
204 sq_quote_argv(&buf, (*argv) + 1, PATH_MAX);
205 free(alias_string);
206 alias_string = buf.buf;
208 trace_printf("trace: alias to shell cmd: %s => %s\n",
209 alias_command, alias_string + 1);
210 ret = system(alias_string + 1);
211 if (ret >= 0 && WIFEXITED(ret) &&
212 WEXITSTATUS(ret) != 127)
213 exit(WEXITSTATUS(ret));
214 die("Failed to run '%s' when expanding alias '%s'\n",
215 alias_string + 1, alias_command);
217 count = split_cmdline(alias_string, &new_argv);
218 option_count = handle_options(&new_argv, &count, &envchanged);
219 if (envchanged)
220 die("alias '%s' changes environment variables\n"
221 "You can use '!git' in the alias to do this.",
222 alias_command);
223 memmove(new_argv - option_count, new_argv,
224 count * sizeof(char *));
225 new_argv -= option_count;
227 if (count < 1)
228 die("empty alias for %s", alias_command);
230 if (!strcmp(alias_command, new_argv[0]))
231 die("recursive alias: %s", alias_command);
233 trace_argv_printf(new_argv,
234 "trace: alias expansion: %s =>",
235 alias_command);
237 new_argv = xrealloc(new_argv, sizeof(char*) *
238 (count + *argcp + 1));
239 /* insert after command name */
240 memcpy(new_argv + count, *argv + 1, sizeof(char*) * *argcp);
241 new_argv[count+*argcp] = NULL;
243 *argv = new_argv;
244 *argcp += count - 1;
246 ret = 1;
249 if (subdir)
250 chdir(subdir);
252 errno = saved_errno;
254 return ret;
257 const char git_version_string[] = GIT_VERSION;
259 #define RUN_SETUP (1<<0)
260 #define USE_PAGER (1<<1)
262 * require working tree to be present -- anything uses this needs
263 * RUN_SETUP for reading from the configuration file.
265 #define NEED_WORK_TREE (1<<2)
267 struct cmd_struct {
268 const char *cmd;
269 int (*fn)(int, const char **, const char *);
270 int option;
273 static int run_command(struct cmd_struct *p, int argc, const char **argv)
275 int status;
276 struct stat st;
277 const char *prefix;
279 prefix = NULL;
280 if (p->option & RUN_SETUP)
281 prefix = setup_git_directory();
283 if (use_pager == -1 && p->option & RUN_SETUP)
284 use_pager = check_pager_config(p->cmd);
285 if (use_pager == -1 && p->option & USE_PAGER)
286 use_pager = 1;
287 commit_pager_choice();
289 if (p->option & NEED_WORK_TREE)
290 setup_work_tree();
292 trace_argv_printf(argv, "trace: built-in: git");
294 status = p->fn(argc, argv, prefix);
295 if (status)
296 return status & 0xff;
298 /* Somebody closed stdout? */
299 if (fstat(fileno(stdout), &st))
300 return 0;
301 /* Ignore write errors for pipes and sockets.. */
302 if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
303 return 0;
305 /* Check for ENOSPC and EIO errors.. */
306 if (fflush(stdout))
307 die("write failure on standard output: %s", strerror(errno));
308 if (ferror(stdout))
309 die("unknown write failure on standard output");
310 if (fclose(stdout))
311 die("close failed on standard output: %s", strerror(errno));
312 return 0;
315 static void handle_internal_command(int argc, const char **argv)
317 const char *cmd = argv[0];
318 static struct cmd_struct commands[] = {
319 { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
320 { "annotate", cmd_annotate, RUN_SETUP },
321 { "apply", cmd_apply },
322 { "archive", cmd_archive },
323 { "blame", cmd_blame, RUN_SETUP },
324 { "branch", cmd_branch, RUN_SETUP },
325 { "bundle", cmd_bundle },
326 { "cat-file", cmd_cat_file, RUN_SETUP },
327 { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
328 { "checkout-index", cmd_checkout_index,
329 RUN_SETUP | NEED_WORK_TREE},
330 { "check-ref-format", cmd_check_ref_format },
331 { "check-attr", cmd_check_attr, RUN_SETUP },
332 { "cherry", cmd_cherry, RUN_SETUP },
333 { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
334 { "clone", cmd_clone },
335 { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
336 { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
337 { "commit-tree", cmd_commit_tree, RUN_SETUP },
338 { "config", cmd_config },
339 { "count-objects", cmd_count_objects, RUN_SETUP },
340 { "describe", cmd_describe, RUN_SETUP },
341 { "diff", cmd_diff },
342 { "diff-files", cmd_diff_files, RUN_SETUP },
343 { "diff-index", cmd_diff_index, RUN_SETUP },
344 { "diff-tree", cmd_diff_tree, RUN_SETUP },
345 { "fast-export", cmd_fast_export, RUN_SETUP },
346 { "fetch", cmd_fetch, RUN_SETUP },
347 { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
348 { "fetch--tool", cmd_fetch__tool, RUN_SETUP },
349 { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
350 { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
351 { "format-patch", cmd_format_patch, RUN_SETUP },
352 { "fsck", cmd_fsck, RUN_SETUP },
353 { "fsck-objects", cmd_fsck, RUN_SETUP },
354 { "gc", cmd_gc, RUN_SETUP },
355 { "get-tar-commit-id", cmd_get_tar_commit_id },
356 { "grep", cmd_grep, RUN_SETUP | USE_PAGER },
357 { "help", cmd_help },
358 #ifndef NO_CURL
359 { "http-fetch", cmd_http_fetch, RUN_SETUP },
360 #endif
361 { "init", cmd_init_db },
362 { "init-db", cmd_init_db },
363 { "log", cmd_log, RUN_SETUP | USE_PAGER },
364 { "ls-files", cmd_ls_files, RUN_SETUP },
365 { "ls-tree", cmd_ls_tree, RUN_SETUP },
366 { "ls-remote", cmd_ls_remote },
367 { "mailinfo", cmd_mailinfo },
368 { "mailsplit", cmd_mailsplit },
369 { "merge-base", cmd_merge_base, RUN_SETUP },
370 { "merge-file", cmd_merge_file },
371 { "merge-ours", cmd_merge_ours, RUN_SETUP },
372 { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
373 { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
374 { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
375 { "name-rev", cmd_name_rev, RUN_SETUP },
376 { "pack-objects", cmd_pack_objects, RUN_SETUP },
377 { "peek-remote", cmd_ls_remote },
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 { "reflog", cmd_reflog, RUN_SETUP },
384 { "remote", cmd_remote, RUN_SETUP },
385 { "repo-config", cmd_config },
386 { "rerere", cmd_rerere, RUN_SETUP },
387 { "reset", cmd_reset, RUN_SETUP },
388 { "rev-list", cmd_rev_list, RUN_SETUP },
389 { "rev-parse", cmd_rev_parse },
390 { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
391 { "rm", cmd_rm, RUN_SETUP },
392 { "send-pack", cmd_send_pack, RUN_SETUP },
393 { "shortlog", cmd_shortlog, USE_PAGER },
394 { "show-branch", cmd_show_branch, RUN_SETUP },
395 { "show", cmd_show, RUN_SETUP | USE_PAGER },
396 { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE | USE_PAGER },
397 { "stripspace", cmd_stripspace },
398 { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
399 { "tag", cmd_tag, RUN_SETUP },
400 { "tar-tree", cmd_tar_tree },
401 { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
402 { "update-index", cmd_update_index, RUN_SETUP },
403 { "update-ref", cmd_update_ref, RUN_SETUP },
404 { "upload-archive", cmd_upload_archive },
405 { "verify-tag", cmd_verify_tag, RUN_SETUP },
406 { "version", cmd_version },
407 { "whatchanged", cmd_whatchanged, RUN_SETUP | USE_PAGER },
408 { "write-tree", cmd_write_tree, RUN_SETUP },
409 { "verify-pack", cmd_verify_pack },
410 { "show-ref", cmd_show_ref, RUN_SETUP },
411 { "pack-refs", cmd_pack_refs, RUN_SETUP },
413 int i;
414 static const char ext[] = STRIP_EXTENSION;
416 if (sizeof(ext) > 1) {
417 i = strlen(argv[0]) - strlen(ext);
418 if (i > 0 && !strcmp(argv[0] + i, ext)) {
419 char *argv0 = strdup(argv[0]);
420 argv[0] = cmd = argv0;
421 argv0[i] = '\0';
425 /* Turn "git cmd --help" into "git help cmd" */
426 if (argc > 1 && !strcmp(argv[1], "--help")) {
427 argv[1] = argv[0];
428 argv[0] = cmd = "help";
431 for (i = 0; i < ARRAY_SIZE(commands); i++) {
432 struct cmd_struct *p = commands+i;
433 if (strcmp(p->cmd, cmd))
434 continue;
435 exit(run_command(p, argc, argv));
439 static void execv_dashed_external(const char **argv)
441 struct strbuf cmd;
442 const char *tmp;
444 strbuf_init(&cmd, 0);
445 strbuf_addf(&cmd, "git-%s", argv[0]);
448 * argv[0] must be the git command, but the argv array
449 * belongs to the caller, and may be reused in
450 * subsequent loop iterations. Save argv[0] and
451 * restore it on error.
453 tmp = argv[0];
454 argv[0] = cmd.buf;
456 trace_argv_printf(argv, "trace: exec:");
458 /* execvp() can only ever return if it fails */
459 execvp(cmd.buf, (char **)argv);
461 trace_printf("trace: exec failed: %s\n", strerror(errno));
463 argv[0] = tmp;
465 strbuf_release(&cmd);
469 int main(int argc, const char **argv)
471 const char *cmd = argv[0] && *argv[0] ? argv[0] : "git-help";
472 char *slash = (char *)cmd + strlen(cmd);
473 const char *cmd_path = NULL;
474 int done_alias = 0;
477 * Take the basename of argv[0] as the command
478 * name, and the dirname as the default exec_path
479 * if we don't have anything better.
482 --slash;
483 while (cmd <= slash && !is_dir_sep(*slash));
484 if (cmd <= slash) {
485 *slash++ = 0;
486 cmd_path = cmd;
487 cmd = slash;
491 * "git-xxxx" is the same as "git xxxx", but we obviously:
493 * - cannot take flags in between the "git" and the "xxxx".
494 * - cannot execute it externally (since it would just do
495 * the same thing over again)
497 * So we just directly call the internal command handler, and
498 * die if that one cannot handle it.
500 if (!prefixcmp(cmd, "git-")) {
501 cmd += 4;
502 argv[0] = cmd;
503 handle_internal_command(argc, argv);
504 die("cannot handle %s internally", cmd);
507 /* Look for flags.. */
508 argv++;
509 argc--;
510 handle_options(&argv, &argc, NULL);
511 commit_pager_choice();
512 if (argc > 0) {
513 if (!prefixcmp(argv[0], "--"))
514 argv[0] += 2;
515 } else {
516 /* The user didn't specify a command; give them help */
517 printf("usage: %s\n\n", git_usage_string);
518 list_common_cmds_help();
519 printf("\n%s\n", git_more_info_string);
520 exit(1);
522 cmd = argv[0];
525 * We use PATH to find git commands, but we prepend some higher
526 * precidence paths: the "--exec-path" option, the GIT_EXEC_PATH
527 * environment, and the $(gitexecdir) from the Makefile at build
528 * time.
530 setup_path(cmd_path);
532 while (1) {
533 /* See if it's an internal command */
534 handle_internal_command(argc, argv);
536 /* .. then try the external ones */
537 execv_dashed_external(argv);
539 /* It could be an alias -- this works around the insanity
540 * of overriding "git log" with "git show" by having
541 * alias.log = show
543 if (done_alias || !handle_alias(&argc, &argv))
544 break;
545 done_alias = 1;
548 if (errno == ENOENT) {
549 if (done_alias) {
550 fprintf(stderr, "Expansion of alias '%s' failed; "
551 "'%s' is not a git-command\n",
552 cmd, argv[0]);
553 exit(1);
555 help_unknown_cmd(cmd);
558 fprintf(stderr, "Failed to run command '%s': %s\n",
559 cmd, strerror(errno));
561 return 1;