Document `auto-fill-function' in relation to `auto-fill-mode'

Fixes: debbugs:2470

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 06201dd41463bbf48ebc29a910fb7a6991fc42a3..6ac0dd3d0b1c99193da569f5b277dbf68cd4bcbb 100644 (file)
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -2,6 +2,8 @@
 
        * simple.el (current-kill): Clarify what
        `interprogram-paste-function' does (bug#7500).
+       (auto-fill-mode): Document `auto-fill-function' in relation to
+       `auto-fill-mode' (bug#2470).
 
 2011-07-16  Lawrence Mitchell  <wence@gmx.li>
 

diff --git a/lisp/simple.el b/lisp/simple.el
index 5dbe1e397948f2375e5d5a422c7239739516b841..7fd7e20b499165b7b62ea15dca183e39dd8ee840 100644 (file)
--- a/lisp/simple.el
+++ b/lisp/simple.el
@@ -5237,14 +5237,16 @@ Some major modes set this.")
 ;; auto-fill-function to nil in a file-local setting is safe and
 ;; can be useful to prevent auto-filling.
 (put 'auto-fill-function 'safe-local-variable 'null)
-;; FIXME: turn into a proper minor mode.
-;; Add a global minor mode version of it.
+
 (define-minor-mode auto-fill-mode
   "Toggle Auto Fill mode.
 With ARG, turn Auto Fill mode on if and only if ARG is positive.
 In Auto Fill mode, inserting a space at a column beyond `current-fill-column'
 automatically breaks the line at a previous space.
 
+When `auto-fill-mode' is on, the `auto-fill-function' variable is
+non-`nil'.
+
 The value of `normal-auto-fill-function' specifies the function to use
 for `auto-fill-function' when turning Auto Fill mode on."
   :variable (eq auto-fill-function normal-auto-fill-function))