Rename --eta-window to --average-rate-window, since that is what it does, and correct the behaviour of the final update so the final rate shown is the average rate across the whole transfer.

This commit is contained in:
Andrew Wood
2023-07-16 21:00:08 +01:00
parent 62b5ac26df
commit 4fddf40436
9 changed files with 29 additions and 13 deletions
+1 -1
View File
@@ -5,7 +5,7 @@ UNRELEASED
* fix: add burst rate limit to transfer, so rate limits are not broken by bursty traffic (pull request [#62](https://github.com/a-j-wood/pv/pull/62) supplied by [Volodymyr Bychkovyak](https://github.com/vbychkoviak))
* feature: the "`--size`" option now accepts "`@filename`" to use the size of another file (pull request [#57](https://github.com/a-j-wood/pv/pull/57) supplied by [Dave Beckett](https://github.com/dajobe))
* feature: the "`--watchfd`" option is now available on OS X (pull request [#60](https://github.com/a-j-wood/pv/pull/60) supplied by [christoph-zededa](https://github.com/christoph-zededa))
* feature: new "`--eta-window`" option, to set the window over which the rate is checked, when calculating the ETA (pull request [#65](https://github.com/a-j-wood/pv/pull/65) supplied by [lemonsqueeze](https://github.com/lemonsqueeze))
* feature: new "`--average-rate-window`" option, to set the window over which the average rate is calculated, also used for ETA (modified from pull request [#65](https://github.com/a-j-wood/pv/pull/65) supplied by [lemonsqueeze](https://github.com/lemonsqueeze))
* feature: the "`--watchfd`" option will now show relative filenames, if they are under the current directory (pull request [#66](https://github.com/a-j-wood/pv/pull/66) supplied by [ikasty](https://github.com/ikasty))
* docs: moved all open issues into GitHub and updated the TODO list
* docs: renamed README to README.md and altered it to Markdown format
+3 -3
View File
@@ -143,7 +143,7 @@ transfer.
.TP
.B \-a, \-\-average\-rate
Turn the average rate counter on. This will display the current average
rate of data transfer (default: last 30s, see --eta-window).
rate of data transfer (default: last 30s, see --average-rate-window).
.TP
.B \-b, \-\-bytes
Turn the total byte counter on. This will display the total amount of
@@ -276,10 +276,10 @@ Wait
seconds between updates. The default is to update every second.
Note that this can be a decimal such as 0.1.
.TP
.B \-m SEC, \-\-eta-window SEC
.B \-m SEC, \-\-average-rate-window SEC
Compute current average rate over a
.B SEC
seconds window for ETA calculation (default 30s).
seconds window for average rate and ETA calculations (default 30s).
.TP
.B \-w WIDTH, \-\-width WIDTH
Assume the terminal is