From dc6271f586ec483cf3d4b96695303bd321a373ce Mon Sep 17 00:00:00 2001
From: Kegan Dougal <7190048+kegsay@users.noreply.github.com>
Date: Wed, 10 Jan 2024 15:28:10 +0000
Subject: [PATCH] Blurb on dirty runs

---
 ENVIRONMENT.md     | 1 +
 cmd/gendoc/main.go | 1 +
 2 files changed, 2 insertions(+)

diff --git a/ENVIRONMENT.md b/ENVIRONMENT.md
index 59d417b..511018f 100644
--- a/ENVIRONMENT.md
+++ b/ENVIRONMENT.md
@@ -2,6 +2,7 @@
 
 ## Complement-Crypto Configuration
 Complement-Crypto is configured exclusively through the use of environment variables. These variables are described below. Additional environment variables can be used, and are outlined at https://github.com/matrix-org/complement/blob/main/ENVIRONMENT.md 
+Complement-Crypto always runs in dirty mode (homeservers exist for the entire duration of the test suite) for performance reasons.
 
 #### `COMPLEMENT_CRYPTO_TCPDUMP`
 If 1, automatically attempts to run `tcpdump` when the containers are running. Stops dumping when tests complete. This will probably require you to run `go test` with `sudo -E`. The `.pcap` file is written to `tests/test.pcap`.  
diff --git a/cmd/gendoc/main.go b/cmd/gendoc/main.go
index 5e3c691..e570a52 100644
--- a/cmd/gendoc/main.go
+++ b/cmd/gendoc/main.go
@@ -128,6 +128,7 @@ func main() {
 		"",
 		"## Complement-Crypto Configuration",
 		"Complement-Crypto is configured exclusively through the use of environment variables. These variables are described below. Additional environment variables can be used, and are outlined at https://github.com/matrix-org/complement/blob/main/ENVIRONMENT.md ",
+		"Complement-Crypto always runs in dirty mode (homeservers exist for the entire duration of the test suite) for performance reasons.",
 	}
 	for _, vd := range varDocs {
 		mdFileLines = append(mdFileLines, fmt.Sprintf("\n#### `%v`", vd.Name))