From 96fd597fef3e9dd514b44d8dcebffcdb00a6ffc0 Mon Sep 17 00:00:00 2001
From: Hugh Nimmo-Smith <hughns@matrix.org>
Date: Thu, 5 Oct 2023 19:11:41 +0100
Subject: [PATCH] Docs for --dryRun

---
 tools/syn2mas/src/migrate.mts | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/tools/syn2mas/src/migrate.mts b/tools/syn2mas/src/migrate.mts
index 2fa2dcd88..645f18f8e 100644
--- a/tools/syn2mas/src/migrate.mts
+++ b/tools/syn2mas/src/migrate.mts
@@ -38,7 +38,7 @@ export async function migrate(argv?: string[]): Promise<void> {
     synapseConfigFile: { type: String, description: "Path to synapse homeserver.yaml config file" },
     masConfigFile: { type: String, description: "Path to MAS config.yaml" },
     upstreamProviderMapping: { type: String, defaultValue: [], multiple: true, description: "Mapping of upstream provider IDs to MAS provider IDs. Format: <upstream_provider_id>:<mas_provider_id>" },
-    dryRun: { type: Boolean, optional: true, defaultValue: false },
+    dryRun: { type: Boolean, optional: true, defaultValue: false, description: "Dry run only, do not write to database" },
     help: { type: Boolean, optional: true, alias: "h", description: "Prints this usage guide" },
   },
   {