]> git.eshelyaron.com Git - emacs.git/commitdiff
Improve documentation of 'face-spec-set-2'
authorEli Zaretskii <eliz@gnu.org>
Sat, 10 Jun 2017 08:39:59 +0000 (11:39 +0300)
committerEli Zaretskii <eliz@gnu.org>
Sat, 10 Jun 2017 08:39:59 +0000 (11:39 +0300)
* lisp/faces.el (face-spec-recalc, face-spec-set-2): Rename 'spec'
to 'face-attrs'.
(face-spec-choose, face-spec-set-2): Doc fix.  (Bug#27238)

lisp/faces.el

index a6ffd1ecd3357f8771981aefc0966a119dd37ea9..1f9b3974c728e8bd871f645705b43236335d859d 100644 (file)
@@ -1594,6 +1594,7 @@ If FRAME is nil, the current FRAME is used."
 (defun face-spec-choose (spec &optional frame no-match-retval)
   "Return the proper attributes for FRAME, out of SPEC.
 
+Value is a plist of face attributes in the form of attribute-value pairs.
 If no match is found or SPEC is nil, return nil, unless NO-MATCH-RETVAL
 is given, in which case return its value instead."
   (unless frame
@@ -1734,32 +1735,34 @@ The following sources are applied in this order:
   ;; `theme-face' records.
   (let ((theme-faces (get face 'theme-face))
        (no-match-found 0)
-       spec theme-face-applied)
+       face-attrs theme-face-applied)
     (if theme-faces
        (dolist (elt (reverse theme-faces))
-         (setq spec (face-spec-choose (cadr elt) frame no-match-found))
-         (unless (eq spec no-match-found)
-           (face-spec-set-2 face frame spec)
+         (setq face-attrs (face-spec-choose (cadr elt) frame no-match-found))
+         (unless (eq face-attrs no-match-found)
+           (face-spec-set-2 face frame face-attrs)
            (setq theme-face-applied t))))
     ;; If there was a spec applicable to FRAME, that overrides the
     ;; defface spec entirely (rather than inheriting from it).  If
     ;; there was no spec applicable to FRAME, apply the defface spec
     ;; as well as any applicable X resources.
     (unless theme-face-applied
-      (setq spec (face-spec-choose (face-default-spec face) frame))
-      (face-spec-set-2 face frame spec)
+      (setq face-attrs (face-spec-choose (face-default-spec face) frame))
+      (face-spec-set-2 face frame face-attrs)
       (make-face-x-resource-internal face frame))
-    (setq spec (face-spec-choose (get face 'face-override-spec) frame))
-    (face-spec-set-2 face frame spec)))
+    (setq face-attrs (face-spec-choose (get face 'face-override-spec) frame))
+    (face-spec-set-2 face frame face-attrs)))
 
-(defun face-spec-set-2 (face frame spec)
-  "Set the face attributes of FACE on FRAME according to SPEC."
+(defun face-spec-set-2 (face frame face-attrs)
+  "Set the face attributes of FACE on FRAME according to FACE-ATTRS.
+FACE-ATTRS is a plist of face attributes in the form of attribute-value
+pairs."
   (let (attrs)
-    (while spec
-      (when (assq (car spec) face-x-resources)
-       (push (car spec) attrs)
-       (push (cadr spec) attrs))
-      (setq spec (cddr spec)))
+    (while face-attrs
+      (when (assq (car face-attrs) face-x-resources)
+       (push (car face-attrs) attrs)
+       (push (cadr face-attrs) attrs))
+      (setq face-attrs (cddr face-attrs)))
     (apply 'set-face-attribute face frame (nreverse attrs))))
 
 (defun face-attr-match-p (face attrs &optional frame)