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