summary refs log tree commit diff
path: root/README.rst
diff options
context:
space:
mode:
authorEric Eastwood <erice@element.io>2021-06-11 03:57:34 -0500
committerGitHub <noreply@github.com>2021-06-11 09:57:34 +0100
commite21c3473324116e4a25346991aca08e3207778e1 (patch)
tree63f6de51f5eafa19bc8e62da2d16c6a2aa015150 /README.rst
parentMention that you need to configure max upload size in reverse proxy as well (... (diff)
downloadsynapse-e21c3473324116e4a25346991aca08e3207778e1.tar.xz
Document how to see logger output when running the twisted tests (#10148)
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst29
1 files changed, 17 insertions, 12 deletions
diff --git a/README.rst b/README.rst
index a14a687fd1..1c9f05cc85 100644
--- a/README.rst
+++ b/README.rst
@@ -293,18 +293,6 @@ try installing the failing modules individually::
 
     pip install -e "module-name"
 
-Once this is done, you may wish to run Synapse's unit tests to
-check that everything is installed correctly::
-
-    python -m twisted.trial tests
-
-This should end with a 'PASSED' result (note that exact numbers will
-differ)::
-
-    Ran 1337 tests in 716.064s
-
-    PASSED (skips=15, successes=1322)
-
 We recommend using the demo which starts 3 federated instances running on ports `8080` - `8082`
 
     ./demo/start.sh
@@ -324,6 +312,23 @@ If you just want to start a single instance of the app and run it directly::
     python -m synapse.app.homeserver --config-path homeserver.yaml
 
 
+Running the unit tests
+======================
+
+After getting up and running, you may wish to run Synapse's unit tests to
+check that everything is installed correctly::
+
+    trial tests
+
+This should end with a 'PASSED' result (note that exact numbers will
+differ)::
+
+    Ran 1337 tests in 716.064s
+
+    PASSED (skips=15, successes=1322)
+
+For more tips on running the unit tests, like running a specific test or
+to see the logging output, see the `CONTRIBUTING doc <CONTRIBUTING.md#run-the-unit-tests>`_.
 
 
 Running the Integration Tests