emacs-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Emacs-diffs] emacs-25 91557f5: Quoting fixes in doc strings and diagnos


From: Paul Eggert
Subject: [Emacs-diffs] emacs-25 91557f5: Quoting fixes in doc strings and diagnostics
Date: Thu, 04 Feb 2016 01:20:22 +0000

branch: emacs-25
commit 91557f5e2decb723544a703d01f11879be07fd04
Author: Paul Eggert <address@hidden>
Commit: Paul Eggert <address@hidden>

    Quoting fixes in doc strings and diagnostics
    
    * lisp/emacs-lisp/bytecomp.el (byte-compile-setq, byte-compile-funcall):
    * lisp/gnus/mml-smime.el (mml-smime-get-dns-cert)
    (mml-smime-get-ldap-cert):
    Follow user style preference when quoting diagnostics.
---
 CONTRIBUTE                  |    2 +-
 admin/release-process       |   18 +++++++++---------
 doc/misc/tramp.texi         |    2 +-
 lisp/emacs-lisp/bytecomp.el |    8 +++++---
 lisp/emacs-lisp/map.el      |    2 +-
 lisp/emacs-lisp/pcase.el    |    6 +++---
 lisp/gnus/mml-smime.el      |    4 ++--
 lisp/xwidget.el             |    8 ++++----
 8 files changed, 26 insertions(+), 24 deletions(-)

diff --git a/CONTRIBUTE b/CONTRIBUTE
index 3ccaff3..f1f3a3f 100644
--- a/CONTRIBUTE
+++ b/CONTRIBUTE
@@ -252,7 +252,7 @@ Emacs uses ERT, Emacs Lisp Regression Testing, for testing. 
 See (info
 for more information on writing and running tests.
 
 If your test lasts longer than some few seconds, mark it in its
-`ert-deftest' definition with ":tags '(:expensive-test)".
+'ert-deftest' definition with ":tags '(:expensive-test)".
 
 To run tests on the entire Emacs tree, run "make check" from the
 top-level directory.  Most tests are in the directory
diff --git a/admin/release-process b/admin/release-process
index 5a95fa2..2f23dac 100644
--- a/admin/release-process
+++ b/admin/release-process
@@ -7,7 +7,7 @@ Each release cycle will be split into two periods.
 ** Phase one: development
 
 The first phase of the release schedule is the "heads-down" working
-period for new features, on the `master' branch and several feature
+period for new features, on the 'master' branch and several feature
 branches.
 
 ** Phase two: fixing and stabilizing the release branch
@@ -23,11 +23,11 @@ new features.
 
 At the beginning of this phase, a release branch called "emacs-NN"
 ("NN" represents the major version number of the new Emacs release)
-will be cut from `master'.  When that happens, the version number on
-`master' should be incremented; use admin/admin.el's `set-version'
+will be cut from 'master'.  When that happens, the version number on
+'master' should be incremented; use admin/admin.el's 'set-version'
 command to do that, then commit the changes it made and push to
-`master'.  For major releases, also update the value of
-`customize-changed-options-previous-release'.
+'master'.  For major releases, also update the value of
+'customize-changed-options-previous-release'.
 
 The 2 main manuals, the User Manual and the Emacs Lisp Manual, need to
 be proofread, preferably by at least 2 different persons, and any
@@ -35,7 +35,7 @@ uncovered problems fixed.  This is a lot of work, so it is 
advisable
 to divide the job between several people (see the checklist near the
 end of this file).
 
-In parallel to this phase, `master' can receive new features, to be
+In parallel to this phase, 'master' can receive new features, to be
 released in the next release cycle.  From time to time, the master
 branches merges bugfix commits from the "emacs-NN" branch.
 
@@ -55,7 +55,7 @@ Change "block" to "unblock" to unblock the bug.
 * TO BE DONE SHORTLY BEFORE RELEASE
 
 ** Make sure the Copyright date reflects the current year in the source
-files.  See `admin/notes/years' for information about maintaining
+files.  See 'admin/notes/years' for information about maintaining
 copyright years for GNU Emacs.
 
 ** Make sure the necessary sources and scripts for any generated files
@@ -344,10 +344,10 @@ windows.texi
 
 * OTHER INFORMATION
 
-For Emacs's versioning scheme, see `admin/notes/versioning'.
+For Emacs's versioning scheme, see 'admin/notes/versioning'.
 
 For instructions to create pretest or release tarballs, announcements,
-etc., see `admin/make-tarball.txt'.
+etc., see 'admin/make-tarball.txt'.
 
 
 Local variables:
diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi
index 7bf2e53..9320a6e 100644
--- a/doc/misc/tramp.texi
+++ b/doc/misc/tramp.texi
@@ -2036,7 +2036,7 @@ When
 @end ifset
 is @code{nil} (the default), such problems do not occur.
 
-To ``turns off'' the backup feature for @value{tramp} files and stop
+To ``turn off'' the backup feature for @value{tramp} files and stop
 @value{tramp} from saving to the backup directory, use this:
 
 @ifset emacs
diff --git a/lisp/emacs-lisp/bytecomp.el b/lisp/emacs-lisp/bytecomp.el
index 4ee8b37..1526e2f 100644
--- a/lisp/emacs-lisp/bytecomp.el
+++ b/lisp/emacs-lisp/bytecomp.el
@@ -1169,7 +1169,7 @@ Each function's symbol gets added to 
`byte-compile-noruntime-functions'."
     (display-warning 'bytecomp string level byte-compile-log-buffer)))
 
 (defun byte-compile-warn (format &rest args)
-  "Issue a byte compiler warning; use (format FORMAT ARGS...) for message."
+  "Issue a byte compiler warning; use (format-message FORMAT ARGS...) for 
message."
   (setq format (apply #'format-message format args))
   (if byte-compile-error-on-warn
       (error "%s" format)              ; byte-compile-file catches and logs it
@@ -3746,7 +3746,8 @@ discarding."
     (if (= (logand len 1) 1)
         (progn
           (byte-compile-log-warning
-           (format "missing value for `%S' at end of setq" (car (last args)))
+           (format-message
+            "missing value for `%S' at end of setq" (car (last args)))
            nil :error)
           (byte-compile-form
            `(signal 'wrong-number-of-arguments '(setq ,len))
@@ -4017,7 +4018,8 @@ that suppresses all warnings during execution of BODY."
       (progn
         (mapc 'byte-compile-form (cdr form))
         (byte-compile-out 'byte-call (length (cdr (cdr form)))))
-    (byte-compile-log-warning "`funcall' called with no arguments" nil :error)
+    (byte-compile-log-warning
+     (format-message "`funcall' called with no arguments") nil :error)
     (byte-compile-form '(signal 'wrong-number-of-arguments '(funcall 0))
                        byte-compile--for-effect)))
 
diff --git a/lisp/emacs-lisp/map.el b/lisp/emacs-lisp/map.el
index 8786115..ec8d3d7 100644
--- a/lisp/emacs-lisp/map.el
+++ b/lisp/emacs-lisp/map.el
@@ -55,7 +55,7 @@ found in the map, the corresponding PAT doesn't match the 
value
 associated to the KEY.
 
 Each element can also be a SYMBOL, which is an abbreviation of a (KEY
-PAT) tuple of the form ('SYMBOL SYMBOL).
+PAT) tuple of the form (\\='SYMBOL SYMBOL).
 
 Keys in ARGS not found in the map are ignored, and the match doesn't
 fail."
diff --git a/lisp/emacs-lisp/pcase.el b/lisp/emacs-lisp/pcase.el
index 7be997e..7e164c0 100644
--- a/lisp/emacs-lisp/pcase.el
+++ b/lisp/emacs-lisp/pcase.el
@@ -111,7 +111,7 @@
 CASES is a list of elements of the form (PATTERN CODE...).
 
 A structural PATTERN describes a template that identifies a class
-of values.  For example, the pattern `(,foo ,bar) matches any
+of values.  For example, the pattern \\=`(,foo ,bar) matches any
 two element list, binding its elements to symbols named `foo' and
 `bar' -- in much the same way that `cl-destructuring-bind' would.
 
@@ -119,12 +119,12 @@ A significant difference from `cl-destructuring-bind' is 
that, if
 a pattern match fails, the next case is tried until either a
 successful match is found or there are no more cases.
 
-Another difference is that pattern elements may be backquoted,
+Another difference is that pattern elements may be quoted,
 meaning they must match exactly: The pattern \\='(foo bar)
 matches only against two element lists containing the symbols
 `foo' and `bar' in that order.  (As a short-hand, atoms always
 match themselves, such as numbers or strings, and need not be
-quoted).
+quoted.)
 
 Lastly, a pattern can be logical, such as (pred numberp), that
 matches any number-like element; or the symbol `_', that matches
diff --git a/lisp/gnus/mml-smime.el b/lisp/gnus/mml-smime.el
index 2d8f25c..248e636 100644
--- a/lisp/gnus/mml-smime.el
+++ b/lisp/gnus/mml-smime.el
@@ -216,7 +216,7 @@ Whether the passphrase is cached at all is controlled by
                                        "")))))
          (if (setq cert (smime-cert-by-dns who))
              (setq result (list 'certfile (buffer-name cert)))
-           (setq bad (format "`%s' not found. " who))))
+           (setq bad (gnus-format-message "`%s' not found. " who))))
       (quit))
     result))
 
@@ -235,7 +235,7 @@ Whether the passphrase is cached at all is controlled by
                                        "")))))
          (if (setq cert (smime-cert-by-ldap who))
              (setq result (list 'certfile (buffer-name cert)))
-           (setq bad (format "`%s' not found. " who))))
+           (setq bad (gnus-format-message "`%s' not found. " who))))
       (quit))
     result))
 
diff --git a/lisp/xwidget.el b/lisp/xwidget.el
index 8c8e679..cd8ec0e 100644
--- a/lisp/xwidget.el
+++ b/lisp/xwidget.el
@@ -144,7 +144,7 @@ Interactively, URL defaults to the string looking like a 
url around point."
 (defun xwidget-webkit-scroll-up ()
   "Scroll webkit up.
 Depending on the value of `xwidget-webkit-scroll-behavior',
-this scrolls in 'native' fashion, or like `image-mode' would."
+this scrolls in `native' fashion, or like `image-mode' would."
   (interactive)
   (if (eq xwidget-webkit-scroll-behavior 'native)
       (xwidget-set-adjustment (xwidget-webkit-last-session) 'vertical t 50)
@@ -153,7 +153,7 @@ this scrolls in 'native' fashion, or like `image-mode' 
would."
 (defun xwidget-webkit-scroll-down ()
   "Scroll webkit down.
 Depending on the value of `xwidget-webkit-scroll-behavior',
-this scrolls in 'native' fashion, or like `image-mode' would."
+this scrolls in `native' fashion, or like `image-mode' would."
   (interactive)
   (if (eq xwidget-webkit-scroll-behavior 'native)
       (xwidget-set-adjustment (xwidget-webkit-last-session) 'vertical t -50)
@@ -162,7 +162,7 @@ this scrolls in 'native' fashion, or like `image-mode' 
would."
 (defun xwidget-webkit-scroll-forward ()
   "Scroll webkit forwards.
 Depending on the value of `xwidget-webkit-scroll-behavior',
-this scrolls in 'native' fashion, or like `image-mode' would."
+this scrolls in `native' fashion, or like `image-mode' would."
   (interactive)
   (if (eq xwidget-webkit-scroll-behavior 'native)
       (xwidget-set-adjustment (xwidget-webkit-last-session) 'horizontal t 50)
@@ -171,7 +171,7 @@ this scrolls in 'native' fashion, or like `image-mode' 
would."
 (defun xwidget-webkit-scroll-backward ()
   "Scroll webkit backwards.
 Depending on the value of `xwidget-webkit-scroll-behavior',
-this scrolls in 'native' fashion, or like `image-mode' would."
+this scrolls in `native' fashion, or like `image-mode' would."
   (interactive)
   (if (eq xwidget-webkit-scroll-behavior 'native)
       (xwidget-set-adjustment (xwidget-webkit-last-session) 'horizontal t -50)



reply via email to

[Prev in Thread] Current Thread [Next in Thread]