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