diff options
| author | Noam Postavsky | 2018-02-05 19:36:27 -0500 |
|---|---|---|
| committer | Noam Postavsky | 2018-02-07 20:17:50 -0500 |
| commit | 04c5bd5b1f1dc07994d70caa640a07da6b5a54b5 (patch) | |
| tree | d506276ecc406bb81c25e0f2ea83dc139c6f8c67 | |
| parent | e209034536b11fbbba19f46a45f6afc316890a5d (diff) | |
| download | emacs-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.texi | 7 | ||||
| -rw-r--r-- | lisp/net/gnutls.el | 2 | ||||
| -rw-r--r-- | lisp/net/starttls.el | 2 | ||||
| -rw-r--r-- | lisp/net/tls.el | 2 | ||||
| -rw-r--r-- | lisp/subr.el | 8 | ||||
| -rw-r--r-- | src/process.c | 18 |
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} |
| 731 | If @var{stopped} is non-@code{nil}, start the process in the | 731 | If @var{stopped} is non-@code{nil}, start the process in the stopped |
| 732 | stopped state. | 732 | state. In the stopped state, a pipe process does not accept incoming |
| 733 | data, 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} |
| 735 | Initialize the process filter to @var{filter}. If not specified, a | 738 | Initialize 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. | |||
| 124 | NAME is name for process. It is modified if necessary to make it unique. | 124 | NAME is name for process. It is modified if necessary to make it unique. |
| 125 | BUFFER is the buffer (or `buffer-name') to associate with the process. | 125 | BUFFER 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 |
| 130 | Third arg is name of the host to connect to, or its IP address. | 130 | Third 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. | |||
| 270 | NAME is name for process. It is modified if necessary to make it unique. | 270 | NAME is name for process. It is modified if necessary to make it unique. |
| 271 | BUFFER is the buffer (or `buffer-name') to associate with the process. | 271 | BUFFER 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 |
| 276 | Third arg is name of the host to connect to, or its IP address. | 276 | Third 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. | |||
| 204 | NAME is name for process. It is modified if necessary to make it unique. | 204 | NAME is name for process. It is modified if necessary to make it unique. |
| 205 | BUFFER is the buffer (or buffer name) to associate with the process. | 205 | BUFFER 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 |
| 210 | Third arg is name of the host to connect to, or its IP address. | 210 | Third 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." | |||
| 2110 | NAME is name for process. It is modified if necessary to make it unique. | 2110 | NAME is name for process. It is modified if necessary to make it unique. |
| 2111 | BUFFER is the buffer (or buffer name) to associate with the process. | 2111 | BUFFER is the buffer (or buffer name) to associate with the process. |
| 2112 | 2112 | ||
| 2113 | Process output (both standard output and standard error streams) goes | 2113 | Process output (both standard output and standard error streams) |
| 2114 | at end of BUFFER, unless you specify an output stream or filter | 2114 | goes at end of BUFFER, unless you specify a filter function to |
| 2115 | function to handle the output. BUFFER may also be nil, meaning that | 2115 | handle the output. BUFFER may also be nil, meaning that this |
| 2116 | this process is not associated with any buffer. | 2116 | process is not associated with any buffer. |
| 2117 | 2117 | ||
| 2118 | PROGRAM is the program file name. It is searched for in `exec-path' | 2118 | PROGRAM 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 |
| 1620 | with the process. Process output goes at end of that buffer, unless | 1620 | with the process. Process output goes at end of that buffer, unless |
| 1621 | you specify an output stream or filter function to handle the output. | 1621 | you specify a filter function to handle the output. BUFFER may be |
| 1622 | BUFFER may be also nil, meaning that this process is not associated | 1622 | also nil, meaning that this process is not associated with any buffer. |
| 1623 | with 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 |
| 1626 | name, followed by strings to give to the program as arguments. | 1625 | name, 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 |
| 2312 | with the process. Process output goes at the end of that buffer, | 2311 | with the process. Process output goes at the end of that buffer, |
| 2313 | unless you specify an output stream or filter function to handle the | 2312 | unless you specify a filter function to handle the output. If BUFFER |
| 2314 | output. If BUFFER is not given, the value of NAME is used. | 2313 | is 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 |
| 2317 | system used for both reading and writing for this process. If CODING | 2316 | system 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 |
| 3027 | with the process. Process output goes at the end of that buffer, | 3026 | with the process. Process output goes at the end of that buffer, |
| 3028 | unless you specify an output stream or filter function to handle the | 3027 | unless you specify a filter function to handle the output. If BUFFER |
| 3029 | output. If BUFFER is not given, the value of NAME is used. | 3028 | is 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 |
| 3032 | system used for both reading and writing for this process. If CODING | 3031 | system 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 |
| 3690 | with the process. Process output goes at end of that buffer, unless | 3689 | with the process. Process output goes at end of that buffer, unless |
| 3691 | you specify an output stream or filter function to handle the output. | 3690 | you specify a filter function to handle the output. BUFFER may be |
| 3692 | BUFFER may be also nil, meaning that this process is not associated | 3691 | also nil, meaning that this process is not associated with any buffer. |
| 3693 | with 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 |
| 3696 | address. The symbol `local' specifies the local host. If specified | 3694 | address. The symbol `local' specifies the local host. If specified |