aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGlenn Morris2014-02-21 15:10:56 -0500
committerGlenn Morris2014-02-21 15:10:56 -0500
commit5fcd01e507c919ff09f317b07d49d1e10c80536b (patch)
tree4f15ec5c05f562a2c4519123f444775b093b63d2
parentf35affb60fe64b0c840133ffbf3c6868a0e7f400 (diff)
downloademacs-5fcd01e507c919ff09f317b07d49d1e10c80536b.tar.gz
emacs-5fcd01e507c919ff09f317b07d49d1e10c80536b.zip
Tweak earlier doc/lispref/processes.texi change
-rw-r--r--doc/lispref/ChangeLog6
-rw-r--r--doc/lispref/processes.texi40
2 files changed, 21 insertions, 25 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index eb6559ba07f..706fe131d7b 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -6,9 +6,9 @@
62014-02-21 Glenn Morris <rgm@gnu.org> 62014-02-21 Glenn Morris <rgm@gnu.org>
7 7
8 * internals.texi (Process Internals): 8 * internals.texi (Process Internals):
9 * processes.texi (Deleting Processes, Output from Processes) 9 * processes.texi (Subprocess Creation, Deleting Processes)
10 (Process Buffers, Filter Functions, Accepting Output, Sentinels) 10 (Output from Processes, Process Buffers, Filter Functions)
11 (Network, Network Servers, Network Processes, Serial Ports): 11 (Accepting Output, Sentinels, Network, Network Servers):
12 Filters and sentinels can no longer be nil. 12 Filters and sentinels can no longer be nil.
13 * elisp.texi (Top): Menu update. 13 * elisp.texi (Top): Menu update.
14 14
diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi
index a564bd604c7..43a3666415d 100644
--- a/doc/lispref/processes.texi
+++ b/doc/lispref/processes.texi
@@ -112,7 +112,7 @@ described below.
112argument that specifies where the standard output from the program will 112argument that specifies where the standard output from the program will
113go. It should be a buffer or a buffer name; if it is a buffer name, 113go. It should be a buffer or a buffer name; if it is a buffer name,
114that will create the buffer if it does not already exist. It can also 114that will create the buffer if it does not already exist. It can also
115be @code{nil}, which says to discard the output unless a filter function 115be @code{nil}, which says to discard the output unless a custom filter function
116handles it. (@xref{Filter Functions}, and @ref{Read and Print}.) 116handles it. (@xref{Filter Functions}, and @ref{Read and Print}.)
117Normally, you should avoid having multiple processes send output to the 117Normally, you should avoid having multiple processes send output to the
118same buffer because their output would be intermixed randomly. 118same buffer because their output would be intermixed randomly.
@@ -1130,12 +1130,12 @@ children of Emacs. @xref{System Processes}.
1130@cindex process output 1130@cindex process output
1131@cindex output from processes 1131@cindex output from processes
1132 1132
1133 There are two ways to receive the output that a subprocess writes to 1133 The output that a subprocess writes to its standard output stream
1134its standard output stream. The output can be inserted in a buffer, 1134is passed to a function called the @dfn{filter function}. The default
1135which is called the associated buffer of the process (@pxref{Process 1135filter function simply inserts the output into a buffer, which is
1136Buffers}), or a function called the @dfn{filter function} can be 1136called the associated buffer of the process (@pxref{Process
1137called to act on the output. If the process has no buffer and no 1137Buffers}). If the process has no buffer then the default filter
1138filter function, its output is discarded. 1138discards the output.
1139 1139
1140 When a subprocess terminates, Emacs reads any pending output, 1140 When a subprocess terminates, Emacs reads any pending output,
1141then stops reading output from that subprocess. Therefore, if the 1141then stops reading output from that subprocess. Therefore, if the
@@ -1221,13 +1221,12 @@ marker that says where to insert output from the process.
1221If @var{process} does not have a buffer, @code{process-mark} returns a 1221If @var{process} does not have a buffer, @code{process-mark} returns a
1222marker that points nowhere. 1222marker that points nowhere.
1223 1223
1224Insertion of process output in a buffer uses this marker to decide where 1224The default filter function uses this marker to decide where to
1225to insert, and updates it to point after the inserted text. That is why 1225insert process output, and updates it to point after the inserted text.
1226successive batches of output are inserted consecutively. 1226That is why successive batches of output are inserted consecutively.
1227 1227
1228Filter functions normally should use this marker in the same fashion 1228Custom filter functions normally should use this marker in the same fashion.
1229as is done by direct insertion of output in the buffer. For an 1229For an example of a filter function that uses @code{process-mark},
1230example of a filter function that uses @code{process-mark},
1231@pxref{Process Filter Example}. 1230@pxref{Process Filter Example}.
1232 1231
1233When the user is expected to enter input in the process buffer for 1232When the user is expected to enter input in the process buffer for
@@ -1269,7 +1268,7 @@ subprocess with a @code{SIGHUP} signal (@pxref{Signals to Processes}).
1269@cindex process filter 1268@cindex process filter
1270 1269
1271 A process @dfn{filter function} is a function that receives the 1270 A process @dfn{filter function} is a function that receives the
1272standard output from the associated process. @emph{all} output from 1271standard output from the associated process. @emph{All} output from
1273that process is passed to the filter. The default filter simply 1272that process is passed to the filter. The default filter simply
1274outputs directly to the process buffer. 1273outputs directly to the process buffer.
1275 1274
@@ -1454,6 +1453,7 @@ code conversion and the end of line conversion---that is, one like
1454@c set-process-filter-multibyte and process-filter-multibyte-p, 1453@c set-process-filter-multibyte and process-filter-multibyte-p,
1455@cindex filter multibyte flag, of process 1454@cindex filter multibyte flag, of process
1456@cindex process filter multibyte flag 1455@cindex process filter multibyte flag
1456@c FIXME there is always a filter function now
1457 When Emacs calls a process filter function, it provides the process 1457 When Emacs calls a process filter function, it provides the process
1458output as a multibyte string or as a unibyte string according to the 1458output as a multibyte string or as a unibyte string according to the
1459process's filter coding system. Emacs 1459process's filter coding system. Emacs
@@ -2282,8 +2282,7 @@ Initialize the process query flag to @var{query-flag}.
2282@xref{Query Before Exit}. 2282@xref{Query Before Exit}.
2283 2283
2284@item :filter @var{filter} 2284@item :filter @var{filter}
2285Initialize the process filter to @var{filter}. (Otherwise the default 2285Initialize the process filter to @var{filter}.
2286filter is used.)
2287 2286
2288@item :filter-multibyte @var{multibyte} 2287@item :filter-multibyte @var{multibyte}
2289If @var{multibyte} is non-@code{nil}, strings given to the process 2288If @var{multibyte} is non-@code{nil}, strings given to the process
@@ -2291,8 +2290,7 @@ filter are multibyte, otherwise they are unibyte. The default is the
2291default value of @code{enable-multibyte-characters}. 2290default value of @code{enable-multibyte-characters}.
2292 2291
2293@item :sentinel @var{sentinel} 2292@item :sentinel @var{sentinel}
2294Initialize the process sentinel to @var{sentinel}. (Otherwise the default 2293Initialize the process sentinel to @var{sentinel}.
2295sentinel is used.)
2296 2294
2297@item :log @var{log} 2295@item :log @var{log}
2298Initialize the log function of a server process to @var{log}. The log 2296Initialize the log function of a server process to @var{log}. The log
@@ -2580,12 +2578,10 @@ state is cleared by @code{continue-process} and set by
2580@code{stop-process}. 2578@code{stop-process}.
2581 2579
2582@item :filter @var{filter} 2580@item :filter @var{filter}
2583Install @var{filter} as the process filter. (Otherwise the default 2581Install @var{filter} as the process filter.
2584filter is used.)
2585 2582
2586@item :sentinel @var{sentinel} 2583@item :sentinel @var{sentinel}
2587Install @var{sentinel} as the process sentinel. (Otherwise the default 2584Install @var{sentinel} as the process sentinel.
2588sentinel is used.)
2589 2585
2590@item :plist @var{plist} 2586@item :plist @var{plist}
2591Install @var{plist} as the initial plist of the process. 2587Install @var{plist} as the initial plist of the process.