2007-04-29 14:38:52 +08:00
|
|
|
#ifndef PROGRESS_H
|
|
|
|
|
#define PROGRESS_H
|
2007-04-19 02:27:45 +08:00
|
|
|
|
2007-10-31 02:57:32 +08:00
|
|
|
struct progress;
|
2007-04-19 02:27:45 +08:00
|
|
|
|
2007-11-05 11:15:41 +08:00
|
|
|
void display_throughput(struct progress *progress, off_t total);
|
2007-04-19 02:27:45 +08:00
|
|
|
int display_progress(struct progress *progress, unsigned n);
|
2007-10-31 02:57:32 +08:00
|
|
|
struct progress *start_progress(const char *title, unsigned total);
|
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>
2017-08-20 01:39:41 +08:00
|
|
|
struct progress *start_delayed_progress(const char *title, unsigned total);
|
2007-10-31 02:57:32 +08:00
|
|
|
void stop_progress(struct progress **progress);
|
2007-11-09 04:45:41 +08:00
|
|
|
void stop_progress_msg(struct progress **progress, const char *msg);
|
2007-04-19 02:27:45 +08:00
|
|
|
|
|
|
|
|
#endif
|
