Doc fixes for bug#5567 (tiny change)

* lisp/window.el (one-window-p, walk-windows, display-buffer): Doc fixes.
* src/window.c (Fnext_window): Doc (and comment) fixes.

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index e46ce544b3aef6547aafc5807d95f8b5cf1e5e9b..1168b4933149eacaa0fe822c994a4d9b41dd201c 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,8 @@
+2011-03-06  Michael Shields  <shields@msrl.com>  (tiny change)
+
+       * window.el (one-window-p, walk-windows, display-buffer):
+       Doc fixes.  (Bug#5567)
+
 2011-03-06  Jay Belanger  <jay.p.belanger@gmail.com>
 
        * cus-edit.el (custom-prompt-variable): Use the `custom-get' property

diff --git a/lisp/window.el b/lisp/window.el
index af5d9a5b16b93797f8d9489511c6d9a971b60ccb..c3f8de6f9ddaf63680855cee021caf9d86155f08 100644 (file)
--- a/lisp/window.el
+++ b/lisp/window.el
@@ -106,11 +106,12 @@ even if it is active.  Otherwise, the minibuffer is counted
 when it is active.
 
 The optional arg ALL-FRAMES t means count windows on all frames.
-If it is `visible', count windows on all visible frames.
-ALL-FRAMES nil or omitted means count only the selected frame,
-plus the minibuffer it uses (which may be on another frame).
-ALL-FRAMES 0 means count all windows in all visible or iconified frames.
-If ALL-FRAMES is anything else, count only the selected frame."
+If it is `visible', count windows on all visible frames on the
+current terminal.  ALL-FRAMES nil or omitted means count only the
+selected frame, plus the minibuffer it uses (which may be on
+another frame).  ALL-FRAMES 0 means count all windows in all
+visible or iconified frames on the current terminal.  If
+ALL-FRAMES is anything else, count only the selected frame."
   (let ((base-window (selected-window)))
     (if (and nomini (eq base-window (minibuffer-window)))
        (setq base-window (next-window base-window)))
@@ -169,9 +170,9 @@ ALL-FRAMES nil or omitted means cycle through all windows on the
 ALL-FRAMES t means cycle through all windows on all existing
  frames.
 ALL-FRAMES `visible' means cycle through all windows on all
- visible frames.
+ visible frames on the current terminal.
 ALL-FRAMES 0 means cycle through all windows on all visible and
- iconified frames.
+ iconified frames on the current terminal.
 ALL-FRAMES a frame means cycle through all windows on that frame
  only.
 Anything else means cycle through all windows on the selected
@@ -1067,9 +1068,11 @@ when the specified buffer is already displayed.  If the buffer is
 already displayed in some window on one of these frames simply
 return that window.  Possible values of FRAME are:
 
-`visible' - consider windows on all visible frames.
+`visible' - consider windows on all visible frames on the current
+terminal.
 
-0 - consider windows on all visible or iconified frames.
+0 - consider windows on all visible or iconified frames on the
+current terminal.
 
 t - consider windows on all frames.
 
@@ -1079,7 +1082,7 @@ nil - consider windows on the selected frame \(actually the
 last non-minibuffer frame\) only.  If, however, either
 `display-buffer-reuse-frames' or `pop-up-frames' is non-nil
 \(non-nil and not graphic-only on a text-only terminal),
-consider all visible or iconified frames."
+consider all visible or iconified frames on the current terminal."
   (interactive "BDisplay buffer:\nP")
   (let* ((can-use-selected-window
          ;; The selected window is usable unless either NOT-THIS-WINDOW

diff --git a/src/ChangeLog b/src/ChangeLog
index 57a2b618d6345e24d9663e7a7cb18f3d2bc608ff..2baef5e811c9f7345be70d342f185ae7e14d16bb 100644 (file)
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,7 @@
+2011-03-06  Michael Shields  <shields@msrl.com>  (tiny change)
+
+       * window.c (Fnext_window): Doc fix.  (Bug#5567)
+
 2011-03-05  Chong Yidong  <cyd@stupidchicken.com>
 
        * nsterm.m (ns_draw_window_cursor): Fix typo in 2011-02-23 commit.

diff --git a/src/window.c b/src/window.c
index 7965269f0e7a611c8c3c5f3f21495bd1bba8d1fc..7c55be972b2ac4dbb95a46cc18acbcf76acc7fe6 100644 (file)
--- a/src/window.c
+++ b/src/window.c
@@ -1769,8 +1769,10 @@ window_list (void)
 
    ALL_FRAMES  t means search all frames,
                nil means search just current frame,
-               `visible' means search just visible frames,
-               0 means search visible and iconified frames,
+               `visible' means search just visible frames on the
+                current terminal,
+               0 means search visible and iconified frames on the
+                current terminal,
                a window means search the frame that window belongs to,
                a frame means consider windows on that frame, only.  */
 
@@ -1836,8 +1838,8 @@ candidate_window_p (Lisp_Object window, Lisp_Object owindow, Lisp_Object minibuf
 
 
 /* Decode arguments as allowed by Fnext_window, Fprevious_window, and
-   Fwindow_list.  See there for the meaning of WINDOW, MINIBUF, and
-   ALL_FRAMES.  */
+   Fwindow_list.  See candidate_window_p for the meaning of WINDOW,
+   MINIBUF, and ALL_FRAMES.  */
 
 static void
 decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object *all_frames)
@@ -1871,12 +1873,6 @@ decode_next_window_args (Lisp_Object *window, Lisp_Object *minibuf, Lisp_Object
     ;
   else if (!EQ (*all_frames, Qt))
     *all_frames = Qnil;
-
-  /* Now *ALL_FRAMES is t meaning search all frames, nil meaning
-     search just current frame, `visible' meaning search just visible
-     frames, 0 meaning search visible and iconified frames, or a
-     window, meaning search the frame that window belongs to, or a
-     frame, meaning consider windows on that frame, only.  */
 }
 
 
@@ -1974,9 +1970,9 @@ ALL-FRAMES nil or omitted means consider all windows on WINDOW's
  windows on all frames that share that minibuffer too.
 ALL-FRAMES t means consider all windows on all existing frames.
 ALL-FRAMES `visible' means consider all windows on all visible
- frames.
+ frames on the current terminal.
 ALL-FRAMES 0 means consider all windows on all visible and
- iconified frames.
+ iconified frames on the current terminal.
 ALL-FRAMES a frame means consider all windows on that frame only.
 Anything else means consider all windows on WINDOW's frame and no
  others.