builtin / rev-list.con commit fast-import: add input format tests (4cedb78)
   1#include "cache.h"
   2#include "commit.h"
   3#include "diff.h"
   4#include "revision.h"
   5#include "list-objects.h"
   6#include "builtin.h"
   7#include "log-tree.h"
   8#include "graph.h"
   9#include "bisect.h"
  10
  11static const char rev_list_usage[] =
  12"git rev-list [OPTION] <commit-id>... [ -- paths... ]\n"
  13"  limiting output:\n"
  14"    --max-count=<n>\n"
  15"    --max-age=<epoch>\n"
  16"    --min-age=<epoch>\n"
  17"    --sparse\n"
  18"    --no-merges\n"
  19"    --min-parents=<n>\n"
  20"    --no-min-parents\n"
  21"    --max-parents=<n>\n"
  22"    --no-max-parents\n"
  23"    --remove-empty\n"
  24"    --all\n"
  25"    --branches\n"
  26"    --tags\n"
  27"    --remotes\n"
  28"    --stdin\n"
  29"    --quiet\n"
  30"  ordering output:\n"
  31"    --topo-order\n"
  32"    --date-order\n"
  33"    --reverse\n"
  34"  formatting output:\n"
  35"    --parents\n"
  36"    --children\n"
  37"    --objects | --objects-edge\n"
  38"    --unpacked\n"
  39"    --header | --pretty\n"
  40"    --abbrev=<n> | --no-abbrev\n"
  41"    --abbrev-commit\n"
  42"    --left-right\n"
  43"  special purpose:\n"
  44"    --bisect\n"
  45"    --bisect-vars\n"
  46"    --bisect-all"
  47;
  48
  49static void finish_commit(struct commit *commit, void *data);
  50static void show_commit(struct commit *commit, void *data)
  51{
  52        struct rev_list_info *info = data;
  53        struct rev_info *revs = info->revs;
  54
  55        graph_show_commit(revs->graph);
  56
  57        if (revs->count) {
  58                if (commit->object.flags & PATCHSAME)
  59                        revs->count_same++;
  60                else if (commit->object.flags & SYMMETRIC_LEFT)
  61                        revs->count_left++;
  62                else
  63                        revs->count_right++;
  64                finish_commit(commit, data);
  65                return;
  66        }
  67
  68        if (info->show_timestamp)
  69                printf("%lu ", commit->date);
  70        if (info->header_prefix)
  71                fputs(info->header_prefix, stdout);
  72
  73        if (!revs->graph)
  74                fputs(get_revision_mark(revs, commit), stdout);
  75        if (revs->abbrev_commit && revs->abbrev)
  76                fputs(find_unique_abbrev(commit->object.sha1, revs->abbrev),
  77                      stdout);
  78        else
  79                fputs(sha1_to_hex(commit->object.sha1), stdout);
  80        if (revs->print_parents) {
  81                struct commit_list *parents = commit->parents;
  82                while (parents) {
  83                        printf(" %s", sha1_to_hex(parents->item->object.sha1));
  84                        parents = parents->next;
  85                }
  86        }
  87        if (revs->children.name) {
  88                struct commit_list *children;
  89
  90                children = lookup_decoration(&revs->children, &commit->object);
  91                while (children) {
  92                        printf(" %s", sha1_to_hex(children->item->object.sha1));
  93                        children = children->next;
  94                }
  95        }
  96        show_decorations(revs, commit);
  97        if (revs->commit_format == CMIT_FMT_ONELINE)
  98                putchar(' ');
  99        else
 100                putchar('\n');
 101
 102        if (revs->verbose_header && commit->buffer) {
 103                struct strbuf buf = STRBUF_INIT;
 104                struct pretty_print_context ctx = {0};
 105                ctx.abbrev = revs->abbrev;
 106                ctx.date_mode = revs->date_mode;
 107                ctx.fmt = revs->commit_format;
 108                pretty_print_commit(&ctx, commit, &buf);
 109                if (revs->graph) {
 110                        if (buf.len) {
 111                                if (revs->commit_format != CMIT_FMT_ONELINE)
 112                                        graph_show_oneline(revs->graph);
 113
 114                                graph_show_commit_msg(revs->graph, &buf);
 115
 116                                /*
 117                                 * Add a newline after the commit message.
 118                                 *
 119                                 * Usually, this newline produces a blank
 120                                 * padding line between entries, in which case
 121                                 * we need to add graph padding on this line.
 122                                 *
 123                                 * However, the commit message may not end in a
 124                                 * newline.  In this case the newline simply
 125                                 * ends the last line of the commit message,
 126                                 * and we don't need any graph output.  (This
 127                                 * always happens with CMIT_FMT_ONELINE, and it
 128                                 * happens with CMIT_FMT_USERFORMAT when the
 129                                 * format doesn't explicitly end in a newline.)
 130                                 */
 131                                if (buf.len && buf.buf[buf.len - 1] == '\n')
 132                                        graph_show_padding(revs->graph);
 133                                putchar('\n');
 134                        } else {
 135                                /*
 136                                 * If the message buffer is empty, just show
 137                                 * the rest of the graph output for this
 138                                 * commit.
 139                                 */
 140                                if (graph_show_remainder(revs->graph))
 141                                        putchar('\n');
 142                                if (revs->commit_format == CMIT_FMT_ONELINE)
 143                                        putchar('\n');
 144                        }
 145                } else {
 146                        if (revs->commit_format != CMIT_FMT_USERFORMAT ||
 147                            buf.len) {
 148                                fwrite(buf.buf, 1, buf.len, stdout);
 149                                putchar(info->hdr_termination);
 150                        }
 151                }
 152                strbuf_release(&buf);
 153        } else {
 154                if (graph_show_remainder(revs->graph))
 155                        putchar('\n');
 156        }
 157        maybe_flush_or_die(stdout, "stdout");
 158        finish_commit(commit, data);
 159}
 160
 161static void finish_commit(struct commit *commit, void *data)
 162{
 163        if (commit->parents) {
 164                free_commit_list(commit->parents);
 165                commit->parents = NULL;
 166        }
 167        free(commit->buffer);
 168        commit->buffer = NULL;
 169}
 170
 171static void finish_object(struct object *obj, const struct name_path *path, const char *name)
 172{
 173        if (obj->type == OBJ_BLOB && !has_sha1_file(obj->sha1))
 174                die("missing blob object '%s'", sha1_to_hex(obj->sha1));
 175}
 176
 177static void show_object(struct object *obj, const struct name_path *path, const char *component)
 178{
 179        char *name = path_name(path, component);
 180        /* An object with name "foo\n0000000..." can be used to
 181         * confuse downstream "git pack-objects" very badly.
 182         */
 183        const char *ep = strchr(name, '\n');
 184
 185        finish_object(obj, path, name);
 186        if (ep) {
 187                printf("%s %.*s\n", sha1_to_hex(obj->sha1),
 188                       (int) (ep - name),
 189                       name);
 190        }
 191        else
 192                printf("%s %s\n", sha1_to_hex(obj->sha1), name);
 193        free(name);
 194}
 195
 196static void show_edge(struct commit *commit)
 197{
 198        printf("-%s\n", sha1_to_hex(commit->object.sha1));
 199}
 200
 201static inline int log2i(int n)
 202{
 203        int log2 = 0;
 204
 205        for (; n > 1; n >>= 1)
 206                log2++;
 207
 208        return log2;
 209}
 210
 211static inline int exp2i(int n)
 212{
 213        return 1 << n;
 214}
 215
 216/*
 217 * Estimate the number of bisect steps left (after the current step)
 218 *
 219 * For any x between 0 included and 2^n excluded, the probability for
 220 * n - 1 steps left looks like:
 221 *
 222 * P(2^n + x) == (2^n - x) / (2^n + x)
 223 *
 224 * and P(2^n + x) < 0.5 means 2^n < 3x
 225 */
 226int estimate_bisect_steps(int all)
 227{
 228        int n, x, e;
 229
 230        if (all < 3)
 231                return 0;
 232
 233        n = log2i(all);
 234        e = exp2i(n);
 235        x = all - e;
 236
 237        return (e < 3 * x) ? n : n - 1;
 238}
 239
 240void print_commit_list(struct commit_list *list,
 241                       const char *format_cur,
 242                       const char *format_last)
 243{
 244        for ( ; list; list = list->next) {
 245                const char *format = list->next ? format_cur : format_last;
 246                printf(format, sha1_to_hex(list->item->object.sha1));
 247        }
 248}
 249
 250static void show_tried_revs(struct commit_list *tried)
 251{
 252        printf("bisect_tried='");
 253        print_commit_list(tried, "%s|", "%s");
 254        printf("'\n");
 255}
 256
 257static void print_var_str(const char *var, const char *val)
 258{
 259        printf("%s='%s'\n", var, val);
 260}
 261
 262static void print_var_int(const char *var, int val)
 263{
 264        printf("%s=%d\n", var, val);
 265}
 266
 267static int show_bisect_vars(struct rev_list_info *info, int reaches, int all)
 268{
 269        int cnt, flags = info->bisect_show_flags;
 270        char hex[41] = "";
 271        struct commit_list *tried;
 272        struct rev_info *revs = info->revs;
 273
 274        if (!revs->commits && !(flags & BISECT_SHOW_TRIED))
 275                return 1;
 276
 277        revs->commits = filter_skipped(revs->commits, &tried,
 278                                       flags & BISECT_SHOW_ALL,
 279                                       NULL, NULL);
 280
 281        /*
 282         * revs->commits can reach "reaches" commits among
 283         * "all" commits.  If it is good, then there are
 284         * (all-reaches) commits left to be bisected.
 285         * On the other hand, if it is bad, then the set
 286         * to bisect is "reaches".
 287         * A bisect set of size N has (N-1) commits further
 288         * to test, as we already know one bad one.
 289         */
 290        cnt = all - reaches;
 291        if (cnt < reaches)
 292                cnt = reaches;
 293
 294        if (revs->commits)
 295                strcpy(hex, sha1_to_hex(revs->commits->item->object.sha1));
 296
 297        if (flags & BISECT_SHOW_ALL) {
 298                traverse_commit_list(revs, show_commit, show_object, info);
 299                printf("------\n");
 300        }
 301
 302        if (flags & BISECT_SHOW_TRIED)
 303                show_tried_revs(tried);
 304
 305        print_var_str("bisect_rev", hex);
 306        print_var_int("bisect_nr", cnt - 1);
 307        print_var_int("bisect_good", all - reaches - 1);
 308        print_var_int("bisect_bad", reaches - 1);
 309        print_var_int("bisect_all", all);
 310        print_var_int("bisect_steps", estimate_bisect_steps(all));
 311
 312        return 0;
 313}
 314
 315int cmd_rev_list(int argc, const char **argv, const char *prefix)
 316{
 317        struct rev_info revs;
 318        struct rev_list_info info;
 319        int i;
 320        int bisect_list = 0;
 321        int bisect_show_vars = 0;
 322        int bisect_find_all = 0;
 323        int quiet = 0;
 324
 325        git_config(git_default_config, NULL);
 326        init_revisions(&revs, prefix);
 327        revs.abbrev = DEFAULT_ABBREV;
 328        revs.commit_format = CMIT_FMT_UNSPECIFIED;
 329        argc = setup_revisions(argc, argv, &revs, NULL);
 330
 331        memset(&info, 0, sizeof(info));
 332        info.revs = &revs;
 333        if (revs.bisect)
 334                bisect_list = 1;
 335
 336        quiet = DIFF_OPT_TST(&revs.diffopt, QUICK);
 337        for (i = 1 ; i < argc; i++) {
 338                const char *arg = argv[i];
 339
 340                if (!strcmp(arg, "--header")) {
 341                        revs.verbose_header = 1;
 342                        continue;
 343                }
 344                if (!strcmp(arg, "--timestamp")) {
 345                        info.show_timestamp = 1;
 346                        continue;
 347                }
 348                if (!strcmp(arg, "--bisect")) {
 349                        bisect_list = 1;
 350                        continue;
 351                }
 352                if (!strcmp(arg, "--bisect-all")) {
 353                        bisect_list = 1;
 354                        bisect_find_all = 1;
 355                        info.bisect_show_flags = BISECT_SHOW_ALL;
 356                        revs.show_decorations = 1;
 357                        continue;
 358                }
 359                if (!strcmp(arg, "--bisect-vars")) {
 360                        bisect_list = 1;
 361                        bisect_show_vars = 1;
 362                        continue;
 363                }
 364                usage(rev_list_usage);
 365
 366        }
 367        if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
 368                /* The command line has a --pretty  */
 369                info.hdr_termination = '\n';
 370                if (revs.commit_format == CMIT_FMT_ONELINE)
 371                        info.header_prefix = "";
 372                else
 373                        info.header_prefix = "commit ";
 374        }
 375        else if (revs.verbose_header)
 376                /* Only --header was specified */
 377                revs.commit_format = CMIT_FMT_RAW;
 378
 379        if ((!revs.commits &&
 380             (!(revs.tag_objects||revs.tree_objects||revs.blob_objects) &&
 381              !revs.pending.nr)) ||
 382            revs.diff)
 383                usage(rev_list_usage);
 384
 385        save_commit_buffer = (revs.verbose_header ||
 386                              revs.grep_filter.pattern_list ||
 387                              revs.grep_filter.header_list);
 388        if (bisect_list)
 389                revs.limited = 1;
 390
 391        if (prepare_revision_walk(&revs))
 392                die("revision walk setup failed");
 393        if (revs.tree_objects)
 394                mark_edges_uninteresting(revs.commits, &revs, show_edge);
 395
 396        if (bisect_list) {
 397                int reaches = reaches, all = all;
 398
 399                revs.commits = find_bisection(revs.commits, &reaches, &all,
 400                                              bisect_find_all);
 401
 402                if (bisect_show_vars)
 403                        return show_bisect_vars(&info, reaches, all);
 404        }
 405
 406        traverse_commit_list(&revs,
 407                             quiet ? finish_commit : show_commit,
 408                             quiet ? finish_object : show_object,
 409                             &info);
 410
 411        if (revs.count) {
 412                if (revs.left_right && revs.cherry_mark)
 413                        printf("%d\t%d\t%d\n", revs.count_left, revs.count_right, revs.count_same);
 414                else if (revs.left_right)
 415                        printf("%d\t%d\n", revs.count_left, revs.count_right);
 416                else if (revs.cherry_mark)
 417                        printf("%d\t%d\n", revs.count_left + revs.count_right, revs.count_same);
 418                else
 419                        printf("%d\n", revs.count_left + revs.count_right);
 420        }
 421
 422        return 0;
 423}