git.con commit correct usage help string for git-hash-object (9ae8e00)
   1#include "builtin.h"
   2#include "exec_cmd.h"
   3#include "cache.h"
   4#include "quote.h"
   5
   6const 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]";
   8
   9const char git_more_info_string[] =
  10        "See 'git help COMMAND' for more information on a specific command.";
  11
  12static int use_pager = -1;
  13struct pager_config {
  14        const char *cmd;
  15        int val;
  16};
  17
  18static int pager_command_config(const char *var, const char *value, void *data)
  19{
  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;
  24}
  25
  26/* returns 0 for "no pager", 1 for "use pager", and -1 for "not specified" */
  27int check_pager_config(const char *cmd)
  28{
  29        struct pager_config c;
  30        c.cmd = cmd;
  31        c.val = -1;
  32        git_config(pager_command_config, &c);
  33        return c.val;
  34}
  35
  36static 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;
  46        }
  47}
  48
  49static int handle_options(const char*** argv, int* argc, int* envchanged)
  50{
  51        int handled = 0;
  52
  53        while (*argc > 0) {
  54                const char *cmd = (*argv)[0];
  55                if (cmd[0] != '-')
  56                        break;
  57
  58                /*
  59                 * For legacy reasons, the "version" and "help"
  60                 * commands can be written with "--" prepended
  61                 * to make them look like flags.
  62                 */
  63                if (!strcmp(cmd, "--help") || !strcmp(cmd, "--version"))
  64                        break;
  65
  66                /*
  67                 * Check remaining flags.
  68                 */
  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);
  76                        }
  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);
  87                        }
  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);
 102                        }
 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);
 121                }
 122
 123                (*argv)++;
 124                (*argc)--;
 125                handled++;
 126        }
 127        return handled;
 128}
 129
 130static int handle_alias(int *argcp, const char ***argv)
 131{
 132        int envchanged = 0, ret = 0, saved_errno = errno;
 133        const char *subdir;
 134        int count, option_count;
 135        const char** new_argv;
 136        const char *alias_command;
 137        char *alias_string;
 138        int unused_nongit;
 139
 140        subdir = setup_git_directory_gently(&unused_nongit);
 141
 142        alias_command = (*argv)[0];
 143        alias_string = alias_lookup(alias_command);
 144        if (alias_string) {
 145                if (alias_string[0] == '!') {
 146                        if (*argcp > 1) {
 147                                struct strbuf buf;
 148
 149                                strbuf_init(&buf, PATH_MAX);
 150                                strbuf_addstr(&buf, alias_string);
 151                                sq_quote_argv(&buf, (*argv) + 1, PATH_MAX);
 152                                free(alias_string);
 153                                alias_string = buf.buf;
 154                        }
 155                        trace_printf("trace: alias to shell cmd: %s => %s\n",
 156                                     alias_command, alias_string + 1);
 157                        ret = system(alias_string + 1);
 158                        if (ret >= 0 && WIFEXITED(ret) &&
 159                            WEXITSTATUS(ret) != 127)
 160                                exit(WEXITSTATUS(ret));
 161                        die("Failed to run '%s' when expanding alias '%s'\n",
 162                            alias_string + 1, alias_command);
 163                }
 164                count = split_cmdline(alias_string, &new_argv);
 165                option_count = handle_options(&new_argv, &count, &envchanged);
 166                if (envchanged)
 167                        die("alias '%s' changes environment variables\n"
 168                                 "You can use '!git' in the alias to do this.",
 169                                 alias_command);
 170                memmove(new_argv - option_count, new_argv,
 171                                count * sizeof(char *));
 172                new_argv -= option_count;
 173
 174                if (count < 1)
 175                        die("empty alias for %s", alias_command);
 176
 177                if (!strcmp(alias_command, new_argv[0]))
 178                        die("recursive alias: %s", alias_command);
 179
 180                trace_argv_printf(new_argv,
 181                                  "trace: alias expansion: %s =>",
 182                                  alias_command);
 183
 184                new_argv = xrealloc(new_argv, sizeof(char*) *
 185                                    (count + *argcp + 1));
 186                /* insert after command name */
 187                memcpy(new_argv + count, *argv + 1, sizeof(char*) * *argcp);
 188                new_argv[count+*argcp] = NULL;
 189
 190                *argv = new_argv;
 191                *argcp += count - 1;
 192
 193                ret = 1;
 194        }
 195
 196        if (subdir)
 197                chdir(subdir);
 198
 199        errno = saved_errno;
 200
 201        return ret;
 202}
 203
 204const char git_version_string[] = GIT_VERSION;
 205
 206#define RUN_SETUP       (1<<0)
 207#define USE_PAGER       (1<<1)
 208/*
 209 * require working tree to be present -- anything uses this needs
 210 * RUN_SETUP for reading from the configuration file.
 211 */
 212#define NEED_WORK_TREE  (1<<2)
 213
 214struct cmd_struct {
 215        const char *cmd;
 216        int (*fn)(int, const char **, const char *);
 217        int option;
 218};
 219
 220static int run_command(struct cmd_struct *p, int argc, const char **argv)
 221{
 222        int status;
 223        struct stat st;
 224        const char *prefix;
 225
 226        prefix = NULL;
 227        if (p->option & RUN_SETUP)
 228                prefix = setup_git_directory();
 229
 230        if (use_pager == -1 && p->option & RUN_SETUP)
 231                use_pager = check_pager_config(p->cmd);
 232        if (use_pager == -1 && p->option & USE_PAGER)
 233                use_pager = 1;
 234        commit_pager_choice();
 235
 236        if (p->option & NEED_WORK_TREE)
 237                setup_work_tree();
 238
 239        trace_argv_printf(argv, "trace: built-in: git");
 240
 241        status = p->fn(argc, argv, prefix);
 242        if (status)
 243                return status & 0xff;
 244
 245        /* Somebody closed stdout? */
 246        if (fstat(fileno(stdout), &st))
 247                return 0;
 248        /* Ignore write errors for pipes and sockets.. */
 249        if (S_ISFIFO(st.st_mode) || S_ISSOCK(st.st_mode))
 250                return 0;
 251
 252        /* Check for ENOSPC and EIO errors.. */
 253        if (fflush(stdout))
 254                die("write failure on standard output: %s", strerror(errno));
 255        if (ferror(stdout))
 256                die("unknown write failure on standard output");
 257        if (fclose(stdout))
 258                die("close failed on standard output: %s", strerror(errno));
 259        return 0;
 260}
 261
 262static void handle_internal_command(int argc, const char **argv)
 263{
 264        const char *cmd = argv[0];
 265        static struct cmd_struct commands[] = {
 266                { "add", cmd_add, RUN_SETUP | NEED_WORK_TREE },
 267                { "annotate", cmd_annotate, RUN_SETUP },
 268                { "apply", cmd_apply },
 269                { "archive", cmd_archive },
 270                { "blame", cmd_blame, RUN_SETUP },
 271                { "branch", cmd_branch, RUN_SETUP },
 272                { "bundle", cmd_bundle },
 273                { "cat-file", cmd_cat_file, RUN_SETUP },
 274                { "checkout", cmd_checkout, RUN_SETUP | NEED_WORK_TREE },
 275                { "checkout-index", cmd_checkout_index,
 276                        RUN_SETUP | NEED_WORK_TREE},
 277                { "check-ref-format", cmd_check_ref_format },
 278                { "check-attr", cmd_check_attr, RUN_SETUP },
 279                { "cherry", cmd_cherry, RUN_SETUP },
 280                { "cherry-pick", cmd_cherry_pick, RUN_SETUP | NEED_WORK_TREE },
 281                { "clone", cmd_clone },
 282                { "clean", cmd_clean, RUN_SETUP | NEED_WORK_TREE },
 283                { "commit", cmd_commit, RUN_SETUP | NEED_WORK_TREE },
 284                { "commit-tree", cmd_commit_tree, RUN_SETUP },
 285                { "config", cmd_config },
 286                { "count-objects", cmd_count_objects, RUN_SETUP },
 287                { "describe", cmd_describe, RUN_SETUP },
 288                { "diff", cmd_diff },
 289                { "diff-files", cmd_diff_files, RUN_SETUP },
 290                { "diff-index", cmd_diff_index, RUN_SETUP },
 291                { "diff-tree", cmd_diff_tree, RUN_SETUP },
 292                { "fast-export", cmd_fast_export, RUN_SETUP },
 293                { "fetch", cmd_fetch, RUN_SETUP },
 294                { "fetch-pack", cmd_fetch_pack, RUN_SETUP },
 295                { "fetch--tool", cmd_fetch__tool, RUN_SETUP },
 296                { "fmt-merge-msg", cmd_fmt_merge_msg, RUN_SETUP },
 297                { "for-each-ref", cmd_for_each_ref, RUN_SETUP },
 298                { "format-patch", cmd_format_patch, RUN_SETUP },
 299                { "fsck", cmd_fsck, RUN_SETUP },
 300                { "fsck-objects", cmd_fsck, RUN_SETUP },
 301                { "gc", cmd_gc, RUN_SETUP },
 302                { "get-tar-commit-id", cmd_get_tar_commit_id },
 303                { "grep", cmd_grep, RUN_SETUP | USE_PAGER },
 304                { "help", cmd_help },
 305#ifndef NO_CURL
 306                { "http-fetch", cmd_http_fetch, RUN_SETUP },
 307#endif
 308                { "init", cmd_init_db },
 309                { "init-db", cmd_init_db },
 310                { "log", cmd_log, RUN_SETUP | USE_PAGER },
 311                { "ls-files", cmd_ls_files, RUN_SETUP },
 312                { "ls-tree", cmd_ls_tree, RUN_SETUP },
 313                { "ls-remote", cmd_ls_remote },
 314                { "mailinfo", cmd_mailinfo },
 315                { "mailsplit", cmd_mailsplit },
 316                { "merge", cmd_merge, RUN_SETUP | NEED_WORK_TREE },
 317                { "merge-base", cmd_merge_base, RUN_SETUP },
 318                { "merge-file", cmd_merge_file },
 319                { "merge-ours", cmd_merge_ours, RUN_SETUP },
 320                { "merge-recursive", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
 321                { "merge-subtree", cmd_merge_recursive, RUN_SETUP | NEED_WORK_TREE },
 322                { "mv", cmd_mv, RUN_SETUP | NEED_WORK_TREE },
 323                { "name-rev", cmd_name_rev, RUN_SETUP },
 324                { "pack-objects", cmd_pack_objects, RUN_SETUP },
 325                { "peek-remote", cmd_ls_remote },
 326                { "pickaxe", cmd_blame, RUN_SETUP },
 327                { "prune", cmd_prune, RUN_SETUP },
 328                { "prune-packed", cmd_prune_packed, RUN_SETUP },
 329                { "push", cmd_push, RUN_SETUP },
 330                { "read-tree", cmd_read_tree, RUN_SETUP },
 331                { "reflog", cmd_reflog, RUN_SETUP },
 332                { "remote", cmd_remote, RUN_SETUP },
 333                { "repo-config", cmd_config },
 334                { "rerere", cmd_rerere, RUN_SETUP },
 335                { "reset", cmd_reset, RUN_SETUP },
 336                { "rev-list", cmd_rev_list, RUN_SETUP },
 337                { "rev-parse", cmd_rev_parse },
 338                { "revert", cmd_revert, RUN_SETUP | NEED_WORK_TREE },
 339                { "rm", cmd_rm, RUN_SETUP },
 340                { "send-pack", cmd_send_pack, RUN_SETUP },
 341                { "shortlog", cmd_shortlog, USE_PAGER },
 342                { "show-branch", cmd_show_branch, RUN_SETUP },
 343                { "show", cmd_show, RUN_SETUP | USE_PAGER },
 344                { "status", cmd_status, RUN_SETUP | NEED_WORK_TREE },
 345                { "stripspace", cmd_stripspace },
 346                { "symbolic-ref", cmd_symbolic_ref, RUN_SETUP },
 347                { "tag", cmd_tag, RUN_SETUP },
 348                { "tar-tree", cmd_tar_tree },
 349                { "unpack-objects", cmd_unpack_objects, RUN_SETUP },
 350                { "update-index", cmd_update_index, RUN_SETUP },
 351                { "update-ref", cmd_update_ref, RUN_SETUP },
 352                { "upload-archive", cmd_upload_archive },
 353                { "verify-tag", cmd_verify_tag, RUN_SETUP },
 354                { "version", cmd_version },
 355                { "whatchanged", cmd_whatchanged, RUN_SETUP | USE_PAGER },
 356                { "write-tree", cmd_write_tree, RUN_SETUP },
 357                { "verify-pack", cmd_verify_pack },
 358                { "show-ref", cmd_show_ref, RUN_SETUP },
 359                { "pack-refs", cmd_pack_refs, RUN_SETUP },
 360        };
 361        int i;
 362        static const char ext[] = STRIP_EXTENSION;
 363
 364        if (sizeof(ext) > 1) {
 365                i = strlen(argv[0]) - strlen(ext);
 366                if (i > 0 && !strcmp(argv[0] + i, ext)) {
 367                        char *argv0 = strdup(argv[0]);
 368                        argv[0] = cmd = argv0;
 369                        argv0[i] = '\0';
 370                }
 371        }
 372
 373        /* Turn "git cmd --help" into "git help cmd" */
 374        if (argc > 1 && !strcmp(argv[1], "--help")) {
 375                argv[1] = argv[0];
 376                argv[0] = cmd = "help";
 377        }
 378
 379        for (i = 0; i < ARRAY_SIZE(commands); i++) {
 380                struct cmd_struct *p = commands+i;
 381                if (strcmp(p->cmd, cmd))
 382                        continue;
 383                exit(run_command(p, argc, argv));
 384        }
 385}
 386
 387static void execv_dashed_external(const char **argv)
 388{
 389        struct strbuf cmd;
 390        const char *tmp;
 391
 392        strbuf_init(&cmd, 0);
 393        strbuf_addf(&cmd, "git-%s", argv[0]);
 394
 395        /*
 396         * argv[0] must be the git command, but the argv array
 397         * belongs to the caller, and may be reused in
 398         * subsequent loop iterations. Save argv[0] and
 399         * restore it on error.
 400         */
 401        tmp = argv[0];
 402        argv[0] = cmd.buf;
 403
 404        trace_argv_printf(argv, "trace: exec:");
 405
 406        /* execvp() can only ever return if it fails */
 407        execvp(cmd.buf, (char **)argv);
 408
 409        trace_printf("trace: exec failed: %s\n", strerror(errno));
 410
 411        argv[0] = tmp;
 412
 413        strbuf_release(&cmd);
 414}
 415
 416
 417int main(int argc, const char **argv)
 418{
 419        const char *cmd = argv[0] && *argv[0] ? argv[0] : "git-help";
 420        char *slash = (char *)cmd + strlen(cmd);
 421        int done_alias = 0;
 422
 423        /*
 424         * Take the basename of argv[0] as the command
 425         * name, and the dirname as the default exec_path
 426         * if we don't have anything better.
 427         */
 428        do
 429                --slash;
 430        while (cmd <= slash && !is_dir_sep(*slash));
 431        if (cmd <= slash) {
 432                *slash++ = 0;
 433                git_set_argv0_path(cmd);
 434                cmd = slash;
 435        }
 436
 437        /*
 438         * "git-xxxx" is the same as "git xxxx", but we obviously:
 439         *
 440         *  - cannot take flags in between the "git" and the "xxxx".
 441         *  - cannot execute it externally (since it would just do
 442         *    the same thing over again)
 443         *
 444         * So we just directly call the internal command handler, and
 445         * die if that one cannot handle it.
 446         */
 447        if (!prefixcmp(cmd, "git-")) {
 448                cmd += 4;
 449                argv[0] = cmd;
 450                handle_internal_command(argc, argv);
 451                die("cannot handle %s internally", cmd);
 452        }
 453
 454        /* Look for flags.. */
 455        argv++;
 456        argc--;
 457        handle_options(&argv, &argc, NULL);
 458        commit_pager_choice();
 459        if (argc > 0) {
 460                if (!prefixcmp(argv[0], "--"))
 461                        argv[0] += 2;
 462        } else {
 463                /* The user didn't specify a command; give them help */
 464                printf("usage: %s\n\n", git_usage_string);
 465                list_common_cmds_help();
 466                printf("\n%s\n", git_more_info_string);
 467                exit(1);
 468        }
 469        cmd = argv[0];
 470
 471        /*
 472         * We use PATH to find git commands, but we prepend some higher
 473         * precidence paths: the "--exec-path" option, the GIT_EXEC_PATH
 474         * environment, and the $(gitexecdir) from the Makefile at build
 475         * time.
 476         */
 477        setup_path();
 478
 479        while (1) {
 480                /* See if it's an internal command */
 481                handle_internal_command(argc, argv);
 482
 483                /* .. then try the external ones */
 484                execv_dashed_external(argv);
 485
 486                /* It could be an alias -- this works around the insanity
 487                 * of overriding "git log" with "git show" by having
 488                 * alias.log = show
 489                 */
 490                if (done_alias || !handle_alias(&argc, &argv))
 491                        break;
 492                done_alias = 1;
 493        }
 494
 495        if (errno == ENOENT) {
 496                if (done_alias) {
 497                        fprintf(stderr, "Expansion of alias '%s' failed; "
 498                                "'%s' is not a git-command\n",
 499                                cmd, argv[0]);
 500                        exit(1);
 501                }
 502                help_unknown_cmd(cmd);
 503        }
 504
 505        fprintf(stderr, "Failed to run command '%s': %s\n",
 506                cmd, strerror(errno));
 507
 508        return 1;
 509}