[Emacs-diffs] /srv/bzr/emacs/trunk r106750: Doc fix for window-scroll-functions.

[Eli Zaretskii]

------------------------------------------------------------
revno: 106750
author: Antoine Levitt <address@hidden>
committer: Eli Zaretskii <address@hidden>
branch nick: trunk
timestamp: Sat 2011-12-31 10:16:41 +0200
message:
  Doc fix for window-scroll-functions.
  
   src/xdisp.c (syms_of_xdisp) <window-scroll-functions>: Add warning
   to the doc string advising against its use for altering the way
   windows are scrolled.
modified:
  src/ChangeLog
  src/xdisp.c

=== modified file 'src/ChangeLog'
--- a/src/ChangeLog     2011-12-28 07:55:49 +0000
+++ b/src/ChangeLog     2011-12-31 08:16:41 +0000
@@ -1,3 +1,9 @@
+2011-12-31  Antoine Levitt  <address@hidden>
+
+       * xdisp.c (syms_of_xdisp) <window-scroll-functions>: Add warning
+       to the doc string advising against its use for altering the way
+       windows are scrolled.
+
 2011-12-28  Kenichi Handa  <address@hidden>
 
        * coding.c (Fdefine_coding_system_internal): Make an utf-8 base

=== modified file 'src/xdisp.c'
--- a/src/xdisp.c       2011-12-31 01:27:15 +0000
+++ b/src/xdisp.c       2011-12-31 08:16:41 +0000
@@ -28325,7 +28325,11 @@
 Each function is called with two arguments, the window and its new
 display-start position.  Note that these functions are also called by
 `set-window-buffer'.  Also note that the value of `window-end' is not
-valid when these functions are called.  */);
+valid when these functions are called.
+
+Warning: Do not use this feature to alter the way the window
+is scrolled.  It is not designed for that, and such use probably won't
+work.  */);
   Vwindow_scroll_functions = Qnil;
 
   DEFVAR_LISP ("window-text-change-functions",