GNU bug report logs - #19483
25.0.50; out-of-date doc and Commentary in `font-lock' wrt `font-lock-syntactic-keywords'

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 19483 in the body.
You can then email your comments to 19483 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: 25.0.50; out-of-date doc and Commentary in `font-lock' wrt
 `font-lock-syntactic-keywords'
Date: Thu, 1 Jan 2015 14:25:33 -0800 (PST)

`C-h v font-lock-syntactic-keywords' says that the variable is obsolete
since 24.1.  But in font-lock.el, the code, multiple doc strings, and
the Commentary all rely on it.

Something is not up to date, it seems.  Whatever that is, it should have
been taken care of at the same time that this variable was declared
obsolete.  That's 4 releases ago, now.  As of Emacs 25.1, it will be 5
releases overdue.

In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2014-10-20 on LEG570
Bzr revision: 118168 rgm <at> gnu.org-20141020195941-icp42t8ttcnud09g
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking=yes,glyphs CPPFLAGS=-DGLYPH_DEBUG=1'

Message #12 received at 19483-done <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 19483-done <at> debbugs.gnu.org
Subject: Re: bug#19483: 25.0.50;
 out-of-date doc and Commentary in `font-lock' wrt
 `font-lock-syntactic-keywords'
Date: Fri, 02 Jan 2015 22:19:07 -0500

tags 19483 notabug
thanks


> `C-h v font-lock-syntactic-keywords' says that the variable is obsolete
> since 24.1.

That's right.

> But in font-lock.el, the code, multiple doc strings, and
> the Commentary all rely on it.

No, they just keep supporting it, because it's only "obsolete" and not
"removed".

Do you really want to advocate we remove features right away when we
decide they're obsolete?


        Stefan

Message #15 received at 19483-done <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 19483-done <at> debbugs.gnu.org
Subject: RE: bug#19483: 25.0.50; out-of-date doc and Commentary in `font-lock'
 wrt `font-lock-syntactic-keywords'
Date: Fri, 2 Jan 2015 23:59:54 -0800 (PST)

> tags 19483 notabug
> thanks
> 
> > `C-h v font-lock-syntactic-keywords' says that the variable is
> > obsolete since 24.1.
> 
> That's right.
> 
> > But in font-lock.el, the code, multiple doc strings, and
> > the Commentary all rely on it.
> 
> No, they just keep supporting it, because it's only "obsolete" and
> not "removed".

The doc and Commentary should reflect the fact that it has been
declared "obsolete".  That's the point.

> Do you really want to advocate we remove features right away when we
> decide they're obsolete?

Strawman, again.  No one suggested that you remove any feature.

Read the bug report.  It's about the doc (including Commentary). 

When you deprecate something, the doc for it should state that it
is deprecated.  Everywhere.

That the doc was not brought up to date about this as soon as
the status changed to deprecated was a doc bug 4 releases ago.
The bug is still there.

Emacs is the self-documenting editor.  It should tell users
about itself accurately.

Message #18 received at 19483-done <at> debbugs.gnu.org (full text, mbox):

From: Stefan Monnier <monnier <at> iro.umontreal.ca>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 19483-done <at> debbugs.gnu.org
Subject: Re: bug#19483: 25.0.50;
 out-of-date doc and Commentary in `font-lock' wrt
 `font-lock-syntactic-keywords'
Date: Sat, 03 Jan 2015 21:36:04 -0500

> The doc and Commentary should reflect the fact that it has been
> declared "obsolete".  That's the point.

Oh, I missed that.  Then, yes, feel free to install a patch for that.
Most of the doc should simply be removed.


        Stefan

Message #21 received at 19483-done <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 19483-done <at> debbugs.gnu.org
Subject: RE: bug#19483: 25.0.50; out-of-date doc and Commentary in `font-lock'
 wrt `font-lock-syntactic-keywords'
Date: Sat, 3 Jan 2015 19:00:29 -0800 (PST)

> > The doc and Commentary should reflect the fact that it has been
> > declared "obsolete".  That's the point.
> 
> Oh, I missed that.  Then, yes, feel free to install a patch for
> that. Most of the doc should simply be removed.

The bug status should not be "done"/"notabug", as long as the
problem exists.

Previous Next

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