From: Scott Baker <scott@perturb.org>
Date: Thu, 23 Nov 2017 04:29:46 +0000 (-0800)
Subject: Include information about the benchmark output/methodology
X-Git-Tag: v1.3.3^2~31^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=31a191b17895d115b35fa4c254a9b99b67bbe58a;p=thirdparty%2Fzstd.git

Include information about the benchmark output/methodology

Addresses #930
---

diff --git a/programs/zstd.1.md b/programs/zstd.1.md
index eea685489..9e4c5d305 100644
--- a/programs/zstd.1.md
+++ b/programs/zstd.1.md
@@ -258,6 +258,9 @@ BENCHMARK
 * `--priority=rt`:
     set process priority to real-time
 
+**Output Format:** CompressionLevel#Filename : IntputSize -> OutputSize (CompressionRatio), CompressionSpeed, DecompressionSpeed
+
+**Methodology:** For both compression and decompression speed, the entire input is compressed/decompressed in-memory to measure speed. A run lasts at least 1 sec, so when files are small, they are compressed/decompressed several times per run, in order to improve measurement accuracy.
 
 ADVANCED COMPRESSION OPTIONS
 ----------------------------