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.

diff --git a/src/ChangeLog b/src/ChangeLog
index f10e2955164dc6892a5e21b9af1869e208b51e26..e8b59fff9a976ae5359a2d4f2c59e3a0bca4516c 100644 (file)
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,9 @@
+2011-12-31  Antoine Levitt  <antoine.levitt@gmail.com>
+
+       * 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  <handa@m17n.org>
 
        * coding.c (Fdefine_coding_system_internal): Make an utf-8 base

diff --git a/src/xdisp.c b/src/xdisp.c
index 39b6813e77438bbb4a5e5a488c7aa2bfcaf654fa..956799091d02ab06b355f5dd42645188aede07cf 100644 (file)
--- a/src/xdisp.c
+++ b/src/xdisp.c
@@ -28325,7 +28325,11 @@ all the functions in the list are called, with the frame as argument.  */);
 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",