From: Glenn Morris <rgm@gnu.org>
Date: Thu, 3 Feb 2011 06:55:48 +0000 (-0800)
Subject: Doc fixes related to face heights. (Bug#2659)
X-Git-Tag: emacs-pretest-23.2.94~26
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=95838641ae01abb8589c99512dfd5ed6bccf25dc;p=emacs.git

Doc fixes related to face heights. (Bug#2659)

* lisp/faces.el (set-face-attribute): Doc fix.

* src/xfaces.c (Finternal_set_lisp_face_attribute):
Try to clarify some error messages.
---

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index 3b8da6fa373..6d0a352ca3c 100644
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -1,3 +1,7 @@
+2011-02-03  Glenn Morris  <rgm@gnu.org>
+
+	* faces.el (set-face-attribute): Doc fix.  (Bug#2659)
+
 2011-02-02  Stefan Monnier  <monnier@iro.umontreal.ca>
 
 	* pcomplete.el (pcomplete-here*): Backport fix for mistaken change
diff --git a/lisp/faces.el b/lisp/faces.el
index a3831084ad8..4a4acefa04c 100644
--- a/lisp/faces.el
+++ b/lisp/faces.el
@@ -616,10 +616,14 @@ It must be one of the symbols `ultra-condensed', `extra-condensed',
 
 `:height'
 
-VALUE must be either an integer specifying the height of the font to use
-in 1/10 pt, a floating point number specifying the amount by which to
-scale any underlying face, or a function, which is called with the old
-height (from the underlying face), and should return the new height.
+VALUE specifies the height of the font, in either absolute or relative
+terms.  An absolute height is an integer, and specifies font height in
+units of 1/10 pt.  A relative height is either a floating point number,
+which specifies a scaling factor for the underlying face height;
+or a function that takes a single argument (the underlying face height)
+and returns the new height.  Note that for the `default' face,
+you can only specify an absolute height (since there is nothing
+for it to be relative to).
 
 `:weight'
 
diff --git a/src/ChangeLog b/src/ChangeLog
index a665fd73047..2b02030fd4f 100644
--- a/src/ChangeLog
+++ b/src/ChangeLog
@@ -1,3 +1,8 @@
+2011-02-03  Glenn Morris  <rgm@gnu.org>
+
+	* xfaces.c (Finternal_set_lisp_face_attribute):
+	Try to clarify some error messages.  (Bug#2659)
+
 2011-02-02  Stefan Monnier  <monnier@iro.umontreal.ca>
 
 	* editfns.c (save_restriction_restore): Don't forget to invalidate the
diff --git a/src/xfaces.c b/src/xfaces.c
index ecd726f4540..e9e677d1b19 100644
--- a/src/xfaces.c
+++ b/src/xfaces.c
@@ -3060,7 +3060,7 @@ FRAME 0 means change the face on all frames, and change the default
 	    {
 	      /* The default face must have an absolute size.  */
 	      if (!INTEGERP (value) || XINT (value) <= 0)
-		signal_error ("Invalid default face height", value);
+		signal_error ("Default face height not absolute and positive", value);
 	    }
 	  else
 	    {
@@ -3070,7 +3070,7 @@ FRAME 0 means change the face on all frames, and change the default
 						     make_number (10),
 						     Qnil);
 	      if (!INTEGERP (test) || XINT (test) <= 0)
-		signal_error ("Invalid face height", value);
+		signal_error ("Face height does not produce a positive integer", value);
 	    }
 	}