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