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.
This commit is contained in:
parent
e209034536
commit
04c5bd5b1f
6 changed files with 20 additions and 19 deletions
|
@ -728,8 +728,11 @@ Initialize the process query flag to @var{query-flag}.
|
||||||
@xref{Query Before Exit}.
|
@xref{Query Before Exit}.
|
||||||
|
|
||||||
@item :stop @var{stopped}
|
@item :stop @var{stopped}
|
||||||
If @var{stopped} is non-@code{nil}, start the process in the
|
If @var{stopped} is non-@code{nil}, start the process in the stopped
|
||||||
stopped state.
|
state. In the stopped state, a pipe process does not accept incoming
|
||||||
|
data, but you can send outgoing data. The stopped state is set by
|
||||||
|
@code{stop-process} and cleared by @code{continue-process}
|
||||||
|
(@pxref{Signals to Processes}).
|
||||||
|
|
||||||
@item :filter @var{filter}
|
@item :filter @var{filter}
|
||||||
Initialize the process filter to @var{filter}. If not specified, a
|
Initialize the process filter to @var{filter}. If not specified, a
|
||||||
|
|
|
@ -124,7 +124,7 @@ Args are NAME BUFFER HOST SERVICE.
|
||||||
NAME is name for process. It is modified if necessary to make it unique.
|
NAME is name for process. It is modified if necessary to make it unique.
|
||||||
BUFFER is the buffer (or `buffer-name') to associate with the process.
|
BUFFER is the buffer (or `buffer-name') to associate with the process.
|
||||||
Process output goes at end of that buffer, unless you specify
|
Process output goes at end of that buffer, unless you specify
|
||||||
an output stream or filter function to handle the output.
|
a filter function to handle the output.
|
||||||
BUFFER may be also nil, meaning that this process is not associated
|
BUFFER may be also nil, meaning that this process is not associated
|
||||||
with any buffer
|
with any buffer
|
||||||
Third arg is name of the host to connect to, or its IP address.
|
Third arg is name of the host to connect to, or its IP address.
|
||||||
|
|
|
@ -270,7 +270,7 @@ Args are NAME BUFFER HOST PORT.
|
||||||
NAME is name for process. It is modified if necessary to make it unique.
|
NAME is name for process. It is modified if necessary to make it unique.
|
||||||
BUFFER is the buffer (or `buffer-name') to associate with the process.
|
BUFFER is the buffer (or `buffer-name') to associate with the process.
|
||||||
Process output goes at end of that buffer, unless you specify
|
Process output goes at end of that buffer, unless you specify
|
||||||
an output stream or filter function to handle the output.
|
a filter function to handle the output.
|
||||||
BUFFER may be also nil, meaning that this process is not associated
|
BUFFER may be also nil, meaning that this process is not associated
|
||||||
with any buffer
|
with any buffer
|
||||||
Third arg is name of the host to connect to, or its IP address.
|
Third arg is name of the host to connect to, or its IP address.
|
||||||
|
|
|
@ -204,7 +204,7 @@ Args are NAME BUFFER HOST PORT.
|
||||||
NAME is name for process. It is modified if necessary to make it unique.
|
NAME is name for process. It is modified if necessary to make it unique.
|
||||||
BUFFER is the buffer (or buffer name) to associate with the process.
|
BUFFER is the buffer (or buffer name) to associate with the process.
|
||||||
Process output goes at end of that buffer, unless you specify
|
Process output goes at end of that buffer, unless you specify
|
||||||
an output stream or filter function to handle the output.
|
a filter function to handle the output.
|
||||||
BUFFER may be also nil, meaning that this process is not associated
|
BUFFER may be also nil, meaning that this process is not associated
|
||||||
with any buffer
|
with any buffer
|
||||||
Third arg is name of the host to connect to, or its IP address.
|
Third arg is name of the host to connect to, or its IP address.
|
||||||
|
|
|
@ -2110,10 +2110,10 @@ and the file name is displayed in the echo area."
|
||||||
NAME is name for process. It is modified if necessary to make it unique.
|
NAME is name for process. It is modified if necessary to make it unique.
|
||||||
BUFFER is the buffer (or buffer name) to associate with the process.
|
BUFFER is the buffer (or buffer name) to associate with the process.
|
||||||
|
|
||||||
Process output (both standard output and standard error streams) goes
|
Process output (both standard output and standard error streams)
|
||||||
at end of BUFFER, unless you specify an output stream or filter
|
goes at end of BUFFER, unless you specify a filter function to
|
||||||
function to handle the output. BUFFER may also be nil, meaning that
|
handle the output. BUFFER may also be nil, meaning that this
|
||||||
this process is not associated with any buffer.
|
process is not associated with any buffer.
|
||||||
|
|
||||||
PROGRAM is the program file name. It is searched for in `exec-path'
|
PROGRAM is the program file name. It is searched for in `exec-path'
|
||||||
\(which see). If nil, just associate a pty with the buffer. Remaining
|
\(which see). If nil, just associate a pty with the buffer. Remaining
|
||||||
|
|
|
@ -1618,9 +1618,8 @@ to make it unique.
|
||||||
|
|
||||||
:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
|
:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
|
||||||
with the process. Process output goes at end of that buffer, unless
|
with the process. Process output goes at end of that buffer, unless
|
||||||
you specify an output stream or filter function to handle the output.
|
you specify a filter function to handle the output. BUFFER may be
|
||||||
BUFFER may be also nil, meaning that this process is not associated
|
also nil, meaning that this process is not associated with any buffer.
|
||||||
with any buffer.
|
|
||||||
|
|
||||||
:command COMMAND -- COMMAND is a list starting with the program file
|
:command COMMAND -- COMMAND is a list starting with the program file
|
||||||
name, followed by strings to give to the program as arguments.
|
name, followed by strings to give to the program as arguments.
|
||||||
|
@ -2310,8 +2309,8 @@ arguments are defined:
|
||||||
|
|
||||||
:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
|
:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
|
||||||
with the process. Process output goes at the end of that buffer,
|
with the process. Process output goes at the end of that buffer,
|
||||||
unless you specify an output stream or filter function to handle the
|
unless you specify a filter function to handle the output. If BUFFER
|
||||||
output. If BUFFER is not given, the value of NAME is used.
|
is not given, the value of NAME is used.
|
||||||
|
|
||||||
:coding CODING -- If CODING is a symbol, it specifies the coding
|
:coding CODING -- If CODING is a symbol, it specifies the coding
|
||||||
system used for both reading and writing for this process. If CODING
|
system used for both reading and writing for this process. If CODING
|
||||||
|
@ -3025,8 +3024,8 @@ the value of PORT is used.
|
||||||
|
|
||||||
:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
|
:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
|
||||||
with the process. Process output goes at the end of that buffer,
|
with the process. Process output goes at the end of that buffer,
|
||||||
unless you specify an output stream or filter function to handle the
|
unless you specify a filter function to handle the output. If BUFFER
|
||||||
output. If BUFFER is not given, the value of NAME is used.
|
is not given, the value of NAME is used.
|
||||||
|
|
||||||
:coding CODING -- If CODING is a symbol, it specifies the coding
|
:coding CODING -- If CODING is a symbol, it specifies the coding
|
||||||
system used for both reading and writing for this process. If CODING
|
system used for both reading and writing for this process. If CODING
|
||||||
|
@ -3688,9 +3687,8 @@ to make it unique.
|
||||||
|
|
||||||
:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
|
:buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
|
||||||
with the process. Process output goes at end of that buffer, unless
|
with the process. Process output goes at end of that buffer, unless
|
||||||
you specify an output stream or filter function to handle the output.
|
you specify a filter function to handle the output. BUFFER may be
|
||||||
BUFFER may be also nil, meaning that this process is not associated
|
also nil, meaning that this process is not associated with any buffer.
|
||||||
with any buffer.
|
|
||||||
|
|
||||||
:host HOST -- HOST is name of the host to connect to, or its IP
|
:host HOST -- HOST is name of the host to connect to, or its IP
|
||||||
address. The symbol `local' specifies the local host. If specified
|
address. The symbol `local' specifies the local host. If specified
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue