bug#30079: 26.0.90; comint commands killing pending input

bug#30079: 26.0.90; comint commands killing pending input

[Charles A. Roelli]

The following four commands all claim to "kill the pending input",
which they don't actually seem to do.  Should the documentation or
implementation be changed?


(defun comint-interrupt-subjob ()
  "Interrupt the current subjob.
This command also kills the pending input
between the process mark and point."
  (interactive)
  (comint-skip-input)
  (interrupt-process nil comint-ptyp)
  ;; (process-send-string nil "\n")
  )

(defun comint-kill-subjob ()
  "Send kill signal to the current subjob.
This command also kills the pending input
between the process mark and point."
  (interactive)
  (comint-skip-input)
  (kill-process nil comint-ptyp))

(defun comint-quit-subjob ()
  "Send quit signal to the current subjob.
This command also kills the pending input
between the process mark and point."
  (interactive)
  (comint-skip-input)
  (quit-process nil comint-ptyp))

(defun comint-stop-subjob ()
  "Stop the current subjob.
This command also kills the pending input
between the process mark and point.

WARNING: if there is no current subjob, you can end up suspending
the top-level process running in the buffer.  If you accidentally do
this, use \\[comint-continue-subjob] to resume the process.  (This
is not a problem with most shells, since they ignore this signal.)"
  (interactive)
  (comint-skip-input)
  (stop-process nil comint-ptyp))

bug#30079: 26.0.90; comint commands killing pending input

[Charles A. Roelli]

> Date: Thu, 11 Jan 2018 21:37:07 +0100
> From: charles@aurox.ch (Charles A. Roelli)
> 
> The following four commands all claim to "kill the pending input",
> which they don't actually seem to do.  Should the documentation or
> implementation be changed?
> 
> 
> (defun comint-interrupt-subjob ()
>   "Interrupt the current subjob.
> This command also kills the pending input
> between the process mark and point."
>   (interactive)
>   (comint-skip-input)
>   (interrupt-process nil comint-ptyp)
>   ;; (process-send-string nil "\n")
>   )
> 
> (defun comint-kill-subjob ()
>   "Send kill signal to the current subjob.
> This command also kills the pending input
> between the process mark and point."
>   (interactive)
>   (comint-skip-input)
>   (kill-process nil comint-ptyp))
> 
> (defun comint-quit-subjob ()
>   "Send quit signal to the current subjob.
> This command also kills the pending input
> between the process mark and point."
>   (interactive)
>   (comint-skip-input)
>   (quit-process nil comint-ptyp))
> 
> (defun comint-stop-subjob ()
>   "Stop the current subjob.
> This command also kills the pending input
> between the process mark and point.
> 
> WARNING: if there is no current subjob, you can end up suspending
> the top-level process running in the buffer.  If you accidentally do
> this, use \\[comint-continue-subjob] to resume the process.  (This
> is not a problem with most shells, since they ignore this signal.)"
>   (interactive)
>   (comint-skip-input)
>   (stop-process nil comint-ptyp))

I pushed a documentation fix to emacs-26:

  commit 98e5fb9bf3b49bea82a4d3e38be20415bd7f7684
  Author: Charles A. Roelli <charles@aurox.ch>
  Date:   Mon Jan 15 21:14:05 2018 +0100

    Remove incorrect documentation in comint.el

    * lisp/comint.el (comint-interrupt-subjob, comint-kill-subjob)
    (comint-quit-subjob, comint-stop-subjob): Remove incorrect
    documentation.  (Bug#30079)

If there's any interest in reinstating the old, documented (but
unimplemented) behavior in the master branch, please reopen.