diff --git a/docs/benchmark-pv-transfers.sh b/docs/benchmark-pv-transfers.sh index 464cf16..a518ae0 100755 --- a/docs/benchmark-pv-transfers.sh +++ b/docs/benchmark-pv-transfers.sh @@ -1,17 +1,21 @@ #!/bin/bash # +# Benchmark transfer rates, and analyse benchmark results. +# # Measure transfer rates and CPU usage with various different options, # multiple times, then calculate the mean and standard deviation for each # set of measurements. # -# The report is written to stdout as tab-separated values, each line +# The results are written to stdout as tab-separated values, each line # prefixed with an opaque system ID (based on "uname -a"), the PV version # expressed as an integer, and a run ID based on the start date and time. # -# Takes a path to a pv binary as an argument. +# In analysis mode, read results from multiple benchmark runs on standard +# input, and for each type of measurement, show the differences between +# either the different PV versions or the different runs. # Defaults. -pv='pv' # pv executable to run the measurements with +pv='pv' # PV executable to run the measurements with rounds='10' # how many rounds of measurements to take testFileMB='256' # max size of each of the test files, in MiB testZeroesMB='1024' # amount of /dev/zero data to use, in MiB @@ -557,26 +561,28 @@ while test -n "$1"; do '-h'|'--help') cat - <