builtin / rev-list.con commit Merge branch 'jc/t1506-shell-param-expansion-gotcha' (d6ad4ff)
   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                pretty_print_commit(revs->commit_format, commit, &buf, &ctx);
 108                if (revs->graph) {
 109                        if (buf.len) {
 110                                if (revs->commit_format != CMIT_FMT_ONELINE)
 111                                        graph_show_oneline(revs->graph);
 112
 113                                graph_show_commit_msg(revs->graph, &buf);
 114
 115                                /*
 116                                 * Add a newline after the commit message.
 117                                 *
 118                                 * Usually, this newline produces a blank
 119                                 * padding line between entries, in which case
 120                                 * we need to add graph padding on this line.
 121                                 *
 122                                 * However, the commit message may not end in a
 123                                 * newline.  In this case the newline simply
 124                                 * ends the last line of the commit message,
 125                                 * and we don't need any graph output.  (This
 126                                 * always happens with CMIT_FMT_ONELINE, and it
 127                                 * happens with CMIT_FMT_USERFORMAT when the
 128                                 * format doesn't explicitly end in a newline.)
 129                                 */
 130                                if (buf.len && buf.buf[buf.len - 1] == '\n')
 131                                        graph_show_padding(revs->graph);
 132                                putchar('\n');
 133                        } else {
 134                                /*
 135                                 * If the message buffer is empty, just show
 136                                 * the rest of the graph output for this
 137                                 * commit.
 138                                 */
 139                                if (graph_show_remainder(revs->graph))
 140                                        putchar('\n');
 141                                if (revs->commit_format == CMIT_FMT_ONELINE)
 142                                        putchar('\n');
 143                        }
 144                } else {
 145                        if (revs->commit_format != CMIT_FMT_USERFORMAT ||
 146                            buf.len) {
 147                                fwrite(buf.buf, 1, buf.len, stdout);
 148                                putchar(info->hdr_termination);
 149                        }
 150                }
 151                strbuf_release(&buf);
 152        } else {
 153                if (graph_show_remainder(revs->graph))
 154                        putchar('\n');
 155        }
 156        maybe_flush_or_die(stdout, "stdout");
 157        finish_commit(commit, data);
 158}
 159
 160static void finish_commit(struct commit *commit, void *data)
 161{
 162        if (commit->parents) {
 163                free_commit_list(commit->parents);
 164                commit->parents = NULL;
 165        }
 166        free(commit->buffer);
 167        commit->buffer = NULL;
 168}
 169
 170static void finish_object(struct object *obj, const struct name_path *path, const char *name)
 171{
 172        if (obj->type == OBJ_BLOB && !has_sha1_file(obj->sha1))
 173                die("missing blob object '%s'", sha1_to_hex(obj->sha1));
 174}
 175
 176static void show_object(struct object *obj, const struct name_path *path, const char *component)
 177{
 178        char *name = path_name(path, component);
 179        /* An object with name "foo\n0000000..." can be used to
 180         * confuse downstream "git pack-objects" very badly.
 181         */
 182        const char *ep = strchr(name, '\n');
 183
 184        finish_object(obj, path, name);
 185        if (ep) {
 186                printf("%s %.*s\n", sha1_to_hex(obj->sha1),
 187                       (int) (ep - name),
 188                       name);
 189        }
 190        else
 191                printf("%s %s\n", sha1_to_hex(obj->sha1), name);
 192        free(name);
 193}
 194
 195static void show_edge(struct commit *commit)
 196{
 197        printf("-%s\n", sha1_to_hex(commit->object.sha1));
 198}
 199
 200static inline int log2i(int n)
 201{
 202        int log2 = 0;
 203
 204        for (; n > 1; n >>= 1)
 205                log2++;
 206
 207        return log2;
 208}
 209
 210static inline int exp2i(int n)
 211{
 212        return 1 << n;
 213}
 214
 215/*
 216 * Estimate the number of bisect steps left (after the current step)
 217 *
 218 * For any x between 0 included and 2^n excluded, the probability for
 219 * n - 1 steps left looks like:
 220 *
 221 * P(2^n + x) == (2^n - x) / (2^n + x)
 222 *
 223 * and P(2^n + x) < 0.5 means 2^n < 3x
 224 */
 225int estimate_bisect_steps(int all)
 226{
 227        int n, x, e;
 228
 229        if (all < 3)
 230                return 0;
 231
 232        n = log2i(all);
 233        e = exp2i(n);
 234        x = all - e;
 235
 236        return (e < 3 * x) ? n : n - 1;
 237}
 238
 239void print_commit_list(struct commit_list *list,
 240                       const char *format_cur,
 241                       const char *format_last)
 242{
 243        for ( ; list; list = list->next) {
 244                const char *format = list->next ? format_cur : format_last;
 245                printf(format, sha1_to_hex(list->item->object.sha1));
 246        }
 247}
 248
 249static void show_tried_revs(struct commit_list *tried)
 250{
 251        printf("bisect_tried='");
 252        print_commit_list(tried, "%s|", "%s");
 253        printf("'\n");
 254}
 255
 256static void print_var_str(const char *var, const char *val)
 257{
 258        printf("%s='%s'\n", var, val);
 259}
 260
 261static void print_var_int(const char *var, int val)
 262{
 263        printf("%s=%d\n", var, val);
 264}
 265
 266static int show_bisect_vars(struct rev_list_info *info, int reaches, int all)
 267{
 268        int cnt, flags = info->bisect_show_flags;
 269        char hex[41] = "";
 270        struct commit_list *tried;
 271        struct rev_info *revs = info->revs;
 272
 273        if (!revs->commits && !(flags & BISECT_SHOW_TRIED))
 274                return 1;
 275
 276        revs->commits = filter_skipped(revs->commits, &tried,
 277                                       flags & BISECT_SHOW_ALL,
 278                                       NULL, NULL);
 279
 280        /*
 281         * revs->commits can reach "reaches" commits among
 282         * "all" commits.  If it is good, then there are
 283         * (all-reaches) commits left to be bisected.
 284         * On the other hand, if it is bad, then the set
 285         * to bisect is "reaches".
 286         * A bisect set of size N has (N-1) commits further
 287         * to test, as we already know one bad one.
 288         */
 289        cnt = all - reaches;
 290        if (cnt < reaches)
 291                cnt = reaches;
 292
 293        if (revs->commits)
 294                strcpy(hex, sha1_to_hex(revs->commits->item->object.sha1));
 295
 296        if (flags & BISECT_SHOW_ALL) {
 297                traverse_commit_list(revs, show_commit, show_object, info);
 298                printf("------\n");
 299        }
 300
 301        if (flags & BISECT_SHOW_TRIED)
 302                show_tried_revs(tried);
 303
 304        print_var_str("bisect_rev", hex);
 305        print_var_int("bisect_nr", cnt - 1);
 306        print_var_int("bisect_good", all - reaches - 1);
 307        print_var_int("bisect_bad", reaches - 1);
 308        print_var_int("bisect_all", all);
 309        print_var_int("bisect_steps", estimate_bisect_steps(all));
 310
 311        return 0;
 312}
 313
 314int cmd_rev_list(int argc, const char **argv, const char *prefix)
 315{
 316        struct rev_info revs;
 317        struct rev_list_info info;
 318        int i;
 319        int bisect_list = 0;
 320        int bisect_show_vars = 0;
 321        int bisect_find_all = 0;
 322        int quiet = 0;
 323
 324        git_config(git_default_config, NULL);
 325        init_revisions(&revs, prefix);
 326        revs.abbrev = DEFAULT_ABBREV;
 327        revs.commit_format = CMIT_FMT_UNSPECIFIED;
 328        argc = setup_revisions(argc, argv, &revs, NULL);
 329
 330        memset(&info, 0, sizeof(info));
 331        info.revs = &revs;
 332        if (revs.bisect)
 333                bisect_list = 1;
 334
 335        quiet = DIFF_OPT_TST(&revs.diffopt, QUICK);
 336        for (i = 1 ; i < argc; i++) {
 337                const char *arg = argv[i];
 338
 339                if (!strcmp(arg, "--header")) {
 340                        revs.verbose_header = 1;
 341                        continue;
 342                }
 343                if (!strcmp(arg, "--timestamp")) {
 344                        info.show_timestamp = 1;
 345                        continue;
 346                }
 347                if (!strcmp(arg, "--bisect")) {
 348                        bisect_list = 1;
 349                        continue;
 350                }
 351                if (!strcmp(arg, "--bisect-all")) {
 352                        bisect_list = 1;
 353                        bisect_find_all = 1;
 354                        info.bisect_show_flags = BISECT_SHOW_ALL;
 355                        revs.show_decorations = 1;
 356                        continue;
 357                }
 358                if (!strcmp(arg, "--bisect-vars")) {
 359                        bisect_list = 1;
 360                        bisect_show_vars = 1;
 361                        continue;
 362                }
 363                usage(rev_list_usage);
 364
 365        }
 366        if (revs.commit_format != CMIT_FMT_UNSPECIFIED) {
 367                /* The command line has a --pretty  */
 368                info.hdr_termination = '\n';
 369                if (revs.commit_format == CMIT_FMT_ONELINE)
 370                        info.header_prefix = "";
 371                else
 372                        info.header_prefix = "commit ";
 373        }
 374        else if (revs.verbose_header)
 375                /* Only --header was specified */
 376                revs.commit_format = CMIT_FMT_RAW;
 377
 378        if ((!revs.commits &&
 379             (!(revs.tag_objects||revs.tree_objects||revs.blob_objects) &&
 380              !revs.pending.nr)) ||
 381            revs.diff)
 382                usage(rev_list_usage);
 383
 384        save_commit_buffer = (revs.verbose_header ||
 385                              revs.grep_filter.pattern_list ||
 386                              revs.grep_filter.header_list);
 387        if (bisect_list)
 388                revs.limited = 1;
 389
 390        if (prepare_revision_walk(&revs))
 391                die("revision walk setup failed");
 392        if (revs.tree_objects)
 393                mark_edges_uninteresting(revs.commits, &revs, show_edge);
 394
 395        if (bisect_list) {
 396                int reaches = reaches, all = all;
 397
 398                revs.commits = find_bisection(revs.commits, &reaches, &all,
 399                                              bisect_find_all);
 400
 401                if (bisect_show_vars)
 402                        return show_bisect_vars(&info, reaches, all);
 403        }
 404
 405        traverse_commit_list(&revs,
 406                             quiet ? finish_commit : show_commit,
 407                             quiet ? finish_object : show_object,
 408                             &info);
 409
 410        if (revs.count) {
 411                if (revs.left_right && revs.cherry_mark)
 412                        printf("%d\t%d\t%d\n", revs.count_left, revs.count_right, revs.count_same);
 413                else if (revs.left_right)
 414                        printf("%d\t%d\n", revs.count_left, revs.count_right);
 415                else if (revs.cherry_mark)
 416                        printf("%d\t%d\n", revs.count_left + revs.count_right, revs.count_same);
 417                else
 418                        printf("%d\n", revs.count_left + revs.count_right);
 419        }
 420
 421        return 0;
 422}