diff options
| author | Glenn Morris | 2014-02-21 00:04:15 -0800 |
|---|---|---|
| committer | Glenn Morris | 2014-02-21 00:04:15 -0800 |
| commit | 458e643be8acb837a8b002d8103e58c228976cd3 (patch) | |
| tree | 9529ba90d65449c9fe2a307ec3b66e959ca5f041 /src | |
| parent | 8dd3e94fb6b780ac2bf5d07795df376a296ef5b5 (diff) | |
| download | emacs-458e643be8acb837a8b002d8103e58c228976cd3.tar.gz emacs-458e643be8acb837a8b002d8103e58c228976cd3.zip | |
Some doc updates for default process sentinels and filters not being nil
* doc/lispref/internals.texi (Process Internals):
* doc/lispref/processes.texi (Deleting Processes, Output from Processes)
(Process Buffers, Filter Functions, Accepting Output, Sentinels)
(Network, Network Servers, Network Processes, Serial Ports):
Filters and sentinels can no longer be nil.
* doc/lispref/elisp.texi (Top): Menu update.
* doc/misc/flymake.texi (Starting the syntax check process): Grammar fix.
* doc/misc/tramp.texi (External packages): Grammar fix.
Reword for default sentinel not being nil any more.
* src/process.c (Fprocess_buffer, Faccept_process_output)
(Finternal_default_process_filter, Finternal_default_process_sentinel):
Doc fixes.
Diffstat (limited to 'src')
| -rw-r--r-- | src/ChangeLog | 6 | ||||
| -rw-r--r-- | src/process.c | 32 |
2 files changed, 23 insertions, 15 deletions
diff --git a/src/ChangeLog b/src/ChangeLog index 2b631dfc5f9..70fce9add14 100644 --- a/src/ChangeLog +++ b/src/ChangeLog | |||
| @@ -1,3 +1,9 @@ | |||
| 1 | 2014-02-21 Glenn Morris <rgm@gnu.org> | ||
| 2 | |||
| 3 | * process.c (Fprocess_buffer, Faccept_process_output) | ||
| 4 | (Finternal_default_process_filter, Finternal_default_process_sentinel): | ||
| 5 | Doc fixes. | ||
| 6 | |||
| 1 | 2014-02-21 Martin Rudalics <rudalics@gmx.at> | 7 | 2014-02-21 Martin Rudalics <rudalics@gmx.at> |
| 2 | 8 | ||
| 3 | * window.c (Fwindow_scroll_bar_width): New function. | 9 | * window.c (Fwindow_scroll_bar_width): New function. |
diff --git a/src/process.c b/src/process.c index 85470b66c3e..c891962ecb2 100644 --- a/src/process.c +++ b/src/process.c | |||
| @@ -1,7 +1,7 @@ | |||
| 1 | /* Asynchronous subprocess control for GNU Emacs. | 1 | /* Asynchronous subprocess control for GNU Emacs. |
| 2 | 2 | ||
| 3 | Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2014 Free Software | 3 | Copyright (C) 1985-1988, 1993-1996, 1998-1999, 2001-2014 |
| 4 | Foundation, Inc. | 4 | Free Software Foundation, Inc. |
| 5 | 5 | ||
| 6 | This file is part of GNU Emacs. | 6 | This file is part of GNU Emacs. |
| 7 | 7 | ||
| @@ -1022,7 +1022,7 @@ Return BUFFER. */) | |||
| 1022 | DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer, | 1022 | DEFUN ("process-buffer", Fprocess_buffer, Sprocess_buffer, |
| 1023 | 1, 1, 0, | 1023 | 1, 1, 0, |
| 1024 | doc: /* Return the buffer PROCESS is associated with. | 1024 | doc: /* Return the buffer PROCESS is associated with. |
| 1025 | Output from PROCESS is inserted in this buffer unless PROCESS has a filter. */) | 1025 | The default process filter inserts output from PROCESS into this buffer. */) |
| 1026 | (register Lisp_Object process) | 1026 | (register Lisp_Object process) |
| 1027 | { | 1027 | { |
| 1028 | CHECK_PROCESS (process); | 1028 | CHECK_PROCESS (process); |
| @@ -1049,7 +1049,7 @@ passed to the filter. | |||
| 1049 | 1049 | ||
| 1050 | The filter gets two arguments: the process and the string of output. | 1050 | The filter gets two arguments: the process and the string of output. |
| 1051 | The string argument is normally a multibyte string, except: | 1051 | The string argument is normally a multibyte string, except: |
| 1052 | - if the process' input coding system is no-conversion or raw-text, | 1052 | - if the process's input coding system is no-conversion or raw-text, |
| 1053 | it is a unibyte string (the non-converted input), or else | 1053 | it is a unibyte string (the non-converted input), or else |
| 1054 | - if `default-enable-multibyte-characters' is nil, it is a unibyte | 1054 | - if `default-enable-multibyte-characters' is nil, it is a unibyte |
| 1055 | string (the result of converting the decoded input multibyte | 1055 | string (the result of converting the decoded input multibyte |
| @@ -1061,7 +1061,7 @@ The string argument is normally a multibyte string, except: | |||
| 1061 | CHECK_PROCESS (process); | 1061 | CHECK_PROCESS (process); |
| 1062 | p = XPROCESS (process); | 1062 | p = XPROCESS (process); |
| 1063 | 1063 | ||
| 1064 | /* Don't signal an error if the process' input file descriptor | 1064 | /* Don't signal an error if the process's input file descriptor |
| 1065 | is closed. This could make debugging Lisp more difficult, | 1065 | is closed. This could make debugging Lisp more difficult, |
| 1066 | for example when doing something like | 1066 | for example when doing something like |
| 1067 | 1067 | ||
| @@ -2758,7 +2758,7 @@ client. The arguments are SERVER, CLIENT, and MESSAGE, where SERVER | |||
| 2758 | is the server process, CLIENT is the new process for the connection, | 2758 | is the server process, CLIENT is the new process for the connection, |
| 2759 | and MESSAGE is a string. | 2759 | and MESSAGE is a string. |
| 2760 | 2760 | ||
| 2761 | :plist PLIST -- Install PLIST as the new process' initial plist. | 2761 | :plist PLIST -- Install PLIST as the new process's initial plist. |
| 2762 | 2762 | ||
| 2763 | :server QLEN -- if QLEN is non-nil, create a server process for the | 2763 | :server QLEN -- if QLEN is non-nil, create a server process for the |
| 2764 | specified FAMILY, SERVICE, and connection type (stream or datagram). | 2764 | specified FAMILY, SERVICE, and connection type (stream or datagram). |
| @@ -2788,21 +2788,21 @@ When a client connection is accepted, a new network process is created | |||
| 2788 | for the connection with the following parameters: | 2788 | for the connection with the following parameters: |
| 2789 | 2789 | ||
| 2790 | - The client's process name is constructed by concatenating the server | 2790 | - The client's process name is constructed by concatenating the server |
| 2791 | process' NAME and a client identification string. | 2791 | process's NAME and a client identification string. |
| 2792 | - If the FILTER argument is non-nil, the client process will not get a | 2792 | - If the FILTER argument is non-nil, the client process will not get a |
| 2793 | separate process buffer; otherwise, the client's process buffer is a newly | 2793 | separate process buffer; otherwise, the client's process buffer is a newly |
| 2794 | created buffer named after the server process' BUFFER name or process | 2794 | created buffer named after the server process's BUFFER name or process |
| 2795 | NAME concatenated with the client identification string. | 2795 | NAME concatenated with the client identification string. |
| 2796 | - The connection type and the process filter and sentinel parameters are | 2796 | - The connection type and the process filter and sentinel parameters are |
| 2797 | inherited from the server process' TYPE, FILTER and SENTINEL. | 2797 | inherited from the server process's TYPE, FILTER and SENTINEL. |
| 2798 | - The client process' contact info is set according to the client's | 2798 | - The client process's contact info is set according to the client's |
| 2799 | addressing information (typically an IP address and a port number). | 2799 | addressing information (typically an IP address and a port number). |
| 2800 | - The client process' plist is initialized from the server's plist. | 2800 | - The client process's plist is initialized from the server's plist. |
| 2801 | 2801 | ||
| 2802 | Notice that the FILTER and SENTINEL args are never used directly by | 2802 | Notice that the FILTER and SENTINEL args are never used directly by |
| 2803 | the server process. Also, the BUFFER argument is not used directly by | 2803 | the server process. Also, the BUFFER argument is not used directly by |
| 2804 | the server process, but via the optional :log function, accepted (and | 2804 | the server process, but via the optional :log function, accepted (and |
| 2805 | failed) connections may be logged in the server process' buffer. | 2805 | failed) connections may be logged in the server process's buffer. |
| 2806 | 2806 | ||
| 2807 | The original argument list, modified with the actual connection | 2807 | The original argument list, modified with the actual connection |
| 2808 | information, is available via the `process-contact' function. | 2808 | information, is available via the `process-contact' function. |
| @@ -3917,7 +3917,7 @@ deactivate_process (Lisp_Object proc) | |||
| 3917 | DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output, | 3917 | DEFUN ("accept-process-output", Faccept_process_output, Saccept_process_output, |
| 3918 | 0, 4, 0, | 3918 | 0, 4, 0, |
| 3919 | doc: /* Allow any pending output from subprocesses to be read by Emacs. | 3919 | doc: /* Allow any pending output from subprocesses to be read by Emacs. |
| 3920 | It is read into the process' buffers or given to their filter functions. | 3920 | It is given to their filter functions. |
| 3921 | Non-nil arg PROCESS means do not return until some output has been received | 3921 | Non-nil arg PROCESS means do not return until some output has been received |
| 3922 | from PROCESS. | 3922 | from PROCESS. |
| 3923 | 3923 | ||
| @@ -5187,7 +5187,8 @@ read_and_dispose_of_process_output (struct Lisp_Process *p, char *chars, | |||
| 5187 | 5187 | ||
| 5188 | DEFUN ("internal-default-process-filter", Finternal_default_process_filter, | 5188 | DEFUN ("internal-default-process-filter", Finternal_default_process_filter, |
| 5189 | Sinternal_default_process_filter, 2, 2, 0, | 5189 | Sinternal_default_process_filter, 2, 2, 0, |
| 5190 | doc: /* Function used as default process filter. */) | 5190 | doc: /* Function used as default process filter. |
| 5191 | This inserts the process's output into its buffer. */) | ||
| 5191 | (Lisp_Object proc, Lisp_Object text) | 5192 | (Lisp_Object proc, Lisp_Object text) |
| 5192 | { | 5193 | { |
| 5193 | struct Lisp_Process *p; | 5194 | struct Lisp_Process *p; |
| @@ -6411,7 +6412,8 @@ status_notify (struct Lisp_Process *deleting_process) | |||
| 6411 | 6412 | ||
| 6412 | DEFUN ("internal-default-process-sentinel", Finternal_default_process_sentinel, | 6413 | DEFUN ("internal-default-process-sentinel", Finternal_default_process_sentinel, |
| 6413 | Sinternal_default_process_sentinel, 2, 2, 0, | 6414 | Sinternal_default_process_sentinel, 2, 2, 0, |
| 6414 | doc: /* Function used as default sentinel for processes. */) | 6415 | doc: /* Function used as default sentinel for processes. |
| 6416 | This inserts a status message into the process's buffer. */) | ||
| 6415 | (Lisp_Object proc, Lisp_Object msg) | 6417 | (Lisp_Object proc, Lisp_Object msg) |
| 6416 | { | 6418 | { |
| 6417 | Lisp_Object buffer, symbol; | 6419 | Lisp_Object buffer, symbol; |