summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlan Mackenzie <acm@muc.de>2010-01-28 16:24:50 +0000
committerAlan Mackenzie <acm@muc.de>2010-01-28 16:24:50 +0000
commitc02f8fe2f1761e6d432fe5716959ce3b27feaff2 (patch)
treec19ba1fa80a617eae26e39c8c18f8bba891cd038
parenta292592c130607e487082c58c52aac31bc9be366 (diff)
downloademacs-c02f8fe2f1761e6d432fe5716959ce3b27feaff2.tar.gz
display.texi (Auto Faces): Say fontification-functions is called
whether or not Font Lock is enabled. Tidy up the wording a bit.
-rw-r--r--doc/lispref/ChangeLog5
-rw-r--r--doc/lispref/display.texi20
2 files changed, 16 insertions, 9 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index 2f5923fb8f1..58c801f5cae 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,3 +1,8 @@
+2010-01-28 Alan Mackenzie <acm@muc.de>
+
+ * display.texi (Auto Faces): Say fontification-functions is called
+ whether or not Font Lock is enabled. Tidy up the wording a bit.
+
2010-01-17 Chong Yidong <cyd@stupidchicken.com>
* elisp.texi: Remove duplicate edition information (Bug#5407).
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index 9c1db3d276f..5f2e4f874a8 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -2654,23 +2654,25 @@ Font-Lock.
@defvar fontification-functions
This variable holds a list of functions that are called by Emacs
-redisplay as needed to assign faces automatically to text in the buffer.
+redisplay as needed, just before doing redisplay. They are called even
+when Font Lock Mode isn't enabled. When Font Lock Mode is enabled, this
+variable usually holds just one function, @code{jit-lock-function}.
The functions are called in the order listed, with one argument, a
-buffer position @var{pos}. Each function should attempt to assign faces
-to the text in the current buffer starting at @var{pos}.
+buffer position @var{pos}. Collectively they should attempt to assign
+faces to the text in the current buffer starting at @var{pos}.
-Each function should record the faces they assign by setting the
-@code{face} property. It should also add a non-@code{nil}
-@code{fontified} property for all the text it has assigned faces to.
+The functions should record the faces they assign by setting the
+@code{face} property. They should also add a non-@code{nil}
+@code{fontified} property to all the text they have assigned faces to.
That property tells redisplay that faces have been assigned to that text
already.
-It is probably a good idea for each function to do nothing if the
+It is probably a good idea for the functions to do nothing if the
character after @var{pos} already has a non-@code{nil} @code{fontified}
property, but this is not required. If one function overrides the
-assignments made by a previous one, the properties as they are
-after the last function finishes are the ones that really matter.
+assignments made by a previous one, the properties after the last
+function finishes are the ones that really matter.
For efficiency, we recommend writing these functions so that they
usually assign faces to around 400 to 600 characters at each call.