Markdownify regression-tests/README

diff --git a/regression-tests/README b/regression-tests/README.md
similarity index 75%
rename from regression-tests/README
rename to regression-tests/README.md
index 458048a1c764adcdc20d2ad310e95d9462d48251..11f6463264bed42a6c2079ec983d51d95c9b07cc 100644 (file)
--- a/regression-tests/README
+++ b/regression-tests/README.md
@@ -5,15 +5,15 @@ Dependencies
 ------------
 We need very recent versions of:
 
-       validns (http://www.validns.net/)
-       ldns-verify-zone (part of ldns)
-       jdnssec-verifyzone (http://www.verisignlabs.com/dnssec-tools/)
-       named-checkzone (part of BIND9)
-       unbound-host (part of unbound)
-       drill (part of ldns)
+ * validns (http://www.validns.net/)
+ * ldns-verify-zone (part of ldns)
+ * jdnssec-verifyzone (http://www.verisignlabs.com/dnssec-tools/)
+ * named-checkzone (part of BIND9)
+ * unbound-host (part of unbound)
+ * drill (part of ldns)
 
 Nice to have:
-       godns q
+ * godns q
 
 If you omit the tools above, some tests fail, but you can still run the
 tests. 
@@ -24,12 +24,16 @@ Automated tests
 For a more hands-off approach, make sure PowerDNS is built with suitable
 modules, and use:
 
+```
 $ ./start-test-stop 5300 gmysql
+```
 
 To start PowerDNS in gmysql mode (including DNSSEC), run all tests, and
 write reports, using udp port 5300 in the process. Use:
 
+```
 $ ./start-test-stop help
+```
 
 to see all available suites.
 
@@ -39,7 +43,7 @@ compatible XML report.
 Manual testing
 --------------
 
-Start PowerDNS with --no-shuffle for best results - the 'too-big-udp' test
+Start PowerDNS with `--no-shuffle` for best results - the 'too-big-udp' test
 fails otherwise, for cosmetical reasons.
 
 Method of operation
@@ -47,18 +51,18 @@ Method of operation
 
 Each directory contains a command that, when executed, process the 'cleandig'
 output for the answer the nameserver sent. This output is stored in the file
-'real_result', and compared to 'expected_result' or one of its replacement
+`real_result`, and compared to `expected_result` or one of its replacement
 files.
 
-Then, 'diff -u' is run on those two files, and the output sent to the file
-'diff'. If everything is as it should be, this diff file is empty, and
+Then, `diff -u` is run on those two files, and the output sent to the file
+`diff`. If everything is as it should be, this diff file is empty, and
 PowerDNS passed the test.
 
 Caveats
 -------
 
 Optional features of the DNS standard can cause a difference to arrise. For
-example, 'Bind 8' appears to fail on nearly all our tests, whereas it is in
+example, "Bind 8" appears to fail on nearly all our tests, whereas it is in
 compliance (except for one case).
 
 Study the diff output to be sure if there is a problem.
@@ -69,32 +73,38 @@ How to run
 See beyond this section for information on how to run automatically.
 
 First make sure PowerDNS has access to the testing zones, which are all
-referred in the 'named.conf' file. Use the 'zone2sql' tool to create sql and
+referred in the `named.conf` file. Use the `zone2sql` tool to create SQL and
 feed it to your database if you want to test one of the sql backends.
 
 Run PowerDNS as (to test gmysql):
 
+```
 $ ../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./  \
 --no-shuffle --launch=gmysql --gmysql-dbname=pdnstest --gmysql-user=root \
 --fancy-records --query-logging --send-root-referral --loglevel=9 \
 --cache-ttl=0 --no-config
+```
 
 or (to test bind, without DNSSEC):
+```
 $ ../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./  \
 --no-shuffle --launch=bind --bind-config=./named.conf                \
 --fancy-records --query-logging --send-root-referral --loglevel=9    \
 --cache-ttl=0 --no-config
+```
 
 or (to test bind with DNSSEC):
 
+```
 $ ./bind-dnssec-setup
 $ ../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./  \
 --no-shuffle --launch=bind --bind-config=./named.conf                \
 --query-logging --send-root-referral --loglevel=9                    \
 --cache-ttl=0 --no-config
+```
 
 Or only sqlite3:
-
+```
 rm powerdns.sqlite3
 sqlite3 powerdns.sqlite3 < ../pdns/no-dnssec.schema.sqlite3.sql
 sqlite3 powerdns.sqlite3 < ../pdns/dnssec.schema.sqlite3.sql
@@ -102,26 +112,27 @@ sqlite3 powerdns.sqlite3 < ../pdns/dnssec.schema.sqlite3.sql
 --transactions --dnssec | sqlite3 powerdns.sqlite3
 echo 'analyze;' | sqlite3 powerdns.sqlite3
 
-
 $ ../pdns/pdns_server --daemon=no --local-port=5300 --socket-dir=./  \
 --no-shuffle --launch=gsqlite3 \
 --gsqlite3-database=./powerdns.sqlite3 --gsqlite3-dnssec             \
 --query-logging --send-root-referral --loglevel=9                    \
 --cache-ttl=0 --no-config
+```
 
-
-Set the 'nameserver' and 'port' variables to point to your pdns_server
+Set the `nameserver` and `port` variables to point to your pdns\_server
 instance:
 
+```
 $ nameserver=127.0.0.1 port=5300 ./runtests
+```
 
-The BIND backend can't do MBOXFW. The 'any-query' test is known to fail
+The BIND backend can't do MBOXFW. The `any-query` test is known to fail
 with bind,gsqlite3.
 
 
 Analysing results
 -----------------
 
-Failed tests appear in the file 'failed_tests', passed tests in
-'passed_tests'. A complete log is in the file 'log'. Examine the 'diff'
+Failed tests appear in the file `failed_tests`, passed tests in
+`passed_tests`. A complete log is in the file `log`. Examine the `diff`
 files in all subdirectories to see what happened.