changeset 111136:bc1274182cc8

Sync docs of selection-coding-system between C and Lisp. * src/w16select.c (syms_of_win16select) <selection-coding-system>: * src/w32select.c (syms_of_w32select) <selection-coding-system>: Sync docs with select.el. * lisp/select.el (selection-coding-system): Sync doc with C versions.
author Glenn Morris <rgm@gnu.org>
date Sat, 23 Oct 2010 19:22:43 -0700
parents 600f564fdc23
children 1b078a586243
files lisp/ChangeLog lisp/select.el src/ChangeLog src/w16select.c src/w32select.c
diffstat 5 files changed, 71 insertions(+), 12 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/ChangeLog	Sat Oct 23 19:13:37 2010 -0700
+++ b/lisp/ChangeLog	Sat Oct 23 19:22:43 2010 -0700
@@ -1,6 +1,7 @@
 2010-10-24  Glenn Morris  <rgm@gnu.org>
 
-	* select.el (next-selection-coding-system): Sync doc with C versions.
+	* select.el (selection-coding-system, next-selection-coding-system):
+	Sync doc with C versions.
 
 	* w32-vars.el (x-select-enable-clipboard):
 	* term/x-win.el (x-select-enable-clipboard): Move to common-win.
--- a/lisp/select.el	Sat Oct 23 19:13:37 2010 -0700
+++ b/lisp/select.el	Sat Oct 23 19:22:43 2010 -0700
@@ -28,8 +28,15 @@
 ;;; Code:
 
 (defcustom selection-coding-system nil
-  "Coding system for communicating with other X clients.
+  "Coding system for communicating with other programs.
 
+For MS-Windows and MS-DOS:
+When sending or receiving text via selection and clipboard, the text
+is encoded or decoded by this coding system.  The default value is
+the current system default encoding on 9x/Me, `utf-16le-dos'
+\(Unicode) on NT/W2K/XP, and `iso-latin-1-dos' on MS-DOS.
+
+For X Windows:
 When sending text via selection and clipboard, if the target
 data-type matches with the type of this coding system, it is used
 for encoding the text.  Otherwise (including the case that this
--- a/src/ChangeLog	Sat Oct 23 19:13:37 2010 -0700
+++ b/src/ChangeLog	Sat Oct 23 19:22:43 2010 -0700
@@ -1,7 +1,9 @@
 2010-10-24  Glenn Morris  <rgm@gnu.org>
 
-	* w16select.c (syms_of_win16select) <next-selection-coding-system>:
-	* w32select.c (syms_of_w32select) <next-selection-coding-system>:
+	* w16select.c (syms_of_win16select) <selection-coding-system>:
+	<next-selection-coding-system>:
+	* w32select.c (syms_of_w32select) <selection-coding-system>:
+	<next-selection-coding-system>:
 	Sync docs with select.el.
 
 	* xfaces.c (syms_of_xfaces) <tty-defined-color-alist>: Sync doc with
--- a/src/w16select.c	Sat Oct 23 19:13:37 2010 -0700
+++ b/src/w16select.c	Sat Oct 23 19:22:43 2010 -0700
@@ -694,10 +694,35 @@
   defsubr (&Sx_selection_exists_p);
 
   DEFVAR_LISP ("selection-coding-system", &Vselection_coding_system,
-	       doc: /* Coding system for communicating with other X clients.
-When sending or receiving text via cut_buffer, selection, and clipboard,
-the text is encoded or decoded by this coding system.
-The default value is `iso-latin-1-dos'.  */);
+	       doc: /* Coding system for communicating with other programs.
+
+For MS-Windows and MS-DOS:
+When sending or receiving text via selection and clipboard, the text
+is encoded or decoded by this coding system.  The default value is
+the current system default encoding on 9x/Me, `utf-16le-dos'
+\(Unicode) on NT/W2K/XP, and `iso-latin-1-dos' on MS-DOS.
+
+For X Windows:
+When sending text via selection and clipboard, if the target
+data-type matches with the type of this coding system, it is used
+for encoding the text.  Otherwise (including the case that this
+variable is nil), a proper coding system is used as below:
+
+data-type	coding system
+---------	-------------
+UTF8_STRING	utf-8
+COMPOUND_TEXT	compound-text-with-extensions
+STRING		iso-latin-1
+C_STRING	no-conversion
+
+When receiving text, if this coding system is non-nil, it is used
+for decoding regardless of the data-type.  If this is nil, a
+proper coding system is used according to the data-type as above.
+
+See also the documentation of the variable `x-select-request-type' how
+to control which data-type to request for receiving text.
+
+The default value is nil.  */);
   Vselection_coding_system = intern ("iso-latin-1-dos");
 
   DEFVAR_LISP ("next-selection-coding-system", &Vnext_selection_coding_system,
--- a/src/w32select.c	Sat Oct 23 19:13:37 2010 -0700
+++ b/src/w32select.c	Sat Oct 23 19:22:43 2010 -0700
@@ -1070,10 +1070,34 @@
 
   DEFVAR_LISP ("selection-coding-system", &Vselection_coding_system,
 	       doc: /* Coding system for communicating with other programs.
-When sending or receiving text via cut_buffer, selection, and
-clipboard, the text is encoded or decoded by this coding system.
-The default value is the current system default encoding on 9x/Me and
-`utf-16le-dos' (Unicode) on NT/W2K/XP.  */);
+
+For MS-Windows and MS-DOS:
+When sending or receiving text via selection and clipboard, the text
+is encoded or decoded by this coding system.  The default value is
+the current system default encoding on 9x/Me, `utf-16le-dos'
+\(Unicode) on NT/W2K/XP, and `iso-latin-1-dos' on MS-DOS.
+
+For X Windows:
+When sending text via selection and clipboard, if the target
+data-type matches with the type of this coding system, it is used
+for encoding the text.  Otherwise (including the case that this
+variable is nil), a proper coding system is used as below:
+
+data-type	coding system
+---------	-------------
+UTF8_STRING	utf-8
+COMPOUND_TEXT	compound-text-with-extensions
+STRING		iso-latin-1
+C_STRING	no-conversion
+
+When receiving text, if this coding system is non-nil, it is used
+for decoding regardless of the data-type.  If this is nil, a
+proper coding system is used according to the data-type as above.
+
+See also the documentation of the variable `x-select-request-type' how
+to control which data-type to request for receiving text.
+
+The default value is nil.  */);
   /* The actual value is set dynamically in the dumped Emacs, see
      below. */
   Vselection_coding_system = Qnil;