multishell - Be more specific about why we use tramp-cleanup-connection.

diff --git a/multishell.el b/multishell.el
index 3043ad7d070160998d8acf99330aa28b3714fe7b..da24034fb39c7df101cc2f41c99bfa80a6c36d43 100644 (file)
--- a/multishell.el
+++ b/multishell.el
@@ -706,7 +706,11 @@ and path nil if none is resolved."
 
       (when (and (derived-mode-p 'shell-mode) (file-remote-p path))
         ;; Returning to disconnected remote shell - do some tidying.
-        ;; Prevents an "Args out of range" failure when reconnecting.
+        ;; Without this cleanup, occasionally restarting a disconnected
+        ;; remote session, particularly one that includes sudo, results in
+        ;; an untraceable "Args out of range" error. That never happens if
+        ;; we precedeed connection attempts with this cleanup -
+        ;; prophylactic.
         (tramp-cleanup-connection
          (tramp-dissect-file-name default-directory 'noexpand)
          'keep-debug 'keep-password))