[Emacs-diffs] /srv/bzr/emacs/trunk r107569: Doc fixes for save-window-excursion.

[Chong Yidong]

------------------------------------------------------------
revno: 107569
fixes bug(s): http://debbugs.gnu.org/9979
committer: Chong Yidong <address@hidden>
branch nick: trunk
timestamp: Mon 2012-03-12 00:10:07 +0800
message:
  Doc fixes for save-window-excursion.
  
  * lisp/subr.el (save-window-excursion): Doc fix.
  
  * doc/lispref/windows.texi (Window Configurations): save-window-excursion is
  now a macro.
  
  * doc/lispref/display.texi (Temporary Displays): with-output-to-temp-buffer is
  now a macro.
modified:
  doc/lispref/ChangeLog
  doc/lispref/display.texi
  doc/lispref/windows.texi
  lisp/ChangeLog
  lisp/subr.el

=== modified file 'doc/lispref/ChangeLog'
--- a/doc/lispref/ChangeLog     2012-03-10 09:55:54 +0000
+++ b/doc/lispref/ChangeLog     2012-03-11 16:10:07 +0000
@@ -1,3 +1,11 @@
+2012-03-11  Chong Yidong  <address@hidden>
+
+       * windows.texi (Window Configurations): save-window-excursion is
+       now a macro.
+
+       * display.texi (Temporary Displays): with-output-to-temp-buffer is
+       now a macro.
+
 2012-03-10  Eli Zaretskii  <address@hidden>
 
        * strings.texi (String Basics):

=== modified file 'doc/lispref/display.texi'
--- a/doc/lispref/display.texi  2012-03-04 06:50:18 +0000
+++ b/doc/lispref/display.texi  2012-03-11 16:10:07 +0000
@@ -1031,7 +1031,7 @@
 buffer and then present it to the user for perusal rather than for
 editing.  Many help commands use this feature.
 
address@hidden with-output-to-temp-buffer buffer-name address@hidden
address@hidden with-output-to-temp-buffer buffer-name address@hidden
 This function executes @var{forms} while arranging to insert any output
 they print into the buffer named @var{buffer-name}, which is first
 created if necessary, and put into Help mode.  Finally, the buffer is
@@ -1083,7 +1083,7 @@
 ---------- Buffer: foo ----------
 @end group
 @end example
address@hidden defspec
address@hidden defmac
 
 @defopt temp-buffer-show-function
 If this variable is address@hidden, @code{with-output-to-temp-buffer}

=== modified file 'doc/lispref/windows.texi'
--- a/doc/lispref/windows.texi  2012-03-04 06:50:18 +0000
+++ b/doc/lispref/windows.texi  2012-03-11 16:10:07 +0000
@@ -3142,7 +3142,7 @@
 @end example
 @end defun
 
address@hidden save-window-excursion address@hidden
address@hidden save-window-excursion address@hidden
 This special form records the window configuration, executes @var{forms}
 in sequence, then restores the earlier window configuration.  The window
 configuration includes, for each window, the value of point and the
@@ -3179,7 +3179,7 @@
      ;; @r{The screen is now split again.}
 @end group
 @end example
address@hidden defspec
address@hidden defmac
 
 @defun window-configuration-p object
 This function returns @code{t} if @var{object} is a window configuration.

=== modified file 'lisp/ChangeLog'
--- a/lisp/ChangeLog    2012-03-11 15:45:44 +0000
+++ b/lisp/ChangeLog    2012-03-11 16:10:07 +0000
@@ -1,5 +1,7 @@
 2012-03-11  Chong Yidong  <address@hidden>
 
+       * subr.el (save-window-excursion): Doc fix (Bug#9979).
+
        * dabbrev.el (dabbrev--find-expansion): Update progress reporter
        when finished (Bug#10963).
 

=== modified file 'lisp/subr.el'
--- a/lisp/subr.el      2012-02-10 15:59:29 +0000
+++ b/lisp/subr.el      2012-03-11 16:10:07 +0000
@@ -3026,13 +3026,12 @@
           (set-buffer ,old-buffer))))))
 
 (defmacro save-window-excursion (&rest body)
-  "Execute BODY, preserving window sizes and contents.
+  "Execute BODY, then restore previous window configuration.
 Return the value of the last form in BODY.
-Restore which buffer appears in which window, where display starts,
-and the value of point and mark for each window.
-Also restore the choice of selected window.
-Also restore which buffer is current.
-Does not restore the value of point in current buffer.
+Restore which buffer appears in which window, where display
+starts, and the value of point and mark for each window, as well
+as the choice of selected window, and which buffer is current.
+The value of point in the current buffer is not restored.
 
 BEWARE: Most uses of this macro introduce bugs.
 E.g. it should not be used to try and prevent some code from opening