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