bug#848: doc for recenter, redisplay

bug#848: doc for recenter, redisplay

[Drew Adams]

I notice that `recenter' has the effect of calling (redisplay t); that
is, it seems to force a redisplay. I don't see this mentioned
anywhere. It might be helpful to mention it. We might want to mention
it in the Elisp manual node Textual Scrolling, where `recenter' is
covered, and also in node Forcing Redisplay, where redisplay is
covered (with an xref to Textual Scrolling).
 
Users who want to both recenter and redisplay might want to know
that `recenter' alone suffices.
 
Users who do not want to force a redisplay might want to know that
`recenter' does that.
 

In GNU Emacs 22.2.1 (i386-mingw-nt5.1.2600)
 of 2008-03-26 on RELEASE
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4)'
 

bug#848: marked as done (doc for recenter, redisplay)

[Emacs bug Tracking System]

[-- Attachment #1: Type: text/plain, Size: 813 bytes --]


Your message dated Mon, 01 Sep 2008 13:54:52 -0400
with message-id <87od37zr83.fsf@cyd.mit.edu>
and subject line Re: doc for recenter, redisplay
has caused the Emacs bug report #848,
regarding doc for recenter, redisplay
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact don@donarmstrong.com
immediately.)


-- 
848: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=848
Emacs Bug Tracking System
Contact don@donarmstrong.com with problems

[-- Attachment #2: Type: message/rfc822, Size: 3525 bytes --]

From: "Drew Adams" <drew.adams@oracle.com>
To: <bug-gnu-emacs@gnu.org>
Subject: doc for recenter, redisplay
Date: Mon, 1 Sep 2008 00:26:38 -0700
Message-ID: <008501c90c04$1388ba60$0200a8c0@us.oracle.com>

I notice that `recenter' has the effect of calling (redisplay t); that
is, it seems to force a redisplay. I don't see this mentioned
anywhere. It might be helpful to mention it. We might want to mention
it in the Elisp manual node Textual Scrolling, where `recenter' is
covered, and also in node Forcing Redisplay, where redisplay is
covered (with an xref to Textual Scrolling).
 
Users who want to both recenter and redisplay might want to know
that `recenter' alone suffices.
 
Users who do not want to force a redisplay might want to know that
`recenter' does that.
 

In GNU Emacs 22.2.1 (i386-mingw-nt5.1.2600)
 of 2008-03-26 on RELEASE
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4)'
 





[-- Attachment #3: Type: message/rfc822, Size: 1942 bytes --]

From: Chong Yidong <cyd@stupidchicken.com>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: 848-done@emacsbugs.donarmstrong.com
Subject: Re: doc for recenter, redisplay
Date: Mon, 01 Sep 2008 13:54:52 -0400
Message-ID: <87od37zr83.fsf@cyd.mit.edu>

> I notice that `recenter' has the effect of calling (redisplay t); that
> is, it seems to force a redisplay. I don't see this mentioned
> anywhere. It might be helpful to mention it. We might want to mention
> it in the Elisp manual node Textual Scrolling, where `recenter' is
> covered, and also in node Forcing Redisplay, where redisplay is
> covered (with an xref to Textual Scrolling).

In the docstring:
  
  If arg is omitted or nil, erase the entire frame and then redraw with
  point in the center of the current window.

In the Emacs manual:

  It also clears the screen and redisplays all windows; this is useful
  in case the screen becomes garbled for any reason (*note Screen
  Garbled::).

In the Elisp manual:

  If @var{count} is @code{nil}, @code{recenter} puts the line containing
  point in the middle of the window, then clears and redisplays the
  entire selected frame.

However, the docstring for recenter-top-bottom (new to Emacs 23) did not
mention this; I've updated it accordingly.