poptoshell - Clarify start-shell-in-buffer and pop-to-buffer behavior.

diff --git a/poptoshell.el b/poptoshell.el
index 153f927479777c933d0d61fbe6e125d898ad79c2..e682cc89f1e9271c81e5dc3445cabcf3890f835c 100644 (file)
--- a/poptoshell.el
+++ b/poptoshell.el
@@ -124,9 +124,12 @@ Emacs tramp syntax to launch a remote shell.
  - If not in a shell buffer (or with universal argument), go to a
    window that is already showing the (a) shell buffer, if any.
 
+   We use `pop-up-windows`, so you can adjust/customize that
+   to control the other-buffer/same-buffer behavior.
+
    In this case, the cursor is left in its prior position in the
-   shell buffer. (Repeating the command will then go to the
-   process input point, by the previous behavior.)
+   shell buffer. Repeating the command will then go to the
+   process input point, per the first item in this list.
 
  - Otherwise, start a new shell buffer, using the current
    directory as the working directory..
@@ -330,7 +333,10 @@ on empty input."
       (setq name (substring name 0 -1)))
   name)
 (defun start-shell-in-buffer (buffer-name)
-  ;; Damn comint requires buffer name be bracketed by "*" asterisks.
+  "Ensure a shell is started, using whatever name we're passed."
+  ;; We work around shell-mode's bracketing of the buffer name, and do
+  ;; some tramp-mode hygiene for remote connections.
+
   (require 'comint)
   (require 'shell)