From: Richard M. Stallman <rms@gnu.org>
Date: Wed, 5 Jul 2006 17:05:41 +0000 (+0000)
Subject: (Attribute Functions): Add examples for face-attribute-relative-p.
X-Git-Tag: emacs-pretest-22.0.90~1681
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=c5a83cf9dda99cec64a453fede7ccb76666b26d0;p=emacs.git

(Attribute Functions): Add examples for face-attribute-relative-p.
---

diff --git a/lispref/display.texi b/lispref/display.texi
index bb0518a0e75..9398e0b95fc 100644
--- a/lispref/display.texi
+++ b/lispref/display.texi
@@ -2116,9 +2116,22 @@ and examine the face attributes which existed in those versions.
 
 @tindex face-attribute-relative-p
 @defun face-attribute-relative-p attribute value
-This function returns non-@code{nil} if @var{value}, when used as
-the value of the face attribute @var{attribute}, is relative (that is,
-if it modifies an underlying or inherited value of @var{attribute}).
+This function returns non-@code{nil} if @var{value}, when used as the
+value of the face attribute @var{attribute}, is relative.  This means
+it would modify, rather than completely override, any value that comes
+from a subsequent face in the face list or that is inherited from
+another face.
+
+@code{unspecified} is a relative value for all attributes.
+For @code{:height}, floating point values are also relative.
+
+For example:
+
+@example
+(read-face-name "Describe face" "= `default' face" t)
+@end example
+
+prompts with @samp{Describe face (default = `default' face): }.
 @end defun
 
 @tindex merge-face-attribute