Update option descriptions

bording · bording · commit 9e417812e1b8 · 2026-04-06T13:24:27.000-04:00
diff --git a/src/NServiceBus.Transport.RabbitMQ.CommandLine/SharedOptions.cs b/src/NServiceBus.Transport.RabbitMQ.CommandLine/SharedOptions.cs
@@ -6,6 +6,8 @@ static class SharedOptions
     {
         const string ConnectionStringEnvironmentVariable = "RabbitMQTransport_ConnectionString";
 
+        //Standard options
+
         public static Option<string> CreateConnectionStringOption()
         {
             var connectionStringOption = new Option<string>("--connectionString", "-c")
@@ -126,17 +128,19 @@ public static Option<string> CreateCertPassphraseOption()
         {
             var certPassphraseOption = new Option<string>("--certPassphrase")
             {
-                Description = "The passphrase for client certificate file for when using a client certificate"
+                Description = "The passphrase for the client certificate file when using a client certificate"
             };
 
             return certPassphraseOption;
         }
 
+        // Options for source broker
+
         public static Option<string> CreateSourceConnectionStringOption()
         {
             var connectionStringOption = new Option<string>("--sourceConnectionString")
             {
-                Description = "Force this command to use the specified connection string"
+                Description = "Force this command to use the specified connection string for the source broker"
             };
 
             return connectionStringOption;
@@ -146,7 +150,7 @@ public static Option<string> CreateSourceConnectionStringEnvOption()
         {
             var connectionStringEnvOption = new Option<string>("--sourceConnectionStringEnv")
             {
-                Description = "Specifies the environment variable where the connection string can be found. --connectionString, if specified, will take precedence over this option.",
+                Description = "Specifies the environment variable where the connection string for the source broker can be found. --sourceConnectionString, if specified, will take precedence over this option.",
                 DefaultValueFactory = _ => "RabbitMQTransport_Source_ConnectionString"
             };
 
@@ -157,7 +161,7 @@ public static Option<string> CreateSourceManagementApiUrlOption()
         {
             var managementApiUrlOption = new Option<string>("--sourceManagementApiUrl")
             {
-                Description = "Overrides the value inferred from the connection string"
+                Description = "Overrides the value inferred from the connection string for the source broker"
             };
 
             return managementApiUrlOption;
@@ -167,7 +171,7 @@ public static Option<string> CreateSourceManagementApiUserNameOption()
         {
             var managementApiUserNameOption = new Option<string>("--sourceManagementApiUserName")
             {
-                Description = "Overrides the value inferred from the connection string. If provided, --managementApiPassword must also be provided or this option will be ignored."
+                Description = "Overrides the value inferred from the connection string for the source broker. If provided, --sourceManagementApiPassword must also be provided or this option will be ignored."
             };
 
             return managementApiUserNameOption;
@@ -177,7 +181,7 @@ public static Option<string> CreateSourceManagementApiPasswordOption()
         {
             var managementApiPasswordOption = new Option<string>("--sourceManagementApiPassword")
             {
-                Description = "Overrides the value inferred from the connection string. If provided, --managementApiUserName must also be provided or this option will be ignored."
+                Description = "Overrides the value inferred from the connection string for the source broker. If provided, --sourceManagementApiUserName must also be provided or this option will be ignored."
             };
 
             return managementApiPasswordOption;
@@ -187,7 +191,7 @@ public static Option<bool> CreateSourceUseExternalAuthOption()
         {
             var useExternalAuthOption = new Option<bool>("--sourceUseExternalAuth")
             {
-                Description = "Use the external authorization option when connecting to the broker",
+                Description = "Use the external authorization option when connecting to the source broker",
                 DefaultValueFactory = _ => false
             };
 
@@ -198,7 +202,7 @@ public static Option<string> CreateSourceCertPathOption()
         {
             var certPathOption = new Option<string>("--sourceCertPath")
             {
-                Description = "Set the path to the client certificate file for connecting to the broker"
+                Description = "Set the path to the client certificate file for connecting to the source broker"
             };
 
             return certPathOption;
@@ -208,17 +212,19 @@ public static Option<string> CreateSourceCertPassphraseOption()
         {
             var certPassphraseOption = new Option<string>("--sourceCertPassphrase")
             {
-                Description = "The passphrase for client certificate file for when using a client certificate"
+                Description = "The passphrase for the client certificate file when using a client certificate to connect to the source broker"
             };
 
             return certPassphraseOption;
         }
 
+        // Options for destination broker
+
         public static Option<string> CreateDestinationConnectionStringOption()
         {
             var connectionStringOption = new Option<string>("--destinationConnectionString")
             {
-                Description = "Force this command to use the specified connection string"
+                Description = "Force this command to use the specified connection string for the destination broker"
             };
 
             return connectionStringOption;
@@ -228,7 +234,7 @@ public static Option<string> CreateDestinationConnectionStringEnvOption()
         {
             var connectionStringEnvOption = new Option<string>("--destinationConnectionStringEnv")
             {
-                Description = "Specifies the environment variable where the connection string can be found. --connectionString, if specified, will take precedence over this option.",
+                Description = "Specifies the environment variable where the connection string for the destination broker can be found. --destinationConnectionString, if specified, will take precedence over this option.",
                 DefaultValueFactory = _ => "RabbitMQTransport_Destination_ConnectionString"
             };
 
@@ -239,7 +245,7 @@ public static Option<string> CreateDestinationManagementApiUrlOption()
         {
             var managementApiUrlOption = new Option<string>("--destinationManagementApiUrl")
             {
-                Description = "Overrides the value inferred from the connection string"
+                Description = "Overrides the value inferred from the connection string for the destination broker"
             };
 
             return managementApiUrlOption;
@@ -249,7 +255,7 @@ public static Option<string> CreateDestinationManagementApiUserNameOption()
         {
             var managementApiUserNameOption = new Option<string>("--destinationManagementApiUserName")
             {
-                Description = "Overrides the value inferred from the connection string. If provided, --managementApiPassword must also be provided or this option will be ignored."
+                Description = "Overrides the value inferred from the connection string for the destination broker. If provided, --destinationManagementApiPassword must also be provided or this option will be ignored."
             };
 
             return managementApiUserNameOption;
@@ -259,7 +265,7 @@ public static Option<string> CreateDestinationManagementApiPasswordOption()
         {
             var managementApiPasswordOption = new Option<string>("--destinationManagementApiPassword")
             {
-                Description = "Overrides the value inferred from the connection string. If provided, --managementApiUserName must also be provided or this option will be ignored."
+                Description = "Overrides the value inferred from the connection string for the destination broker. If provided, --destinationManagementApiUserName must also be provided or this option will be ignored."
             };
 
             return managementApiPasswordOption;
@@ -269,7 +275,7 @@ public static Option<bool> CreateDestinationUseExternalAuthOption()
         {
             var useExternalAuthOption = new Option<bool>("--destinationUseExternalAuth")
             {
-                Description = "Use the external authorization option when connecting to the broker",
+                Description = "Use the external authorization option when connecting to the destination broker",
                 DefaultValueFactory = _ => false
             };
 
@@ -280,7 +286,7 @@ public static Option<string> CreateDestinationCertPathOption()
         {
             var certPathOption = new Option<string>("--destinationCertPath")
             {
-                Description = "Set the path to the client certificate file for connecting to the broker"
+                Description = "Set the path to the client certificate file for connecting to the destination broker"
             };
 
             return certPathOption;
@@ -290,7 +296,7 @@ public static Option<string> CreateDestinationCertPassphraseOption()
         {
             var certPassphraseOption = new Option<string>("--destinationCertPassphrase")
             {
-                Description = "The passphrase for client certificate file for when using a client certificate"
+                Description = "The passphrase for the client certificate file when using a client certificate to connect to the destination broker"
             };
 
             return certPassphraseOption;

Original file line number	Diff line number	Diff line change
`@@ -6,6 +6,8 @@ static class SharedOptions`
`6`	`6`	`{`
`7`	`7`	`const string ConnectionStringEnvironmentVariable = "RabbitMQTransport_ConnectionString";`
`8`	`8`
	`9`	`+ //Standard options`
	`10`	`+`
`9`	`11`	`public static Option<string> CreateConnectionStringOption()`
`10`	`12`	`{`
`11`	`13`	`var connectionStringOption = new Option<string>("--connectionString", "-c")`
`@@ -126,17 +128,19 @@ public static Option<string> CreateCertPassphraseOption()`
`126`	`128`	`{`
`127`	`129`	`var certPassphraseOption = new Option<string>("--certPassphrase")`
`128`	`130`	`{`
`129`		`- Description = "The passphrase for client certificate file for when using a client certificate"`
	`131`	`+ Description = "The passphrase for the client certificate file when using a client certificate"`
`130`	`132`	`};`
`131`	`133`
`132`	`134`	`return certPassphraseOption;`
`133`	`135`	`}`
`134`	`136`
	`137`	`+ // Options for source broker`
	`138`	`+`
`135`	`139`	`public static Option<string> CreateSourceConnectionStringOption()`
`136`	`140`	`{`
`137`	`141`	`var connectionStringOption = new Option<string>("--sourceConnectionString")`
`138`	`142`	`{`
`139`		`- Description = "Force this command to use the specified connection string"`
	`143`	`+ Description = "Force this command to use the specified connection string for the source broker"`
`140`	`144`	`};`
`141`	`145`
`142`	`146`	`return connectionStringOption;`
`@@ -146,7 +150,7 @@ public static Option<string> CreateSourceConnectionStringEnvOption()`
`146`	`150`	`{`
`147`	`151`	`var connectionStringEnvOption = new Option<string>("--sourceConnectionStringEnv")`
`148`	`152`	`{`
`149`		`- Description = "Specifies the environment variable where the connection string can be found. --connectionString, if specified, will take precedence over this option.",`
	`153`	`+ Description = "Specifies the environment variable where the connection string for the source broker can be found. --sourceConnectionString, if specified, will take precedence over this option.",`
`150`	`154`	`DefaultValueFactory = _ => "RabbitMQTransport_Source_ConnectionString"`
`151`	`155`	`};`
`152`	`156`
`@@ -157,7 +161,7 @@ public static Option<string> CreateSourceManagementApiUrlOption()`
`157`	`161`	`{`
`158`	`162`	`var managementApiUrlOption = new Option<string>("--sourceManagementApiUrl")`
`159`	`163`	`{`
`160`		`- Description = "Overrides the value inferred from the connection string"`
	`164`	`+ Description = "Overrides the value inferred from the connection string for the source broker"`
`161`	`165`	`};`
`162`	`166`
`163`	`167`	`return managementApiUrlOption;`
`@@ -167,7 +171,7 @@ public static Option<string> CreateSourceManagementApiUserNameOption()`
`167`	`171`	`{`
`168`	`172`	`var managementApiUserNameOption = new Option<string>("--sourceManagementApiUserName")`
`169`	`173`	`{`
`170`		`- Description = "Overrides the value inferred from the connection string. If provided, --managementApiPassword must also be provided or this option will be ignored."`
	`174`	`+ Description = "Overrides the value inferred from the connection string for the source broker. If provided, --sourceManagementApiPassword must also be provided or this option will be ignored."`
`171`	`175`	`};`
`172`	`176`
`173`	`177`	`return managementApiUserNameOption;`
`@@ -177,7 +181,7 @@ public static Option<string> CreateSourceManagementApiPasswordOption()`
`177`	`181`	`{`
`178`	`182`	`var managementApiPasswordOption = new Option<string>("--sourceManagementApiPassword")`
`179`	`183`	`{`
`180`		`- Description = "Overrides the value inferred from the connection string. If provided, --managementApiUserName must also be provided or this option will be ignored."`
	`184`	`+ Description = "Overrides the value inferred from the connection string for the source broker. If provided, --sourceManagementApiUserName must also be provided or this option will be ignored."`
`181`	`185`	`};`
`182`	`186`
`183`	`187`	`return managementApiPasswordOption;`
`@@ -187,7 +191,7 @@ public static Option<bool> CreateSourceUseExternalAuthOption()`
`187`	`191`	`{`
`188`	`192`	`var useExternalAuthOption = new Option<bool>("--sourceUseExternalAuth")`
`189`	`193`	`{`
`190`		`- Description = "Use the external authorization option when connecting to the broker",`
	`194`	`+ Description = "Use the external authorization option when connecting to the source broker",`
`191`	`195`	`DefaultValueFactory = _ => false`
`192`	`196`	`};`
`193`	`197`
`@@ -198,7 +202,7 @@ public static Option<string> CreateSourceCertPathOption()`
`198`	`202`	`{`
`199`	`203`	`var certPathOption = new Option<string>("--sourceCertPath")`
`200`	`204`	`{`
`201`		`- Description = "Set the path to the client certificate file for connecting to the broker"`
	`205`	`+ Description = "Set the path to the client certificate file for connecting to the source broker"`
`202`	`206`	`};`
`203`	`207`
`204`	`208`	`return certPathOption;`
`@@ -208,17 +212,19 @@ public static Option<string> CreateSourceCertPassphraseOption()`
`208`	`212`	`{`
`209`	`213`	`var certPassphraseOption = new Option<string>("--sourceCertPassphrase")`
`210`	`214`	`{`
`211`		`- Description = "The passphrase for client certificate file for when using a client certificate"`
	`215`	`+ Description = "The passphrase for the client certificate file when using a client certificate to connect to the source broker"`
`212`	`216`	`};`
`213`	`217`
`214`	`218`	`return certPassphraseOption;`
`215`	`219`	`}`
`216`	`220`
	`221`	`+ // Options for destination broker`
	`222`	`+`
`217`	`223`	`public static Option<string> CreateDestinationConnectionStringOption()`
`218`	`224`	`{`
`219`	`225`	`var connectionStringOption = new Option<string>("--destinationConnectionString")`
`220`	`226`	`{`
`221`		`- Description = "Force this command to use the specified connection string"`
	`227`	`+ Description = "Force this command to use the specified connection string for the destination broker"`
`222`	`228`	`};`
`223`	`229`
`224`	`230`	`return connectionStringOption;`
`@@ -228,7 +234,7 @@ public static Option<string> CreateDestinationConnectionStringEnvOption()`
`228`	`234`	`{`
`229`	`235`	`var connectionStringEnvOption = new Option<string>("--destinationConnectionStringEnv")`
`230`	`236`	`{`
`231`		`- Description = "Specifies the environment variable where the connection string can be found. --connectionString, if specified, will take precedence over this option.",`
	`237`	`+ Description = "Specifies the environment variable where the connection string for the destination broker can be found. --destinationConnectionString, if specified, will take precedence over this option.",`
`232`	`238`	`DefaultValueFactory = _ => "RabbitMQTransport_Destination_ConnectionString"`
`233`	`239`	`};`
`234`	`240`
`@@ -239,7 +245,7 @@ public static Option<string> CreateDestinationManagementApiUrlOption()`
`239`	`245`	`{`
`240`	`246`	`var managementApiUrlOption = new Option<string>("--destinationManagementApiUrl")`
`241`	`247`	`{`
`242`		`- Description = "Overrides the value inferred from the connection string"`
	`248`	`+ Description = "Overrides the value inferred from the connection string for the destination broker"`
`243`	`249`	`};`
`244`	`250`
`245`	`251`	`return managementApiUrlOption;`
`@@ -249,7 +255,7 @@ public static Option<string> CreateDestinationManagementApiUserNameOption()`
`249`	`255`	`{`
`250`	`256`	`var managementApiUserNameOption = new Option<string>("--destinationManagementApiUserName")`
`251`	`257`	`{`
`252`		`- Description = "Overrides the value inferred from the connection string. If provided, --managementApiPassword must also be provided or this option will be ignored."`
	`258`	`+ Description = "Overrides the value inferred from the connection string for the destination broker. If provided, --destinationManagementApiPassword must also be provided or this option will be ignored."`
`253`	`259`	`};`
`254`	`260`
`255`	`261`	`return managementApiUserNameOption;`
`@@ -259,7 +265,7 @@ public static Option<string> CreateDestinationManagementApiPasswordOption()`
`259`	`265`	`{`
`260`	`266`	`var managementApiPasswordOption = new Option<string>("--destinationManagementApiPassword")`
`261`	`267`	`{`
`262`		`- Description = "Overrides the value inferred from the connection string. If provided, --managementApiUserName must also be provided or this option will be ignored."`
	`268`	`+ Description = "Overrides the value inferred from the connection string for the destination broker. If provided, --destinationManagementApiUserName must also be provided or this option will be ignored."`
`263`	`269`	`};`
`264`	`270`
`265`	`271`	`return managementApiPasswordOption;`
`@@ -269,7 +275,7 @@ public static Option<bool> CreateDestinationUseExternalAuthOption()`
`269`	`275`	`{`
`270`	`276`	`var useExternalAuthOption = new Option<bool>("--destinationUseExternalAuth")`
`271`	`277`	`{`
`272`		`- Description = "Use the external authorization option when connecting to the broker",`
	`278`	`+ Description = "Use the external authorization option when connecting to the destination broker",`
`273`	`279`	`DefaultValueFactory = _ => false`
`274`	`280`	`};`
`275`	`281`
`@@ -280,7 +286,7 @@ public static Option<string> CreateDestinationCertPathOption()`
`280`	`286`	`{`
`281`	`287`	`var certPathOption = new Option<string>("--destinationCertPath")`
`282`	`288`	`{`
`283`		`- Description = "Set the path to the client certificate file for connecting to the broker"`
	`289`	`+ Description = "Set the path to the client certificate file for connecting to the destination broker"`
`284`	`290`	`};`
`285`	`291`
`286`	`292`	`return certPathOption;`
`@@ -290,7 +296,7 @@ public static Option<string> CreateDestinationCertPassphraseOption()`
`290`	`296`	`{`
`291`	`297`	`var certPassphraseOption = new Option<string>("--destinationCertPassphrase")`
`292`	`298`	`{`
`293`		`- Description = "The passphrase for client certificate file for when using a client certificate"`
	`299`	`+ Description = "The passphrase for the client certificate file when using a client certificate to connect to the destination broker"`
`294`	`300`	`};`
`295`	`301`
`296`	`302`	`return certPassphraseOption;`