[Emacs-diffs] /srv/bzr/emacs/trunk r107240: Fix bug #10783 with doc strings of selection-related functions and variables.

[Eli Zaretskii]

------------------------------------------------------------
revno: 107240 [merge]
fixes bug(s): http://debbugs.gnu.org/10783
committer: Eli Zaretskii <address@hidden>
branch nick: trunk
timestamp: Sat 2012-02-11 11:41:49 +0200
message:
  Fix bug #10783 with doc strings of selection-related functions and variables.
  
   src/w16select.c (Fx_selection_exists_p): Sync doc string with
   xselect.c.
   lisp/term/pc-win.el (x-select-text, x-selection-owner-p)
   (x-own-selection-internal, x-disown-selection-internal)
   (x-get-selection-internal): Sync doc strings and argument lists
   with xselect.c, common-win.el and x-win.el.
modified:
  lisp/ChangeLog
  lisp/term/pc-win.el
  src/ChangeLog
  src/w16select.c

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-02-11 04:20:16 +0000
+++ b/lisp/ChangeLog    2012-02-11 09:38:41 +0000
@@ -1,3 +1,10 @@
+2012-02-11  Eli Zaretskii  <address@hidden>
+
+       * term/pc-win.el (x-select-text, x-selection-owner-p)
+       (x-own-selection-internal, x-disown-selection-internal)
+       (x-get-selection-internal): Sync doc strings and argument lists
+       with xselect.c, common-win.el and x-win.el.  (Bug#10783)
+
 2012-02-11  Leo Liu  <address@hidden>
 
        * progmodes/python.el (python-end-of-statement): Fix infinite

=== modified file 'lisp/term/pc-win.el'
--- a/lisp/term/pc-win.el       2012-01-19 07:21:25 +0000
+++ b/lisp/term/pc-win.el       2012-02-11 09:38:41 +0000
@@ -218,11 +218,12 @@
 clipboard.  If `x-select-enable-primary' is non-nil, put TEXT in
 the primary selection.
 
-On Windows, make TEXT the current selection.  If
+On MS-Windows, make TEXT the current selection.  If
 `x-select-enable-clipboard' is non-nil, copy the text to the
 clipboard as well.
 
-On Nextstep, put TEXT in the pasteboard."
+On Nextstep, put TEXT in the pasteboard (`x-select-enable-clipboard'
+is not used)."
   (if x-select-enable-clipboard
       (w16-set-clipboard-data text))
   (setq x-last-selected-text text))
@@ -248,13 +249,17 @@
          (setq x-last-selected-text text))))))
 
 ;; x-selection-owner-p is used in simple.el.
-(defun x-selection-owner-p (&optional type)
+(defun x-selection-owner-p (&optional selection terminal)
   "Whether the current Emacs process owns the given X Selection.
 The arg should be the name of the selection in question, typically one of
 the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.
 \(Those are literal upper-case symbol names, since that's what X expects.)
 For convenience, the symbol nil is the same as `PRIMARY',
-and t is the same as `SECONDARY'."
+and t is the same as `SECONDARY'.
+
+TERMINAL should be a terminal object or a frame specifying the X
+server to query.  If omitted or nil, that stands for the selected
+frame's display, or the first available X display."
     (if x-select-enable-clipboard
       (let (text)
        ;; Don't die if w16-get-clipboard-data signals an error.
@@ -272,30 +277,41 @@
 
 ;; x-own-selection-internal and x-disown-selection-internal are used
 ;; in select.el:x-set-selection.
-(defun x-own-selection-internal (type value)
-  "Assert an X selection of the given TYPE with the given VALUE.
-TYPE is a symbol, typically `PRIMARY', `SECONDARY', or `CLIPBOARD'.
+(defun x-own-selection-internal (selection value &optional frame)
+  "Assert an X selection of the type SELECTION with and value VALUE.
+SELECTION is a symbol, typically `PRIMARY', `SECONDARY', or `CLIPBOARD'.
 \(Those are literal upper-case symbol names, since that's what X expects.)
 VALUE is typically a string, or a cons of two markers, but may be
-anything that the functions on `selection-converter-alist' know about."
+anything that the functions on `selection-converter-alist' know about.
+
+FRAME should be a frame that should own the selection.  If omitted or
+nil, it defaults to the selected frame."
   (ignore-errors
     (x-select-text value))
   value)
 
-(defun x-disown-selection-internal (selection &optional time)
+(defun x-disown-selection-internal (selection &optional time-object terminal)
   "If we own the selection SELECTION, disown it.
-Disowning it means there is no such selection."
+Disowning it means there is no such selection.
+
+TERMINAL should be a terminal object or a frame specifying the X
+server to query.  If omitted or nil, that stands for the selected
+frame's display, or the first available X display."
   (if (x-selection-owner-p selection)
       t))
 
 ;; x-get-selection-internal is used in select.el
-(defun x-get-selection-internal (selection type &optional time_stamp)
+(defun x-get-selection-internal (selection-symbol target-type &optional 
time_stamp terminal)
   "Return text selected from some X window.
 SELECTION is a symbol, typically `PRIMARY', `SECONDARY', or `CLIPBOARD'.
 \(Those are literal upper-case symbol names, since that's what X expects.)
 TYPE is the type of data desired, typically `STRING'.
 TIME_STAMP is the time to use in the XConvertSelection call for foreign
-selections.  If omitted, defaults to the time for the last event."
+selections.  If omitted, defaults to the time for the last event.
+
+TERMINAL should be a terminal object or a frame specifying the X
+server to query.  If omitted or nil, that stands for the selected
+frame's display, or the first available X display."
   (x-get-selection-value))
 
 ;; From src/fontset.c:

=== modified file 'src/ChangeLog'
--- a/src/ChangeLog     2012-02-10 08:38:22 +0000
+++ b/src/ChangeLog     2012-02-11 09:38:41 +0000
@@ -1,3 +1,8 @@
+2012-02-11  Eli Zaretskii  <address@hidden>
+
+       * w16select.c (Fx_selection_exists_p): Sync doc string with
+       xselect.c.  (Bug#10783)
+
 2012-02-10  Glenn Morris  <address@hidden>
 
        * fns.c (Fsecure_hash): Doc fix.

=== modified file 'src/w16select.c'
--- a/src/w16select.c   2012-01-19 07:21:25 +0000
+++ b/src/w16select.c   2012-02-11 09:38:41 +0000
@@ -637,14 +637,17 @@
 /* Support checking for a clipboard selection. */
 
 DEFUN ("x-selection-exists-p", Fx_selection_exists_p, Sx_selection_exists_p,
-       0, 1, 0,
-       doc: /* Whether there is an owner for the given X Selection.
-The arg should be the name of the selection in question, typically one of
-the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.
-\(Those are literal upper-case symbol names, since that's what X expects.)
-For convenience, the symbol nil is the same as `PRIMARY',
-and t is the same as `SECONDARY'.  */)
-  (Lisp_Object selection)
+       0, 2, 0,
+       doc: /* Whether there is an owner for the given X selection.
+SELECTION should be the name of the selection in question, typically
+one of the symbols `PRIMARY', `SECONDARY', or `CLIPBOARD'.  (X expects
+these literal upper-case names.)  The symbol nil is the same as
+`PRIMARY', and t is the same as `SECONDARY'.
+
+TERMINAL should be a terminal object or a frame specifying the X
+server to query.  If omitted or nil, that stands for the selected
+frame's display, or the first available X display.  */)
+  (Lisp_Object selection, Lisp_Object terminal)
 {
   CHECK_SYMBOL (selection);