aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNoam Postavsky2018-02-05 19:36:27 -0500
committerNoam Postavsky2018-02-07 20:17:50 -0500
commit04c5bd5b1f1dc07994d70caa640a07da6b5a54b5 (patch)
treed506276ecc406bb81c25e0f2ea83dc139c6f8c67
parente209034536b11fbbba19f46a45f6afc316890a5d (diff)
downloademacs-04c5bd5b1f1dc07994d70caa640a07da6b5a54b5.tar.gz
emacs-04c5bd5b1f1dc07994d70caa640a07da6b5a54b5.zip
Doc fixes for process functions (Bug#30349)
* doc/lispref/processes.texi (Asynchronous Processes): Explain what the 'stopped' state means for a pipe process. * src/process.c (Fmake_process, Fmake_pipe_process) (Fmake_serial_process, Fmake_network_process): * lisp/subr.el (start-process): * lisp/net/tls.el (open-tls-stream): * lisp/net/starttls.el (starttls-open-stream): * lisp/net/gnutls.el (open-gnutls-stream): Remove meaningless phrase "specify an output stream" phrase from docstring.
-rw-r--r--doc/lispref/processes.texi7
-rw-r--r--lisp/net/gnutls.el2
-rw-r--r--lisp/net/starttls.el2
-rw-r--r--lisp/net/tls.el2
-rw-r--r--lisp/subr.el8
-rw-r--r--src/process.c18
6 files changed, 20 insertions, 19 deletions
diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi
index 8a8425cb84b..34426f339c6 100644
--- a/doc/lispref/processes.texi
+++ b/doc/lispref/processes.texi
@@ -728,8 +728,11 @@ Initialize the process query flag to @var{query-flag}.
728@xref{Query Before Exit}. 728@xref{Query Before Exit}.
729 729
730@item :stop @var{stopped} 730@item :stop @var{stopped}
731If @var{stopped} is non-@code{nil}, start the process in the 731If @var{stopped} is non-@code{nil}, start the process in the stopped
732stopped state. 732state. In the stopped state, a pipe process does not accept incoming
733data, but you can send outgoing data. The stopped state is set by
734@code{stop-process} and cleared by @code{continue-process}
735(@pxref{Signals to Processes}).
733 736
734@item :filter @var{filter} 737@item :filter @var{filter}
735Initialize the process filter to @var{filter}. If not specified, a 738Initialize the process filter to @var{filter}. If not specified, a
diff --git a/lisp/net/gnutls.el b/lisp/net/gnutls.el
index 5afd5c5804b..ea17fb518e2 100644
--- a/lisp/net/gnutls.el
+++ b/lisp/net/gnutls.el
@@ -124,7 +124,7 @@ Args are NAME BUFFER HOST SERVICE.
124NAME is name for process. It is modified if necessary to make it unique. 124NAME is name for process. It is modified if necessary to make it unique.
125BUFFER is the buffer (or `buffer-name') to associate with the process. 125BUFFER is the buffer (or `buffer-name') to associate with the process.
126 Process output goes at end of that buffer, unless you specify 126 Process output goes at end of that buffer, unless you specify
127 an output stream or filter function to handle the output. 127 a filter function to handle the output.
128 BUFFER may be also nil, meaning that this process is not associated 128 BUFFER may be also nil, meaning that this process is not associated
129 with any buffer 129 with any buffer
130Third arg is name of the host to connect to, or its IP address. 130Third arg is name of the host to connect to, or its IP address.
diff --git a/lisp/net/starttls.el b/lisp/net/starttls.el
index 2069843e3bb..e2dff2d53d6 100644
--- a/lisp/net/starttls.el
+++ b/lisp/net/starttls.el
@@ -270,7 +270,7 @@ Args are NAME BUFFER HOST PORT.
270NAME is name for process. It is modified if necessary to make it unique. 270NAME is name for process. It is modified if necessary to make it unique.
271BUFFER is the buffer (or `buffer-name') to associate with the process. 271BUFFER is the buffer (or `buffer-name') to associate with the process.
272 Process output goes at end of that buffer, unless you specify 272 Process output goes at end of that buffer, unless you specify
273 an output stream or filter function to handle the output. 273 a filter function to handle the output.
274 BUFFER may be also nil, meaning that this process is not associated 274 BUFFER may be also nil, meaning that this process is not associated
275 with any buffer 275 with any buffer
276Third arg is name of the host to connect to, or its IP address. 276Third arg is name of the host to connect to, or its IP address.
diff --git a/lisp/net/tls.el b/lisp/net/tls.el
index ae49edcb1d5..b02a2654d41 100644
--- a/lisp/net/tls.el
+++ b/lisp/net/tls.el
@@ -204,7 +204,7 @@ Args are NAME BUFFER HOST PORT.
204NAME is name for process. It is modified if necessary to make it unique. 204NAME is name for process. It is modified if necessary to make it unique.
205BUFFER is the buffer (or buffer name) to associate with the process. 205BUFFER is the buffer (or buffer name) to associate with the process.
206 Process output goes at end of that buffer, unless you specify 206 Process output goes at end of that buffer, unless you specify
207 an output stream or filter function to handle the output. 207 a filter function to handle the output.
208 BUFFER may be also nil, meaning that this process is not associated 208 BUFFER may be also nil, meaning that this process is not associated
209 with any buffer 209 with any buffer
210Third arg is name of the host to connect to, or its IP address. 210Third arg is name of the host to connect to, or its IP address.
diff --git a/lisp/subr.el b/lisp/subr.el
index 64cbbd52ab8..2de5b3766c2 100644
--- a/lisp/subr.el
+++ b/lisp/subr.el
@@ -2110,10 +2110,10 @@ and the file name is displayed in the echo area."
2110NAME is name for process. It is modified if necessary to make it unique. 2110NAME is name for process. It is modified if necessary to make it unique.
2111BUFFER is the buffer (or buffer name) to associate with the process. 2111BUFFER is the buffer (or buffer name) to associate with the process.
2112 2112
2113Process output (both standard output and standard error streams) goes 2113Process output (both standard output and standard error streams)
2114at end of BUFFER, unless you specify an output stream or filter 2114goes at end of BUFFER, unless you specify a filter function to
2115function to handle the output. BUFFER may also be nil, meaning that 2115handle the output. BUFFER may also be nil, meaning that this
2116this process is not associated with any buffer. 2116process is not associated with any buffer.
2117 2117
2118PROGRAM is the program file name. It is searched for in `exec-path' 2118PROGRAM is the program file name. It is searched for in `exec-path'
2119\(which see). If nil, just associate a pty with the buffer. Remaining 2119\(which see). If nil, just associate a pty with the buffer. Remaining
diff --git a/src/process.c b/src/process.c
index 8a438cfeb8b..c561d01060c 100644
--- a/src/process.c
+++ b/src/process.c
@@ -1618,9 +1618,8 @@ to make it unique.
1618 1618
1619:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate 1619:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
1620with the process. Process output goes at end of that buffer, unless 1620with the process. Process output goes at end of that buffer, unless
1621you specify an output stream or filter function to handle the output. 1621you specify a filter function to handle the output. BUFFER may be
1622BUFFER may be also nil, meaning that this process is not associated 1622also nil, meaning that this process is not associated with any buffer.
1623with any buffer.
1624 1623
1625:command COMMAND -- COMMAND is a list starting with the program file 1624:command COMMAND -- COMMAND is a list starting with the program file
1626name, followed by strings to give to the program as arguments. 1625name, followed by strings to give to the program as arguments.
@@ -2310,8 +2309,8 @@ arguments are defined:
2310 2309
2311:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate 2310:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
2312with the process. Process output goes at the end of that buffer, 2311with the process. Process output goes at the end of that buffer,
2313unless you specify an output stream or filter function to handle the 2312unless you specify a filter function to handle the output. If BUFFER
2314output. If BUFFER is not given, the value of NAME is used. 2313is not given, the value of NAME is used.
2315 2314
2316:coding CODING -- If CODING is a symbol, it specifies the coding 2315:coding CODING -- If CODING is a symbol, it specifies the coding
2317system used for both reading and writing for this process. If CODING 2316system used for both reading and writing for this process. If CODING
@@ -3025,8 +3024,8 @@ the value of PORT is used.
3025 3024
3026:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate 3025:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
3027with the process. Process output goes at the end of that buffer, 3026with the process. Process output goes at the end of that buffer,
3028unless you specify an output stream or filter function to handle the 3027unless you specify a filter function to handle the output. If BUFFER
3029output. If BUFFER is not given, the value of NAME is used. 3028is not given, the value of NAME is used.
3030 3029
3031:coding CODING -- If CODING is a symbol, it specifies the coding 3030:coding CODING -- If CODING is a symbol, it specifies the coding
3032system used for both reading and writing for this process. If CODING 3031system used for both reading and writing for this process. If CODING
@@ -3688,9 +3687,8 @@ to make it unique.
3688 3687
3689:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate 3688:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
3690with the process. Process output goes at end of that buffer, unless 3689with the process. Process output goes at end of that buffer, unless
3691you specify an output stream or filter function to handle the output. 3690you specify a filter function to handle the output. BUFFER may be
3692BUFFER may be also nil, meaning that this process is not associated 3691also nil, meaning that this process is not associated with any buffer.
3693with any buffer.
3694 3692
3695:host HOST -- HOST is name of the host to connect to, or its IP 3693:host HOST -- HOST is name of the host to connect to, or its IP
3696address. The symbol `local' specifies the local host. If specified 3694address. The symbol `local' specifies the local host. If specified