Mercurial > emacs

changeset 104752:fcbe482879e0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(describe-face): Adjust the output format to be more like describe-variable, and to mention (obsolete) face aliases. Adjust the whitespace so that help-setup-xref works.
author Glenn Morris <rgm@gnu.org>
date Mon, 31 Aug 2009 01:32:58 +0000
parents 0299ec0f58e6
children 8debb6dffc0f
files lisp/faces.el
diffstat 1 files changed, 26 insertions(+), 6 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/faces.el	Mon Aug 31 01:32:36 2009 +0000
+++ b/lisp/faces.el	Mon Aug 31 01:32:58 2009 +0000
@@ -1,7 +1,8 @@
 ;;; faces.el --- Lisp faces
 
 ;; Copyright (C) 1992, 1993, 1994, 1995, 1996, 1998, 1999, 2000, 2001,
-;;   2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+;;   2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009
+;;   Free Software Foundation, Inc.
 
 ;; Maintainer: FSF
 ;; Keywords: internal
@@ -552,7 +553,7 @@
     (if alias
         (progn
           (setq doc (get alias 'face-documentation))
-          (format "%s is an alias for the face `%s'.%s" face alias
+	  (format "%s is an alias for the face `%s'.%s" face alias
                   (if doc (format "\n%s" doc)
                     "")))
       (get face 'face-documentation))))
@@ -1368,10 +1369,29 @@
 		    file-name)
 		(insert (concat " (" (propertize "sample" 'font-lock-face f) ")"))
 		(princ (concat " (" customize-label ")\n"))
-		(insert "Documentation: "
-			(or (face-documentation f)
-			    "Not documented as a face.")
-			"\n")
+		;; FIXME not sure how much of this belongs here, and
+		;; how much in `face-documentation'.  The latter is
+		;; not used much, but needs to return nil for
+		;; undocumented faces.
+		(let ((alias (get f 'face-alias))
+		      (face f)
+		      obsolete)
+		  (when alias
+		    (setq face alias)
+		    (insert
+		     (format "\n  %s is an alias for the face `%s'.\n%s"
+			     f alias
+			     (if (setq obsolete (get f 'obsolete-face))
+				 (format "  This face is obsolete%s; use `%s' instead.\n"
+					 (if (stringp obsolete)
+					     (format " since %s" obsolete)
+					   "")
+					 alias)
+			       ""))))
+		  (insert "\nDocumentation:\n"
+			  (or (face-documentation face)
+			      "Not documented as a face.")
+			  "\n\n"))
 		(with-current-buffer standard-output
 		  (save-excursion
 		    (re-search-backward