Revert "Prefer ‘format’ to ‘substitute-command-keys’"

This reverts commit 6af5aad26411ffe21c3fe4bc5438347110910111.

13 files changed, 97 insertions, 71 deletions

diff --git a/lisp/cedet/mode-local.el b/lisp/cedet/mode-local.el
index aa1dd65068f..3bdc3ea6155 100644
--- a/lisp/cedet/mode-local.el
+++ b/lisp/cedet/mode-local.el
@@ -629,9 +629,10 @@ SYMBOL is a function that can be overridden."
 (defun mode-local-print-binding (symbol)
   "Print the SYMBOL binding."
   (let ((value (symbol-value symbol)))
-    (princ (format "\n     ‘%s’ value is\n       " symbol))
+    (princ (format (substitute-command-keys "\n     ‘%s’ value is\n       ")
+                   symbol))
     (if (and value (symbolp value))
-        (princ (format "‘%s’" value))
+        (princ (format (substitute-command-keys "‘%s’") value))
       (let ((pt (point)))
         (pp value)
         (save-excursion
@@ -689,7 +690,7 @@ SYMBOL is a function that can be overridden."
       )
      ((symbolp buffer-or-mode)
       (setq mode buffer-or-mode)
-      (princ (format "‘%s’\n" buffer-or-mode))
+      (princ (format (substitute-command-keys "‘%s’\n") buffer-or-mode))
       )
      ((signal 'wrong-type-argument
               (list 'buffer-or-mode buffer-or-mode))))
@@ -699,7 +700,7 @@ SYMBOL is a function that can be overridden."
     (while mode
       (setq table (get mode 'mode-local-symbol-table))
       (when table
-        (princ (format "\n- From ‘%s’\n" mode))
+        (princ (format (substitute-command-keys "\n- From ‘%s’\n") mode))
         (mode-local-print-bindings table))
       (setq mode (get-mode-local-parent mode)))))
 
diff --git a/lisp/cedet/srecode/srt-mode.el b/lisp/cedet/srecode/srt-mode.el
index efcfe4ba51d..48f055561ea 100644
--- a/lisp/cedet/srecode/srt-mode.el
+++ b/lisp/cedet/srecode/srt-mode.el
@@ -258,9 +258,9 @@ we can tell font lock about them.")
             (when (class-abstract-p C)
               (throw 'skip nil))
 
-            (princ (format "‘"))
+            (princ (substitute-command-keys "‘"))
             (princ name)
-            (princ (format "’"))
+            (princ (substitute-command-keys "’"))
             (when (slot-exists-p C 'key)
               (when key
                 (princ " - Character Key: ")
diff --git a/lisp/cus-theme.el b/lisp/cus-theme.el
index f8e5650db78..bc221e17c4b 100644
--- a/lisp/cus-theme.el
+++ b/lisp/cus-theme.el
@@ -492,10 +492,10 @@ It includes all faces in list FACES."
                          '("" "c")))
         doc)
     (when fn
-      (princ (format " in ‘"))
+      (princ (substitute-command-keys " in ‘"))
       (help-insert-xref-button (file-name-nondirectory fn)
                                'help-theme-def fn)
-      (princ (format "’")))
+      (princ (substitute-command-keys "’")))
     (princ ".\n")
     (if (custom-theme-p theme)
         (progn
diff --git a/lisp/descr-text.el b/lisp/descr-text.el
index 579278ceaa0..71233d406e1 100644
--- a/lisp/descr-text.el
+++ b/lisp/descr-text.el
@@ -161,8 +161,11 @@ otherwise."
       ;; Buttons
       (when (and button (not (widgetp wid-button)))
         (newline)
-        (insert (format "Here is a ‘%S’ button labeled ‘%s’.\n\n"
-                        button-type button-label)))
+        (insert (substitute-command-keys "Here is a ‘")
+                (format "%S" button-type)
+                (substitute-command-keys "’ button labeled ‘")
+                button-label
+                (substitute-command-keys "’.\n\n")))
       ;; Overlays
       (when overlays
         (newline)
@@ -736,7 +739,9 @@ relevant to POS."
                       (when face
                         (insert (propertize " " 'display '(space :align-to 5))
                                 "face: ")
-                        (insert (format "‘%s’\n" face))))))
+                        (insert (substitute-command-keys "‘")
+                                (symbol-name face)
+                                (substitute-command-keys "’\n"))))))
               (insert "these terminal codes:\n")
               (dotimes (i (length disp-vector))
                 (insert (car (aref disp-vector i))
diff --git a/lisp/emacs-lisp/cl-extra.el b/lisp/emacs-lisp/cl-extra.el
index 6f436db7100..8ed50f4f530 100644
--- a/lisp/emacs-lisp/cl-extra.el
+++ b/lisp/emacs-lisp/cl-extra.el
@@ -752,16 +752,16 @@ including `cl-block' and `cl-eval-when'."
         ;; FIXME: Add a `cl-class-of' or `cl-typeof' or somesuch.
         (metatype (cl--class-name (symbol-value (aref class 0)))))
     (insert (symbol-name type)
-            (format " is a type (of kind ‘"))
+            (substitute-command-keys " is a type (of kind ‘"))
     (help-insert-xref-button (symbol-name metatype)
                              'cl-help-type metatype)
-    (insert (format "’)"))
+    (insert (substitute-command-keys "’)"))
     (when location
-      (insert (format " in ‘"))
+      (insert (substitute-command-keys " in ‘"))
       (help-insert-xref-button
        (help-fns-short-filename location)
        'cl-type-definition type location 'define-type)
-      (insert (format "’")))
+      (insert (substitute-command-keys "’")))
     (insert ".\n")
 
     ;; Parents.
@@ -771,10 +771,10 @@ including `cl-block' and `cl-eval-when'."
         (insert " Inherits from ")
         (while (setq cur (pop pl))
           (setq cur (cl--class-name cur))
-          (insert (format "‘"))
+          (insert (substitute-command-keys "‘"))
           (help-insert-xref-button (symbol-name cur)
                                    'cl-help-type cur)
-          (insert (format (if pl "’, " "’"))))
+          (insert (substitute-command-keys (if pl "’, " "’"))))
         (insert ".\n")))
 
     ;; Children, if available.  ¡For EIEIO!
@@ -785,10 +785,10 @@ including `cl-block' and `cl-eval-when'."
       (when ch
         (insert " Children ")
         (while (setq cur (pop ch))
-          (insert (format "‘"))
+          (insert (substitute-command-keys "‘"))
           (help-insert-xref-button (symbol-name cur)
                                    'cl-help-type cur)
-          (insert (format (if ch "’, " "’"))))
+          (insert (substitute-command-keys (if ch "’, " "’"))))
         (insert ".\n")))
 
     ;; Type's documentation.
@@ -804,10 +804,10 @@ including `cl-block' and `cl-eval-when'."
       (when generics
         (insert (propertize "Specialized Methods:\n\n" 'face 'bold))
         (dolist (generic generics)
-          (insert (format "‘"))
+          (insert (substitute-command-keys "‘"))
           (help-insert-xref-button (symbol-name generic)
                                    'help-function generic)
-          (insert (format "’"))
+          (insert (substitute-command-keys "’"))
           (pcase-dolist (`(,qualifiers ,args ,doc)
                          (cl--generic-method-documentation generic type))
             (insert (format " %s%S\n" qualifiers args)
diff --git a/lisp/emacs-lisp/cl-generic.el b/lisp/emacs-lisp/cl-generic.el
index cecd7378620..5d527619d6d 100644
--- a/lisp/emacs-lisp/cl-generic.el
+++ b/lisp/emacs-lisp/cl-generic.el
@@ -864,11 +864,11 @@ MET-NAME is a cons (SYMBOL . SPECIALIZERS)."
                                    (cl--generic-method-specializers method)))
                    (file (find-lisp-object-file-name met-name 'cl-defmethod)))
               (when file
-                (insert (format " in ‘"))
+                (insert (substitute-command-keys " in ‘"))
                 (help-insert-xref-button (help-fns-short-filename file)
                                          'help-function-def met-name file
                                          'cl-defmethod)
-                (insert (format "’.\n"))))
+                (insert (substitute-command-keys "’.\n"))))
             (insert "\n" (or (nth 2 info) "Undocumented") "\n\n")))))))
 
 (defun cl--generic-specializers-apply-to-type-p (specializers type)
diff --git a/lisp/emacs-lisp/eieio-opt.el b/lisp/emacs-lisp/eieio-opt.el
index c4d6d35a13b..0b003360ed5 100644
--- a/lisp/emacs-lisp/eieio-opt.el
+++ b/lisp/emacs-lisp/eieio-opt.el
@@ -141,11 +141,11 @@ are not abstract."
         (setq location
               (find-lisp-object-file-name ctr def)))
       (when location
-        (insert (format " in ‘"))
+        (insert (substitute-command-keys " in ‘"))
         (help-insert-xref-button
          (help-fns-short-filename location)
          'cl-type-definition ctr location 'define-type)
-        (insert (format "’")))
+        (insert (substitute-command-keys "’")))
       (insert ".\nCreates an object of class " (symbol-name ctr) ".")
       (goto-char (point-max))
       (if (autoloadp def)
diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el
index f7cd6a1870a..3d2dbdf8712 100644
--- a/lisp/emacs-lisp/package.el
+++ b/lisp/emacs-lisp/package.el
@@ -2204,7 +2204,7 @@ Otherwise no newline is inserted."
                                    "Installed"
                                  (capitalize status))
                                'font-lock-face 'package-status-builtin-face))
-           (insert (format " in ‘"))
+           (insert (substitute-command-keys " in ‘"))
            (let ((dir (abbreviate-file-name
                        (file-name-as-directory
                         (if (file-in-directory-p pkg-dir package-user-dir)
@@ -2213,10 +2213,11 @@ Otherwise no newline is inserted."
              (help-insert-xref-button dir 'help-package-def pkg-dir))
            (if (and (package-built-in-p name)
                     (not (package-built-in-p name version)))
-               (insert (format "’,\n             shadowing a ")
+               (insert (substitute-command-keys
+                        "’,\n             shadowing a ")
                        (propertize "built-in package"
                                    'font-lock-face 'package-status-builtin-face))
-             (insert (format "’")))
+             (insert (substitute-command-keys "’")))
            (if signed
                (insert ".")
              (insert " (unsigned)."))
diff --git a/lisp/faces.el b/lisp/faces.el
index 15ed699aaa8..e628ee7870b 100644
--- a/lisp/faces.el
+++ b/lisp/faces.el
@@ -1436,10 +1436,12 @@ If FRAME is omitted or nil, use the selected frame."
                   (when alias
                     (setq face alias)
                     (insert
-                     (format "\n  %s is an alias for the face ‘%s’.\n%s"
+                     (format (substitute-command-keys
+                              "\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"
+                                 (format (substitute-command-keys
+                                          "  This face is obsolete%s; use ‘%s’ instead.\n")
                                          (if (stringp obsolete)
                                              (format " since %s" obsolete)
                                            "")
@@ -1457,11 +1459,13 @@ If FRAME is omitted or nil, use the selected frame."
                     (help-xref-button 1 'help-customize-face f)))
                 (setq file-name (find-lisp-object-file-name f 'defface))
                 (when file-name
-                  (princ (format "Defined in ‘%s’"
-                                 (file-name-nondirectory file-name)))
+                  (princ (substitute-command-keys "Defined in ‘"))
+                  (princ (file-name-nondirectory file-name))
+                  (princ (substitute-command-keys "’"))
                   ;; Make a hyperlink to the library.
                   (save-excursion
-                    (re-search-backward (format "‘\\([^‘’]+\\)’") nil t)
+                    (re-search-backward
+                     (substitute-command-keys "‘\\([^‘’]+\\)’") nil t)
                     (help-xref-button 1 'help-face-def f file-name))
                   (princ ".")
                   (terpri)
diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index 8ed9a477399..afd09ca6df5 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -319,7 +319,9 @@ suitable file is found, return nil."
             (when remapped
               (princ "Its keys are remapped to ")
               (princ (if (symbolp remapped)
-                         (format "‘%s’" remapped)
+                         (concat (substitute-command-keys "‘")
+                                 (symbol-name remapped)
+                                 (substitute-command-keys "’"))
                        "an anonymous command"))
               (princ ".\n"))
 
@@ -353,16 +355,18 @@ suitable file is found, return nil."
       (insert "\nThis function has a compiler macro")
       (if (symbolp handler)
           (progn
-            (insert (format " ‘%s’" handler))
+            (insert (format (substitute-command-keys " ‘%s’") handler))
             (save-excursion
-              (re-search-backward (format "‘\\([^‘’]+\\)’") nil t)
+              (re-search-backward (substitute-command-keys "‘\\([^‘’]+\\)’")
+                                  nil t)
               (help-xref-button 1 'help-function handler)))
         ;; FIXME: Obsolete since 24.4.
         (let ((lib (get function 'compiler-macro-file)))
           (when (stringp lib)
-            (insert (format " in ‘%s’" lib))
+            (insert (format (substitute-command-keys " in ‘%s’") lib))
             (save-excursion
-              (re-search-backward (format "‘\\([^‘’]+\\)’") nil t)
+              (re-search-backward (substitute-command-keys "‘\\([^‘’]+\\)’")
+                                  nil t)
               (help-xref-button 1 'help-function-cmacro function lib)))))
       (insert ".\n"))))
 
@@ -417,13 +421,13 @@ suitable file is found, return nil."
                           (get function
                                'derived-mode-parent))))
     (when parent-mode
-      (insert (format "\nParent mode: ‘"))
+      (insert (substitute-command-keys "\nParent mode: ‘"))
       (let ((beg (point)))
         (insert (format "%s" parent-mode))
         (make-text-button beg (point)
                           'type 'help-function
                           'help-args (list parent-mode)))
-      (insert (format "’.\n")))))
+      (insert (substitute-command-keys "’.\n")))))
 
 (defun help-fns--obsolete (function)
   ;; Ignore lambda constructs, keyboard macros, etc.
@@ -438,9 +442,10 @@ suitable file is found, return nil."
               " is obsolete")
       (when (nth 2 obsolete)
         (insert (format " since %s" (nth 2 obsolete))))
-      (insert (cond ((stringp use)
-                     (concat ";\n" (substitute-command-keys use)))
-                    (use (format ";\nuse ‘%s’ instead." use))
+      (insert (cond ((stringp use) (concat ";\n" use))
+                    (use (format (substitute-command-keys
+                                  ";\nuse ‘%s’ instead.")
+                                 use))
                     (t "."))
               "\n"))))
 
@@ -476,7 +481,8 @@ FILE is the file where FUNCTION was probably defined."
                           (format ";\nin Lisp code %s" interactive-only))
                          ((and (symbolp 'interactive-only)
                                (not (eq interactive-only t)))
-                          (format ";\nin Lisp code use ‘%s’ instead."
+                          (format (substitute-command-keys
+                                   ";\nin Lisp code use ‘%s’ instead.")
                                   interactive-only))
                          (t "."))
                    "\n")))))
@@ -545,7 +551,8 @@ FILE is the file where FUNCTION was probably defined."
                  ;; Aliases are Lisp functions, so we need to check
                  ;; aliases before functions.
                  (aliased
-                  (format "an alias for ‘%s’" real-def))
+                  (format (substitute-command-keys "an alias for ‘%s’")
+                          real-def))
                  ((autoloadp def)
                   (format "%s autoloaded %s"
                           (if (commandp def) "an interactive" "an")
@@ -579,22 +586,24 @@ FILE is the file where FUNCTION was probably defined."
       (with-current-buffer standard-output
         (save-excursion
           (save-match-data
-            (when (re-search-backward (format "alias for ‘\\([^‘’]+\\)’")
+            (when (re-search-backward (substitute-command-keys
+                                       "alias for ‘\\([^‘’]+\\)’")
                                       nil t)
               (help-xref-button 1 'help-function real-def)))))
 
       (when file-name
-        (princ (format " in ‘"))
+        (princ (substitute-command-keys " in ‘"))
         ;; We used to add .el to the file name,
         ;; but that's completely wrong when the user used load-file.
         (princ (if (eq file-name 'C-source)
                    "C source code"
                  (help-fns-short-filename file-name)))
-        (princ (format "’"))
+        (princ (substitute-command-keys "’"))
         ;; Make a hyperlink to the library.
         (with-current-buffer standard-output
           (save-excursion
-            (re-search-backward (format "‘\\([^‘’]+\\)’") nil t)
+            (re-search-backward (substitute-command-keys "‘\\([^‘’]+\\)’")
+                                nil t)
             (help-xref-button 1 'help-function-def function file-name))))
       (princ ".")
       (with-current-buffer (help-buffer)
@@ -727,14 +736,17 @@ it is displayed along with the global value."
 
               (if file-name
                   (progn
-                    (princ (format " is a variable defined in ‘"))
+                    (princ (substitute-command-keys
+                            " is a variable defined in ‘"))
                     (princ (if (eq file-name 'C-source)
                                "C source code"
                              (file-name-nondirectory file-name)))
-                    (princ (format "’.\n"))
+                    (princ (substitute-command-keys "’.\n"))
                     (with-current-buffer standard-output
                       (save-excursion
-                        (re-search-backward (format "‘\\([^‘’]+\\)’") nil t)
+                        (re-search-backward (substitute-command-keys
+                                             "‘\\([^‘’]+\\)’")
+                                            nil t)
                         (help-xref-button 1 'help-variable-def
                                           variable file-name)))
                     (if valvoid
@@ -864,7 +876,8 @@ if it is given a local binding.\n")))
               ;; Mention if it's an alias.
               (unless (eq alias variable)
                 (setq extra-line t)
-                (princ (format "  This variable is an alias for ‘%s’.\n"
+                (princ (format (substitute-command-keys
+                                "  This variable is an alias for ‘%s’.\n")
                                alias)))
 
               (when obsolete
@@ -872,9 +885,9 @@ if it is given a local binding.\n")))
                 (princ "  This variable is obsolete")
                 (if (nth 2 obsolete)
                     (princ (format " since %s" (nth 2 obsolete))))
-                (princ (cond ((stringp use)
-                              (concat ";\n  " (substitute-command-keys use)))
-                             (use (format ";\n  use ‘%s’ instead."
+                (princ (cond ((stringp use) (concat ";\n  " use))
+                             (use (format (substitute-command-keys
+                                           ";\n  use ‘%s’ instead.")
                                           (car obsolete)))
                              (t ".")))
                 (terpri))
@@ -905,7 +918,7 @@ if it is given a local binding.\n")))
                               ;; Otherwise, assume it was set directly.
                               (setq file (car file)
                                     dir-file nil)))
-                        (princ (format
+                        (princ (substitute-command-keys
                                 (if dir-file
                                     "by the file\n  ‘"
                                   "for the directory\n  ‘")))
@@ -913,7 +926,7 @@ if it is given a local binding.\n")))
                           (insert-text-button
                            file 'type 'help-dir-local-var-def
                            'help-args (list variable file)))
-                        (princ (format "’.\n"))))
+                        (princ (substitute-command-keys "’.\n"))))
                   (princ "  This variable's value is file-local.\n")))
 
               (when (memq variable ignored-local-variables)
@@ -937,7 +950,8 @@ file-local variable.\n")
                 (princ "if its value\n  satisfies the predicate ")
                 (princ (if (byte-code-function-p safe-var)
                            "which is a byte-compiled expression.\n"
-                         (format "‘%s’.\n" safe-var))))
+                         (format (substitute-command-keys "‘%s’.\n")
+                                 safe-var))))
 
               (if extra-line (terpri))
               (princ "Documentation:\n")
diff --git a/lisp/help.el b/lisp/help.el
index a8991b5f82b..db87d5852b6 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -964,12 +964,14 @@ documentation for the major and minor modes of that buffer."
         (let* ((mode major-mode)
                (file-name (find-lisp-object-file-name mode nil)))
           (when file-name
-            (princ (format " defined in ‘%s’"
-                           (file-name-nondirectory file-name)))
+            (princ (concat (substitute-command-keys " defined in ‘")
+                           (file-name-nondirectory file-name)
+                           (substitute-command-keys "’")))
             ;; Make a hyperlink to the library.
             (with-current-buffer standard-output
               (save-excursion
-                (re-search-backward (format "‘\\([^‘’]+\\)’") nil t)
+                (re-search-backward (substitute-command-keys "‘\\([^‘’]+\\)’")
+                                    nil t)
                 (help-xref-button 1 'help-function-def mode file-name)))))
         (princ ":\n")
         (princ (documentation major-mode)))))
diff --git a/src/doc.c b/src/doc.c
index 9c9bdf3997a..f871ac75b59 100644
--- a/src/doc.c
+++ b/src/doc.c
@@ -927,13 +927,14 @@ Otherwise, return a new string.  */)
           if (NILP (tem))
             {
               name = Fsymbol_name (name);
-              insert1 (CALLN (Fformat, build_string ("\nUses keymap "uLSQM)));
+              insert1 (Fsubstitute_command_keys
+                       (build_string ("\nUses keymap "uLSQM)));
               insert_from_string (name, 0, 0,
                                   SCHARS (name),
                                   SBYTES (name), 1);
-              insert1 (CALLN (Fformat,
-                              (build_string
-                               (uRSQM", which is not currently defined.\n"))));
+              insert1 (Fsubstitute_command_keys
+                       (build_string
+                        (uRSQM", which is not currently defined.\n")));
               if (start[-1] == '<') keymap = Qnil;
             }
           else if (start[-1] == '<')
diff --git a/src/syntax.c b/src/syntax.c
index 30560affdf0..d45936b2b28 100644
--- a/src/syntax.c
+++ b/src/syntax.c
@@ -1333,11 +1333,9 @@ DEFUN ("internal-describe-syntax-value", Finternal_describe_syntax_value,
     insert_string (" (nestable)");
 
   if (prefix)
-    {
-      AUTO_STRING (prefixdoc,
-                   ",\n\t  is a prefix character for `backward-prefix-chars'");
-      insert1 (Fsubstitute_command_keys (prefixdoc));
-    }
+    insert1 (Fsubstitute_command_keys
+             (build_string
+              (",\n\t  is a prefix character for `backward-prefix-chars'")));
 
   return syntax;
 }