GNU bug report logs - #17730
24.4.50; (elisp) `Syntactic Font Lock': undescribed OTHER-VARS

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 17730 in the body.
You can then email your comments to 17730 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.4.50; (elisp) `Syntactic Font Lock': undescribed OTHER-VARS
Date: Sat, 7 Jun 2014 21:23:41 -0700 (PDT)

The doc refers to "an OTHER-VARS element in `font-lock-defaults':

 Variable: font-lock-syntactic-face-function
 If this variable is non-`nil', it should be a function to determine
 which face to use for a given syntactic element (a string or a
 comment).  The value is normally set through an OTHER-VARS element
 in `font-lock-defaults'.

Incomprehensible.  There is no "an OTHER-VARS element" described
anywhere in the doc of `font-lock-defaults' or in the link in the next
paragraph (node `Faces for Font Lock').

And there is no "OTHER-VARS" anywhere in the Emacs Lisp code, other than
a presumably unrelated (and just as undescribed) occurrence in pcase.el.



In GNU Emacs 24.4.50.1 (i686-pc-mingw32)
 of 2014-06-01 on ODIEONE
Bzr revision: 117212 michael.albinus <at> gmx.de-20140601104945-g88x0mwrxorz302h
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/Devel/emacs/snapshot/trunk
 --enable-checking=yes,glyphs 'CFLAGS=-O0 -g3'
 LDFLAGS=-Lc:/Devel/emacs/lib 'CPPFLAGS=-DGC_MCHECK=1
 -Ic:/Devel/emacs/include''

Message #8 received at 17730 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 17730 <at> debbugs.gnu.org
Subject: Re: bug#17730: 24.4.50;
 (elisp) `Syntactic Font Lock': undescribed OTHER-VARS
Date: Fri, 29 Apr 2016 22:41:44 +0200

Drew Adams <drew.adams <at> oracle.com> writes:

> The doc refers to "an OTHER-VARS element in `font-lock-defaults':
>
>  Variable: font-lock-syntactic-face-function
>  If this variable is non-`nil', it should be a function to determine
>  which face to use for a given syntactic element (a string or a
>  comment).  The value is normally set through an OTHER-VARS element
>  in `font-lock-defaults'.
>
> Incomprehensible.  There is no "an OTHER-VARS element" described
> anywhere in the doc of `font-lock-defaults' or in the link in the next
> paragraph (node `Faces for Font Lock').

After looking through font-core.el for several seconds, I don't have any
idea, either, what this is supposed to mean.  This is the full text:

The previous version was:

-Specify this variable using @var{other-vars} in
 @code{font-lock-defaults}.

and

-Major modes normally set this variable with @var{other-vars} in
-@code{font-lock-defaults}.

but vc-region-history on the doc string of that variable seems to say
that it has never talked about "other-vars".

Anybody want to take a guess at what this is supposed to mean?

 -- Variable: font-lock-syntactic-face-function
     If this variable is non-‘nil’, it should be a function to determine
     which face to use for a given syntactic element (a string or a
     comment).  The value is normally set through an OTHER-VARS element
     in ‘font-lock-defaults’.

     The function is called with one argument, the parse state at point
     returned by ‘parse-partial-sexp’, and should return a face.  The
     default value returns ‘font-lock-comment-face’ for comments and
     ‘font-lock-string-face’ for strings (*note Faces for Font Lock::).



-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Message #11 received at 17730 <at> debbugs.gnu.org (full text, mbox):

From: Michael Heerdegen <michael_heerdegen <at> web.de>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 17730 <at> debbugs.gnu.org, Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#17730: 24.4.50;
 (elisp) `Syntactic Font Lock': undescribed OTHER-VARS
Date: Sun, 01 May 2016 01:06:04 +0200

Lars Ingebrigtsen <larsi <at> gnus.org> writes:

> Anybody want to take a guess at what this is supposed to mean?

Looks like this refers to this thing described in the doc of
`font-lock-defaults':

"Further item elements are alists of the form (VARIABLE . VALUE) and are
in no particular order.  Each VARIABLE is made buffer-local before set
to VALUE."

Also see the following sentences.

Maybe the docstring of `font-lock-defaults' has been changed, and a
further version used the name "OTHER-VARS".


Michael.

Message #14 received at 17730 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Michael Heerdegen <michael_heerdegen <at> web.de>
Cc: 17730 <at> debbugs.gnu.org, Drew Adams <drew.adams <at> oracle.com>
Subject: Re: bug#17730: 24.4.50; (elisp) `Syntactic Font Lock': undescribed
 OTHER-VARS
Date: Sun, 03 Nov 2019 17:20:15 +0100

Michael Heerdegen <michael_heerdegen <at> web.de> writes:

> Lars Ingebrigtsen <larsi <at> gnus.org> writes:
>
>> Anybody want to take a guess at what this is supposed to mean?
>
> Looks like this refers to this thing described in the doc of
> `font-lock-defaults':
>
> "Further item elements are alists of the form (VARIABLE . VALUE) and are
> in no particular order.  Each VARIABLE is made buffer-local before set
> to VALUE."
>
> Also see the following sentences.
>
> Maybe the docstring of `font-lock-defaults' has been changed, and a
> further version used the name "OTHER-VARS".

Yup; that makes sense.  I've now adjusted the manual and added a
real-life example to help make it obvious what we're talking about.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.