From ca425c7c87bc939777a1dceea7fbe1fe563bc3ca Mon Sep 17 00:00:00 2001 From: Lars Magne Ingebrigtsen Date: Sat, 16 Jul 2011 20:42:38 +0200 Subject: [PATCH] Document `auto-fill-function' in relation to `auto-fill-mode' Fixes: debbugs:2470 --- lisp/ChangeLog | 2 ++ lisp/simple.el | 6 ++++-- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 06201dd41463..6ac0dd3d0b1c 100644 --- 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 diff --git a/lisp/simple.el b/lisp/simple.el index 5dbe1e397948..7fd7e20b4991 100644 --- 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))