[Emacs-diffs] master 001c7dd: Text quoting fixes in cedet, emulation, emacs-lisp

[Paul Eggert]

branch: master
commit 001c7dd928238a196dff4166ad29141116ef6d1c
Author: Paul Eggert <address@hidden>
Commit: Paul Eggert <address@hidden>

    Text quoting fixes in cedet, emulation, emacs-lisp
    
    * lisp/cedet/ede.el (ede-check-project-directory):
    * lisp/cedet/semantic/analyze/debug.el:
    (semantic-analyzer-debug-insert-include-summary):
    * lisp/cedet/semantic/bovine/c.el (semantic-c-describe-environment):
    * lisp/cedet/semantic/decorate/include.el:
    (semantic-decoration-unknown-include-describe)
    (semantic-decoration-all-include-summary):
    * lisp/cedet/semantic/ia.el (semantic-ia-fast-jump):
    * lisp/emulation/edt.el (edt-load-keys):
    * lisp/emulation/viper-cmd.el:
    (viper-display-current-destructive-command)
    (viper-query-replace, viper-brac-function):
    * lisp/emulation/viper-ex.el (viper-get-ex-token, ex-compile):
    * lisp/emulation/viper-macs.el (viper-unrecord-kbd-macro):
    Respect text quoting style in doc string or diagnostic.
    * lisp/cedet/mode-local.el (describe-mode-local-overload):
    Use format-message to avoid overtranslating quotes.
    * lisp/emacs-lisp/checkdoc.el (checkdoc-in-sample-code-p):
    Escape an apostrophe in a docstring.
    * lisp/emacs-lisp/warnings.el (lwarn): Fix doc string.
---
 lisp/cedet/ede.el                       |    9 +++++----
 lisp/cedet/mode-local.el                |   11 +++++------
 lisp/cedet/semantic/analyze/debug.el    |    9 +++++----
 lisp/cedet/semantic/bovine/c.el         |    9 ++++++---
 lisp/cedet/semantic/decorate/include.el |   15 +++++++++------
 lisp/cedet/semantic/ia.el               |   10 ++++++----
 lisp/emacs-lisp/checkdoc.el             |    2 +-
 lisp/emacs-lisp/warnings.el             |    4 ++--
 lisp/emulation/edt.el                   |    3 ++-
 lisp/emulation/viper-cmd.el             |   13 +++++++------
 lisp/emulation/viper-ex.el              |    4 ++--
 lisp/emulation/viper-macs.el            |   12 ++++++------
 12 files changed, 56 insertions(+), 45 deletions(-)

diff --git a/lisp/cedet/ede.el b/lisp/cedet/ede.el
index 3b06cf7..7d99b17 100644
--- a/lisp/cedet/ede.el
+++ b/lisp/cedet/ede.el
@@ -512,7 +512,7 @@ Sets buffer local variables for EDE."
        (when projdetect
          ;; No project was loaded, but we have a project description
          ;; object.  This means that we try to load it.
-         ;; 
+         ;;
          ;; Before loading, we need to check if it is a safe
          ;; project to load before requesting it to be loaded.
 
@@ -728,9 +728,10 @@ Return nil if DIR should not be in 
`ede-project-directories'."
       (when (listp ede-project-directories)
        (or (member dir ede-project-directories)
            (when (funcall ede-check-project-query-fcn
-                          (format "`%s' is not listed in 
`ede-project-directories'.
+                          (format-message
+                           "`%s' is not listed in `ede-project-directories'.
 Add it to the list of allowed project directories? "
-                                  dir))
+                           dir))
              (push dir ede-project-directories)
              ;; If possible, save `ede-project-directories'.
              (if (or custom-file user-init-file)
@@ -799,7 +800,7 @@ Optional argument NAME is the name to give this project."
                                              "Unknown file name specifier %S"
                                              pf)))
                                :targets nil)
-                
+
                 ))
         (inits (oref obj initializers)))
     ;; Force the name to match for new objects.
diff --git a/lisp/cedet/mode-local.el b/lisp/cedet/mode-local.el
index 9ee8750..287e655 100644
--- a/lisp/cedet/mode-local.el
+++ b/lisp/cedet/mode-local.el
@@ -643,15 +643,14 @@ SYMBOL is a function that can be overridden."
                     (with-current-buffer describe-function-orig-buffer
                       (fetch-overload symbol)))))
       (insert (overload-docstring-extension symbol) "\n\n")
-      (insert (substitute-command-keys (format "default function: `%s'\n" 
default)))
+      (insert (format-message "default function: `%s'\n" default))
       (when (and (boundp 'describe-function-orig-buffer) ;; added in Emacs 25
                 describe-function-orig-buffer)
        (if override
-           (insert (substitute-command-keys
-                    (format "\noverride in buffer '%s': `%s'\n"
-                            describe-function-orig-buffer override)))
-         (insert (substitute-command-keys (format "\nno override in buffer 
'%s'\n"
-                                                  
describe-function-orig-buffer)))))
+           (insert (format-message "\noverride in buffer '%s': `%s'\n"
+                                   describe-function-orig-buffer override))
+         (insert (format-message "\nno override in buffer '%s'\n"
+                                 describe-function-orig-buffer))))
       )))
 
 (add-hook 'help-fns-describe-function-functions 'describe-mode-local-overload)
diff --git a/lisp/cedet/semantic/analyze/debug.el 
b/lisp/cedet/semantic/analyze/debug.el
index d0ab7c82..76a6cc2 100644
--- a/lisp/cedet/semantic/analyze/debug.el
+++ b/lisp/cedet/semantic/analyze/debug.el
@@ -405,7 +405,8 @@ or implementing a version specific to ")
 
     (princ "\n\nInclude Path Summary:")
     (when edeobj
-       (princ "\n\nThis file's project include search is handled by the EDE 
object:\n")
+       (princ (substitute-command-keys
+               "\n\nThis file's project include search is handled by the EDE 
object:\n"))
        (princ "  Buffer Target:  ")
        (princ (object-print edeobj))
        (princ "\n")
@@ -463,12 +464,12 @@ or implementing a version specific to ")
 
          (princ "\nYou can fix the include path for ")
          (princ (symbol-name (oref table major-mode)))
-         (princ " by using this function:
+         (princ (substitute-command-keys " by using this function:
 
-M-x semantic-customize-system-include-path RET
+\\[semantic-customize-system-include-path]
 
 which customizes the mode specific variable for the mode-local
-variable `semantic-dependency-system-include-path'.")
+variable `semantic-dependency-system-include-path'."))
          )
 
       (princ "\n No unknown includes.\n"))
diff --git a/lisp/cedet/semantic/bovine/c.el b/lisp/cedet/semantic/bovine/c.el
index 6639f17..1c25c7b 100644
--- a/lisp/cedet/semantic/bovine/c.el
+++ b/lisp/cedet/semantic/bovine/c.el
@@ -2176,7 +2176,8 @@ actually in their parent which is not accessible.")
 
       (princ "\n\nInclude Path Summary:\n")
       (when (and (boundp 'ede-object) ede-object)
-       (princ "\n  This file's project include is handled by:\n")
+       (princ (substitute-command-keys
+               "\n  This file's project include is handled by:\n"))
        (let ((objs (if (listp ede-object)
                        ede-object
                      (list ede-object))))
@@ -2194,14 +2195,16 @@ actually in their parent which is not accessible.")
        )
 
       (when semantic-dependency-include-path
-       (princ "\n  This file's generic include path is:\n")
+       (princ (substitute-command-keys
+               "\n  This file's generic include path is:\n"))
        (dolist (dir semantic-dependency-include-path)
          (princ "    ")
          (princ dir)
          (princ "\n")))
 
       (when semantic-dependency-system-include-path
-       (princ "\n  This file's system include path is:\n")
+       (princ (substitute-command-keys
+               "\n  This file's system include path is:\n"))
        (dolist (dir semantic-dependency-system-include-path)
          (princ "    ")
          (princ dir)
diff --git a/lisp/cedet/semantic/decorate/include.el 
b/lisp/cedet/semantic/decorate/include.el
index 7bfca77..962dc49 100644
--- a/lisp/cedet/semantic/decorate/include.el
+++ b/lisp/cedet/semantic/decorate/include.el
@@ -503,7 +503,8 @@ Argument EVENT is the mouse clicked event."
       (princ "Include File: ")
       (princ (semantic-format-tag-name tag nil t))
       (princ "\n\n")
-      (princ "This header file has been marked \"Unknown\".
+      (princ (substitute-command-keys "\
+This header file has been marked \"Unknown\".
 This means that Semantic has not been able to locate this file on disk.
 
 When Semantic cannot find an include file, this means that the
@@ -521,9 +522,9 @@ M-x semantic-add-system-include RET /path/to/includes RET
 
 or, in your .emacs file do:
 
-  (semantic-add-system-include \"/path/to/include\" '")
+  (semantic-add-system-include \"/path/to/include\" \\='"))
       (princ (symbol-name mm))
-      (princ ")
+      (princ (substitute-command-keys ")
 
 to add the path to Semantic's search.
 
@@ -531,7 +532,7 @@ If this is an include file that belongs to your project, 
then you may
 need to update `semanticdb-project-roots' or better yet, use `ede'
 to manage your project.  See the ede manual for projects that will
 wrap existing project code for Semantic's benefit.
-")
+"))
 
       (when (or (eq mm 'c++-mode) (eq mm 'c-mode))
        (princ "
@@ -745,7 +746,8 @@ Argument EVENT describes the event that caused this 
function to be called."
       (when (and (boundp 'ede-object)
                 (boundp 'ede-object-project)
                 ede-object)
-       (princ "  This file's project include search is handled by the EDE 
object:\n")
+       (princ (substitute-command-keys
+               "  This file's project include search is handled by the EDE 
object:\n"))
        (princ "    Buffer Target:  ")
        (princ (object-print ede-object))
        (princ "\n")
@@ -769,7 +771,8 @@ Argument EVENT describes the event that caused this 
function to be called."
              (princ "\n"))
            )))
 
-      (princ "\n  This file's system include path is:\n")
+      (princ (substitute-command-keys
+             "\n  This file's system include path is:\n"))
       (dolist (dir semantic-dependency-system-include-path)
        (princ "    ")
        (princ dir)
diff --git a/lisp/cedet/semantic/ia.el b/lisp/cedet/semantic/ia.el
index 2216fa9..27e6db1 100644
--- a/lisp/cedet/semantic/ia.el
+++ b/lisp/cedet/semantic/ia.el
@@ -364,15 +364,17 @@ origin of the code at point."
       (let ((secondclass (car (reverse (oref ctxt prefixtypes)))))
        (cond
         ((and (semantic-tag-with-position-p secondclass)
-              (y-or-n-p (format "Could not find `%s'.  Jump to %s? "
-                                first (semantic-tag-name secondclass))))
+              (y-or-n-p (format-message
+                         "Could not find `%s'.  Jump to %s? "
+                         first (semantic-tag-name secondclass))))
          (semantic-ia--fast-jump-helper secondclass)
          )
         ;; If we missed out on the class of the second item, then
         ;; just visit SECOND.
         ((and (semantic-tag-p second)
-              (y-or-n-p (format "Could not find `%s'.  Jump to %s? "
-                                first (semantic-tag-name second))))
+              (y-or-n-p (format-message
+                         "Could not find `%s'.  Jump to %s? "
+                         first (semantic-tag-name second))))
          (semantic-ia--fast-jump-helper second)
          ))))
 
diff --git a/lisp/emacs-lisp/checkdoc.el b/lisp/emacs-lisp/checkdoc.el
index 8a845f9..b2c8119 100644
--- a/lisp/emacs-lisp/checkdoc.el
+++ b/lisp/emacs-lisp/checkdoc.el
@@ -1954,7 +1954,7 @@ from the comment."
   "Return non-nil if the current point is in a code fragment.
 A code fragment is identified by an open parenthesis followed by a
 symbol which is a valid function or a word in all CAPS, or a parenthesis
-that is quoted with the ' character.  Only the region from START to LIMIT
+that is quoted with the \\=' character.  Only the region from START to LIMIT
 is allowed while searching for the bounding parenthesis."
   (save-match-data
     (save-restriction
diff --git a/lisp/emacs-lisp/warnings.el b/lisp/emacs-lisp/warnings.el
index d729a9a..b88af1d 100644
--- a/lisp/emacs-lisp/warnings.el
+++ b/lisp/emacs-lisp/warnings.el
@@ -314,7 +314,7 @@ See also `warning-series', `warning-prefix-function' and
 ;; Any keymap that is defined will do.
 ;;;###autoload
 (defun lwarn (type level message &rest args)
-  "Display a warning message made from (format MESSAGE ARGS...).
+  "Display a warning message made from (format-message MESSAGE ARGS...).
 \\<special-mode-map>
 Aside from generating the message with `format-message',
 this is equivalent to `display-warning'.
@@ -336,7 +336,7 @@ LEVEL should be either :debug, :warning, :error, or 
:emergency
 
 ;;;###autoload
 (defun warn (message &rest args)
-  "Display a warning message made from (format MESSAGE ARGS...).
+  "Display a warning message made from (format-message MESSAGE ARGS...).
 Aside from generating the message with `format-message',
 this is equivalent to `display-warning', using
 `emacs' as the type and `:warning' as the level."
diff --git a/lisp/emulation/edt.el b/lisp/emulation/edt.el
index 2c9e579..9bd1627 100644
--- a/lisp/emulation/edt.el
+++ b/lisp/emulation/edt.el
@@ -1984,7 +1984,8 @@ created."
                  (if (edt-y-or-n-p "Do you want to run it now? ")
                      (load-file path)
                    (error "EDT Emulation not configured")))
-             (insert "Nope, I can't seem to find it.  :-(\n\n")
+             (insert (substitute-command-keys
+                     "Nope, I can't seem to find it.  :-(\n\n"))
              (sit-for 20)
              (error "EDT Emulation not configured"))))))
 
diff --git a/lisp/emulation/viper-cmd.el b/lisp/emulation/viper-cmd.el
index 4fe948a..8b3f6b4 100644
--- a/lisp/emulation/viper-cmd.el
+++ b/lisp/emulation/viper-cmd.el
@@ -1751,8 +1751,8 @@ invokes the command before that, etc."
 
     (setq this-command 'viper-display-current-destructive-command)
 
-    (message " `.' runs  %s%s"
-            (concat "`" (viper-array-to-string keys) "'")
+    (message " `.' runs  `%s'%s"
+            (viper-array-to-string keys)
             (viper-abbreviate-string
              (if (featurep 'xemacs)
                  (replace-in-string ; xemacs
@@ -1763,7 +1763,8 @@ invokes the command before that, etc."
                text ; emacs
                )
              max-text-len
-             "  inserting  `" "'" "    ......."))
+             (format-message "  inserting  `") (format-message "'")
+             "    ......."))
     ))
 
 
@@ -4341,7 +4342,7 @@ and regexp replace."
          (query-replace-regexp
           str
           (viper-read-string-with-history
-           (format "Query replace regexp `%s' with: " str)
+           (format-message "Query replace regexp `%s' with: " str)
            nil  ; no initial
            'viper-replace1-history
            (car viper-replace1-history) ; default
@@ -4349,7 +4350,7 @@ and regexp replace."
        (query-replace
         str
         (viper-read-string-with-history
-         (format "Query replace `%s' with: " str)
+         (format-message "Query replace `%s' with: " str)
          nil  ; no initial
          'viper-replace1-history
          (car viper-replace1-history) ; default
@@ -4643,7 +4644,7 @@ One can use \\=`\\=` and \\='\\=' to temporarily jump 1 
step back."
                                     reg (buffer-name buf) line-no))
                     (princ (format "Here is some text around %c:\n\n %s"
                                     reg text)))
-                (princ (format viper-EmptyTextmarker reg))))
+                (princ (format-message viper-EmptyTextmarker reg))))
             ))
          (t (error viper-InvalidTextmarker reg)))))
 
diff --git a/lisp/emulation/viper-ex.el b/lisp/emulation/viper-ex.el
index e6bcf8f..fb2c179 100644
--- a/lisp/emulation/viper-ex.el
+++ b/lisp/emulation/viper-ex.el
@@ -491,7 +491,7 @@ reversed."
             (forward-char 1)
             (cond ((looking-at "'") (setq ex-token nil))
                   ((looking-at "[a-z]") (setq ex-token (following-char)))
-                  (t (error "Marks are ' and a-z")))
+                  (t (error "%s" "Marks are ' and a-z")))
             (forward-char 1))
            ((looking-at "\n")
             (setq ex-token-type 'end-mark)
@@ -2190,7 +2190,7 @@ Please contact your system administrator. "
 (defun ex-compile ()
   "Reads args from the command line, then runs make with the args.
 If no args are given, then it runs the last compile command.
-Type 'mak ' (including the space) to run make with no args."
+Type `mak ' (including the space) to run make with no args."
   (let (args)
     (with-current-buffer (setq viper-ex-work-buf
                                (get-buffer-create viper-ex-work-buf-name))
diff --git a/lisp/emulation/viper-macs.el b/lisp/emulation/viper-macs.el
index e856832..4b33b42 100644
--- a/lisp/emulation/viper-macs.el
+++ b/lisp/emulation/viper-macs.el
@@ -529,9 +529,9 @@ mistakes in macro names to be passed to this function is to 
use
     (cond ((and (cdr buf-mapping)
                (or (and (not (cdr mode-mapping)) (not (cdr global-mapping)))
                    (y-or-n-p
-                    (format "Unmap %S for `%s' only? "
-                            (viper-display-macro macro-name)
-                            (buffer-name)))))
+                    (format-message "Unmap %S for `%s' only? "
+                                    (viper-display-macro macro-name)
+                                    (buffer-name)))))
           (setq macro-pair buf-mapping)
           (message "%S is unmapped for %s in `%s'"
                    (viper-display-macro macro-name)
@@ -539,9 +539,9 @@ mistakes in macro names to be passed to this function is to 
use
          ((and (cdr mode-mapping)
                (or (not (cdr global-mapping))
                    (y-or-n-p
-                    (format "Unmap %S for the major mode `%S' only? "
-                            (viper-display-macro macro-name)
-                            major-mode))))
+                    (format-message "Unmap %S for the major mode `%S' only? "
+                                    (viper-display-macro macro-name)
+                                    major-mode))))
           (setq macro-pair mode-mapping)
           (message "%S is unmapped for %s in %S"
                    (viper-display-macro macro-name) state-name major-mode))