Improve documentation of the internal Lisp_Process->status field

Contrary to the existing documentation here, the value of this
field cannot be the symbols open or closed.  Furthermore, this
field is never set to "stop" for network connections.
* src/process.h (Lisp_Process): Improve/fix documentation of the
'status' field.  (Bug#78784)

(cherry picked from commit 4d88b925ba839fab9448915edcc699a6647df71c)

diff --git a/src/process.h b/src/process.h
index a27e95a9199fd3e3d9d10fe32755fc80c57e268e..1e0ad8c7f68bfe81bb120e31828fb95ab3160bfc 100644 (file)
--- a/src/process.h
+++ b/src/process.h
@@ -83,13 +83,20 @@ struct Lisp_Process
     Lisp_Object mark;
 
     /* Symbol indicating status of process.
-       This may be a symbol: run, open, closed, listen, or failed.
+       This may be a symbol: run, listen, or failed.
        Or it may be a pair (connect . ADDRINFOS) where ADDRINFOS is
        a list of remaining (PROTOCOL . ADDRINFO) pairs to try.
        Or it may be (failed ERR) where ERR is an integer, string or symbol.
        Or it may be a list, whose car is stop, exit or signal
        and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
-       or (SIGNAL_NUMBER . COREDUMP_FLAG).  */
+       or (SIGNAL_NUMBER . COREDUMP_FLAG).
+       The symbols open and closed are not used here: an open network
+       process has an internal status of "run" and a closed network
+       process an internal status of "exit".
+       Stopped network processes do not set this status to "stop";
+       instead, they set command to t. "stop" is only used here to
+       indicate stopped system processes.
+     */
     Lisp_Object status;
 
     /* Coding-system for decoding the input from this process.  */