summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNoam Postavsky <npostavs@gmail.com>2019-04-19 00:55:14 -0400
committerNoam Postavsky <npostavs@gmail.com>2019-04-28 17:20:17 -0400
commit140e7f890fa94f8b6381dfa3e0682cacfa92a593 (patch)
tree3912ef04d7bc01108fa48c5193f8e2a9a24d7d53
parent7cb5364ef5334de0fb1bc2e470bea450e4567d24 (diff)
downloademacs-140e7f890fa94f8b6381dfa3e0682cacfa92a593.tar.gz
Recommend using font-lock-face over face (Bug#35044)
* doc/lispref/modes.texi (Precalculated Fontification): Explain advantages of using font-lock-face over face.
-rw-r--r--doc/lispref/modes.texi7
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi
index 919816f3dee..0ff13d72e2f 100644
--- a/doc/lispref/modes.texi
+++ b/doc/lispref/modes.texi
@@ -3201,7 +3201,12 @@ is disabled, @code{font-lock-face} has no effect on the display.
It is ok for a mode to use @code{font-lock-face} for some text and
also use the normal Font Lock machinery. But if the mode does not use
the normal Font Lock machinery, it should not set the variable
-@code{font-lock-defaults}.
+@code{font-lock-defaults}. In this case the @code{face} property will
+not be overriden, so using the @code{face} property could work too.
+However, using @code{font-lock-face} is generally preferable as it
+allows the user to control the fontification by toggling
+@code{font-lock-mode}, and lets the code work regardless of whether
+the mode uses Font Lock machinery or not.
@node Faces for Font Lock
@subsection Faces for Font Lock