progress: simplify "delayed" progress API
commit8aade107dd84dcaff3f23caae80a013878db2de7
authorJunio C Hamano <gitster@pobox.com>
Sat, 19 Aug 2017 17:39:41 +0000 (19 10:39 -0700)
committerJunio C Hamano <gitster@pobox.com>
Sat, 19 Aug 2017 21:01:34 +0000 (19 14:01 -0700)
treea39913a6541fa64dd4d92bb0b27788209ca6dc7a
parent4d7268b888d7bb6d675340ec676e4239739d0f6d
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>
builtin/blame.c
builtin/fsck.c
builtin/prune-packed.c
builtin/prune.c
builtin/rev-list.c
diffcore-rename.c
progress.c
progress.h
unpack-trees.c