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

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

[Drew Adams]

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@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''

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

[Lars Ingebrigtsen]

Drew Adams <drew.adams@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

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

[Michael Heerdegen]

Lars Ingebrigtsen <larsi@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.

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

[Lars Ingebrigtsen]

Michael Heerdegen <michael_heerdegen@web.de> writes:

> Lars Ingebrigtsen <larsi@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