GNU bug report logs - #8962
24.0.50; do not simply reuse (hard-code) font-lock faces for apropos

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 8962 in the body.
You can then email your comments to 8962 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.0.50; do not simply reuse (hard-code) font-lock faces for apropos
Date: Wed, 29 Jun 2011 14:02:47 -0700

In the past, the same, hard-coded face (`(italic variable-pitch)') was
used for the `Command', `Variable', `Option', and `Properties' links in
apropos output buffers.

At least this had the advantage of not being horribly ugly.  But it had
the disadvantage of not distinguishing the various types of thing by
appearance.

The problem with the current situation is that you have simply reused
font-lock faces, instead of creating new faces (that perhaps inherit
from the same font-lock faces).

Faces that a user might have customized for font-lock, and which work
well for code (e.g. Lisp code), do not necessarily work well for
apropos.

For instance, I use red for `font-lock-function-name-face'.  That is
horrible in apropos output.  But I have no way to customize it for
apropos, without also changing it for code etc.

This is very unwise design.  If you want to use a customizable face
instead of hard-coding the face, great.  But in that case create faces
for apropos itself, so a user can customize the appearance of apropos
without also affecting the appearance of font-lock in general.

You can always make the apropos faces inherit from any faces you like.
But please do not couple things this way, making it hard on users.

This kind of thing is hard-coding - a no-no:

(define-button-type 'apropos-function
  'apropos-label "Function"
  'apropos-short-label "f"
  'face '(font-lock-function-name-face button)
;;      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
;;      NO NO ----------

  'help-echo "mouse-2, RET: Display more help on this function"
  'follow-link t
  'action (lambda (button)
     (describe-function (button-get button 'apropos-symbol))))


In GNU Emacs 24.0.50.1 (i386-mingw-nt5.1.2600)
 of 2011-06-27 on 3249CTO
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (4.5) --no-opt --cflags
-Ic:/build/include'

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

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Chong Yidong'" <cyd <at> gnu.org>, <8962 <at> debbugs.gnu.org>
Cc: tracker <at> debbugs.gnu.org, 'GNU bug Tracking System' <help-debbugs <at> gnu.org>
Subject: bug#8962: 24.0.50;
	do not simply reuse (hard-code) font-lock faces for apropos
Date: Sat, 28 Jan 2012 21:19:01 -0800

No reason is given why this is considered a "wishlist" bug.

Such hardcoded faces are anathema and should be corrected, giving users the
control they deserve.  Hardcoding is not the GNU way.  It does not respect
users.  Especially so in the context of user help such as `apropos'.

> From: GNU bug Tracking System Sent: Saturday, January 28, 2012 8:54 PM
> Processing commands for control <at> debbugs.gnu.org:
> 
> > severity 8962 wishlist
> Bug #8962 [emacs] 24.0.50; do not simply reuse (hard-code) 
> font-lock faces for apropos
> Severity set to 'wishlist' from 'normal'
> 
> > thanks
> Stopping processing here.
> 
> Please contact help-debbugs <at> gnu.org if you need assistance.
> 
> GNU bugs database, http://debbugs.gnu.org/

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

From: Chong Yidong <cyd <at> gnu.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 8962 <at> debbugs.gnu.org
Subject: Re: bug#8962: 24.0.50;
	do not simply reuse (hard-code) font-lock faces for apropos
Date: Mon, 23 Apr 2012 23:40:22 +0800

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

> The problem with the current situation is that you have simply reused
> font-lock faces, instead of creating new faces (that perhaps inherit
> from the same font-lock faces).

Fixed now in trunk.

Previous Next

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