[Emacs-diffs] master 2cac2e2 3/5: Quoting fixes in lisp/textmodes

[Paul Eggert]

branch: master
commit 2cac2e2e1067b6f48e96667b9c030cdb5df88af4
Author: Paul Eggert <address@hidden>
Commit: Paul Eggert <address@hidden>

    Quoting fixes in lisp/textmodes
    
    * lisp/textmodes/bibtex.el (bibtex-validate)
    (bibtex-validate-globally, bibtex-search-entries):
    * lisp/textmodes/ispell.el (ispell-command-loop):
    * lisp/textmodes/page-ext.el (search-pages, pages-directory):
    * lisp/textmodes/texinfmt.el (texinfmt-version)
    (texinfo-format-region, texinfo-format-buffer-1):
    * lisp/textmodes/two-column.el (2C-split):
    Respect text quoting style in doc strings and diagnostics.
    * lisp/textmodes/conf-mode.el (conf-mode-map, conf-quote-normal):
    * lisp/textmodes/sgml-mode.el (sgml-specials, sgml-mode):
    Escape apostrophes in doc strings.
---
 lisp/textmodes/bibtex.el     |   39 +++++++++++++++++++++++----------------
 lisp/textmodes/conf-mode.el  |    6 +++---
 lisp/textmodes/ispell.el     |    3 ++-
 lisp/textmodes/page-ext.el   |   14 ++++++++------
 lisp/textmodes/sgml-mode.el  |   10 +++++-----
 lisp/textmodes/texinfmt.el   |   36 +++++++++++++++++-------------------
 lisp/textmodes/two-column.el |    5 ++---
 7 files changed, 60 insertions(+), 53 deletions(-)

diff --git a/lisp/textmodes/bibtex.el b/lisp/textmodes/bibtex.el
index b1232d4..279f657 100644
--- a/lisp/textmodes/bibtex.el
+++ b/lisp/textmodes/bibtex.el
@@ -4232,7 +4232,7 @@ Return t if test was successful, nil otherwise."
                (cond ((not previous))
                      ((member key key-list)
                       (push (cons (bibtex-current-line)
-                                  (format "Duplicate key `%s'" key))
+                                  (format-message "Duplicate key `%s'" key))
                             error-list))
                      ((and bibtex-maintain-sorted-entries
                            (not (bibtex-lessp previous current)))
@@ -4255,8 +4255,9 @@ Return t if test was successful, nil otherwise."
                          (cdr (assoc-string (car key) bibtex-reference-keys)))
                 (bibtex-search-entry (car key))
                 (push (cons (bibtex-current-line)
-                            (format "Duplicate key `%s' in %s" (car key)
-                                    (abbreviate-file-name (buffer-file-name 
buffer))))
+                            (format-message
+                            "Duplicate key `%s' in %s" (car key)
+                            (abbreviate-file-name (buffer-file-name buffer))))
                       error-list))))
 
           (when test-thoroughly
@@ -4306,14 +4307,16 @@ Return t if test was successful, nil otherwise."
                        (if (setq idx (nth 3 field))
                            (bibtex-vec-push alt-expect idx (car field))
                          (push (cons beg-line
-                                     (format "Required field `%s' missing"
-                                             (car field)))
+                                     (format-message
+                                     "Required field `%s' missing"
+                                     (car field)))
                                error-list)))
                      (dotimes (idx num-alt)
                        (unless (aref alt-fields idx)
                          (push (cons beg-line
-                                     (format "Alternative fields `%s' missing"
-                                             (aref alt-expect idx)))
+                                     (format-message
+                                     "Alternative fields `%s' missing"
+                                     (aref alt-expect idx)))
                                error-list))))))))
             (bibtex-progress-message 'done)))))
 
@@ -4327,7 +4330,8 @@ Return t if test was successful, nil otherwise."
             (unless (eq major-mode 'compilation-mode) (compilation-mode))
             (let ((inhibit-read-only t))
               (delete-region (point-min) (point-max))
-              (insert "BibTeX mode command `bibtex-validate'\n"
+              (insert (substitute-command-keys
+                      "BibTeX mode command `bibtex-validate'\n")
                       (if syntax-error
                           "Maybe undetected errors due to syntax errors.  \
 Correct and validate again.\n"
@@ -4362,9 +4366,10 @@ Return t if test was successful, nil otherwise."
               (if (or (and strings (bibtex-string= entry-type "string"))
                       (assoc-string entry-type bibtex-entry-alist t))
                   (if (member key key-list)
-                      (push (format "%s:%d: Duplicate key `%s'\n"
-                                    (buffer-file-name)
-                                    (bibtex-current-line) key)
+                      (push (format-message
+                            "%s:%d: Duplicate key `%s'\n"
+                            (buffer-file-name)
+                            (bibtex-current-line) key)
                             error-list)
                     (push key key-list))))
             (push (cons buffer key-list) buffer-key-list)))))
@@ -4377,9 +4382,10 @@ Return t if test was successful, nil otherwise."
           (dolist (key (cdr (assq buffer buffer-key-list)))
             (when (assoc-string key current-keys)
               (bibtex-search-entry key)
-              (push (format "%s:%d: Duplicate key `%s' in %s\n"
-                            (buffer-file-name) (bibtex-current-line) key
-                            (abbreviate-file-name (buffer-file-name buffer)))
+              (push (format-message
+                    "%s:%d: Duplicate key `%s' in %s\n"
+                    (buffer-file-name) (bibtex-current-line) key
+                    (abbreviate-file-name (buffer-file-name buffer)))
                     error-list))))))
 
     ;; Process error list
@@ -4389,7 +4395,8 @@ Return t if test was successful, nil otherwise."
             (unless (eq major-mode 'compilation-mode) (compilation-mode))
             (let ((inhibit-read-only t))
               (delete-region (point-min) (point-max))
-              (insert "BibTeX mode command `bibtex-validate-globally'\n\n")
+              (insert (substitute-command-keys
+                      "BibTeX mode command `bibtex-validate-globally'\n\n"))
               (dolist (err (sort error-list 'string-lessp)) (insert err))
               (set-buffer-modified-p nil))
             (goto-char (point-min))
@@ -5280,7 +5287,7 @@ where FILE is the BibTeX file of ENTRY."
             (bibtex-display-entries entries)
           (message "No BibTeX entries %smatching `%s'"
                    (if (string= "" field) ""
-                     (format "with field `%s' " field))
+                     (format-message "with field `%s' " field))
                    regexp)))
     entries))
 
diff --git a/lisp/textmodes/conf-mode.el b/lisp/textmodes/conf-mode.el
index b6bea21..267d23f 100644
--- a/lisp/textmodes/conf-mode.el
+++ b/lisp/textmodes/conf-mode.el
@@ -122,7 +122,7 @@ not align (only setting space according to 
`conf-assignment-space')."
     (define-key menu-map [c-s0] '("--"))
     (define-key menu-map [conf-quote-normal]
       '(menu-item "Set quote syntax normal" conf-quote-normal
-                 :help "Set the syntax of \' and \" to punctuation"))
+                 :help "Set the syntax of \\=' and \" to punctuation"))
     (define-key menu-map [conf-align-assignments]
       '(menu-item "Align assignments" conf-align-assignments
                  :help "Align assignments"))
@@ -296,8 +296,8 @@ contents of the region.  Otherwise, operate on the whole 
buffer."
 
 
 (defun conf-quote-normal (arg)
-  "Set the syntax of ' and \" to punctuation.
-With prefix arg, only do it for ' if 1, or only for \" if 2.
+  "Set the syntax of \\=' and \" to punctuation.
+With prefix arg, only do it for \\=' if 1, or only for \" if 2.
 This only affects the current buffer.  Some conf files use quotes
 to delimit strings, while others allow quotes as simple parts of
 the assigned value.  In those files font locking will be wrong,
diff --git a/lisp/textmodes/ispell.el b/lisp/textmodes/ispell.el
index dda983b..3fe21c4 100644
--- a/lisp/textmodes/ispell.el
+++ b/lisp/textmodes/ispell.el
@@ -2297,7 +2297,8 @@ Global `ispell-quit' set to start location to continue 
spell session."
                (insert "\n\t"))
              (insert (car guess) "    ")
              (setq guess (cdr guess)))
-           (insert "\nUse option `i' to accept this spelling and put it in 
your private dictionary.\n")))
+           (insert (substitute-command-keys
+                    "\nUse option `i' to accept this spelling and put it in 
your private dictionary.\n"))))
       (while choices
        (when (> (+ 7 (current-column)
                    (length (car choices))
diff --git a/lisp/textmodes/page-ext.el b/lisp/textmodes/page-ext.el
index d3bd33e..57134e0 100644
--- a/lisp/textmodes/page-ext.el
+++ b/lisp/textmodes/page-ext.el
@@ -395,8 +395,8 @@ Point is left in the body of page."
   "Search for REGEXP, starting from point, and narrow to page it is in."
   (interactive (list
                 (read-string
-                 (format "Search for `%s' (end with RET): "
-                         (or pages-last-search "regexp")))))
+                 (format-message "Search for `%s' (end with RET): "
+                                (or pages-last-search "regexp")))))
   (if (equal regexp "")
       (setq regexp pages-last-search)
     (setq pages-last-search regexp))
@@ -549,16 +549,18 @@ directory for only the accessible portion of the buffer."
           (list nil
                 nil
                 (read-string
-                 (format "Select according to `%s' (end with RET): "
-                         (or pages-directory-previous-regexp "regexp")))))
+                 (format-message
+                 "Select according to `%s' (end with RET): "
+                 (or pages-directory-previous-regexp "regexp")))))
          ((> (prefix-numeric-value current-prefix-arg) 0)
           (list t t nil))
          ((< (prefix-numeric-value current-prefix-arg) 0)
           (list nil
                 t
                 (read-string
-                 (format "Select according to `%s' (end with RET): "
-                         (or pages-directory-previous-regexp "regexp")))))))
+                 (format-message
+                 "Select according to `%s' (end with RET): "
+                 (or pages-directory-previous-regexp "regexp")))))))
 
   (if (equal regexp "")
       (setq regexp pages-directory-previous-regexp)
diff --git a/lisp/textmodes/sgml-mode.el b/lisp/textmodes/sgml-mode.el
index 6a14b52..1d872f0 100644
--- a/lisp/textmodes/sgml-mode.el
+++ b/lisp/textmodes/sgml-mode.el
@@ -106,10 +106,10 @@ This list is used when first loading the `sgml-mode' 
library.
 The supported characters and potential disadvantages are:
 
   ?\\\"        Makes \" in text start a string.
-  ?'   Makes ' in text start a string.
+  ?\\='        Makes \\=' in text start a string.
   ?-   Makes -- in text start a comment.
 
-When only one of ?\\\" or ?' are included, \"'\" or '\"', as can be found in
+When only one of ?\\\" or ?\\=' are included, \"\\='\" or \\='\"\\=', as can 
be found in
 DTDs, start a string.  To partially avoid this problem this also makes these
 self insert as named entities depending on `sgml-quick-keys'.
 
@@ -482,14 +482,14 @@ This function is designed for use in 
`fill-nobreak-predicate'.
 (define-derived-mode sgml-mode text-mode '(sgml-xml-mode "XML" "SGML")
   "Major mode for editing SGML documents.
 Makes > match <.
-Keys <, &, SPC within <>, \", / and ' can be electric depending on
+Keys <, &, SPC within <>, \", / and \\=' can be electric depending on
 `sgml-quick-keys'.
 
 An argument of N to a tag-inserting command means to wrap it around
 the next N words.  In Transient Mark mode, when the mark is active,
 N defaults to -1, which means to wrap it around the current region.
 
-If you like upcased tags, put (setq sgml-transformation-function 'upcase)
+If you like upcased tags, put (setq sgml-transformation-function \\='upcase)
 in your init file.
 
 Use \\[sgml-validate] to validate your document with an SGML parser.
@@ -2066,7 +2066,7 @@ Images in many formats can be inlined with <img 
src=\"URL\">.
 If you mainly create your own documents, `sgml-specials' might be
 interesting.  But note that some HTML 2 browsers can't handle `&apos;'.
 To work around that, do:
-   (eval-after-load \"sgml-mode\" '(aset sgml-char-names ?' nil))
+   (eval-after-load \"sgml-mode\" '(aset sgml-char-names ?\\=' nil))
 
 \\{html-mode-map}"
   (setq-local sgml-display-text html-display-text)
diff --git a/lisp/textmodes/texinfmt.el b/lisp/textmodes/texinfmt.el
index d08daea..37f10a8 100644
--- a/lisp/textmodes/texinfmt.el
+++ b/lisp/textmodes/texinfmt.el
@@ -34,7 +34,7 @@
 If optional argument HERE is non-nil, insert info at point."
   (interactive "P")
   (let ((version-string
-         (format "Version of `texinfmt.el': %s" texinfmt-version)))
+         (format-message "Version of `texinfmt.el': %s" texinfmt-version)))
     (if here
         (insert version-string)
       (if (called-interactively-p 'interactive)
@@ -330,25 +330,24 @@ converted to Info is stored in a temporary buffer."
           (let ((arg (texinfo-parse-arg-discard)))
             (insert " "
               texinfo-region-buffer-name
-              " buffer for:  `")
+              (format-message " buffer for:  `"))
             (insert (file-name-nondirectory (expand-file-name arg)))
-            (insert "',        -*-Text-*-\n")))
+            (insert (format-message "',        -*-Text-*-\n"))))
       ;; Else no address@hidden' line
       (insert " "
               texinfo-region-buffer-name
               " buffer                       -*-Text-*-\n"))
-    (insert "produced by `texinfo-format-region'\n"
+    (insert (format-message "produced by `texinfo-format-region'\n")
             "from a region in: "
             (if (buffer-file-name input-buffer)
-                  (concat "`"
-                          (file-name-sans-versions
-                           (file-name-nondirectory
-                            (buffer-file-name input-buffer)))
-                          "'")
-                (concat "buffer `" (buffer-name input-buffer) "'"))
-              "\nusing `texinfmt.el' version "
-              texinfmt-version
-              ".\n\n")
+               (format-message "`%s'"
+                       (file-name-sans-versions
+                        (file-name-nondirectory
+                         (buffer-file-name input-buffer))))
+             (format-message "buffer `%s'" (buffer-name input-buffer)))
+            (format-message "\nusing `texinfmt.el' version ")
+            texinfmt-version
+            ".\n\n")
 
     ;; Now convert for real.
     (goto-char (point-min))
@@ -479,19 +478,18 @@ if large.  You can use `Info-split' to do this manually."
     ;; Insert info about how this file was made.
     (insert "Info file: "
             texinfo-format-filename ",    -*-Text-*-\n"
-            "produced by `texinfo-format-buffer'\n"
+            (format-message "produced by `texinfo-format-buffer'\n")
             ;; Date string removed so that regression testing is easier.
             ;; "on "
             ;; (insert (format-time-string "%e %b %Y")) " "
             "from file"
             (if (buffer-file-name input-buffer)
-                (concat " `"
+                (format-message " `%s'"
                         (file-name-sans-versions
                          (file-name-nondirectory
-                          (buffer-file-name input-buffer)))
-                        "'")
-              (concat "buffer `" (buffer-name input-buffer) "'"))
-            "\nusing `texinfmt.el' version "
+                          (buffer-file-name input-buffer))))
+              (format-message "buffer `%s'" (buffer-name input-buffer)))
+            (format-message "\nusing `texinfmt.el' version ")
             texinfmt-version
             ".\n\n")
     ;; Return data for indices.
diff --git a/lisp/textmodes/two-column.el b/lisp/textmodes/two-column.el
index ea6b525..5e318b5 100644
--- a/lisp/textmodes/two-column.el
+++ b/lisp/textmodes/two-column.el
@@ -373,9 +373,8 @@ First column's text    sSs  Second column's text
 \(See  \\[describe-mode] .)"
   (interactive "*p")
   (and (2C-other)
-       (if (y-or-n-p (concat "Overwrite associated buffer `"
-                            (buffer-name (2C-other))
-                            "'? "))
+       (if (y-or-n-p (format-message "Overwrite associated buffer ‘%s’? "
+                                    (buffer-name (2C-other))))
           (with-current-buffer (2C-other)
             (erase-buffer))
         (signal 'quit nil)))