[PATCH] connect.c: clarify BUG() messages in push_ssh_options
- From
Matthias Aßhauer <mha1993@live.de>
- Date
- Apr 25, 2020, 09:43 UTC
- Message-ID
- <AM0PR04MB4771946E0134D9D875AB1A8AA5D10@AM0PR04MB4771.eurprd04.prod.outlook.com>
- In-Reply-To
- <AM0PR04MB4771FB8BCD1EEB7E60EF54C7A5D00@AM0PR04MB4771.eurprd04.prod.outlook.com>
The current BUG() messages in push_ssh_options imply that calling push_ssh_options and passing VARIANT_AUTO is always a bug and we should check for it once at the top of push_ssh_options instead of multiple times in various if statements. That is not actually the case. When the caller passes CONNECT_IPV4, CONNECT_IPV6 or a custom port alongside VARIANT_AUTO we cannot translate that to an option to the underlying SSH implementation without knowing the variant. As long as the caller does not specify IPV4/IPV6 or a custom port, it is ok for the caller to leave the variant AUTO. Let's explicitly state that the bug is in the combination of parameters.
Signed-off-by: Matthias Aßhauer <mha1993@live.de> --- connect.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/connect.c b/connect.c index 23013c6344..c15e60b13a 100644 --- a/connect.c +++ b/connect.c @@ -1118,7 +1118,7 @@ static void push_ssh_options(struct argv_array *args, struct argv_array *env, if (flags & CONNECT_IPV4) { switch (variant) { case VARIANT_AUTO: - BUG("VARIANT_AUTO passed to push_ssh_options"); + BUG("VARIANT_AUTO and CONNECT_IPV4 passed to push_ssh_options"); case VARIANT_SIMPLE: die(_("ssh variant 'simple' does not support -4")); case VARIANT_SSH: @@ -1130,7 +1130,7 @@ static void push_ssh_options(struct argv_array *args, struct argv_array *env, } else if (flags & CONNECT_IPV6) { switch (variant) { case VARIANT_AUTO: - BUG("VARIANT_AUTO passed to push_ssh_options"); + BUG("VARIANT_AUTO and CONNECT_IPV6 passed to push_ssh_options"); case VARIANT_SIMPLE: die(_("ssh variant 'simple' does not support -6")); case VARIANT_SSH: @@ -1147,7 +1147,7 @@ static void push_ssh_options(struct argv_array *args, struct argv_array *env, if (port) { switch (variant) { case VARIANT_AUTO: - BUG("VARIANT_AUTO passed to push_ssh_options"); + BUG("VARIANT_AUTO and a custom port passed to push_ssh_options"); case VARIANT_SIMPLE: die(_("ssh variant 'simple' does not support setting port")); case VARIANT_SSH:
-- 2.17.1