* faces.el (face-attribute, set-face-attribute): Mention existence
authorChong Yidong <cyd@stupidchicken.com>
Fri, 18 Nov 2005 02:25:24 +0000 (02:25 +0000)
committerChong Yidong <cyd@stupidchicken.com>
Fri, 18 Nov 2005 02:25:24 +0000 (02:25 +0000)
of `:ignore-defface' setting in docstring.

lisp/ChangeLog
lisp/faces.el

index 4f748d5..03ba7c9 100644 (file)
@@ -1,3 +1,8 @@
+2005-11-17  Chong Yidong  <cyd@stupidchicken.com>
+
+       * faces.el (face-attribute, set-face-attribute): Mention existence
+       of `:ignore-defface' setting in docstring.
+
 2005-11-17  Stefan Monnier  <monnier@iro.umontreal.ca>
 
        * simple.el (completion-setup-function): Fix last change.
index 85d8e88..a60805e 100644 (file)
@@ -357,11 +357,12 @@ If the optional argument FRAME is given, report on face FACE in that frame.
 If FRAME is t, report on the defaults for face FACE (for new frames).
 If FRAME is omitted or nil, use the selected frame.
 
-If INHERIT is nil, only attributes directly defined by FACE are considered,
-  so the return value may be `unspecified', or a relative value.
+If INHERIT is nil, only attributes directly defined by FACE are
+  considered, so the return value may be `unspecified',
+  `:ignore-defface', or a relative value.
 If INHERIT is non-nil, FACE's definition of ATTRIBUTE is merged with the
   faces specified by its `:inherit' attribute; however the return value
-  may still be `unspecified' or relative.
+  may still be relative.
 If INHERIT is a face or a list of faces, then the result is further merged
   with that face (or faces), until it becomes specified and absolute.
 
@@ -560,8 +561,13 @@ the default for new frames (this is done automatically each time an
 attribute is changed on all frames).
 
 ARGS must come in pairs ATTRIBUTE VALUE.  ATTRIBUTE must be a valid
-face attribute name.  All attributes can be set to `unspecified';
-this fact is not further mentioned below.
+face attribute name.
+
+Unless you're certain you know what you're doing, don't set an
+attribute to `unspecified' .  To make a face ignore the attribute
+given in the defface spec, assign it the value `:ignore-defface'.
+You can do this for any attribute; this fact is not further
+mentioned below.
 
 The following attributes are recognized: