summary refs log tree commit diff
diff options
context:
space:
mode:
authorEric Eastwood <erice@element.io>2022-05-09 04:38:32 -0500
committerGitHub <noreply@github.com>2022-05-09 10:38:32 +0100
commit18d6c18aa16ab9809656d1175adf4617da44e36c (patch)
tree66b499af8e3494bfea1eda20dfd2ebcb94f64ef0
parentUse `Concatenate` to annotate `do_execute` (#12666) (diff)
downloadsynapse-18d6c18aa16ab9809656d1175adf4617da44e36c.tar.xz
Fix docs on how to run specific Complement tests after recent `complement.sh` change (#12664)
Diffstat (limited to '')
-rw-r--r--changelog.d/12664.doc1
-rw-r--r--docs/development/contributing_guide.md4
2 files changed, 3 insertions, 2 deletions
diff --git a/changelog.d/12664.doc b/changelog.d/12664.doc
new file mode 100644
index 0000000000..142d18037a
--- /dev/null
+++ b/changelog.d/12664.doc
@@ -0,0 +1 @@
+Fix docs on how to run specific Complement tests using the `complement.sh` test runner.
diff --git a/docs/development/contributing_guide.md b/docs/development/contributing_guide.md
index 3b5c774018..d356c72bf7 100644
--- a/docs/development/contributing_guide.md
+++ b/docs/development/contributing_guide.md
@@ -270,13 +270,13 @@ COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh
 To run a specific test file, you can pass the test name at the end of the command. The name passed comes from the naming structure in your Complement tests. If you're unsure of the name, you can do a full run and copy it from the test output:
 
 ```sh
-COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh TestBackfillingHistory
+COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -run TestImportHistoricalMessages
 ```
 
 To run a specific test, you can specify the whole name structure:
 
 ```sh
-COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh TestBackfillingHistory/parallel/Backfilled_historical_events_resolve_with_proper_state_in_correct_order
+COMPLEMENT_DIR=../complement ./scripts-dev/complement.sh -run TestImportHistoricalMessages/parallel/Historical_events_resolve_in_the_correct_order
 ```