aboutsummaryrefslogtreecommitdiffstats
path: root/src/process.c
diff options
context:
space:
mode:
authorEli Zaretskii2016-08-24 17:36:28 +0300
committerEli Zaretskii2016-08-24 17:36:28 +0300
commit88a5052579069be93a0af556c9a43a8ed75d3efb (patch)
tree29fb4799516a2d8f5e6cd84c5dc801720a63c69a /src/process.c
parent89eb09f6a1df176fbaa3cbb996f60948efc5f463 (diff)
downloademacs-88a5052579069be93a0af556c9a43a8ed75d3efb.tar.gz
emacs-88a5052579069be93a0af556c9a43a8ed75d3efb.zip
Improve and clarify documentation of subprocesses
* doc/lispref/processes.texi (Subprocess Creation, Shell Arguments): Mention 'make-process' rather than 'start-process'. Update wrt standard destinations of standard output/error streams and due to different formats of arguments accepted by 'make-process'. (Processes): Mention process objects that represent connections. (Synchronous Processes): Minor clarifications. (Asynchronous Processes): Describe 'make-process' and 'make-pipe-process' before 'start-process'. Update and expand the documentation. (Deleting Processes, Process Information, Input to Processes) (Signals to Processes, Query Before Exit, Network): Update and expand the documentation, especially wrt process objects that represent connections. (Output from Processes): Mention the possibility of separating stderr via 'make-process'. (Filter Functions): Mention that stderr by default arrives at the filter function together with stdout. (Bug#24287) * src/process.c (Fprocess_id, Fprocess_command) (Fprocess_contact, Fprocess_type, Fstop_process): Doc fixes for process objects that represent connections.
Diffstat (limited to 'src/process.c')
-rw-r--r--src/process.c26
1 files changed, 13 insertions, 13 deletions
diff --git a/src/process.c b/src/process.c
index 05934294a04..7ab92b0102c 100644
--- a/src/process.c
+++ b/src/process.c
@@ -928,7 +928,7 @@ If PROCESS has not yet exited or died, return 0. */)
928DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0, 928DEFUN ("process-id", Fprocess_id, Sprocess_id, 1, 1, 0,
929 doc: /* Return the process id of PROCESS. 929 doc: /* Return the process id of PROCESS.
930This is the pid of the external process which PROCESS uses or talks to. 930This is the pid of the external process which PROCESS uses or talks to.
931For a network connection, this value is nil. */) 931For a network, serial, and pipe connections, this value is nil. */)
932 (register Lisp_Object process) 932 (register Lisp_Object process)
933{ 933{
934 pid_t pid; 934 pid_t pid;
@@ -952,8 +952,8 @@ DEFUN ("process-command", Fprocess_command, Sprocess_command, 1, 1, 0,
952 doc: /* Return the command that was executed to start PROCESS. 952 doc: /* Return the command that was executed to start PROCESS.
953This is a list of strings, the first string being the program executed 953This is a list of strings, the first string being the program executed
954and the rest of the strings being the arguments given to it. 954and the rest of the strings being the arguments given to it.
955For a network or serial process, this is nil (process is running) or t 955For a network or serial or pipe connection, this is nil (process is running)
956\(process is stopped). */) 956or t (process is stopped). */)
957 (register Lisp_Object process) 957 (register Lisp_Object process)
958{ 958{
959 CHECK_PROCESS (process); 959 CHECK_PROCESS (process);
@@ -1181,13 +1181,13 @@ DEFUN ("process-query-on-exit-flag",
1181DEFUN ("process-contact", Fprocess_contact, Sprocess_contact, 1181DEFUN ("process-contact", Fprocess_contact, Sprocess_contact,
1182 1, 2, 0, 1182 1, 2, 0,
1183 doc: /* Return the contact info of PROCESS; t for a real child. 1183 doc: /* Return the contact info of PROCESS; t for a real child.
1184For a network or serial connection, the value depends on the optional 1184For a network or serial or pipe connection, the value depends on the
1185KEY arg. If KEY is nil, value is a cons cell of the form (HOST 1185optional KEY arg. If KEY is nil, value is a cons cell of the form
1186SERVICE) for a network connection or (PORT SPEED) for a serial 1186\(HOST SERVICE) for a network connection or (PORT SPEED) for a serial
1187connection. If KEY is t, the complete contact information for the 1187connection; it is t for a pipe connection. If KEY is t, the complete
1188connection is returned, else the specific value for the keyword KEY is 1188contact information for the connection is returned, else the specific
1189returned. See `make-network-process' or `make-serial-process' for a 1189value for the keyword KEY is returned. See `make-network-process',
1190list of keywords. */) 1190\`make-serial-process', or `make-pipe-process' for the list of keywords. */)
1191 (register Lisp_Object process, Lisp_Object key) 1191 (register Lisp_Object process, Lisp_Object key)
1192{ 1192{
1193 Lisp_Object contact; 1193 Lisp_Object contact;
@@ -1254,7 +1254,7 @@ a socket connection. */)
1254 1254
1255DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0, 1255DEFUN ("process-type", Fprocess_type, Sprocess_type, 1, 1, 0,
1256 doc: /* Return the connection type of PROCESS. 1256 doc: /* Return the connection type of PROCESS.
1257The value is either the symbol `real', `network', or `serial'. 1257The value is either the symbol `real', `network', `serial', or `pipe'.
1258PROCESS may be a process, a buffer, the name of a process or buffer, or 1258PROCESS may be a process, a buffer, the name of a process or buffer, or
1259nil, indicating the current buffer's process. */) 1259nil, indicating the current buffer's process. */)
1260 (Lisp_Object process) 1260 (Lisp_Object process)
@@ -6156,8 +6156,8 @@ See function `interrupt-process' for more details on usage. */)
6156DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0, 6156DEFUN ("stop-process", Fstop_process, Sstop_process, 0, 2, 0,
6157 doc: /* Stop process PROCESS. May be process or name of one. 6157 doc: /* Stop process PROCESS. May be process or name of one.
6158See function `interrupt-process' for more details on usage. 6158See function `interrupt-process' for more details on usage.
6159If PROCESS is a network or serial process, inhibit handling of incoming 6159If PROCESS is a network or serial or pipe connection, inhibit handling
6160traffic. */) 6160of incoming traffic. */)
6161 (Lisp_Object process, Lisp_Object current_group) 6161 (Lisp_Object process, Lisp_Object current_group)
6162{ 6162{
6163 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process) 6163 if (PROCESSP (process) && (NETCONN_P (process) || SERIALCONN_P (process)