From: Timo Tijhof <krinklemail@gmail.com>
Date: Sat, 27 Jan 2018 00:31:54 +0000 (-0800)
Subject: benchmarks: Improve readme and convert to Markdown
X-Git-Tag: 1.31.0-rc.0~788^2
X-Git-Url: http://git.cyclocoop.org/data/%24oldEdit?a=commitdiff_plain;h=be15056c37936efdb7bb9afe577ea8bac1f68625;p=lhc%2Fweb%2Fwiklou.git

benchmarks: Improve readme and convert to Markdown

* Add sections.
* Rename to *.md.
* Document that taskset is Linux-specific.

Change-Id: If6c5e54eda4dd1d6ea02445efa73e356dbc49016
---

diff --git a/maintenance/benchmarks/README b/maintenance/benchmarks/README
deleted file mode 100644
index 27da9defd1..0000000000
--- a/maintenance/benchmarks/README
+++ /dev/null
@@ -1,10 +0,0 @@
-This directory hold several benchmarking scripts used as a proof of speed
-or to track PHP performances over time.
-
-To get somehow accurate result, you might want to bound the PHP process
-to a specific CPU with `taskset` and raise its priority with `nice`. Example:
-
- $ taskset 1 nice -n-10 php bench_wfIsWindows.php
-
-australia-untidy.html.gz contains representative input text for
-benchmarkTidy.php. It needs to be decompressed before use.
diff --git a/maintenance/benchmarks/README.md b/maintenance/benchmarks/README.md
new file mode 100644
index 0000000000..b411c52611
--- /dev/null
+++ b/maintenance/benchmarks/README.md
@@ -0,0 +1,15 @@
+This directory hold several benchmarking scripts used track performances of
+MediaWiki and/or PHP.
+
+## Consistency
+
+On Linux, use of `taskset` and `nice` can help get more consistent results.
+
+For example:
+
+ $ taskset 1 nice -n-10 php bench_wfIsWindows.php
+
+## Fixtures
+
+* australia-untidy.html.gz: Representative input text for benchmarkTidy.php.
+  It needs to be decompressed before use.