From 15797ba17b84b86e0ace0418ae1874eac949eb58 Mon Sep 17 00:00:00 2001
From: Yaman Umuroglu <yamanu@xilinx.com>
Date: Fri, 3 Jul 2020 17:29:07 +0100
Subject: [PATCH] [Docs] mention parallel testing

---
 docs/finn/getting_started.rst | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/docs/finn/getting_started.rst b/docs/finn/getting_started.rst
index f4fa7a13d..8b20cebcf 100644
--- a/docs/finn/getting_started.rst
+++ b/docs/finn/getting_started.rst
@@ -73,8 +73,12 @@ from the FINN root directory* as follows:
 
   python setup.py test --addopts "-k test_end2end_tfc_w1a2"
 
-Please see the pytest documentation for more about picking tests by marks or
-by name.
+Finally, if you want to run tests in parallel (e.g. to take advantage of a multi-core CPU)
+you can use:
+ * pytest-parallel for any rtlsim tests, e.g. `python setup.py test --addopts "-k rtlsim --workers auto"`
+ * pytest-xdist for anything else, make sure to add `--dist=loadfile` if you have tests in the same file that have dependencies on each other e.g. `python setup.py test --addopts "-k mytest -n auto --dist=loadfile"`
+
+Please see the pytest documentation for more about picking tests by marks or by name.
 
 Environment variables
 **********************
-- 
GitLab