From f51f247a1c74394072f32ab22a216920c6dac9c4 Mon Sep 17 00:00:00 2001
From: Oliver Gugger <gugger@gmail.com>
Date: Sat, 7 Nov 2020 13:56:55 +0100
Subject: [PATCH] docs: describe new itest make commands

---
 docs/MAKEFILE.md | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/docs/MAKEFILE.md b/docs/MAKEFILE.md
index 558eb850..98532882 100644
--- a/docs/MAKEFILE.md
+++ b/docs/MAKEFILE.md
@@ -121,6 +121,32 @@ Arguments:
 - `icase=<itestcase>` (the snake_case version of the testcase name field in the testCases slice (i.e. sweep_coins), not the test func name)
 - `timeout=<timeout>`
 
+`itest-parallel`
+------
+Does the same as `itest` but splits the total set of tests into
+`NUM_ITEST_TRANCHES` tranches (currently set to 6 by default, can be overwritten
+by setting `tranches=Y`) and runs them in parallel.
+
+Arguments:
+- `icase=<itestcase>`: The snake_case version of the testcase name field in the
+  testCases slice (i.e. `sweep_coins`, not the test func name) or any regular
+  expression describing a set of tests.
+- `timeout=<timeout>`
+- `tranches=<number_of_tranches>`: The number of parts/tranches to split the
+  total set of tests into.
+- `parallel=<number_of_threads>`: The number of threads to run in parallel. Must
+  be greater or equal to `tranches`, otherwise undefined behavior is expected.
+
+`flakehunter-parallel`
+------
+Runs the test specified by `icase` simultaneously `parallel` (default=6) times
+until an error occurs. Useful for hunting flakes.
+
+Example:
+```shell
+$ make flakehunter-parallel icase='(data_loss_protection|channel_backup)' backend=neutrino
+```
+
 `lint`
 ------
 Ensures that [`gopkg.in/alecthomas/gometalinter.v1`][gometalinter] is