changeset 49281:f9e4999d3025

(set-process-filter): Document unibyte/multibyte-ness of string argument.
author Kim F. Storm <storm@cua.dk>
date Thu, 16 Jan 2003 12:59:18 +0000
parents 39c17dda288e
children 6a6be3d3a898
files src/process.c
diffstat 1 files changed, 11 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/src/process.c	Thu Jan 16 12:59:00 2003 +0000
+++ b/src/process.c	Thu Jan 16 12:59:18 2003 +0000
@@ -844,10 +844,18 @@
        2, 2, 0,
        doc: /* Give PROCESS the filter function FILTER; nil means no filter.
 t means stop accepting output from the process.
-When a process has a filter, each time it does output
-the entire string of output is passed to the filter.
+
+When a process has a filter, its buffer is not used for output.
+Instead, each time it does output, the entire string of output is
+passed to the filter.  
+
 The filter gets two arguments: the process and the string of output.
-If the process has a filter, its buffer is not used for output.  */)
+The string argument is normally a multibyte string, except:
+- if the process' input coding system is no-conversion or raw-text,
+  it is a unibyte string (the non-converted input), or else
+- if `default-enable-multibyte-characters' is nil, it is a unibyte
+  string (the result of converting the decoded input multibyte
+  string to unibyte with `string-make-unibyte').  */)
      (process, filter)
      register Lisp_Object process, filter;
 {