Skip to content

Commit

Permalink
Quoting fixes in doc strings and diagnostics
Browse files Browse the repository at this point in the history
* 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.
  • Loading branch information
eggert committed Feb 4, 2016
1 parent 2c0dc9f commit 91557f5
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 24 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTE
Expand Up @@ -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
Expand Down
18 changes: 9 additions & 9 deletions admin/release-process
Expand Up @@ -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
Expand All @@ -23,19 +23,19 @@ 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
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.

Expand All @@ -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
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion doc/misc/tramp.texi
Expand Up @@ -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
Expand Down
8 changes: 5 additions & 3 deletions lisp/emacs-lisp/bytecomp.el
Expand Up @@ -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
Expand Down Expand Up @@ -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))
Expand Down Expand Up @@ -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)))

Expand Down
2 changes: 1 addition & 1 deletion lisp/emacs-lisp/map.el
Expand Up @@ -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."
Expand Down
6 changes: 3 additions & 3 deletions lisp/emacs-lisp/pcase.el
Expand Up @@ -111,20 +111,20 @@
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.
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
Expand Down
4 changes: 2 additions & 2 deletions lisp/gnus/mml-smime.el
Expand Up @@ -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))

Expand All @@ -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))

Expand Down
8 changes: 4 additions & 4 deletions lisp/xwidget.el
Expand Up @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand All @@ -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)
Expand Down

0 comments on commit 91557f5

Please sign in to comment.