Added all changes made between v1.6.6 and June 2020

doc/NEWS

@@ -1,3 +1,35 @@
+x.x.x - NOT YET RELEASED
+  - fix: starting pv in the background no longer immediately stops unless
+    the transfer is to/from the terminal (Andriy Gapon, Jonathan Elchison)
+  - fix: using -B, -A, or -T now switches on -C implicitly
+    (Johannes Gerer, André Stapf)
+  - fix: AIX build fixes (Peter Korsgaard)
+  - i18n: updated German "--help" translations (Richard Fonfara)
+  - i18n: switched to UTF-8 encoding, added missing translations (de,fr,pt)
+  - docs: new "common switches" manual section (Jacek Wielemborek)
+  - docs: use placeholder instead of /dev/sda in the manual (Pranav Peshwe)
+  - docs: mention MacOS pipes and "-B 1024" in the manual (Jan Venekamp)
+  - docs: correct shell in autoconf/scripts/index.sh  (Juan Picca)
+  - cleanup: various compiler warnings cleaned up
+
+  Full changelog is below:
+  - (r181) added common switches section to manual (Jacek Wielemborek)
+  - (r184) use placeholder instead of /dev/sda in the manual (Pranav Peshwe)
+  - (r185) replace ash with sh in autoconf/scripts/index.sh (Juan Picca)
+  - (r185) added note to manual about "-B 1024" in MacOS pipes (Jan Venekamp)
+  - (r185) fix AIX config check when the CWD contains "yes" (Peter Korsgaard)
+  - (r189) (#1556) updated German "--help" translations (Richard Fonfara)
+  - (r189) updated missing German translations and changed to UTF-8 encoding
+  - (r191) updated missing French translations and changed to UTF-8 encoding
+  - (r193) updated missing Portuguese translations, changed to UTF-8 encoding
+  - (r196) (#1563) using -B, -A, or -T now switches on -C implicitly
+    (Johannes Gerer, André Stapf)
+  - (r199) fixed numerous compiler warnings in newer GCC versions
+  - (r200,205) fixed bug where "pv /dev/zero >/dev/null &" stopped
+    immediately (Jonathan Elchison, Andriy Gapon)
+  - (r203,205) marked unused arguments with GCC unused attribute, started
+    using boolean data type for flags, corrected more compiler warnings
+
 1.6.6 - 30 June 2017
   - (r161) use %llu instead of %Lu for better compatibility (Eric A. Borisch)
   - (r162) (#1532) fix target buffer size (-B) being ignored (AndCycle, Ilya

doc/TODO

@@ -1,21 +1,30 @@
 Things still to do:
 
+  - store terminal state in shm seg (Lars Ellenberg - Feb 2018)
+  - (as above) fix race condition with multiple "pv -c" (Viktor Ashirov - Jan 2020, Lars Ellenberg)
+  - (#1287) if the first pv exits, should the second become IPC leader?
+  - option to show bits/sec instead of bytes (John W. O'Brien - Jan 2019)
+  - option for alternate units like kB (x1000) (David Henderson [cliquesoft.org] - Dec 2018)
+  - (same as above) option to make input suffixes decimal not binary (ie kb rather than KiB)
+  - allow decimal values for -s, -L, -B (suggestion - Thomas Watson)
   - allow -E to take a block size argument so errors cause a skip to the
     next block (Anthony DeRobertis)
   - (#1559) momentary ETA option (Luc Gommans)
-  - (#1556) correct German translations (Richard Fonfara)
   - (#1557) use clock_gettime() in ETA calculation (Mateju Miroslav)
   - (#1561) show days in same format in ETA as in elapsed time
   - (#1562) allow -r with -l and -n to output lines/sec (Roland Kletzing)
-  - (#1563) make -B imply -C (Johannes Gerer)
   - document zsh <() incompatibility (frederik@ofb.net - Frederik Eaton)
+  - apply patch for MacOS 11 (Apple Silicon) stat64 issue (Filippo Valsorda)
   - do not check terminal in -q/-n mode (zsh <(pv -n) fails)
   - if -w/-H was specified, ignore SIGWINCH
+  - reset ETA on SIGUSR1 (Jacek Wielemborek - Jan 2019)
   - option to enable O_DIRECT (Romain Kang, Jacek Wielemborek)
   - use posix_fadvise() like cat(1) does (Jacek Wielemborek)
+  - before exit, flush output (e.g. writing to USB disk), update counters during flush (Kalin KOZHUHAROV - Jun 2018)
+  - permit -c with -d PID:FD, reject -N with -d PID (Norman Rasmussen)
   - (#1508) add watchfd tests
-  - (#1534) allow multiple -d options
-  - (#1533) one-shot option (Jacek Wielemborek)
+  - (#1554) allow multiple -d options (Linus Heckemann for multiple PID:FD)
+  - (#1553) one-shot option (Jacek Wielemborek)
   - (#1505) option to switch rate to per minute if really slow
   - (#1510) option "--progress-from FILE", read last number and use it as bytes read:
     pv --progress-from <( while sleep 1; do du -sb somedir; done ) -s 123g
@@ -24,8 +33,23 @@ Things still to do:
   - (#1286) option for process title (Martin Sarsale) as "pv - name:FooProcess -xyz - transferred: 1.3GB - 500KB/s - running: 10:15:30s"
   - (#1290) look at effect of O_SYNC or fsync on performance
   - (#1281) option (-x?) to use xterm title line for status (Joachim Haga)
-  - (#1287) if the first pv exits, should the second become IPC leader?
   - (#1560) use Unicode for more granular progress bar (Alexander Petrossian)
+  - show fd backwards reads more neatly than negative huge numbers
+  - "swallow" option to discard output (André Stapf - Apr 2017)
+  - differentiate "eta" from "fineta" in display (André Stapf - Apr 2017)
+  - continue timer even if input or output is blocking (Martin Probst - Jun 2017)
+  - incorporate ETA patch from Christoph Biedl - Jul 2017
+  - incorporate dynamic interval patch from Christoph Biedl - Dec 2019
+  - option "--size-file" or similar to use size of a file for "-s"
+  - fix rate limit downgrade as per patch (Stephen Kitt - Jan 2018)
+  - normalise progress to 100% if overrun (Andrej Gantvorg - Mar 2018)
+  - incorporate average rate interval patch "rate-window"/"eta-window" (lemonsqueeze/Matt - May/Sep 2018 - https://github.com/lemonsqueeze/pv)
+  - incorporate rate limit patch (Jered Floyd - Dec 2018)
+  - option --sparse (with block size option) to write sparse output (Andriy Galetski - Apr 2019)
+  - correct "-n" behaviour when going past 100% of "-s" size (Marcel - Nov 2018)
+  - option to show speed gauge (% max speed) if progress not known (Ryan Cooley - Jun 2019)
+  - look at
+    https://www.reddit.com/r/unix/comments/6gxduc/how_is_gnu_yes_so_fast/diua761/
 
   - add development support for http://clang-analyzer.llvm.org/
   - stats for avg/min/max/stddev throughput (Venky.N.Iyer)

doc/quickref.1.in

@@ -1,4 +1,4 @@
-.TH @UCPACKAGE@ 1 "June 2017" Linux "User Manuals"
+.TH @UCPACKAGE@ 1 "June 2020" Linux "User Manuals"
 .SH NAME
 @PACKAGE@ \- monitor the progress of data through a pipe
 .SH SYNOPSIS
@@ -63,19 +63,19 @@ program for a full-screen progress display:
 Taking an image of a disk, skipping errors:
 
 .RS
-.B @PACKAGE@ -EE /dev/sda > disk-image.img
+.B @PACKAGE@ -EE /dev/your/disk/device > disk-image.img
 .RE
 
 Writing an image back to a disk:
 
 .RS
-.B @PACKAGE@ disk-image.img > /dev/sda
+.B @PACKAGE@ disk-image.img > /dev/your/disk/device
 .RE
 
 Zeroing a disk:
 
 .RS
-.B @PACKAGE@ < /dev/zero > /dev/sda
+.B @PACKAGE@ < /dev/zero > /dev/your/disk/device
 .RE
 
 Note that if the input size cannot be calculated, and the output is a block
@@ -155,7 +155,8 @@ percentage of the transfer buffer in use - but see the caveat under
 .B %T
 in the
 .B FORMATTING
-section below.
+section below.  Implies
+.BR \-C .
 .TP
 .B \-A, \-\-last\-written NUM
 Show the last
@@ -164,7 +165,8 @@ bytes written - but see the caveat under
 .B %nA
 in the
 .B FORMATTING
-section below.
+section below.  Implies
+.BR \-C .
 .TP
 .B \-F, \-\-format FORMAT
 Ignore the options
@@ -312,7 +314,10 @@ Use a transfer buffer size of
 bytes.  A suffix of "K", "M", "G", or "T" can be added to denote
 kibibytes (*1024), mebibytes, and so on.  The default buffer size is the
 block size of the input file's filesystem multiplied by 32 (512KiB max), or
-400KiB if the block size cannot be determined.
+400KiB if the block size cannot be determined.  This can be useful on
+platforms like MacOS which perform better in pipelines with specific buffer
+sizes such as 1024.  Implies
+.BR \-C .
 .TP
 .B \-C, \-\-no-splice
 Never use
@@ -328,13 +333,18 @@ but means that the transfer buffer may not be used.  This prevents
 .B \-A
 and
 .B \-T
-from working, so if you want to use
-.B \-A
+from working, and makes
+.B \-B
+redundant, so using
+.BR \-A ,
+.BR \-T ,
 or
-.B \-T
-then you will need to use
-.BR \-C ,
-at the cost of a small loss in transfer efficiency.
+.B \-B
+automatically switches on
+.BR \-C .
+Switching on
+.B \-C
+results in a small loss of transfer efficiency.
 (This option has no effect on systems where
 .BR splice (2)
 is unavailable).
@@ -513,6 +523,11 @@ Show only the elapsed time - useful as a simple timer, e.g.
 The default behaviour: progress bar, elapsed time, estimated completion
 time, current rate, and byte counter.
 
+.P
+On MacOS, it may be useful to specify
+.B -B 1024
+in a pipeline, as this may improve performance.
+
 
 .SH EXIT STATUS
 An exit status of 1 indicates a problem with the
@@ -544,6 +559,7 @@ A signal was caught that caused an early exit.
 .B 64
 Memory allocation failed.
 
+.P
 A zero exit status indicates no problems.
 
 

doc/release-checklist

@@ -9,12 +9,12 @@ Before releasing a new version, go through this checklist:
   - make indent indentclean
   - make update-po
   - make test
-  - commit
+  - commit to SVN
   - wipe build directory, re-run generate.sh and configure
   - make release
   - make manhtml | tidy -asxhtml | sed -e '1,/<body>/d' -e '/<\/body>/,$d'
   - update HTML for todo and news
-  - copy and sign tar.gz to HTML directory
-  - submit new release
+  - copy and sign tar.gz to HTML directory (sig as both .asc and .txt)
+  - submit new release to Sourceforge
   - upload HTML
   - check validator results for project page and manual