progress: simplify "delayed" progress API

We used to expose the full power of the delayed progress API to the
callers, so that they can specify, not just the message to show and
expected total amount of work that is used to compute the percentage
of work performed so far, the percent-threshold parameter P and the
delay-seconds parameter N.  The progress meter starts to show at N
seconds into the operation only if we have not yet completed P per-cent
of the total work.

Most callers used either (0%, 2s) or (50%, 1s) as (P, N), but there
are oddballs that chose more random-looking values like 95%.

For a smoother workload, (50%, 1s) would allow us to start showing
the progress meter earlier than (0%, 2s), while keeping the chance
of not showing progress meter for long running operation the same as
the latter.  For a task that would take 2s or more to complete, it
is likely that less than half of it would complete within the first
second, if the workload is smooth.  But for a spiky workload whose
earlier part is easier, such a setting is likely to fail to show the
progress meter entirely and (0%, 2s) is more appropriate.

But that is merely a theory.  Realistically, it is of dubious value
to ask each codepath to carefully consider smoothness of their
workload and specify their own setting by passing two extra
parameters.  Let's simplify the API by dropping both parameters and
have everybody use (0%, 2s).

Oh, by the way, the percent-threshold parameter and the structure
member were consistently misspelled, which also is now fixed ;-)

Helped-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
pull/403/merge
Junio C Hamano 5 years ago
parent 4d7268b888
commit 8aade107dd
  1. 3
      builtin/blame.c
  2. 2
      builtin/fsck.c
  3. 3
      builtin/prune-packed.c
  4. 2
      builtin/prune.c
  5. 2
      builtin/rev-list.c
  6. 4
      diffcore-rename.c
  7. 15
      progress.c
  8. 3
      progress.h
  9. 3
      unpack-trees.c

@ -925,8 +925,7 @@ parse_done:
sb.found_guilty_entry = &found_guilty_entry;
sb.found_guilty_entry_data = &pi;
if (show_progress)
pi.progress = start_progress_delay(_("Blaming lines"),
sb.num_lines, 50, 1);
pi.progress = start_delayed_progress(_("Blaming lines"), sb.num_lines);
assign_blame(&sb, opt);

@ -188,7 +188,7 @@ static int traverse_reachable(void)
unsigned int nr = 0;
int result = 0;
if (show_progress)
progress = start_progress_delay(_("Checking connectivity"), 0, 0, 2);
progress = start_delayed_progress(_("Checking connectivity"), 0);
while (pending.nr) {
struct object_array_entry *entry;
struct object *obj;

@ -37,8 +37,7 @@ static int prune_object(const struct object_id *oid, const char *path,
void prune_packed_objects(int opts)
{
if (opts & PRUNE_PACKED_VERBOSE)
progress = start_progress_delay(_("Removing duplicate objects"),
256, 95, 2);
progress = start_delayed_progress(_("Removing duplicate objects"), 256);
for_each_loose_file_in_objdir(get_object_directory(),
prune_object, NULL, prune_subdir, &opts);

@ -138,7 +138,7 @@ int cmd_prune(int argc, const char **argv, const char *prefix)
if (show_progress == -1)
show_progress = isatty(2);
if (show_progress)
progress = start_progress_delay(_("Checking connectivity"), 0, 0, 2);
progress = start_delayed_progress(_("Checking connectivity"), 0);
mark_reachable_objects(&revs, 1, expire, progress);
stop_progress(&progress);

@ -364,7 +364,7 @@ int cmd_rev_list(int argc, const char **argv, const char *prefix)
revs.limited = 1;
if (show_progress)
progress = start_progress_delay(show_progress, 0, 0, 2);
progress = start_delayed_progress(show_progress, 0);
if (use_bitmap_index && !revs.prune) {
if (revs.count && !revs.left_right && !revs.cherry_mark) {

@ -532,9 +532,9 @@ void diffcore_rename(struct diff_options *options)
}
if (options->show_rename_progress) {
progress = start_progress_delay(
progress = start_delayed_progress(
_("Performing inexact rename detection"),
rename_dst_nr * rename_src_nr, 50, 1);
rename_dst_nr * rename_src_nr);
}
mx = xcalloc(st_mult(NUM_CANDIDATE_PER_DST, num_create), sizeof(*mx));

@ -34,7 +34,7 @@ struct progress {
unsigned total;
unsigned last_percent;
unsigned delay;
unsigned delayed_percent_treshold;
unsigned delayed_percent_threshold;
struct throughput *throughput;
uint64_t start_ns;
};
@ -88,7 +88,7 @@ static int display(struct progress *progress, unsigned n, const char *done)
return 0;
if (progress->total) {
unsigned percent = n * 100 / progress->total;
if (percent > progress->delayed_percent_treshold) {
if (percent > progress->delayed_percent_threshold) {
/* inhibit this progress report entirely */
clear_progress_signal();
progress->delay = -1;
@ -205,8 +205,8 @@ int display_progress(struct progress *progress, unsigned n)
return progress ? display(progress, n, NULL) : 0;
}
struct progress *start_progress_delay(const char *title, unsigned total,
unsigned percent_treshold, unsigned delay)
static struct progress *start_progress_delay(const char *title, unsigned total,
unsigned percent_threshold, unsigned delay)
{
struct progress *progress = malloc(sizeof(*progress));
if (!progress) {
@ -219,7 +219,7 @@ struct progress *start_progress_delay(const char *title, unsigned total,
progress->total = total;
progress->last_value = -1;
progress->last_percent = -1;
progress->delayed_percent_treshold = percent_treshold;
progress->delayed_percent_threshold = percent_threshold;
progress->delay = delay;
progress->throughput = NULL;
progress->start_ns = getnanotime();
@ -227,6 +227,11 @@ struct progress *start_progress_delay(const char *title, unsigned total,
return progress;
}
struct progress *start_delayed_progress(const char *title, unsigned total)
{
return start_progress_delay(title, total, 0, 2);
}
struct progress *start_progress(const char *title, unsigned total)
{
return start_progress_delay(title, total, 0, 0);

@ -6,8 +6,7 @@ struct progress;
void display_throughput(struct progress *progress, off_t total);
int display_progress(struct progress *progress, unsigned n);
struct progress *start_progress(const char *title, unsigned total);
struct progress *start_progress_delay(const char *title, unsigned total,
unsigned percent_treshold, unsigned delay);
struct progress *start_delayed_progress(const char *title, unsigned total);
void stop_progress(struct progress **progress);
void stop_progress_msg(struct progress **progress, const char *msg);

@ -343,8 +343,7 @@ static struct progress *get_progress(struct unpack_trees_options *o)
total++;
}
return start_progress_delay(_("Checking out files"),
total, 50, 1);
return start_delayed_progress(_("Checking out files"), total);
}
static int check_updates(struct unpack_trees_options *o)

Loading…
Cancel
Save