From ac16149ba470ae8a625d42a61adbb6e84254c675 Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Tue, 17 Nov 2015 15:28:50 -0800 Subject: [PATCH] =?utf8?q?Fix=20docstring=20quoting=20problems=20with=20?= =?utf8?q?=E2=80=98=20'=E2=80=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Problem reported by Artur Malabarba in: http://lists.gnu.org/archive/html/emacs-devel/2015-11/msg01513.html Most of these fixes are to documentation; many involve fixing longstanding quoting glitches that are independent of the recent substitute-command-keys changes. The changes to code are: * lisp/cedet/mode-local.el (mode-local-augment-function-help) (describe-mode-local-overload): Substitute docstrings before displaying them. * lisp/emacs-lisp/cl-macs.el (cl--transform-lambda): Quote the generated docstring for later substitution. --- lisp/calculator.el | 6 +++--- lisp/calendar/calendar.el | 8 ++++---- lisp/calendar/diary-lib.el | 2 +- lisp/calendar/icalendar.el | 4 ++-- lisp/cedet/ede.el | 8 ++++---- lisp/cedet/ede/files.el | 2 +- lisp/cedet/mode-local.el | 6 ++++-- lisp/cedet/semantic.el | 4 ++-- lisp/cedet/semantic/bovine/c.el | 4 ++-- lisp/cedet/semantic/db-find.el | 2 +- lisp/cedet/semantic/doc.el | 6 +++--- lisp/cedet/semantic/fw.el | 2 +- lisp/cedet/semantic/lex.el | 4 ++-- lisp/cedet/semantic/sort.el | 2 +- lisp/cedet/semantic/symref.el | 12 ++++++------ lisp/cedet/semantic/tag.el | 20 ++++++++++---------- lisp/desktop.el | 8 ++++---- lisp/dframe.el | 6 +++--- lisp/emacs-lisp/advice.el | 4 ++-- lisp/emacs-lisp/avl-tree.el | 2 +- lisp/emacs-lisp/backquote.el | 4 ++-- lisp/emacs-lisp/bytecomp.el | 6 +++--- lisp/emacs-lisp/chart.el | 4 ++-- lisp/emacs-lisp/cl-macs.el | 11 ++++++----- lisp/emacs-lisp/easy-mmode.el | 4 ++-- lisp/emacs-lisp/ert.el | 2 +- lisp/emacs-lisp/gv.el | 2 +- lisp/emacs-lisp/let-alist.el | 8 ++++---- lisp/emulation/keypad.el | 16 ++++++++-------- lisp/emulation/viper-keym.el | 2 +- lisp/epg.el | 16 ++++++++-------- lisp/erc/erc-backend.el | 2 +- lisp/erc/erc-button.el | 6 +++--- lisp/erc/erc-match.el | 2 +- lisp/erc/erc-ring.el | 3 +-- lisp/erc/erc-track.el | 6 +++--- lisp/erc/erc.el | 10 +++++----- lisp/eshell/esh-cmd.el | 6 +++--- lisp/eshell/esh-util.el | 4 ++-- lisp/facemenu.el | 4 ++-- lisp/faces.el | 2 +- lisp/files.el | 6 +++--- lisp/filesets.el | 2 +- lisp/find-file.el | 2 +- lisp/frame.el | 6 +++--- lisp/gnus/gnus-mlspl.el | 4 ++-- lisp/gnus/message.el | 4 ++-- lisp/gnus/mm-decode.el | 2 +- lisp/gnus/mm-util.el | 2 +- lisp/hi-lock.el | 2 +- lisp/htmlfontify.el | 40 ++++++++++++++++++++-------------------- lisp/ibuffer.el | 2 +- lisp/ido.el | 10 +++++----- lisp/image-dired.el | 4 ++-- lisp/image.el | 2 +- lisp/imenu.el | 2 +- lisp/indent.el | 2 +- lisp/mail/feedmail.el | 12 ++++++------ lisp/mail/hashcash.el | 2 +- lisp/mail/rfc2368.el | 2 +- lisp/mail/rmail.el | 4 ++-- lisp/mh-e/mh-e.el | 8 ++++---- lisp/mh-e/mh-identity.el | 12 ++++++------ lisp/mh-e/mh-seq.el | 2 +- lisp/net/ange-ftp.el | 2 +- lisp/net/eww.el | 2 +- lisp/net/imap.el | 6 +++--- lisp/net/mairix.el | 2 +- lisp/net/newst-backend.el | 10 +++++----- lisp/net/newst-plainview.el | 12 ++++++------ lisp/net/rcirc.el | 2 +- lisp/net/soap-client.el | 4 ++-- lisp/net/tramp.el | 4 ++-- lisp/org/ob-core.el | 4 ++-- lisp/org/ob-exp.el | 2 +- lisp/org/ob-table.el | 4 ++-- lisp/org/org-agenda.el | 4 ++-- lisp/org/org-faces.el | 2 +- lisp/org/org-list.el | 2 +- lisp/org/org-macs.el | 2 +- lisp/org/org.el | 6 +++--- lisp/printing.el | 8 ++++---- lisp/proced.el | 16 ++++++++-------- lisp/progmodes/cc-mode.el | 4 ++-- lisp/progmodes/compile.el | 4 ++-- lisp/progmodes/cpp.el | 2 +- lisp/progmodes/f90.el | 4 ++-- lisp/progmodes/flymake.el | 2 +- lisp/progmodes/fortran.el | 4 ++-- lisp/progmodes/gdb-mi.el | 6 +++--- lisp/progmodes/gud.el | 2 +- lisp/progmodes/hideif.el | 32 ++++++++++++++++---------------- lisp/progmodes/hideshow.el | 6 +++--- lisp/progmodes/idlwave.el | 26 +++++++++++++------------- lisp/progmodes/js.el | 12 ++++++------ lisp/progmodes/mantemp.el | 2 +- lisp/progmodes/pascal.el | 4 ++-- lisp/progmodes/python.el | 8 ++++---- lisp/progmodes/sh-script.el | 2 +- lisp/progmodes/simula.el | 8 ++++---- lisp/progmodes/sql.el | 4 ++-- lisp/progmodes/vera-mode.el | 2 +- lisp/progmodes/verilog-mode.el | 12 ++++++------ lisp/progmodes/vhdl-mode.el | 30 +++++++++++++++--------------- lisp/ps-bdf.el | 2 +- lisp/ps-print.el | 10 +++++----- lisp/ses.el | 32 ++++++++++++++++---------------- lisp/simple.el | 2 +- lisp/speedbar.el | 16 ++++++++-------- lisp/subr.el | 2 +- lisp/tempo.el | 2 +- lisp/term.el | 2 +- lisp/textmodes/bibtex.el | 4 ++-- lisp/textmodes/page-ext.el | 2 +- lisp/textmodes/refbib.el | 6 +++--- lisp/textmodes/refer.el | 6 +++--- lisp/textmodes/reftex-vars.el | 8 ++++---- lisp/textmodes/sgml-mode.el | 2 +- lisp/textmodes/table.el | 4 ++-- lisp/textmodes/tex-mode.el | 2 +- lisp/textmodes/text-mode.el | 2 +- lisp/time-stamp.el | 2 +- lisp/url/url-auth.el | 4 ++-- lisp/url/url-http.el | 2 +- lisp/url/url-util.el | 4 ++-- lisp/userlock.el | 4 ++-- lisp/vc/ediff-init.el | 6 +++--- lisp/vc/ediff-wind.el | 2 +- lisp/vc/log-edit.el | 4 ++-- lisp/vc/pcvs.el | 2 +- lisp/vc/smerge-mode.el | 6 +++--- lisp/vc/vc-cvs.el | 16 ++++++++-------- lisp/vc/vc-hooks.el | 4 ++-- lisp/vc/vc.el | 2 +- lisp/wid-edit.el | 2 +- lisp/windmove.el | 2 +- lisp/window.el | 10 +++++----- lisp/woman.el | 6 +++--- lisp/xml.el | 10 +++++----- src/dispnew.c | 16 ++++++++-------- src/fns.c | 2 +- src/frame.c | 16 ++++++++-------- 142 files changed, 432 insertions(+), 430 deletions(-) diff --git a/lisp/calculator.el b/lisp/calculator.el index 80b7c070f1f..b0908012714 100644 --- a/lisp/calculator.el +++ b/lisp/calculator.el @@ -65,7 +65,7 @@ Note that this requires easymenu. Must be set before loading." :group 'calculator) (defcustom calculator-unary-style 'postfix - "Value is either 'prefix or 'postfix. + "Value is either `prefix' or `postfix'. This determines the default behavior of unary operators." :type '(choice (const prefix) (const postfix)) :group 'calculator) @@ -332,10 +332,10 @@ documentation for an example.") "A table to convert input characters to corresponding radix symbols.") (defvar calculator-output-radix nil - "The mode for display, one of: nil (decimal), 'bin, 'oct or 'hex.") + "The mode for display, one of: nil (decimal), `bin', `oct' or `hex'.") (defvar calculator-input-radix nil - "The mode for input, one of: nil (decimal), 'bin, 'oct or 'hex.") + "The mode for input, one of: nil (decimal), `bin', `oct' or `hex'.") (defvar calculator-deg nil "Non-nil if trig functions operate on degrees instead of radians.") diff --git a/lisp/calendar/calendar.el b/lisp/calendar/calendar.el index 6c1b4c258e9..4c659bfa29c 100644 --- a/lisp/calendar/calendar.el +++ b/lisp/calendar/calendar.el @@ -881,11 +881,11 @@ is a list of expressions that can involve the keywords `month', `day', and `year' (all numbers in string form), and `monthname' and `dayname' \(both alphabetic strings). For example, a typical American form would be - '(month \"/\" day \"/\" (substring year -2)) + (month \"/\" day \"/\" (substring year -2)) whereas - '((format \"%9s, %9s %2s, %4s\" dayname monthname day year)) + ((format \"%9s, %9s %2s, %4s\" dayname monthname day year)) would give the usual American style in fixed-length fields. The variables `calendar-iso-date-display-form', `calendar-european-date-display-form', and @@ -1184,8 +1184,8 @@ A negative year is interpreted as BC; -1 being 1 BC, and so on." (defsubst calendar-day-number (date) "Return the day number within the year of the date DATE. -For example, (calendar-day-number '(1 1 1987)) returns the value 1, -while (calendar-day-number '(12 31 1980)) returns 366." +For example, (calendar-day-number \\='(1 1 1987)) returns the value 1, +while (calendar-day-number \\='(12 31 1980)) returns 366." (let* ((month (calendar-extract-month date)) (day (calendar-extract-day date)) (year (calendar-extract-year date)) diff --git a/lisp/calendar/diary-lib.el b/lisp/calendar/diary-lib.el index 7382abf67fc..93891bf2f16 100644 --- a/lisp/calendar/diary-lib.el +++ b/lisp/calendar/diary-lib.el @@ -1190,7 +1190,7 @@ ensure that all relevant variables are set. \(setq diary-mail-days 3 diary-file \"/path/to/diary.file\" - calendar-date-style 'european + calendar-date-style \\='european diary-mail-addr \"user@host.name\") \(diary-mail-entries) diff --git a/lisp/calendar/icalendar.el b/lisp/calendar/icalendar.el index 0955e72aa04..0c7a0636b08 100644 --- a/lisp/calendar/icalendar.el +++ b/lisp/calendar/icalendar.el @@ -1296,8 +1296,8 @@ Returns an alist." "Return a VALARM block. Argument ADVANCE-TIME is a number giving the time when the alarm fires (minutes before the respective event). Argument ALARM-SPEC -is a list which must be one of '(audio), '(display) or -'(email (ADDRESS1 ...)), see `icalendar-export-alarms'. Argument +is a list which must be one of (audio), (display) or +(email (ADDRESS1 ...)), see `icalendar-export-alarms'. Argument SUMMARY is a string which contains a short description for the alarm." (let* ((action (car alarm-spec)) diff --git a/lisp/cedet/ede.el b/lisp/cedet/ede.el index 76ec3567c63..2a522bcccd8 100644 --- a/lisp/cedet/ede.el +++ b/lisp/cedet/ede.el @@ -81,12 +81,12 @@ "Whether a new source file should be automatically added to a target. Whenever a new file is encountered in a directory controlled by a project file, all targets are queried to see if it should be added. -If the value is 'always, then the new file is added to the first -target encountered. If the value is 'multi-ask, then if more than one +If the value is `always', then the new file is added to the first +target encountered. If the value is `multi-ask', then if more than one target wants the file, the user is asked. If only one target wants the file, then it is automatically added to that target. If the -value is 'ask, then the user is always asked, unless there is no -target willing to take the file. 'never means never perform the check." +value is `ask', then the user is always asked, unless there is no +target willing to take the file. `never' means never perform the check." :group 'ede :type '(choice (const always) (const multi-ask) diff --git a/lisp/cedet/ede/files.el b/lisp/cedet/ede/files.el index 4ba823adeee..81a1a6adf2e 100644 --- a/lisp/cedet/ede/files.el +++ b/lisp/cedet/ede/files.el @@ -304,7 +304,7 @@ Do this whenever a new project is created, as opposed to loaded." ;; instead so that -P can be obsoleted. (defun ede-directory-project-p (dir &optional force) "Return a project description object if DIR is in a project. -Optional argument FORCE means to ignore a hash-hit of 'nomatch. +Optional argument FORCE means to ignore a hash-hit of `nomatch'. This depends on an up to date `ede-project-class-files' variable. Any directory that contains the file .ede-ignore will always return nil. diff --git a/lisp/cedet/mode-local.el b/lisp/cedet/mode-local.el index b5995ffa397..c1e06cb4586 100644 --- a/lisp/cedet/mode-local.el +++ b/lisp/cedet/mode-local.el @@ -627,7 +627,8 @@ SYMBOL is a function that can be overridden." (beginning-of-line) (forward-line -1)) (let ((inhibit-read-only t)) - (insert (overload-docstring-extension symbol) "\n") + (insert (substitute-command-keys (overload-docstring-extension symbol)) + "\n") ;; NOTE TO SELF: ;; LIST ALL LOADED OVERRIDES FOR SYMBOL HERE ))) @@ -641,7 +642,8 @@ SYMBOL is a function that can be overridden." (fetch-overload symbol))) modes) - (insert (overload-docstring-extension symbol) "\n\n") + (insert (substitute-command-keys (overload-docstring-extension symbol)) + "\n\n") (insert (format-message "default function: `%s'\n" default)) (if override (insert (format-message "\noverride in buffer `%s': `%s'\n" diff --git a/lisp/cedet/semantic.el b/lisp/cedet/semantic.el index 290cd907beb..a9af84af3d4 100644 --- a/lisp/cedet/semantic.el +++ b/lisp/cedet/semantic.el @@ -1191,7 +1191,7 @@ This function can be used by `completion-at-point-functions'." (defun semantic-analyze-notc-completion-at-point-function () "Return possible analysis completions at point. The completions provided are via `semantic-analyze-possible-completions', -but with the 'no-tc option passed in, which means constraints based +but with the `no-tc' option passed in, which means constraints based on what is being assigned to are ignored. This function can be used by `completion-at-point-functions'." (when (semantic-active-p) @@ -1207,7 +1207,7 @@ This function can be used by `completion-at-point-functions'." (defun semantic-analyze-nolongprefix-completion-at-point-function () "Return possible analysis completions at point. The completions provided are via `semantic-analyze-possible-completions', -but with the 'no-tc and 'no-longprefix option passed in, which means +but with the `no-tc' and `no-longprefix' option passed in, which means constraints resulting in a long multi-symbol dereference are ignored. This function can be used by `completion-at-point-functions'." (when (semantic-active-p) diff --git a/lisp/cedet/semantic/bovine/c.el b/lisp/cedet/semantic/bovine/c.el index 1c25c7b0808..d5af635d14c 100644 --- a/lisp/cedet/semantic/bovine/c.el +++ b/lisp/cedet/semantic/bovine/c.el @@ -1513,7 +1513,7 @@ Override function for `semantic-tag-protection'." (define-mode-local-override semantic-find-tags-included c-mode (&optional table) - "Find all tags in TABLE that are of the 'include class. + "Find all tags in TABLE that are of the `include' class. TABLE is a tag table. See `semantic-something-to-tag-table'. For C++, we also have to search namespaces for include tags." (let ((tags (semantic-find-tags-by-class 'include table)) @@ -1948,7 +1948,7 @@ For types with a :parent, create faux namespaces to put TAG into." (define-mode-local-override semanticdb-find-table-for-include c-mode (includetag &optional table) "For a single INCLUDETAG found in TABLE, find a `semanticdb-table' object -INCLUDETAG is a semantic TAG of class 'include. +INCLUDETAG is a semantic TAG of class `include'. TABLE is a semanticdb table that identifies where INCLUDETAG came from. TABLE is optional if INCLUDETAG has an overlay of :filename attribute. diff --git a/lisp/cedet/semantic/db-find.el b/lisp/cedet/semantic/db-find.el index 293f535d60b..b441cd18b63 100644 --- a/lisp/cedet/semantic/db-find.el +++ b/lisp/cedet/semantic/db-find.el @@ -854,7 +854,7 @@ This makes it appear more like the results of a `semantic-find-' call. Optional FIND-FILE-MATCH loads all files associated with RESULTS into buffers. This has the side effect of enabling `semantic-tag-buffer' to return a value. -If FIND-FILE-MATCH is 'name, then only the filename is stored +If FIND-FILE-MATCH is `name', then only the filename is stored in each tag instead of loading each file into a buffer. If the input RESULTS are not going to be used again, and if FIND-FILE-MATCH is nil, you can use `semanticdb-fast-strip-find-results' diff --git a/lisp/cedet/semantic/doc.el b/lisp/cedet/semantic/doc.el index 3ceb3510ad2..65718a0532e 100644 --- a/lisp/cedet/semantic/doc.el +++ b/lisp/cedet/semantic/doc.el @@ -41,7 +41,7 @@ some documentation in a comment preceding TAG's definition which we can look for. When appropriate, this can be overridden by a language specific enhancement. Optional argument NOSNARF means to only return the lexical analyzer token for it. -If nosnarf if 'lex, then only return the lex token." +If NOSNARF is `lex', then only return the lex token." (if (not tag) (setq tag (semantic-current-tag))) (save-excursion (when (semantic-tag-with-position-p tag) @@ -66,7 +66,7 @@ If nosnarf if 'lex, then only return the lex token." If TAG is nil. use the tag under point. Searches the space between TAG and the preceding tag for a comment, and converts the comment into clean documentation. -Optional argument NOSNARF with a value of 'lex means to return +Optional argument NOSNARF with a value of `lex' means to return just the lexical token and not the string." (if (not tag) (setq tag (semantic-current-tag))) (save-excursion @@ -92,7 +92,7 @@ just the lexical token and not the string." "Snarf up the comment at POINT for `semantic-documentation-for-tag'. Attempt to strip out comment syntactic sugar. Argument NOSNARF means don't modify the found text. -If NOSNARF is 'lex, then return the lex token." +If NOSNARF is `lex', then return the lex token." (let* ((semantic-ignore-comments nil) (semantic-lex-analyzer #'semantic-comment-lexer)) (if (memq nosnarf '(lex flex)) ;; keep `flex' for compatibility diff --git a/lisp/cedet/semantic/fw.el b/lisp/cedet/semantic/fw.el index d8ba6f275f3..b7a6ed352d1 100644 --- a/lisp/cedet/semantic/fw.el +++ b/lisp/cedet/semantic/fw.el @@ -193,7 +193,7 @@ Possible Lifespans are: )) (defun semantic-cache-data-post-command-hook () - "Flush `semantic-cache-data-overlays' based 'lifespan property. + "Flush `semantic-cache-data-overlays' based `lifespan' property. Remove self from `post-command-hook' if it is empty." (let ((newcache nil) (oldcache semantic-cache-data-overlays)) diff --git a/lisp/cedet/semantic/lex.el b/lisp/cedet/semantic/lex.el index 7738e06ff88..c8645c2b7d3 100644 --- a/lisp/cedet/semantic/lex.el +++ b/lisp/cedet/semantic/lex.el @@ -1815,13 +1815,13 @@ to keep comments as part of the token stream.") (make-variable-buffer-local 'semantic-ignore-comments) (defvar semantic-flex-enable-newlines nil - "When flexing, report 'newlines as syntactic elements. + "When flexing, report newlines as syntactic elements. Useful for languages where the newline is a special case terminator. Only set this on a per mode basis, not globally.") (make-variable-buffer-local 'semantic-flex-enable-newlines) (defvar semantic-flex-enable-whitespace nil - "When flexing, report 'whitespace as syntactic elements. + "When flexing, report whitespace as syntactic elements. Useful for languages where the syntax is whitespace dependent. Only set this on a per mode basis, not globally.") (make-variable-buffer-local 'semantic-flex-enable-whitespace) diff --git a/lisp/cedet/semantic/sort.el b/lisp/cedet/semantic/sort.el index 587d084701d..22826635986 100644 --- a/lisp/cedet/semantic/sort.el +++ b/lisp/cedet/semantic/sort.el @@ -453,7 +453,7 @@ has some sort of label defining a parent. The parent return will be a string. The default behavior, if not overridden with -`tag-member-parent' gets the 'parent extra +`tag-member-parent' gets the `parent' extra specifier of TAG. If this function is overridden, use diff --git a/lisp/cedet/semantic/symref.el b/lisp/cedet/semantic/symref.el index 15070dc0558..04684035ac0 100644 --- a/lisp/cedet/semantic/symref.el +++ b/lisp/cedet/semantic/symref.el @@ -162,7 +162,7 @@ ARGS are the initialization arguments to pass to the created class." ;;;###autoload (defun semantic-symref-find-references-by-name (name &optional scope tool-return) "Find a list of references to NAME in the current project. -Optional SCOPE specifies which file set to search. Defaults to 'project. +Optional SCOPE specifies which file set to search. Defaults to `project'. Refers to `semantic-symref-tool', to determine the reference tool to use for the current buffer. Returns an object of class `semantic-symref-result'. @@ -186,7 +186,7 @@ to perform the search. This was added for use by a test harness." ;;;###autoload (defun semantic-symref-find-tags-by-name (name &optional scope) "Find a list of tags by NAME in the current project. -Optional SCOPE specifies which file set to search. Defaults to 'project. +Optional SCOPE specifies which file set to search. Defaults to `project'. Refers to `semantic-symref-tool', to determine the reference tool to use for the current buffer. Returns an object of class `semantic-symref-result'." @@ -206,7 +206,7 @@ Returns an object of class `semantic-symref-result'." ;;;###autoload (defun semantic-symref-find-tags-by-regexp (name &optional scope) "Find a list of references to NAME in the current project. -Optional SCOPE specifies which file set to search. Defaults to 'project. +Optional SCOPE specifies which file set to search. Defaults to `project'. Refers to `semantic-symref-tool', to determine the reference tool to use for the current buffer. Returns an object of class `semantic-symref-result'." @@ -226,7 +226,7 @@ Returns an object of class `semantic-symref-result'." ;;;###autoload (defun semantic-symref-find-tags-by-completion (name &optional scope) "Find a list of references to NAME in the current project. -Optional SCOPE specifies which file set to search. Defaults to 'project. +Optional SCOPE specifies which file set to search. Defaults to `project'. Refers to `semantic-symref-tool', to determine the reference tool to use for the current buffer. Returns an object of class `semantic-symref-result'." @@ -246,7 +246,7 @@ Returns an object of class `semantic-symref-result'." ;;;###autoload (defun semantic-symref-find-file-references-by-name (name &optional scope) "Find a list of references to NAME in the current project. -Optional SCOPE specifies which file set to search. Defaults to 'project. +Optional SCOPE specifies which file set to search. Defaults to `project'. Refers to `semantic-symref-tool', to determine the reference tool to use for the current buffer. Returns an object of class `semantic-symref-result'." @@ -267,7 +267,7 @@ Returns an object of class `semantic-symref-result'." (defun semantic-symref-find-text (text &optional scope) "Find a list of occurrences of TEXT in the current project. TEXT is a regexp formatted for use with egrep. -Optional SCOPE specifies which file set to search. Defaults to 'project. +Optional SCOPE specifies which file set to search. Defaults to `project'. Refers to `semantic-symref-tool', to determine the reference tool to use for the current buffer. Returns an object of class `semantic-symref-result'." diff --git a/lisp/cedet/semantic/tag.el b/lisp/cedet/semantic/tag.el index 34fc8ba92ce..8ec5fffd413 100644 --- a/lisp/cedet/semantic/tag.el +++ b/lisp/cedet/semantic/tag.el @@ -375,7 +375,7 @@ Optional argument IGNORABLE-ATTRIBUTES is passed down to (defun semantic-tag-of-type-p (tag type) "Compare TAG's type against TYPE. Non nil if equivalent. -TYPE can be a string, or a tag of class 'type. +TYPE can be a string, or a tag of class `type'. This can be complex since some tags might have a :type that is a tag, while other tags might just have a string. This function will also be return true of TAG's type is compared directly to the declaration of a @@ -462,12 +462,12 @@ pairs eliminated: "Create a generic semantic tag. NAME is a string representing the name of this tag. CLASS is the symbol that represents the class of tag this is, -such as 'variable, or 'function. +such as `variable', or `function'. ATTRIBUTES is a list of additional attributes belonging to this tag." (list name class (semantic-tag-make-plist attributes) nil nil)) (defsubst semantic-tag-new-variable (name type &optional default-value &rest attributes) - "Create a semantic tag of class 'variable. + "Create a semantic tag of class `variable'. NAME is the name of this variable. TYPE is a string or semantic tag representing the type of this variable. Optional DEFAULT-VALUE is a string representing the default value of this @@ -479,7 +479,7 @@ tag." attributes)) (defsubst semantic-tag-new-function (name type arg-list &rest attributes) - "Create a semantic tag of class 'function. + "Create a semantic tag of class `function'. NAME is the name of this function. TYPE is a string or semantic tag representing the type of this function. ARG-LIST is a list of strings or semantic tags representing the @@ -491,7 +491,7 @@ ATTRIBUTES is a list of additional attributes belonging to this tag." attributes)) (defsubst semantic-tag-new-type (name type members parents &rest attributes) - "Create a semantic tag of class 'type. + "Create a semantic tag of class `type'. NAME is the name of this type. TYPE is a string or semantic tag representing the type of this type. MEMBERS is a list of strings or semantic tags representing the @@ -516,7 +516,7 @@ ATTRIBUTES is a list of additional attributes belonging to this tag." attributes)) (defsubst semantic-tag-new-include (name system-flag &rest attributes) - "Create a semantic tag of class 'include. + "Create a semantic tag of class `include'. NAME is the name of this include. SYSTEM-FLAG represents that we were able to identify this include as belonging to the system, as opposed to belonging to the local project. @@ -526,7 +526,7 @@ ATTRIBUTES is a list of additional attributes belonging to this tag." attributes)) (defsubst semantic-tag-new-package (name detail &rest attributes) - "Create a semantic tag of class 'package. + "Create a semantic tag of class `package'. NAME is the name of this package. DETAIL is extra information about this package, such as a location where it can be found. @@ -536,7 +536,7 @@ ATTRIBUTES is a list of additional attributes belonging to this tag." attributes)) (defsubst semantic-tag-new-code (name detail &rest attributes) - "Create a semantic tag of class 'code. + "Create a semantic tag of class `code'. NAME is a name for this code. DETAIL is extra information about the code. ATTRIBUTES is a list of additional attributes belonging to this tag." @@ -823,7 +823,7 @@ in SUPERS." (defun semantic-tag-type-superclass-protection (tag parentstring) "Return the inheritance protection in TAG from PARENTSTRING. PARENTSTRING is the name of the parent being inherited. -The return protection is a symbol, 'public, 'protection, and 'private." +The return protection is a symbol, `public', `protection', and `private'." (let ((supers (semantic-tag-get-attribute tag :superclasses))) (cond ((stringp supers) 'public) @@ -946,7 +946,7 @@ ATTRIBUTES is a list of additional attributes belonging to this tag." The returned value is a tag of the class that `semantic-tag-alias-class' returns for TAG. The default is to return the value of the :definition attribute. -Return nil if TAG is not of class 'alias." +Return nil if TAG is not of class `alias'." (when (semantic-tag-of-class-p tag 'alias) (:override (semantic-tag-get-attribute tag :definition)))) diff --git a/lisp/desktop.el b/lisp/desktop.el index e95a8c9288b..5a709b9d5b6 100644 --- a/lisp/desktop.el +++ b/lisp/desktop.el @@ -519,8 +519,8 @@ code like (defun foo-restore-desktop-buffer ... - (add-to-list 'desktop-buffer-mode-handlers - '(foo-mode . foo-restore-desktop-buffer)) + (add-to-list \\='desktop-buffer-mode-handlers + \\='(foo-mode . foo-restore-desktop-buffer)) The major mode function must either be autoloaded, or of the form \"foobar-mode\" and defined in library \"foobar\", so that desktop @@ -586,8 +586,8 @@ code like (defun foo-desktop-restore ... - (add-to-list 'desktop-minor-mode-handlers - '(foo-mode . foo-desktop-restore)) + (add-to-list \\='desktop-minor-mode-handlers + \\='(foo-mode . foo-desktop-restore)) The minor mode function must either be autoloaded, or of the form \"foobar-mode\" and defined in library \"foobar\", so that desktop diff --git a/lisp/dframe.el b/lisp/dframe.el index d8ddbc8f08f..b5df1bcb7bd 100644 --- a/lisp/dframe.el +++ b/lisp/dframe.el @@ -420,7 +420,7 @@ CREATE-HOOK is a hook to run after creating a frame." (defun dframe-reposition-frame (new-frame parent-frame location) "Move NEW-FRAME to be relative to PARENT-FRAME. -LOCATION can be one of 'random, 'left, 'right, 'left-right, or 'top-bottom." +LOCATION can be one of `random', `left', `right', `left-right', or `top-bottom'." (if (featurep 'xemacs) (dframe-reposition-frame-xemacs new-frame parent-frame location) (dframe-reposition-frame-emacs new-frame parent-frame location))) @@ -431,7 +431,7 @@ LOCATION can be one of 'random, 'left, 'right, 'left-right, or 'top-bottom." (defun dframe-reposition-frame-emacs (new-frame parent-frame location) "Move NEW-FRAME to be relative to PARENT-FRAME. -LOCATION can be one of 'random, 'left-right, 'top-bottom, or +LOCATION can be one of `random', `left-right', `top-bottom', or a cons cell indicating a position of the form (LEFT . TOP)." ;; Position dframe. ;; Do no positioning if not on a windowing system, @@ -514,7 +514,7 @@ a cons cell indicating a position of the form (LEFT . TOP)." (defun dframe-reposition-frame-xemacs (_new-frame _parent-frame _location) "Move NEW-FRAME to be relative to PARENT-FRAME. -LOCATION can be one of 'random, 'left-right, or 'top-bottom." +LOCATION can be one of `random', `left-right', or `top-bottom'." ;; Not yet implemented ) diff --git a/lisp/emacs-lisp/advice.el b/lisp/emacs-lisp/advice.el index 4ee830023fc..d13bc2ff4ff 100644 --- a/lisp/emacs-lisp/advice.el +++ b/lisp/emacs-lisp/advice.el @@ -1629,7 +1629,7 @@ COMPILE argument of `ad-activate' was supplied as nil." Only proper subtrees are considered, for example, if TREE is (1 (2 (3)) 4) then the subtrees will be 1 (2 (3)) 2 (3) 3 4, dotted structures are allowed too. Once a qualifying subtree has been found its subtrees will -not be considered anymore. (ad-substitute-tree 'atom 'identity tree) +not be considered anymore. (ad-substitute-tree \\='atom \\='identity tree) generates a copy of TREE." (cond ((consp tReE) (cons (if (funcall sUbTrEe-TeSt (car tReE)) @@ -2419,7 +2419,7 @@ as if they had been supplied to a function with TARGET-ARGLIST directly. Excess source arguments will be neglected, missing source arguments will be supplied as nil. Returns a `funcall' or `apply' form with the second element being `function' which has to be replaced by an actual function argument. -Example: (ad-map-arglists '(a &rest args) '(w x y z)) will return +Example: (ad-map-arglists \\='(a &rest args) \\='(w x y z)) will return (funcall ad--addoit-function a (car args) (car (cdr args)) (nth 2 args))." (let* ((parsed-source-arglist (ad-parse-arglist source-arglist)) (source-reqopt-args (append (nth 0 parsed-source-arglist) diff --git a/lisp/emacs-lisp/avl-tree.el b/lisp/emacs-lisp/avl-tree.el index 99a329b021e..9dcebb2bf42 100644 --- a/lisp/emacs-lisp/avl-tree.el +++ b/lisp/emacs-lisp/avl-tree.el @@ -561,7 +561,7 @@ Note that if you don't care about the order in which FUNCTION is applied, just that the resulting list is in the correct order, then - (avl-tree-mapf function 'cons tree (not reverse)) + (avl-tree-mapf function \\='cons tree (not reverse)) is more efficient." (nreverse (avl-tree-mapf fun 'cons tree reverse))) diff --git a/lisp/emacs-lisp/backquote.el b/lisp/emacs-lisp/backquote.el index dc61e156130..12bd8dae08c 100644 --- a/lisp/emacs-lisp/backquote.el +++ b/lisp/emacs-lisp/backquote.el @@ -43,7 +43,7 @@ (defun backquote-list*-function (first &rest list) "Like `list' but the last argument is the tail of the new list. -For example (backquote-list* 'a 'b 'c) => (a b . c)" +For example (backquote-list* \\='a \\='b \\='c) => (a b . c)" ;; The recursive solution is much nicer: ;; (if list (cons first (apply 'backquote-list*-function list)) first)) ;; but Emacs is not very good at efficiently processing recursion. @@ -60,7 +60,7 @@ For example (backquote-list* 'a 'b 'c) => (a b . c)" (defmacro backquote-list*-macro (first &rest list) "Like `list' but the last argument is the tail of the new list. -For example (backquote-list* 'a 'b 'c) => (a b . c)" +For example (backquote-list* \\='a \\='b \\='c) => (a b . c)" ;; The recursive solution is much nicer: ;; (if list (list 'cons first (cons 'backquote-list*-macro list)) first)) ;; but Emacs is not very good at efficiently processing such things. diff --git a/lisp/emacs-lisp/bytecomp.el b/lisp/emacs-lisp/bytecomp.el index db200f3c504..024719168af 100644 --- a/lisp/emacs-lisp/bytecomp.el +++ b/lisp/emacs-lisp/bytecomp.el @@ -265,8 +265,8 @@ This option is enabled by default because it reduces Emacs memory usage." (defcustom byte-optimize-log nil "If non-nil, the byte-compiler will log its optimizations. -If this is 'source, then only source-level optimizations will be logged. -If it is 'byte, then only byte-level optimizations will be logged. +If this is `source', then only source-level optimizations will be logged. +If it is `byte', then only byte-level optimizations will be logged. The information is logged to `byte-compile-log-buffer'." :group 'bytecomp :type '(choice (const :tag "none" nil) @@ -1691,7 +1691,7 @@ Any other non-nil value of ARG means to ask the user. If optional argument LOAD is non-nil, loads the file after compiling. If compilation is needed, this functions returns the result of -`byte-compile-file'; otherwise it returns 'no-byte-compile." +`byte-compile-file'; otherwise it returns `no-byte-compile'." (interactive (let ((file buffer-file-name) (file-name nil) diff --git a/lisp/emacs-lisp/chart.el b/lisp/emacs-lisp/chart.el index 06601252a4c..c0a42038e94 100644 --- a/lisp/emacs-lisp/chart.el +++ b/lisp/emacs-lisp/chart.el @@ -479,7 +479,7 @@ See `chart-sort-matchlist' for more details." (defun chart-sort-matchlist (namelst numlst pred) "Sort NAMELST and NUMLST (both sequence objects) based on predicate PRED. -PRED should be the equivalent of '<, except it must expect two +PRED should be the equivalent of `<', except it must expect two cons cells of the form (NAME . NUM). See `sort' for more details." ;; 1 - create 1 list of cons cells (let ((newlist nil) @@ -571,7 +571,7 @@ R1 and R2 are dotted pairs. Colorize it with FACE." (defun chart-bar-quickie (dir title namelst nametitle numlst numtitle &optional max sort-pred) "Wash over the complex EIEIO stuff and create a nice bar chart. -Create it going in direction DIR ['horizontal 'vertical] with TITLE +Create it going in direction DIR [`horizontal' `vertical'] with TITLE using a name sequence NAMELST labeled NAMETITLE with values NUMLST labeled NUMTITLE. Optional arguments: diff --git a/lisp/emacs-lisp/cl-macs.el b/lisp/emacs-lisp/cl-macs.el index 80f0cd73cee..09d2d3f9a5e 100644 --- a/lisp/emacs-lisp/cl-macs.el +++ b/lisp/emacs-lisp/cl-macs.el @@ -298,9 +298,10 @@ FORM is of the form (ARGS . BODY)." (if (stringp (car header)) (pop header)) ;; Be careful with make-symbol and (back)quote, ;; see bug#12884. - (let ((print-gensym nil) (print-quoted t)) - (format "%S" (cons 'fn (cl--make-usage-args - orig-args))))) + (help--docstring-quote + (let ((print-gensym nil) (print-quoted t)) + (format "%S" (cons 'fn (cl--make-usage-args + orig-args)))))) header))) ;; FIXME: we'd want to choose an arg name for the &rest param ;; and pass that as `expr' to cl--do-arglist, but that ends up @@ -2829,8 +2830,8 @@ is a shorthand for (NAME NAME)." (defun cl-struct-sequence-type (struct-type) "Return the sequence used to build STRUCT-TYPE. -STRUCT-TYPE is a symbol naming a struct type. Return 'vector or -'list, or nil if STRUCT-TYPE is not a struct type. " +STRUCT-TYPE is a symbol naming a struct type. Return `vector' or +`list', or nil if STRUCT-TYPE is not a struct type. " (declare (side-effect-free t) (pure t)) (cl--struct-class-type (cl--struct-get-class struct-type))) diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index 56f95111ab8..321895de4e1 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -148,7 +148,7 @@ BODY contains code to execute each time the mode is enabled or disabled. For example, you could write (define-minor-mode foo-mode \"If enabled, foo on you!\" - :lighter \" Foo\" :require 'foo :global t :group 'hassle :version \"27.5\" + :lighter \" Foo\" :require \\='foo :global t :group \\='hassle :version \"27.5\" ...BODY CODE...)" (declare (doc-string 2) (debug (&define name string-or-null-p @@ -502,7 +502,7 @@ Valid keywords and arguments are: :inherit Parent keymap. :group Ignored. :suppress Non-nil to call `suppress-keymap' on keymap, - 'nodigits to suppress digits as prefix arguments." + `nodigits' to suppress digits as prefix arguments." (let (inherit dense suppress) (while args (let ((key (pop args)) diff --git a/lisp/emacs-lisp/ert.el b/lisp/emacs-lisp/ert.el index 21c1f1be394..d572d544e11 100644 --- a/lisp/emacs-lisp/ert.el +++ b/lisp/emacs-lisp/ert.el @@ -187,7 +187,7 @@ using :expected-result. See `ert-test-result-type-p' for a description of valid values for RESULT-TYPE. \(fn NAME () [DOCSTRING] [:expected-result RESULT-TYPE] \ -[:tags '(TAG...)] BODY...)" +[:tags \\='(TAG...)] BODY...)" (declare (debug (&define :name test name sexp [&optional stringp] [&rest keywordp sexp] def-body)) diff --git a/lisp/emacs-lisp/gv.el b/lisp/emacs-lisp/gv.el index 94fe6c3d441..9e00190e000 100644 --- a/lisp/emacs-lisp/gv.el +++ b/lisp/emacs-lisp/gv.el @@ -534,7 +534,7 @@ This macro only makes sense when used in a place." "Return a reference to PLACE. This is like the `&' operator of the C language. Note: this only works reliably with lexical binding mode, except for very -simple PLACEs such as (function-symbol 'foo) which will also work in dynamic +simple PLACEs such as (function-symbol \\='foo) which will also work in dynamic binding mode." (let ((code (gv-letplace (getter setter) place diff --git a/lisp/emacs-lisp/let-alist.el b/lisp/emacs-lisp/let-alist.el index ca7a904a087..393f1d51050 100644 --- a/lisp/emacs-lisp/let-alist.el +++ b/lisp/emacs-lisp/let-alist.el @@ -117,10 +117,10 @@ For instance, the following code essentially expands to - (let ((.title (cdr (assq 'title alist))) - (.body (cdr (assq 'body alist))) - (.site (cdr (assq 'site alist))) - (.site.contents (cdr (assq 'contents (cdr (assq 'site alist)))))) + (let ((.title (cdr (assq \\='title alist))) + (.body (cdr (assq \\='body alist))) + (.site (cdr (assq \\='site alist))) + (.site.contents (cdr (assq \\='contents (cdr (assq \\='site alist)))))) (if (and .title .body) .body .site diff --git a/lisp/emulation/keypad.el b/lisp/emulation/keypad.el index 8d5e6cf9b5b..b4911102a72 100644 --- a/lisp/emulation/keypad.el +++ b/lisp/emulation/keypad.el @@ -199,15 +199,15 @@ keys are bound. Setup Binding ------------------------------------------------------------- - 'prefix Command prefix argument, i.e. M-0 .. M-9 and M-- - 'S-cursor Bind shifted keypad keys to the shifted cursor movement keys. - 'cursor Bind keypad keys to the cursor movement keys. - 'numeric Plain numeric keypad, i.e. 0 .. 9 and . (or DECIMAL arg) - 'none Removes all bindings for keypad keys in function-key-map; - this enables any user-defined bindings for the keypad keys - in the global and local keymaps. + `prefix' Command prefix argument, i.e. M-0 .. M-9 and M-- + `S-cursor' Bind shifted keypad keys to the shifted cursor movement keys. + `cursor' Bind keypad keys to the cursor movement keys. + `numeric' Plain numeric keypad, i.e. 0 .. 9 and . (or DECIMAL arg) + `none' Removes all bindings for keypad keys in function-key-map; + this enables any user-defined bindings for the keypad keys + in the global and local keymaps. -If SETUP is 'numeric and the optional fourth argument DECIMAL is non-nil, +If SETUP is `numeric' and the optional fourth argument DECIMAL is non-nil, the decimal key on the keypad is mapped to DECIMAL instead of `.'" (let* ((i 0) (var (cond diff --git a/lisp/emulation/viper-keym.el b/lisp/emulation/viper-keym.el index 272556d3bae..e26994cd130 100644 --- a/lisp/emulation/viper-keym.el +++ b/lisp/emulation/viper-keym.el @@ -497,7 +497,7 @@ Useful in some modes, such as Gnus, MH, etc.") "Override some vi-state or insert-state bindings in the current buffer. The effect is seen in the current buffer only. Useful for customizing mailer buffers, gnus, etc. -STATE is 'vi-state, 'insert-state, or 'emacs-state +STATE is `vi-state', `insert-state', or `emacs-state'. ALIST is of the form ((key . func) (key . func) ...) Normally, this would be called from a hook to a major mode or on a per buffer basis. diff --git a/lisp/epg.el b/lisp/epg.el index 71a83c3c670..88829e532de 100644 --- a/lisp/epg.el +++ b/lisp/epg.el @@ -1339,8 +1339,8 @@ callback data (if any)." (defun epg-list-keys (context &optional name mode) "Return a list of epg-key objects matched with NAME. -If MODE is nil or 'public, only public keyring should be searched. -If MODE is t or 'secret, only secret keyring should be searched. +If MODE is nil or `public', only public keyring should be searched. +If MODE is t or `secret', only secret keyring should be searched. Otherwise, only public keyring should be searched and the key signatures should be included. NAME is either a string or a list of strings." @@ -1680,8 +1680,8 @@ which will return a list of `epg-signature' object." "Initiate a sign operation on PLAIN. PLAIN is a data object. -If optional 3rd argument MODE is t or 'detached, it makes a detached signature. -If it is nil or 'normal, it makes a normal signature. +If optional 3rd argument MODE is t or `detached', it makes a detached signature. +If it is nil or `normal', it makes a normal signature. Otherwise, it makes a cleartext signature. If you use this function, you will need to wait for the completion of @@ -1724,8 +1724,8 @@ If you are unsure, use synchronous version of this function (defun epg-sign-file (context plain signature &optional mode) "Sign a file PLAIN and store the result to a file SIGNATURE. If SIGNATURE is nil, it returns the result as a string. -If optional 3rd argument MODE is t or 'detached, it makes a detached signature. -If it is nil or 'normal, it makes a normal signature. +If optional 3rd argument MODE is t or `detached', it makes a detached signature. +If it is nil or `normal', it makes a normal signature. Otherwise, it makes a cleartext signature." (unwind-protect (progn @@ -1745,8 +1745,8 @@ Otherwise, it makes a cleartext signature." (defun epg-sign-string (context plain &optional mode) "Sign a string PLAIN and return the output as string. -If optional 3rd argument MODE is t or 'detached, it makes a detached signature. -If it is nil or 'normal, it makes a normal signature. +If optional 3rd argument MODE is t or `detached', it makes a detached signature. +If it is nil or `normal', it makes a normal signature. Otherwise, it makes a cleartext signature." (let ((input-file (unless (or (eq (epg-context-protocol context) 'CMS) diff --git a/lisp/erc/erc-backend.el b/lisp/erc/erc-backend.el index 755443f8a94..b52c8f5454f 100644 --- a/lisp/erc/erc-backend.el +++ b/lisp/erc/erc-backend.el @@ -370,7 +370,7 @@ This overrides `erc-server-coding-system' depending on the current target as returned by `erc-default-target'. Example: If you know that the channel #linux-ru uses the coding-system -`cyrillic-koi8', then add '(\"#linux-ru\" . cyrillic-koi8) to the +`cyrillic-koi8', then add (\"#linux-ru\" . cyrillic-koi8) to the alist." :group 'erc-server :type '(repeat (cons (string :tag "Target") diff --git a/lisp/erc/erc-button.el b/lisp/erc/erc-button.el index 0e4c70944bb..d6f4b12ebbf 100644 --- a/lisp/erc/erc-button.el +++ b/lisp/erc/erc-button.el @@ -165,11 +165,11 @@ REGEXP is the string matching text around the button or a symbol entries in lists or alists are considered to be nicks or other complete words. Therefore they are enclosed in \\< and \\> while searching. REGEXP can also be the quoted symbol - 'nicknames, which matches the nickname of any user on the + \\='nicknames, which matches the nickname of any user on the current server. BUTTON is the number of the regexp grouping actually matching the - button, This is ignored if REGEXP is 'nicknames. + button, This is ignored if REGEXP is \\='nicknames. FORM is a lisp expression which must eval to true for the button to be added, @@ -180,7 +180,7 @@ CALLBACK is the function to call when the user push this button. PAR is a number of a regexp grouping whose text will be passed to CALLBACK. There can be several PAR arguments. If REGEXP is - 'nicknames, these are ignored, and CALLBACK will be called with + \\='nicknames, these are ignored, and CALLBACK will be called with the nickname matched as the argument." :group 'erc-button :version "24.1" ; remove finger (bug#4443) diff --git a/lisp/erc/erc-match.el b/lisp/erc/erc-match.el index 0622b18ca7f..ec3266fa1bd 100644 --- a/lisp/erc/erc-match.el +++ b/lisp/erc/erc-match.el @@ -191,7 +191,7 @@ use for the logged message." "Flag specifying when matched message logging should happen. When nil, don't log any matched messages. When t, log messages. -When 'away, log messages only when away." +When `away', log messages only when away." :group 'erc-match :type '(choice (const nil) (const away) diff --git a/lisp/erc/erc-ring.el b/lisp/erc/erc-ring.el index de988cc8275..77528eae88c 100644 --- a/lisp/erc/erc-ring.el +++ b/lisp/erc/erc-ring.el @@ -58,7 +58,7 @@ be recalled using M-p and M-n." (defvar erc-input-ring-index nil "Position in the input ring for erc. -If nil, the input line is blank and the user is conceptually 'after' +If nil, the input line is blank and the user is conceptually after the most recently added item in the ring. If an integer, the input line is non-blank and displays the item from the ring indexed by this variable.") @@ -148,4 +148,3 @@ containing a password." ;; Local Variables: ;; indent-tabs-mode: nil ;; End: - diff --git a/lisp/erc/erc-track.el b/lisp/erc/erc-track.el index 2ebc1f22c09..5af1663378f 100644 --- a/lisp/erc/erc-track.el +++ b/lisp/erc/erc-track.el @@ -101,7 +101,7 @@ disconnected from `erc-modified-channels-alist'." (defcustom erc-track-exclude-types '("NICK" "333" "353") "List of message types to be ignored. -This list could look like '(\"JOIN\" \"PART\"). +This list could look like (\"JOIN\" \"PART\"). By default, exclude changes of nicknames (NICK), display of who set the channel topic (333), and listing of users on the current @@ -210,7 +210,7 @@ If you would like to ignore changes in certain channels where there are no faces corresponding to your `erc-track-faces-priority-list', set this variable. You can set a list of channel name strings, so those will be ignored while all other channels will be tracked as normal. -Other options are 'all, to apply this to all channels or nil, to disable +Other options are `all', to apply this to all channels or nil, to disable this feature. Note: If you have a lot of faces listed in `erc-track-faces-priority-list', @@ -326,7 +326,7 @@ when there are no more active channels." leastactive - find buffer with least unseen messages mostactive - find buffer with most unseen messages. -If set to 'importance, the importance is determined by position +If set to `importance', the importance is determined by position in `erc-track-faces-priority-list', where first is most important." :group 'erc-track diff --git a/lisp/erc/erc.el b/lisp/erc/erc.el index d82089f5b05..ab90df8fd3c 100644 --- a/lisp/erc/erc.el +++ b/lisp/erc/erc.el @@ -629,7 +629,7 @@ See also: `erc-get-channel-user-list'." (defvar erc-channel-modes nil "List of strings representing channel modes. -E.g. '(\"i\" \"m\" \"s\" \"b Quake!*@*\") +E.g. (\"i\" \"m\" \"s\" \"b Quake!*@*\") \(not sure the ban list will be here, but why not)") (make-variable-buffer-local 'erc-channel-modes) @@ -3249,7 +3249,7 @@ LINE has the format \"USER ACTION\"." (put 'erc-cmd-ME 'do-not-parse-args t) (defun erc-cmd-ME\'S (line) - "Do a /ME command, but add the string \" 's\" to the beginning." + "Do a /ME command, but add the string \" \\='s\" to the beginning." (erc-cmd-ME (concat " 's" line))) (put 'erc-cmd-ME\'S 'do-not-parse-args t) @@ -5025,7 +5025,7 @@ See also `erc-remove-current-channel-member'." (defun erc-update-channel-topic (channel topic &optional modify) "Find a buffer for CHANNEL and set the TOPIC for it. -If optional MODIFY is 'append or 'prepend, then append or prepend the +If optional MODIFY is `append' or `prepend', then append or prepend the TOPIC string to the current topic." (erc-with-buffer (channel) (cond ((eq modify 'append) @@ -5188,7 +5188,7 @@ person who changed the modes." (t (setq erc-channel-user-limit nil)))))) (defun erc-update-channel-key (channel onoff key) - "Update CHANNEL's key to KEY if ONOFF is 'on or to nil if it's 'off." + "Update CHANNEL's key to KEY if ONOFF is `on' or to nil if it's `off'." (erc-with-buffer (channel) (cond ((eq onoff 'on) (setq erc-channel-key key)) @@ -6730,7 +6730,7 @@ This function should be on `erc-kill-channel-hook'." (text-property-not-all (point-min) (point-max) 'erc-parsed nil)) (defun erc-restore-text-properties () - "Restore the property 'erc-parsed for the region." + "Restore the property `erc-parsed' for the region." (let ((parsed-posn (erc-find-parsed-property))) (put-text-property (point-min) (point-max) diff --git a/lisp/eshell/esh-cmd.el b/lisp/eshell/esh-cmd.el index 535e169bcb3..72c8a239ff3 100644 --- a/lisp/eshell/esh-cmd.el +++ b/lisp/eshell/esh-cmd.el @@ -284,7 +284,7 @@ command line.") (defvar eshell-command-arguments nil) (defvar eshell-in-pipeline-p nil "Internal Eshell variable, non-nil inside a pipeline. -Has the value 'first, 'last for the first/last commands in the pipeline, +Has the value `first', `last' for the first/last commands in the pipeline, otherwise t.") (defvar eshell-in-subcommand-p nil) (defvar eshell-last-arguments nil) @@ -670,8 +670,8 @@ For an external command, it means an exit code of 0." "Separate TERMS using SEPARATOR. If REVERSED is non-nil, the list of separated term groups will be returned in reverse order. If LAST-TERMS-SYM is a symbol, its value -will be set to a list of all the separator operators found (or '(list -nil)' if none)." +will be set to a list of all the separator operators found (or (nil) +if none)." (let ((sub-terms (list t)) (eshell-sep-terms (list t)) subchains) diff --git a/lisp/eshell/esh-util.el b/lisp/eshell/esh-util.el index f645702ac2b..e99a316889a 100644 --- a/lisp/eshell/esh-util.el +++ b/lisp/eshell/esh-util.el @@ -678,8 +678,8 @@ If NOSORT is non-nil, the list is not sorted--its order is unpredictable. (defun eshell-file-attributes (file &optional id-format) "Return the attributes of FILE, playing tricks if it's over ange-ftp. The optional argument ID-FORMAT specifies the preferred uid and -gid format. Valid values are 'string and 'integer, defaulting to -'integer. See `file-attributes'." +gid format. Valid values are `string' and `integer', defaulting to +`integer'. See `file-attributes'." (let* ((file (expand-file-name file)) entry) (if (string-equal (file-remote-p file 'method) "ftp") diff --git a/lisp/facemenu.el b/lisp/facemenu.el index 3d5894309df..885c15f4e5c 100644 --- a/lisp/facemenu.el +++ b/lisp/facemenu.el @@ -637,8 +637,8 @@ color. The function should accept a single argument, the color name." (defun list-colors-duplicates (&optional list) "Return a list of colors with grouped duplicate colors. If a color has no duplicates, then the element of the returned list -has the form '(COLOR-NAME). The element of the returned list with -duplicate colors has the form '(COLOR-NAME DUPLICATE-COLOR-NAME ...). +has the form (COLOR-NAME). The element of the returned list with +duplicate colors has the form (COLOR-NAME DUPLICATE-COLOR-NAME ...). This function uses the predicate `facemenu-color-equal' to compare color names. If the optional argument LIST is non-nil, it should be a list of colors to display. Otherwise, this function uses diff --git a/lisp/faces.el b/lisp/faces.el index 769f326efbe..ecd34a5280e 100644 --- a/lisp/faces.el +++ b/lisp/faces.el @@ -276,7 +276,7 @@ If FRAME is omitted or nil, use the selected frame." (defun face-list-p (face-or-list) "True if FACE-OR-LIST is a list of faces. Return nil if FACE-OR-LIST is a non-nil atom, or a cons cell whose car -is either 'foreground-color, 'background-color, or a keyword." +is either `foreground-color', `background-color', or a keyword." ;; The logic of merge_face_ref (xfaces.c) is recreated here. (and (listp face-or-list) (not (memq (car face-or-list) diff --git a/lisp/files.el b/lisp/files.el index fdda9b2a77e..fdc27ead450 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -787,8 +787,8 @@ return nil. PATH should be a list of directories to look in, like the lists in `exec-path' or `load-path'. If SUFFIXES is non-nil, it should be a list of suffixes to append to -file name when searching. If SUFFIXES is nil, it is equivalent to '(\"\"). -Use '(\"/\") to disable PATH search, but still try the suffixes in SUFFIXES. +file name when searching. If SUFFIXES is nil, it is equivalent to (\"\"). +Use (\"/\") to disable PATH search, but still try the suffixes in SUFFIXES. If non-nil, PREDICATE is used instead of `file-readable-p'. This function will normally skip directories, so if you want it to find @@ -6884,7 +6884,7 @@ as in \"og+rX-w\"." (defun read-file-modes (&optional prompt orig-file) "Read file modes in octal or symbolic notation and return its numeric value. -PROMPT is used as the prompt, default to `File modes (octal or symbolic): '. +PROMPT is used as the prompt, default to \"File modes (octal or symbolic): \". ORIG-FILE is the name of a file on whose mode bits to base returned permissions if what user types requests to add, remove, or set permissions based on existing mode bits, as in \"og+rX-w\"." diff --git a/lisp/filesets.el b/lisp/filesets.el index 28d0cd85582..ad3b4db4956 100644 --- a/lisp/filesets.el +++ b/lisp/filesets.el @@ -140,7 +140,7 @@ put \"(setq filesets-menu-ensure-use-cached VALUE)\" into your startup file -- before loading filesets.el. So, when should you think about setting this value to t? If filesets.el -is loaded before user customizations. Thus, if (require 'filesets) +is loaded before user customizations. Thus, if (require \\='filesets) precedes the `custom-set-variables' command or, for XEmacs, if init.el is loaded before custom.el, set this variable to t.") diff --git a/lisp/find-file.el b/lisp/find-file.el index 5c2c5064453..f6e6daf9ed1 100644 --- a/lisp/find-file.el +++ b/lisp/find-file.el @@ -222,7 +222,7 @@ may not exist. A typical format is - '(\".\" \"/usr/include\" \"$PROJECT/*/include\") + (\".\" \"/usr/include\" \"$PROJECT/*/include\") Environment variables can be inserted between slashes (`/'). They will be replaced by their definition. If a variable does diff --git a/lisp/frame.el b/lisp/frame.el index f02406541a1..2584d09fb01 100644 --- a/lisp/frame.el +++ b/lisp/frame.el @@ -68,7 +68,7 @@ handles the corresponding kind of display.") You can set this in your init file; for example, (setq initial-frame-alist - '((top . 1) (left . 1) (width . 80) (height . 55))) + \\='((top . 1) (left . 1) (width . 80) (height . 55))) Parameters specified here supersede the values given in `default-frame-alist'. @@ -103,7 +103,7 @@ initial minibuffer frame. You can set this in your init file; for example, (setq minibuffer-frame-alist - '((top . 1) (left . 1) (width . 80) (height . 2))) + \\='((top . 1) (left . 1) (width . 80) (height . 2))) It is not necessary to include (minibuffer . only); that is appended when the minibuffer frame is created." @@ -911,7 +911,7 @@ if you want Emacs to examine the brightness for you. If you change this without using customize, you should use `frame-set-background-mode' to update existing frames; -e.g. (mapc 'frame-set-background-mode (frame-list))." +e.g. (mapc \\='frame-set-background-mode (frame-list))." :group 'faces :set #'(lambda (var value) (set-default var value) diff --git a/lisp/gnus/gnus-mlspl.el b/lisp/gnus/gnus-mlspl.el index 37a5d6150db..cb95aac45e5 100644 --- a/lisp/gnus/gnus-mlspl.el +++ b/lisp/gnus/gnus-mlspl.el @@ -122,9 +122,9 @@ clauses will be generated. If CATCH-ALL is nil, no catch-all handling is performed, regardless of catch-all marks in group parameters. Otherwise, if there is no selected group whose SPLIT-REGEXP matches the empty string, nor is -there a selected group whose SPLIT-SPEC is 'catch-all, this fancy +there a selected group whose SPLIT-SPEC is `catch-all', this fancy split (say, a group name) will be appended to the returned SPLIT list, -as the last element of a '| SPLIT. +as the last element of a `|' SPLIT. For example, given the following group parameters: diff --git a/lisp/gnus/message.el b/lisp/gnus/message.el index 1b693d77983..a6c82824e4e 100644 --- a/lisp/gnus/message.el +++ b/lisp/gnus/message.el @@ -865,7 +865,7 @@ It may also be a function. For e.g., if you wish to set the envelope sender address so that bounces go to the right place or to deal with listserv's usage of that address, you -might set this variable to '(\"-f\" \"you@some.where\")." +might set this variable to (\"-f\" \"you@some.where\")." :group 'message-sending :link '(custom-manual "(message)Mail Variables") :type '(choice (function) @@ -1114,7 +1114,7 @@ Note: Many newsgroups frown upon nontraditional reply styles. You probably want to set this variable only for specific groups, e.g. using `gnus-posting-styles': - (eval (set (make-local-variable 'message-cite-reply-position) 'above))" + (eval (set (make-local-variable \\='message-cite-reply-position) \\='above))" :version "24.1" :type '(choice (const :tag "Reply inline" traditional) (const :tag "Reply above" above) diff --git a/lisp/gnus/mm-decode.el b/lisp/gnus/mm-decode.el index 327b0e6e86f..be56d2398af 100644 --- a/lisp/gnus/mm-decode.el +++ b/lisp/gnus/mm-decode.el @@ -393,7 +393,7 @@ enables you to choose manually one of two types those mails include." (defcustom mm-inline-large-images nil "If t, then all images fit in the buffer. -If 'resize, try to resize the images so they fit." +If `resize', try to resize the images so they fit." :type '(radio (const :tag "Inline large images as they are." t) (const :tag "Resize large images." resize) diff --git a/lisp/gnus/mm-util.el b/lisp/gnus/mm-util.el index ab9145f8b1c..24d3a9e749e 100644 --- a/lisp/gnus/mm-util.el +++ b/lisp/gnus/mm-util.el @@ -1074,7 +1074,7 @@ can be encoded using a single one of the corresponding coding systems. It treats `mm-coding-system-priorities' as the list of preferred coding systems; a useful example setting for this list in Western -Europe would be '(iso-8859-1 iso-8859-15 utf-8), which would default +Europe would be (iso-8859-1 iso-8859-15 utf-8), which would default to the very standard Latin 1 coding system, and only move to coding systems that are less supported as is necessary to encode the characters that exist in the buffer. diff --git a/lisp/hi-lock.el b/lisp/hi-lock.el index 89b1204ad11..5bab906ee99 100644 --- a/lisp/hi-lock.el +++ b/lisp/hi-lock.el @@ -332,7 +332,7 @@ which can be called interactively, are: (See `font-lock-keywords'.) They may be edited and re-loaded with \\[hi-lock-find-patterns], any valid `font-lock-keywords' form is acceptable. When a file is loaded the patterns are read if `hi-lock-file-patterns-policy' is - 'ask and the user responds y to the prompt, or if + `ask' and the user responds y to the prompt, or if `hi-lock-file-patterns-policy' is bound to a function and that function returns t. diff --git a/lisp/htmlfontify.el b/lisp/htmlfontify.el index 719cb50ac77..aed341c3713 100644 --- a/lisp/htmlfontify.el +++ b/lisp/htmlfontify.el @@ -260,10 +260,10 @@ These functions will be called with the HTML buffer as the current buffer." :type '(hook)) (defcustom hfy-default-face-def nil - "Fallback `defface' specification for the face 'default, used when + "Fallback `defface' specification for the face `default', used when `hfy-display-class' has been set (the normal htmlfontify way of extracting potentially non-current face information doesn't necessarily work for -'default).\n +`default').\n Example: I customize this to:\n \((t :background \"black\" :foreground \"white\" :family \"misc-fixed\"))" :group 'htmlfontify @@ -408,23 +408,23 @@ calculating a face's attributes. This is useful when, for example, you are running Emacs on a tty or in batch mode, and want htmlfontify to have access to the face spec you would use if you were connected to an X display.\n Some valid class specification elements are:\n - '(class color) - '(class grayscale) - '(background dark) - '(background light) - '(type x-toolkit) - '(type tty) - '(type motif) - '(type lucid) + (class color) + (class grayscale) + (background dark) + (background light) + (type x-toolkit) + (type tty) + (type motif) + (type lucid) Multiple values for a tag may be combined, to indicate that any one or more of these values in the specification key constitutes a match, eg:\n -'((class color grayscale) (type tty)) would match any of:\n - '((class color)) - '((class grayscale)) - '((class color grayscale)) - '((class color foo)) - '((type tty)) - '((type tty) (class color))\n +((class color grayscale) (type tty)) would match any of:\n + ((class color)) + ((class grayscale)) + ((class color grayscale)) + ((class color foo)) + ((type tty)) + ((type tty) (class color))\n and so on." :type '(alist :key-type (symbol) :value-type (symbol)) :group 'htmlfontify @@ -879,10 +879,10 @@ specify - this matches Emacs's behavior when deciding on which face attributes to use, to the best of my understanding).\n If CLASS is nil, then you just get whatever `face-attr-construct' returns, ie the current specification in effect for FACE.\n -*NOTE*: This function forces any face that is not 'default and which has -no :inherit property to inherit from 'default (this is because 'default +*NOTE*: This function forces any face that is not `default' and which has +no :inherit property to inherit from `default' (this is because `default' is magical in that Emacs's fonts behave as if they inherit implicitly from -'default, but no such behavior exists in HTML/CSS).\n +`default', but no such behavior exists in HTML/CSS).\n See also `hfy-display-class' for details of valid values for CLASS." (let ((face-spec (if class diff --git a/lisp/ibuffer.el b/lisp/ibuffer.el index 89477bd919f..5819f63c671 100644 --- a/lisp/ibuffer.el +++ b/lisp/ibuffer.el @@ -128,7 +128,7 @@ own!): Thus, if you wanted to use these two formats, the appropriate value for this variable would be - '((mark \" \" name) + \\='((mark \" \" name) (mark modified read-only (name 16 16 :left) (size 6 -1 :right))) diff --git a/lisp/ido.el b/lisp/ido.el index 6ad354c58f2..22025e2eb51 100644 --- a/lisp/ido.el +++ b/lisp/ido.el @@ -742,8 +742,8 @@ not provide the normal completion. To show the completions, use \\[ido-toggle-i (defcustom ido-enter-matching-directory 'only "Additional methods to enter sub-directory of first/only matching item. -If value is 'first, enter first matching sub-directory when typing a slash. -If value is 'only, typing a slash only enters the sub-directory if it is +If value is `first', enter first matching sub-directory when typing a slash. +If value is `only', typing a slash only enters the sub-directory if it is the only matching item. If value is t, automatically enter a sub-directory when it is the only matching item, even without typing a slash." @@ -755,7 +755,7 @@ matching item, even without typing a slash." (defcustom ido-create-new-buffer 'prompt "Specify whether a new buffer is created if no buffer matches substring. -Choices are 'always to create new buffers unconditionally, 'prompt to +Choices are `always' to create new buffers unconditionally, `prompt' to ask user whether to create buffer, or 'never to never create new buffer." :type '(choice (const always) (const prompt) @@ -1605,8 +1605,8 @@ With ARG, turn Ido mode on if arg is positive, off otherwise. Turning on Ido mode will remap (via a minor-mode keymap) the default keybindings for the `find-file' and `switch-to-buffer' families of commands to the Ido versions of these functions. -However, if ARG arg equals 'files, remap only commands for files, or -if it equals 'buffers, remap only commands for buffer switching. +However, if ARG arg equals `files', remap only commands for files, or +if it equals `buffers', remap only commands for buffer switching. This function also adds a hook to the minibuffer." (interactive "P") (setq ido-mode diff --git a/lisp/image-dired.el b/lisp/image-dired.el index c5efb338152..ae3921ccbad 100644 --- a/lisp/image-dired.el +++ b/lisp/image-dired.el @@ -1205,8 +1205,8 @@ comment." (defun image-dired-modify-mark-on-thumb-original-file (command) "Modify mark in dired buffer. -COMMAND is one of 'mark for marking file in dired, 'unmark for -unmarking file in dired or 'flag for flagging file for delete in +COMMAND is one of `mark' for marking file in dired, `unmark' for +unmarking file in dired or `flag' for flagging file for delete in dired." (let ((file-name (image-dired-original-file-name)) (dired-buf (image-dired-associated-dired-buffer))) diff --git a/lisp/image.el b/lisp/image.el index 295b79f161d..4ee22b580e6 100644 --- a/lisp/image.el +++ b/lisp/image.el @@ -154,7 +154,7 @@ compatibility with versions of Emacs that lack the variable (let* ((load-path (image-load-path-for-library \"mh-e\" \"mh-logo.xpm\")) (image-load-path (cons (car load-path) - (when (boundp 'image-load-path) + (when (boundp \\='image-load-path) image-load-path)))) (mh-tool-bar-folder-buttons-init))" (unless library (error "No library specified")) diff --git a/lisp/imenu.el b/lisp/imenu.el index 717ac633665..57db68626e1 100644 --- a/lisp/imenu.el +++ b/lisp/imenu.el @@ -509,7 +509,7 @@ If REVERSE is non-nil then the beginning is 100 and the end is 0." (defun imenu--split (list n) "Split LIST into sublists of max length N. -Example (imenu--split '(1 2 3 4 5 6 7 8) 3)-> '((1 2 3) (4 5 6) (7 8)) +Example (imenu--split \\='(1 2 3 4 5 6 7 8) 3) => ((1 2 3) (4 5 6) (7 8)) The returned list DOES NOT share structure with LIST." (let ((remain list) (result '()) diff --git a/lisp/indent.el b/lisp/indent.el index cba8f755f8f..cf3770f1f69 100644 --- a/lisp/indent.el +++ b/lisp/indent.el @@ -610,7 +610,7 @@ See also `indent-relative-maybe'." "List of tab stop positions used by `tab-to-tab-stop'. This should be nil, or a list of integers, ordered from smallest to largest. It implicitly extends to infinity through repetition of the last step. -For example, '(1 2 5) is equivalent to '(1 2 5 8 11 ...). If the list has +For example, (1 2 5) is equivalent to (1 2 5 8 11 ...). If the list has fewer than 2 elements, `tab-width' is used as the \"last step\". A value of nil means a tab stop every `tab-width' columns." :group 'indent diff --git a/lisp/mail/feedmail.el b/lisp/mail/feedmail.el index aec93db3fa6..bb93cff96bc 100644 --- a/lisp/mail/feedmail.el +++ b/lisp/mail/feedmail.el @@ -606,7 +606,7 @@ variables or other means, this option has no effect." May be t, in which case a default is computed (and you probably won't be happy with it). May be nil, in which case nothing in particular is done with respect to From: lines. By design, will not replace an -existing From: line, but you can achieve that with a fiddle-plex 'replace +existing From: line, but you can achieve that with a fiddle-plex `replace' action. If neither nil nor t, it may be a string, a fiddle-plex, or a function @@ -870,11 +870,11 @@ headers for specific addresses. May be t, in which case a \"To:\" header is added to the message with the stripped address as the header contents. The fiddle-plex operator -is 'supplement. +is `supplement'. May be a string, in which case the string is assumed to be the name of a message header field with the stripped address serving as the value. -The fiddle-plex operator is 'supplement. +The fiddle-plex operator is `supplement'. May be a function, in which case it is called with no arguments and is expected to return nil, t, a string, another function, or a fiddle-plex. @@ -891,7 +891,7 @@ If a list, each item is acted on in turn as described above. For example, - (setq feedmail-spray-address-fiddle-plex-list 'feedmail-spray-via-bbdb) + (setq feedmail-spray-address-fiddle-plex-list \\='feedmail-spray-via-bbdb) The idea of the example is that, during spray mode, as each message is about to be transmitted to an individual address, the function will be @@ -1383,7 +1383,7 @@ See documentation of `feedmail-mail-send-hook-splitter' for details." (defun feedmail-confirm-addresses-hook-example () "An example of a `feedmail-last-chance-hook'. It shows the simple addresses and gets a confirmation. Use as: - (setq feedmail-last-chance-hook 'feedmail-confirm-addresses-hook-example)." + (setq feedmail-last-chance-hook \\='feedmail-confirm-addresses-hook-example)." (save-window-excursion (display-buffer (set-buffer (get-buffer-create " F-C-A-H-E"))) (erase-buffer) @@ -2080,7 +2080,7 @@ backup file names and the like)." (defun feedmail-queue-reminder (&optional what-event) "Perform some kind of reminder activity about queued and draft messages. Called with an optional symbol argument which says what kind of event -is triggering the reminder activity. The default is 'on-demand, which +is triggering the reminder activity. The default is `on-demand', which is what you typically would use if you were putting this in your Emacs start-up or mail hook code. Other recognized values for WHAT-EVENT (these are passed internally by feedmail): diff --git a/lisp/mail/hashcash.el b/lisp/mail/hashcash.el index 70170654f67..1e57119f5a5 100644 --- a/lisp/mail/hashcash.el +++ b/lisp/mail/hashcash.el @@ -97,7 +97,7 @@ If this is not in your PATH, specify an absolute file name." (defcustom hashcash-extra-generate-parameters nil "A list of parameter strings passed to `hashcash-program' when minting. -For example, you may want to set this to '(\"-Z2\") to reduce header length." +For example, you may want to set this to (\"-Z2\") to reduce header length." :type '(repeat string) :group 'hashcash) diff --git a/lisp/mail/rfc2368.el b/lisp/mail/rfc2368.el index 50ff2cfb8ea..3cea39e1b2c 100644 --- a/lisp/mail/rfc2368.el +++ b/lisp/mail/rfc2368.el @@ -87,7 +87,7 @@ MAILTO-URL should be a RFC 2368 (mailto) compliant url. A cons cell w/ a key of `Body' is a special case and is considered a header for this purpose. The returned alist is intended for use w/ the `compose-mail' interface. -Note: make sure MAILTO-URL has been 'unhtmlized' (e.g. & -> &), before +Note: make sure MAILTO-URL has been \"unhtmlized\" (e.g., & -> &), before calling this function." (let ((case-fold-search t) prequery query headers-alist) diff --git a/lisp/mail/rmail.el b/lisp/mail/rmail.el index 8e38564b14a..1a211a3e9cb 100644 --- a/lisp/mail/rmail.el +++ b/lisp/mail/rmail.el @@ -98,7 +98,7 @@ its character representation and its display representation.") (defvar rmail-header-style 'normal "The current header display style choice, one of -'normal (selected headers) or 'full (all headers).") +`normal' (selected headers) or `full' (all headers).") (defvar rmail-mime-decoded nil "Non-nil if message has been processed by `rmail-show-mime-function'.") @@ -298,7 +298,7 @@ mail URLs as the source mailbox.") ;;;###autoload (defun rmail-movemail-variant-p (&rest variants) "Return t if the current movemail variant is any of VARIANTS. -Currently known variants are 'emacs and 'mailutils." +Currently known variants are `emacs' and `mailutils'." (when (not rmail-movemail-variant-in-use) ;; Autodetect (setq rmail-movemail-variant-in-use (rmail-autodetect))) diff --git a/lisp/mh-e/mh-e.el b/lisp/mh-e/mh-e.el index c757920ef29..85e64189fbd 100644 --- a/lisp/mh-e/mh-e.el +++ b/lisp/mh-e/mh-e.el @@ -872,7 +872,7 @@ variant." (defun mh-variant-p (&rest variants) "Return t if variant is any of VARIANTS. -Currently known variants are 'MH, 'nmh, and 'gnu-mh." +Currently known variants are `MH', `nmh', and `gnu-mh'." (let ((variant-in-use (cadr (assoc 'variant (assoc mh-variant-in-use (mh-variants)))))) (not (null (member variant-in-use variants))))) @@ -1435,7 +1435,7 @@ the \"Value Menu\". You can specify an alternate \"From:\" header field using the \"From Field\" menu item. You must include a valid email address. A standard format is \"First Last \". If you use an initial -with a period, then you must quote your name as in '\"First I. Last\" +with a period, then you must quote your name as in `\"First I. Last\" '. People usually list the name of the company where they work using the \"Organization Field\" menu item. Set any arbitrary header field and value in the \"Other Field\" menu item. @@ -1599,8 +1599,8 @@ other field matches. The handler functions are passed two or three arguments: the FIELD itself (for example, \"From\"), or one of the special -fields (for example, \":signature\"), and the ACTION 'remove or -'add. If the action is 'add, an additional argument +fields (for example, \":signature\"), and the ACTION `remove' or +`add'. If the action is `add', an additional argument containing the VALUE for the field is given." :type '(repeat (cons (string :tag "Field") function)) :group 'mh-identity diff --git a/lisp/mh-e/mh-identity.el b/lisp/mh-e/mh-identity.el index cdd92fe3307..2da3fa26b29 100644 --- a/lisp/mh-e/mh-identity.el +++ b/lisp/mh-e/mh-identity.el @@ -180,9 +180,9 @@ See `mh-identity-list'." ;;;###mh-autoload (defun mh-identity-handler-gpg-identity (field action &optional value) "Process header FIELD \":pgg-default-user-id\". -The ACTION is one of 'remove or 'add. If 'add, the VALUE is added. +The ACTION is one of `remove' or `add'. If `add', the VALUE is added. The buffer-local variable `mh-identity-pgg-default-user-id' is set to -VALUE when action 'add is selected." +VALUE when action `add' is selected." (cond ((or (equal action 'remove) (not value) @@ -194,7 +194,7 @@ VALUE when action 'add is selected." ;;;###mh-autoload (defun mh-identity-handler-signature (field action &optional value) "Process header FIELD \":signature\". -The ACTION is one of 'remove or 'add. If 'add, the VALUE is +The ACTION is one of `remove' or `add'. If `add', the VALUE is added." (cond ((equal action 'remove) @@ -225,7 +225,7 @@ added." ;;;###mh-autoload (defun mh-identity-handler-attribution-verb (field action &optional value) "Process header FIELD \":attribution-verb\". -The ACTION is one of 'remove or 'add. If 'add, the VALUE is +The ACTION is one of `remove' or `add'. If `add', the VALUE is added." (when (and (markerp mh-identity-attribution-verb-start) (markerp mh-identity-attribution-verb-end)) @@ -283,7 +283,7 @@ bottom of the header. If action is 'add, the VALUE is added." ;;;###mh-autoload (defun mh-identity-handler-top (field action &optional value) "Process header FIELD. -The ACTION is one of 'remove or 'add. If 'add, the VALUE is +The ACTION is one of `remove' or `add'. If `add', the VALUE is added. If the field wasn't present, it is added to the top of the header." (mh-identity-handler-default field action t value)) @@ -291,7 +291,7 @@ header." ;;;###mh-autoload (defun mh-identity-handler-bottom (field action &optional value) "Process header FIELD. -The ACTION is one of 'remove or 'add. If 'add, the VALUE is +The ACTION is one of `remove' or `add'. If `add', the VALUE is added. If the field wasn't present, it is added to the bottom of the header." (mh-identity-handler-default field action nil value)) diff --git a/lisp/mh-e/mh-seq.el b/lisp/mh-e/mh-seq.el index 259f60de2d5..13cf71f8a49 100644 --- a/lisp/mh-e/mh-seq.el +++ b/lisp/mh-e/mh-seq.el @@ -555,7 +555,7 @@ change." ;;;###mh-autoload (defun mh-valid-view-change-operation-p (op) "Check if the view change operation can be performed. -OP is one of 'widen and 'unthread." +OP is one of `widen' and `unthread'." (cond ((eq (car mh-view-ops) op) (pop mh-view-ops)) (t nil))) diff --git a/lisp/net/ange-ftp.el b/lisp/net/ange-ftp.el index 4f7fa3b8f39..7fbf7f3650f 100644 --- a/lisp/net/ange-ftp.el +++ b/lisp/net/ange-ftp.el @@ -3863,7 +3863,7 @@ If VERBOSE-P is non-nil, print progress report in the echo area. FILES is a list of files to copy in the form (from-file to-file ok-if-already-exists keep-date) E.g., - (ange-ftp-copy-files-async t nil t '((\"a\" \"b\" t t) (\"c\" \"d\" t t)))" + (ange-ftp-copy-files-async t nil t \\='((\"a\" \"b\" t t) (\"c\" \"d\" t t)))" (unless okay-p (error "%s: %s" 'ange-ftp-copy-files-async line)) (if files (let* ((ff (car files)) diff --git a/lisp/net/eww.el b/lisp/net/eww.el index 5748e88bbca..cd659d0840e 100644 --- a/lisp/net/eww.el +++ b/lisp/net/eww.el @@ -93,7 +93,7 @@ desktop. Otherwise, such entries will be retained." (defcustom eww-restore-desktop nil "How to restore EWW buffers on `desktop-restore'. -If t or 'auto, the buffers will be reloaded automatically. +If t or `auto', the buffers will be reloaded automatically. If nil, buffers will require manual reload, and will contain the text specified in `eww-restore-reload-prompt' instead of the actual Web page contents." diff --git a/lisp/net/imap.el b/lisp/net/imap.el index b559ff65908..33eb3e43836 100644 --- a/lisp/net/imap.el +++ b/lisp/net/imap.el @@ -453,7 +453,7 @@ second the status (OK, NO, BAD etc) of the command.") When non-nil, use an alternative UIDS form. Enabling appears to be required for some servers (e.g., Microsoft Exchange 2007) -which otherwise would trigger a response 'BAD The specified +which otherwise would trigger a response `BAD The specified message set is invalid.'. We don't unconditionally use this form, since this is said to be significantly inefficient. @@ -1564,8 +1564,8 @@ returned, if ITEMS is a symbol only its value is returned." (defun imap-mailbox-status-asynch (mailbox items &optional buffer) "Send status item requests ITEMS on MAILBOX to server in BUFFER. ITEMS can be a symbol or a list of symbols, valid symbols are one of -the STATUS data items -- i.e. 'messages, 'recent, 'uidnext, 'uidvalidity -or 'unseen. The IMAP command tag is returned." +the STATUS data items -- i.e., `messages', `recent', `uidnext', `uidvalidity' +or `unseen'. The IMAP command tag is returned." (with-current-buffer (or buffer (current-buffer)) (imap-send-command (list "STATUS \"" (imap-utf7-encode mailbox) diff --git a/lisp/net/mairix.el b/lisp/net/mairix.el index a73b4dfa921..997e47b1ec2 100644 --- a/lisp/net/mairix.el +++ b/lisp/net/mairix.el @@ -211,7 +211,7 @@ nil for disabling this).") (defvar mairix-widget-other '(threads flags) "Other editable mairix commands when using customization widgets. -Currently there are 'threads and 'flags.") +Currently there are `threads' and `flags'.") ;;;; Internal variables diff --git a/lisp/net/newst-backend.el b/lisp/net/newst-backend.el index 072fd015b60..2bec11ee3a3 100644 --- a/lisp/net/newst-backend.el +++ b/lisp/net/newst-backend.el @@ -502,8 +502,8 @@ This is a list of the form where LABEL is a symbol. TITLE, DESCRIPTION, and LINK are strings. TIME is a time value as returned by `current-time'. -AGE is a symbol: 'new, 'old, 'immortal, and 'obsolete denote -ordinary news items, whereas 'feed denotes an item which is not a +AGE is a symbol: `new', `old', `immortal', and `obsolete' denote +ordinary news items, whereas `feed' denotes an item which is not a headline but describes the feed itself. INDEX denotes the original position of the item -- used for restoring the original order. PREFORMATTED-CONTENTS and PREFORMATTED-TITLE hold the @@ -1987,7 +1987,7 @@ Renders the HTML code in the region POS1 to POS2 using htmlr." (defun newsticker--cache-replace-age (data feed old-age new-age) "Mark all items in DATA in FEED which carry age OLD-AGE with NEW-AGE. -If FEED is 'any it applies to all feeds. If OLD-AGE is 'any, +If FEED is `any' it applies to all feeds. If OLD-AGE is `any', all marks are replaced by NEW-AGE. Removes all pre-formatted contents." (mapc (lambda (a-feed) (when (or (eq feed 'any) @@ -2038,7 +2038,7 @@ The properties which are checked are TITLE, DESC, LINK, AGE, and GUID. In general all properties must match in order to return a certain item, except for the following cases. -If AGE equals 'feed the TITLE, DESCription and LINK do not +If AGE equals `feed' the TITLE, DESCription and LINK do not matter. If DESC is nil it is ignored as well. If `newsticker-desc-comp-max' is non-nil, only the first `newsticker-desc-comp-max' characters of DESC are taken into @@ -2143,7 +2143,7 @@ which the item got." (defun newsticker--cache-remove (data feed-symbol age) "Remove all entries from DATA in the feed FEED-SYMBOL with AGE. -FEED-SYMBOL may be 'any. Entries from old feeds, which are no longer in +FEED-SYMBOL may be `any'. Entries from old feeds, which are no longer in `newsticker-url-list' or `newsticker-url-list-defaults', are removed as well." (let* ((pos data) diff --git a/lisp/net/newst-plainview.el b/lisp/net/newst-plainview.el index 0cb5d8c6a2f..b4e569078a9 100644 --- a/lisp/net/newst-plainview.el +++ b/lisp/net/newst-plainview.el @@ -228,7 +228,7 @@ Each function is called after one of `newsticker-next-item', `newsticker-next-new-item', `newsticker-previous-item', `newsticker-previous-new-item' has been called. -The default value 'newsticker--buffer-make-item-completely-visible +The default value `newsticker--buffer-make-item-completely-visible' assures that the current item is always completely visible." :type 'hook :options '(newsticker--buffer-make-item-completely-visible) @@ -240,7 +240,7 @@ assures that the current item is always completely visible." Each function is called after one of `newsticker-next-feed', and `newsticker-previous-feed' has been called. -The default value 'newsticker--buffer-make-item-completely-visible +The default value `newsticker--buffer-make-item-completely-visible' assures that the current feed is completely visible." :type 'hook :options '(newsticker--buffer-make-item-completely-visible) @@ -251,7 +251,7 @@ assures that the current feed is completely visible." "List of functions run after the newsticker buffer has been updated. Each function is called after `newsticker-buffer-update' has been called. -The default value `\\='newsticker-w3m-show-inline-images' loads inline +The default value `newsticker-w3m-show-inline-images' loads inline images." :type 'hook :group 'newsticker-plainview-hooks) @@ -263,7 +263,7 @@ Each function is called after `newsticker-toggle-auto-narrow-to-feed' or `newsticker-toggle-auto-narrow-to-item' has been called. -The default value `\\='newsticker-w3m-show-inline-images' loads inline +The default value `newsticker-w3m-show-inline-images' loads inline images." :type 'hook :group 'newsticker-plainview-hooks) @@ -1524,8 +1524,8 @@ Scans the buffer between START and END." (defun newsticker--buffer-set-invisibility (start end) "Add invisibility properties according to nt-type property. -Scans the buffer between START and END. Sets the 'invisible -property to '(- )." +Scans the buffer between START and END. Sets the `invisible' +property to (- )." (save-excursion ;; reset invisibility settings (put-text-property start end 'invisible nil) diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el index d58f3ebd4ea..3539dcf91f4 100644 --- a/lisp/net/rcirc.el +++ b/lisp/net/rcirc.el @@ -320,7 +320,7 @@ Called with 5 arguments, PROCESS, SENDER, RESPONSE, TARGET and TEXT." (defcustom rcirc-decode-coding-system 'utf-8 "Coding system used to decode incoming irc messages. -Set to 'undecided if you want the encoding of the incoming +Set to `undecided' if you want the encoding of the incoming messages autodetected." :type 'coding-system :group 'rcirc) diff --git a/lisp/net/soap-client.el b/lisp/net/soap-client.el index 71d42459974..790084a4862 100644 --- a/lisp/net/soap-client.el +++ b/lisp/net/soap-client.el @@ -58,7 +58,7 @@ (require 'mm-decode) (defsubst soap-warning (message &rest args) - "Display a warning MESSAGE with ARGS, using the 'soap-client warning type." + "Display a warning MESSAGE with ARGS, using the `soap-client' warning type." ;; Do not use #'format-message, to support older Emacs versions. (display-warning 'soap-client (apply #'format message args) :warning)) @@ -562,7 +562,7 @@ fractional seconds, and the DST (daylight savings time) field is replaced with DATATYPE, a symbol representing the XSD primitive datatype. This symbol can be used to determine which fields apply and which don't when it's not already clear from context. -For example a datatype of 'time means the year, month and day +For example a datatype of `time' means the year, month and day fields should be ignored. This function will throw an error if DATE-TIME-STRING represents diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index 42a9e3d6710..40c3f368a9f 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -694,8 +694,8 @@ Useful for \"rsync\" like methods.") It can have the following values: - 'ftp -- Ange-FTP respective EFS like syntax (GNU Emacs default) - 'sep -- Syntax as defined for XEmacs." + `ftp' -- Ange-FTP respective EFS like syntax (GNU Emacs default) + `sep' -- Syntax as defined for XEmacs." :group 'tramp :version "24.4" :type `(choice (const :tag ,(if (featurep 'xemacs) "EFS" "Ange-FTP") ftp) diff --git a/lisp/org/ob-core.el b/lisp/org/ob-core.el index 11cd2530dd7..271a015323c 100644 --- a/lisp/org/ob-core.el +++ b/lisp/org/ob-core.el @@ -1402,7 +1402,7 @@ specified in the properties of the current outline entry." ALTS is a cons of two character options where each option may be either the numeric code of a single character or a list of character alternatives. For example to split on balanced -instances of \"[ \t]:\" set ALTS to '((32 9) . 58)." +instances of \"[ \t]:\" set ALTS to ((32 9) . 58)." (let* ((matches (lambda (ch spec) (if (listp spec) (member ch spec) (equal spec ch)))) (matched (lambda (ch last) (if (consp alts) @@ -1511,7 +1511,7 @@ shown below. ;; row and column names (defun org-babel-del-hlines (table) - "Remove all 'hlines from TABLE." + "Remove all `hline's from TABLE." (remove 'hline table)) (defun org-babel-get-colnames (table) diff --git a/lisp/org/ob-exp.el b/lisp/org/ob-exp.el index 92006f81756..58bd1ec7758 100644 --- a/lisp/org/ob-exp.el +++ b/lisp/org/ob-exp.el @@ -53,7 +53,7 @@ (defcustom org-export-babel-evaluate t "Switch controlling code evaluation during export. When set to nil no code will be evaluated as part of the export -process. When set to 'inline-only, only inline code blocks will +process. When set to `inline-only', only inline code blocks will be executed." :group 'org-babel :version "24.1" diff --git a/lisp/org/ob-table.el b/lisp/org/ob-table.el index 1f381dbe570..47a538cbd99 100644 --- a/lisp/org/ob-table.el +++ b/lisp/org/ob-table.el @@ -67,7 +67,7 @@ element list, whose first element is the name of the variable and second element is a string of its value. The following call to `org-sbe' would be equivalent to the following source code block. - (org-sbe 'source-block (n $2) (m 3)) + (org-sbe \\='source-block (n $2) (m 3)) #+begin_src emacs-lisp :var results=source-block(n=val_at_col_2, m=3) :results silent results @@ -84,7 +84,7 @@ the header argument which can then be passed before all variables as shown in the example below. | 1 | 2 | :file nothing.png | nothing.png | -#+TBLFM: @1$4='(org-sbe test-sbe $3 (x $1) (y $2))" +#+TBLFM: @1$4=\\='(org-sbe test-sbe $3 (x $1) (y $2))" (declare (debug (form form))) (let* ((header-args (if (stringp (car variables)) (car variables) "")) (variables (if (stringp (car variables)) (cdr variables) variables))) diff --git a/lisp/org/org-agenda.el b/lisp/org/org-agenda.el index 0b3be562489..4e42004d97d 100644 --- a/lisp/org/org-agenda.el +++ b/lisp/org/org-agenda.el @@ -7085,8 +7085,8 @@ their type." ;;;###autoload (defun org-agenda-set-restriction-lock (&optional type) "Set restriction lock for agenda, to current subtree or file. -Restriction will be the file if TYPE is `file', or if type is the -universal prefix '(4), or if the cursor is before the first headline +Restriction will be the file if TYPE is `file', or if TYPE is the +universal prefix `(4)', or if the cursor is before the first headline in the file. Otherwise, restriction will be to the current subtree." (interactive "P") (and (equal type '(4)) (setq type 'file)) diff --git a/lisp/org/org-faces.el b/lisp/org/org-faces.el index 46936f4b66f..1b46b80eb0a 100644 --- a/lisp/org/org-faces.el +++ b/lisp/org/org-faces.el @@ -666,7 +666,7 @@ belong to the weekend." (0.0 . default)) "Faces for showing deadlines in the agenda. This is a list of cons cells. The cdr of each cell is a face to be used, -and it can also just be like '(:foreground \"yellow\"). +and it can also just be like (:foreground \"yellow\"). Each car is a fraction of the head-warning time that must have passed for this the face in the cdr to be used for display. The numbers must be given in descending order. The head-warning time is normally taken diff --git a/lisp/org/org-list.el b/lisp/org/org-list.el index c8266500fe3..12d4db39b65 100644 --- a/lisp/org/org-list.el +++ b/lisp/org/org-list.el @@ -174,7 +174,7 @@ to the bullet that should be used when this item is demoted. For example, (setq org-list-demote-modify-bullet - '((\"+\" . \"-\") (\"-\" . \"+\") (\"*\" . \"+\"))) + \\='((\"+\" . \"-\") (\"-\" . \"+\") (\"*\" . \"+\"))) will make diff --git a/lisp/org/org-macs.el b/lisp/org/org-macs.el index ea8e7b532aa..0b10f55247f 100644 --- a/lisp/org/org-macs.el +++ b/lisp/org/org-macs.el @@ -137,7 +137,7 @@ Otherwise return nil." ;; FIXME: Slated for removal. Current Org mode does not support Emacs < 22 (defmacro org-maybe-intangible (props) - "Add '(intangible t) to PROPS if Emacs version is earlier than Emacs 22. + "Add (intangible t) to PROPS if Emacs version is earlier than Emacs 22. In Emacs 21, invisible text is not avoided by the command loop, so the intangible property is needed to make sure point skips this text. In Emacs 22, this is not necessary. The intangible text property has diff --git a/lisp/org/org.el b/lisp/org/org.el index 7a6d6cc1b3f..957a7d029ec 100644 --- a/lisp/org/org.el +++ b/lisp/org/org.el @@ -7094,7 +7094,7 @@ open and agenda-wise Org files." (org-flag-drawer t)))))) (defun org-cycle-hide-inline-tasks (state) - "Re-hide inline tasks when switching to 'contents or 'children + "Re-hide inline tasks when switching to `contents' or `children' visibility state." (case state (contents @@ -7323,8 +7323,8 @@ returns to the original buffer in which the visibility is still unchanged. After RET it will also jump to the location selected in the indirect buffer and expose the headline hierarchy above. -With a prefix argument, use the alternative interface: e.g. if -`org-goto-interface' is 'outline use 'outline-path-completion." +With a prefix argument, use the alternative interface: e.g., if +`org-goto-interface' is `outline' use `outline-path-completion'." (interactive "P") (org-goto-map) (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level)))) diff --git a/lisp/printing.el b/lisp/printing.el index ae0f3fdbc67..b02b10a6fb4 100644 --- a/lisp/printing.el +++ b/lisp/printing.el @@ -2929,7 +2929,7 @@ INHERITS Specify the inheritance for SYMBOL group. It's a symbol name Let's see an example to illustrate the inheritance mechanism: (setq pr-setting-database - '((no-duplex ; setting symbol name + \\='((no-duplex ; setting symbol name nil ; inherits nil nil ; local kill-local (pr-file-duplex . nil) ; settings @@ -2979,9 +2979,9 @@ SETTING It's a cons like: This setting is ignored if VARIABLE is equal to keyword `inherits-from:'. Examples: - '(ps-landscape-mode . nil) - '(ps-spool-duplex . t) - '(pr-gs-device . (my-gs-device t))" + (ps-landscape-mode . nil) + (ps-spool-duplex . t) + (pr-gs-device . (my-gs-device t))" :type '(repeat (list :tag "" diff --git a/lisp/proced.el b/lisp/proced.el index 502a90e2dc9..5bd53e47db5 100644 --- a/lisp/proced.el +++ b/lisp/proced.el @@ -159,15 +159,15 @@ argument, the value of the attribute. The value nil means take as is. If JUSTIFY is an integer, its modulus gives the width of the attribute values formatted with FORMAT. If JUSTIFY is positive, NAME appears -right-justified, otherwise it appears left-justified. If JUSTIFY is 'left -or 'right, the field width is calculated from all field values in the listing. -If JUSTIFY is 'left, the field values are formatted left-justified and +right-justified, otherwise it appears left-justified. If JUSTIFY is `left' +or `right', the field width is calculated from all field values in the listing. +If JUSTIFY is `left', the field values are formatted left-justified and right-justified otherwise. PREDICATE is the predicate for sorting and filtering the process listing based on attribute KEY. PREDICATE takes two arguments P1 and P2, the corresponding attribute values of two processes. PREDICATE should -return 'equal if P1 has same rank like P2. Any other non-nil value says +return `equal' if P1 has same rank like P2. Any other non-nil value says that P1 is \"less than\" P2, or nil if not. If PREDICATE is nil the attribute cannot be sorted. @@ -178,7 +178,7 @@ SORT-SCHEME is a list (KEY1 KEY2 ...) defining a hierarchy of rules for sorting the process listing. KEY1, KEY2, ... are KEYs appearing as cars of `proced-grammar-alist'. First the PREDICATE of KEY1 is evaluated. If it yields non-equal, it defines the sort order for the corresponding -processes. If it evaluates to 'equal the PREDICATE of KEY2 is evaluated, etc. +processes. If it evaluates to `equal' the PREDICATE of KEY2 is evaluated, etc. REFINER can be a list of flags (LESS-B EQUAL-B LARGER-B) used by the command `proced-refine' (see there) to refine the listing based on attribute KEY. @@ -186,7 +186,7 @@ This command compares the value of attribute KEY of every process with the value of attribute KEY of the process at the position of point using PREDICATE. If PREDICATE yields non-nil, the process is accepted if LESS-B is non-nil. -If PREDICATE yields 'equal, the process is accepted if EQUAL-B is non-nil. +If PREDICATE yields `equal', the process is accepted if EQUAL-B is non-nil. If PREDICATE yields nil, the process is accepted if LARGER-B is non-nil. REFINER can also be a list (FUNCTION HELP-ECHO). @@ -1251,9 +1251,9 @@ When called interactively, an empty string means nil, i.e., no sorting. Prefix ARG controls sort order: - If prefix ARG is positive (negative), sort in ascending (descending) order. -- If ARG is nil or 'no-arg and SCHEME is equal to the previous sorting scheme, +- If ARG is nil or `no-arg' and SCHEME is equal to the previous sorting scheme, reverse the sorting order. -- If ARG is nil or 'no-arg and SCHEME differs from the previous sorting scheme, +- If ARG is nil or `no-arg' and SCHEME differs from the previous sorting scheme, adopt the sorting order defined for SCHEME in `proced-grammar-alist'. Set variable `proced-sort' to SCHEME. The current sort scheme is displayed diff --git a/lisp/progmodes/cc-mode.el b/lisp/progmodes/cc-mode.el index a46ee15ed5e..37cae099635 100644 --- a/lisp/progmodes/cc-mode.el +++ b/lisp/progmodes/cc-mode.el @@ -479,7 +479,7 @@ preferably use the `c-mode-menu' language constant directly." and the line breaking/filling code. Intended to be used by other packages that embed CC Mode. -MODE is the CC Mode flavor to set up, e.g. 'c-mode or 'java-mode. +MODE is the CC Mode flavor to set up, e.g. `c-mode' or `java-mode'. DEFAULT-STYLE tells which indentation style to install. It has the same format as `c-default-style'. @@ -647,7 +647,7 @@ In addition to the work done by `c-basic-common-init' and customary in CC Mode modes but which aren't strictly necessary for CC Mode to operate correctly. -MODE is the symbol for the mode to initialize, like 'c-mode. See +MODE is the symbol for the mode to initialize, like `c-mode'. See `c-basic-common-init' for details. It's only optional to be compatible with old code; callers should always specify it." diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index 9e2d625a4d4..d9b4b6984ff 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el @@ -951,7 +951,7 @@ from a different message." (defvar compilation--previous-directory-cache nil "A pair (POS . RES) caching the result of previous directory search. Basically, this pair says that calling - (previous-single-property-change POS 'compilation-directory) + (previous-single-property-change POS \\='compilation-directory) returned RES, i.e. there is no change of `compilation-directory' between POS and RES.") (make-variable-buffer-local 'compilation--previous-directory-cache) @@ -967,7 +967,7 @@ POS and RES.") (t (setq compilation--previous-directory-cache nil)))) (defun compilation--previous-directory (pos) - "Like (previous-single-property-change POS 'compilation-directory), but faster." + "Like (previous-single-property-change POS \\='compilation-directory), but faster." ;; This avoids an N² behavior when there's no/few compilation-directory ;; entries, in which case each call to previous-single-property-change ;; ends up having to walk very far back to find the last change. diff --git a/lisp/progmodes/cpp.el b/lisp/progmodes/cpp.el index 3cf17f48b5f..faa917a87a7 100644 --- a/lisp/progmodes/cpp.el +++ b/lisp/progmodes/cpp.el @@ -664,7 +664,7 @@ otherwise make them unwritable." (defun cpp-edit-write (symbol branch) "Set which branches of SYMBOL should be writable to BRANCH. -BRANCH should be either nil (false branch), t (true branch) or 'both." +BRANCH should be either nil (false branch), t (true branch) or `both'." (interactive (list (cpp-choose-symbol) (cpp-choose-branch))) (setcar (nthcdr 3 (cpp-edit-list-entry-get-or-create symbol)) branch) (cpp-edit-reset)) diff --git a/lisp/progmodes/f90.el b/lisp/progmodes/f90.el index 0e333f1f7ed..324efb0e1bb 100644 --- a/lisp/progmodes/f90.el +++ b/lisp/progmodes/f90.el @@ -295,7 +295,7 @@ the constant `f90-no-break-re' ensures that such tokens are not split." (defcustom f90-auto-keyword-case nil "Automatic case conversion of keywords. -The options are 'downcase-word, 'upcase-word, 'capitalize-word and nil." +The options are `downcase-word', `upcase-word', `capitalize-word' and nil." :type '(choice (const downcase-word) (const upcase-word) (const capitalize-word) (const nil)) :safe (lambda (value) (memq value '(downcase-word @@ -2330,7 +2330,7 @@ Any other key combination is executed normally." ;; Change the keywords according to argument. (defun f90-change-keywords (change-word &optional beg end) "Change the case of F90 keywords in the region (if specified) or buffer. -CHANGE-WORD should be one of 'upcase-word, 'downcase-word, 'capitalize-word." +CHANGE-WORD should be one of `upcase-word', `downcase-word', `capitalize-word'." (save-excursion (setq beg (or beg (point-min)) end (or end (point-max))) diff --git a/lisp/progmodes/flymake.el b/lisp/progmodes/flymake.el index 3adadd1386e..882ac064b82 100644 --- a/lisp/progmodes/flymake.el +++ b/lisp/progmodes/flymake.el @@ -989,7 +989,7 @@ For the format of LINE-ERR-INFO, see `flymake-ler-make-ler'." (funcall flymake-get-project-include-dirs-function basedir)) (defun flymake-get-system-include-dirs () - "System include dirs - from the 'INCLUDE' env setting." + "System include dirs - from the `INCLUDE' env setting." (let* ((includes (getenv "INCLUDE"))) (if includes (split-string includes path-separator t) nil))) diff --git a/lisp/progmodes/fortran.el b/lisp/progmodes/fortran.el index ef470055065..33fe4b37cf8 100644 --- a/lisp/progmodes/fortran.el +++ b/lisp/progmodes/fortran.el @@ -1258,7 +1258,7 @@ Auto-indent does not happen if a numeric ARG is used." (defun fortran-previous-statement () "Move point to beginning of the previous Fortran statement. -Returns 'first-statement if that statement is the first +Returns `first-statement' if that statement is the first non-comment Fortran statement in the file, and nil otherwise. Directive lines are treated as comments." (interactive) @@ -1290,7 +1290,7 @@ Directive lines are treated as comments." (defun fortran-next-statement () "Move point to beginning of the next Fortran statement. -Returns 'last-statement if that statement is the last +Returns `last-statement' if that statement is the last non-comment Fortran statement in the file, and nil otherwise. Directive lines are treated as comments." (interactive) diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index 4bee7c1dfa2..16f82ccb47f 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -1630,7 +1630,7 @@ this trigger is subscribed to `gdb-buf-publisher' and called with (make-comint-in-buffer "gdb-inferior" (current-buffer) nil)) (defcustom gdb-display-io-nopopup nil - "When non-nil, and the 'gdb-inferior-io buffer is buried, don't pop it up." + "When non-nil, and the `gdb-inferior-io' buffer is buried, don't pop it up." :type 'boolean :group 'gdb :version "25.1") @@ -2788,7 +2788,7 @@ buffer with `gdb-bind-function-to-buffer'. If SIGNAL-LIST is non-nil, GDB-COMMAND is sent only when the defined trigger is called with an argument from SIGNAL-LIST. It's not recommended to define triggers with empty SIGNAL-LIST. -Normally triggers should respond at least to 'update signal. +Normally triggers should respond at least to the `update' signal. Normally the trigger defined by this command must be called from the buffer where HANDLER-NAME must work. This should be done so @@ -3252,7 +3252,7 @@ corresponding to the mode line clicked." "Define a NAME command which will act upon thread on the current line. CUSTOM-DEFUN may use locally bound `thread' variable, which will -be the value of 'gdb-thread property of the current line. +be the value of `gdb-thread' property of the current line. If `gdb-thread' is nil, error is signaled." `(defun ,name (&optional event) ,(when doc doc) diff --git a/lisp/progmodes/gud.el b/lisp/progmodes/gud.el index 1284ef2857a..024547cc487 100644 --- a/lisp/progmodes/gud.el +++ b/lisp/progmodes/gud.el @@ -3080,7 +3080,7 @@ the character after the end of the expr." "Scan from SPAN-START to SPAN-END for punctuation characters. If `->' is found, return `?.'. If `.' is found, return `?.'. If any other punctuation is found, return `??'. -If no punctuation is found, return `? '." +If no punctuation is found, return `?\\s'." (let ((result ?\s) (syntax)) (while (< span-start span-end) diff --git a/lisp/progmodes/hideif.el b/lisp/progmodes/hideif.el index e0d25c4439d..71646d312c4 100644 --- a/lisp/progmodes/hideif.el +++ b/lisp/progmodes/hideif.el @@ -653,7 +653,7 @@ that form should be displayed.") (stringp id)))) (defun hif-define-operator (tokens) - "`Upgrade' hif-define xxx to '(hif-define xxx)' so it won't be substituted." + "\"Upgrade\" hif-define XXX to `(hif-define XXX)' so it won't be substituted." (let ((result nil) (tok nil)) (while (setq tok (pop tokens)) @@ -766,7 +766,7 @@ macros to prevent self-reference." (error "Error: unexpected token: %s" hif-token))))) (defun hif-exprlist () - "Parse an exprlist: expr { ',' expr}." + "Parse an exprlist: expr { `,' expr}." (let ((result (hif-expr))) (if (eq hif-token 'hif-comma) (let ((temp (list result))) @@ -780,7 +780,7 @@ macros to prevent self-reference." (defun hif-expr () "Parse an expression as found in #if. -expr : or-expr | or-expr '?' expr ':' expr." +expr : or-expr | or-expr `?' expr `:' expr." (let ((result (hif-or-expr)) middle) (while (eq hif-token 'hif-conditional) @@ -794,7 +794,7 @@ expr : or-expr | or-expr '?' expr ':' expr." result)) (defun hif-or-expr () - "Parse an or-expr : and-expr | or-expr '||' and-expr." + "Parse an or-expr : and-expr | or-expr `||' and-expr." (let ((result (hif-and-expr))) (while (eq hif-token 'hif-or) (hif-nexttoken) @@ -802,7 +802,7 @@ expr : or-expr | or-expr '?' expr ':' expr." result)) (defun hif-and-expr () - "Parse an and-expr : logior-expr | and-expr '&&' logior-expr." + "Parse an and-expr : logior-expr | and-expr `&&' logior-expr." (let ((result (hif-logior-expr))) (while (eq hif-token 'hif-and) (hif-nexttoken) @@ -810,7 +810,7 @@ expr : or-expr | or-expr '?' expr ':' expr." result)) (defun hif-logior-expr () - "Parse a logor-expr : logxor-expr | logor-expr '|' logxor-expr." + "Parse a logor-expr : logxor-expr | logor-expr `|' logxor-expr." (let ((result (hif-logxor-expr))) (while (eq hif-token 'hif-logior) (hif-nexttoken) @@ -818,7 +818,7 @@ expr : or-expr | or-expr '?' expr ':' expr." result)) (defun hif-logxor-expr () - "Parse a logxor-expr : logand-expr | logxor-expr '^' logand-expr." + "Parse a logxor-expr : logand-expr | logxor-expr `^' logand-expr." (let ((result (hif-logand-expr))) (while (eq hif-token 'hif-logxor) (hif-nexttoken) @@ -826,7 +826,7 @@ expr : or-expr | or-expr '?' expr ':' expr." result)) (defun hif-logand-expr () - "Parse a logand-expr : eq-expr | logand-expr '&' eq-expr." + "Parse a logand-expr : eq-expr | logand-expr `&' eq-expr." (let ((result (hif-eq-expr))) (while (eq hif-token 'hif-logand) (hif-nexttoken) @@ -866,7 +866,7 @@ expr : or-expr | or-expr '?' expr ':' expr." (defun hif-math () "Parse an expression with + or -. - math : muldiv | math '+|-' muldiv." + math : muldiv | math `+'|`-' muldiv." (let ((result (hif-muldiv-expr)) (math-op nil)) (while (memq hif-token '(hif-plus hif-minus)) @@ -877,7 +877,7 @@ expr : or-expr | or-expr '?' expr ':' expr." (defun hif-muldiv-expr () "Parse an expression with *,/,%. - muldiv : factor | muldiv '*|/|%' factor." + muldiv : factor | muldiv `*'|`/'|`%' factor." (let ((result (hif-factor)) (math-op nil)) (while (memq hif-token '(hif-multiply hif-divide hif-modulo)) @@ -888,8 +888,8 @@ expr : or-expr | or-expr '?' expr ':' expr." (defun hif-factor () "Parse a factor. -factor : '!' factor | '~' factor | '(' expr ')' | 'defined(' id ')' | - 'id(parmlist)' | strings | id." +factor : `!' factor | `~' factor | `(' expr `)' | `defined(' id `)' | + id `(' parmlist `)' | strings | id." (cond ((eq hif-token 'hif-not) (hif-nexttoken) @@ -999,9 +999,9 @@ This macro cannot be evaluated alone without parameters input." (defun hif-token-concat (a b) "Concatenate two tokens into a longer token. Currently support only simple token concatenation. Also support weird (but -valid) token concatenation like '>' ## '>' becomes '>>'. Here we take care only +valid) token concatenation like `>' ## `>' becomes `>>'. Here we take care only those that can be evaluated during preprocessing time and ignore all those that -can only be evaluated at C(++) runtime (like '++', '--' and '+='...)." +can only be evaluated at C(++) runtime (like `++', `--' and `+='...)." (if (or (memq a hif-valid-token-list) (memq b hif-valid-token-list)) (let* ((ra (car (rassq a hif-token-alist))) @@ -1632,8 +1632,8 @@ not be expanded." result)))) (defun hif-parse-macro-arglist (str) - "Parse argument list formatted as '( arg1 [ , argn] [...] )'. -The '...' is also included. Return a list of the arguments, if '...' exists the + "Parse argument list formatted as `( arg1 [ , argn] [...] )'. +The `...' is also included. Return a list of the arguments, if `...' exists the first arg will be `hif-etc'." (let* ((hif-simple-token-only nil) ; Dynamic binding var for `hif-tokenize' (tokenlist diff --git a/lisp/progmodes/hideshow.el b/lisp/progmodes/hideshow.el index dba497b1f41..ebc5e2404c8 100644 --- a/lisp/progmodes/hideshow.el +++ b/lisp/progmodes/hideshow.el @@ -439,9 +439,9 @@ See `hs-c-like-adjust-block-beginning' for an example of using this.") You can display this in the mode line by adding the symbol `hs-headline' to the variable `mode-line-format'. For example, - (unless (memq 'hs-headline mode-line-format) + (unless (memq \\='hs-headline mode-line-format) (setq mode-line-format - (append '(\"-\" hs-headline) mode-line-format))) + (append \\='(\"-\" hs-headline) mode-line-format))) Note that `mode-line-format' is buffer-local.") @@ -934,7 +934,7 @@ if ARG is omitted or nil. When hideshow minor mode is on, the menu bar is augmented with hideshow commands and the hideshow commands are enabled. -The value '(hs . t) is added to `buffer-invisibility-spec'. +The value (hs . t) is added to `buffer-invisibility-spec'. The main commands are: `hs-hide-all', `hs-show-all', `hs-hide-block', `hs-show-block', `hs-hide-level' and `hs-toggle-hiding'. There is also diff --git a/lisp/progmodes/idlwave.el b/lisp/progmodes/idlwave.el index ac2259df6a4..1546e9ad6e6 100644 --- a/lisp/progmodes/idlwave.el +++ b/lisp/progmodes/idlwave.el @@ -808,7 +808,7 @@ See `idlwave-check-abbrev'." (defcustom idlwave-abbrev-change-case nil "Non-nil means all abbrevs will be forced to either upper or lower case. If the value t, all expanded abbrevs will be upper case. -If the value is 'down then abbrevs will be forced to lower case. +If the value is `down' then abbrevs will be forced to lower case. If nil, the case will not change. If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be upper case, regardless of this variable." @@ -963,7 +963,7 @@ a file." (defcustom idlwave-doc-modifications-keyword "HISTORY" "The modifications keyword to use with the log documentation commands. -A ':' is added to the keyword end. +A `:' is added to the keyword end. Inserted by doc-header and used to position logs by doc-modification. If nil it will not be inserted." :group 'idlwave-documentation @@ -999,7 +999,7 @@ it without compromising backwards-compatibility." (defcustom idlwave-shell-command-line-options nil "A list of command line options for calling the IDL program. Since IDL is executed directly without going through a shell like /bin/sh, -this should be a list of strings like '(\"-rt=file\" \"-nw\") with a separate +this should be a list of strings like (\"-rt=file\" \"-nw\") with a separate string for each argument. But you may also give a single string which contains the options whitespace-separated. Emacs will be kind enough to split it for you." @@ -1021,7 +1021,7 @@ Obsolete, if the IDL Assistant is being used for help." Will be used to bind debugging commands in the shell buffer and in all source buffers. These are additional convenience bindings, the debugging commands are always available with the `C-c C-d' prefix. -If you set this to '(control shift), this means setting a breakpoint will +If you set this to (control shift), this means setting a breakpoint will be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers are `control', `meta', `super', `hyper', `alt', and `shift'." :group 'idlwave-shell-general-setup @@ -1557,15 +1557,15 @@ KEY is a string - same as for the `define-key' function. CMD is a function of no arguments or a list to be evaluated. CMD is bound to KEY in `idlwave-mode-map' by defining an anonymous function calling `self-insert-command' followed by CMD. If KEY contains more than one -character a binding will only be set if SELECT is 'both. +character a binding will only be set if SELECT is `both'. \(KEY . CMD) is also placed in the `idlwave-indent-expand-table', replacing any previous value for KEY. If a binding is not set then it will instead be placed in `idlwave-indent-action-table'. If the optional argument SELECT is nil then an action and binding are -created. If SELECT is 'noaction, then a binding is always set and no -action is created. If SELECT is 'both then an action and binding +created. If SELECT is `noaction', then a binding is always set and no +action is created. If SELECT is `both' then an action and binding will both be created even if KEY contains more than one character. Otherwise, if SELECT is non-nil then only an action is created. @@ -2690,7 +2690,7 @@ statement." (append st (match-end 0)))))) (defun idlwave-expand-equal (&optional before after is-action) - "Pad '=' with spaces. + "Pad `=' with spaces. Two cases: Assignment statement, and keyword assignment. Which case is determined using `idlwave-start-of-substatement' and `idlwave-statement-type'. The equal sign will be surrounded by BEFORE @@ -2835,7 +2835,7 @@ ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is either a function name to be called with `funcall' or a list to be evaluated with `eval'. The action performed by FUNC should leave point after the match for REG - otherwise an infinite loop may be -entered. FUNC is always passed a final argument of 'is-action, so it +entered. FUNC is always passed a final argument of `is-action', so it can discriminate between being run as an action, or a key binding." (let ((action-key (car action)) (action-routine (cdr action))) @@ -6240,7 +6240,7 @@ If yes, return the index (>=1)." (defun idlwave-all-method-classes (method &optional type) "Return all classes which have a method METHOD. -TYPE is 'fun or 'pro. +TYPE is `fun' or `pro'. When TYPE is not specified, both procedures and functions will be considered." (if (null method) (mapcar 'car (idlwave-class-alist)) @@ -6255,7 +6255,7 @@ When TYPE is not specified, both procedures and functions will be considered." (defun idlwave-all-method-keyword-classes (method keyword &optional type) "Return all classes which have a method METHOD with keyword KEYWORD. -TYPE is 'fun or 'pro. +TYPE is `fun' or `pro'. When TYPE is not specified, both procedures and functions will be considered." (if (or (null method) (null keyword)) @@ -6644,8 +6644,8 @@ This function is not general, can only be used for completion stuff." special-selector) "Perform TYPE completion of word before point against LIST. SELECTOR is the PREDICATE argument for the completion function. Show -PROMPT in echo area. TYPE is one of the intern types, e.g. 'function, -'procedure, 'class-tag, 'keyword, 'sysvar, etc. SPECIAL-SELECTOR is +PROMPT in echo area. TYPE is one of the intern types, e.g., `function', +`procedure', `class-tag', `keyword', `sysvar'. SPECIAL-SELECTOR is used only once, for `all-completions', and can be used to, e.g., accumulate information on matching completions." (let* ((completion-ignore-case t) diff --git a/lisp/progmodes/js.el b/lisp/progmodes/js.el index 3ce1c17352f..356a31db094 100644 --- a/lisp/progmodes/js.el +++ b/lisp/progmodes/js.el @@ -97,7 +97,7 @@ name.") "\\.\\(" js--name-re "\\)\\s-*?=\\s-*?\\(function\\)\\_>") "Regexp matching an explicit JavaScript prototype \"method\" declaration. Group 1 is a (possibly-dotted) class name, group 2 is a method name, -and group 3 is the 'function' keyword.") +and group 3 is the `function' keyword.") (defconst js--plain-class-re (concat "^\\s-*\\(" js--dotted-name-re "\\)\\.prototype" @@ -831,7 +831,7 @@ lines." (defun js--forward-function-decl () "Move forward over a JavaScript function declaration. -This puts point at the 'function' keyword. +This puts point at the `function' keyword. If this is a syntactically-correct non-expression function, return the name of the function, or t if the name could not be @@ -3366,8 +3366,8 @@ left-to-right." (defun js--read-tab (prompt) "Read a Mozilla tab with prompt PROMPT. -Return a cons of (TYPE . OBJECT). TYPE is either 'window or -'tab, and OBJECT is a JavaScript handle to a ChromeWindow or a +Return a cons of (TYPE . OBJECT). TYPE is either `window' or +`tab', and OBJECT is a JavaScript handle to a ChromeWindow or a browser, respectively." ;; Prime IDO @@ -3778,12 +3778,12 @@ If one hasn't been set, or if it's stale, prompt for a new one." "Major mode for editing JSX. To customize the indentation for this mode, set the SGML offset -variables (`sgml-basic-offset', `sgml-attribute-offset' et al) +variables (`sgml-basic-offset', `sgml-attribute-offset' et al.) locally, like so: (defun set-jsx-indentation () (setq-local sgml-basic-offset js-indent-level)) - (add-hook 'js-jsx-mode-hook #'set-jsx-indentation)" + (add-hook \\='js-jsx-mode-hook #\\='set-jsx-indentation)" :group 'js (setq-local indent-line-function #'js-jsx-indent-line)) diff --git a/lisp/progmodes/mantemp.el b/lisp/progmodes/mantemp.el index a0f50fc0f19..6c89a518049 100644 --- a/lisp/progmodes/mantemp.el +++ b/lisp/progmodes/mantemp.el @@ -128,7 +128,7 @@ (defun mantemp-insert-cxx-syntax () "Insert C++ syntax around each template class and function. -Insert 'template class' for classes, 'template' for +Insert `template class' for classes, 'template' for functions and add the statement delimiter `;' at the end of the lines." (save-excursion diff --git a/lisp/progmodes/pascal.el b/lisp/progmodes/pascal.el index 454367c10fa..904001d3383 100644 --- a/lisp/progmodes/pascal.el +++ b/lisp/progmodes/pascal.el @@ -236,8 +236,8 @@ The name of the function or case is included between the braces." "List of contexts where auto lineup of :'s or ='s should be done. Elements can be of type: `paramlist', `declaration' or `case', which will do auto lineup in parameterlist, declarations or case-statements -respectively. The word `all' will do all lineups. '(case paramlist) for -instance will do lineup in case-statements and parameterlist, while '(all) +respectively. The word `all' will do all lineups. (case paramlist) for +instance will do lineup in case-statements and parameterlist, while (all) will do all lineups." :type '(set :extra-offset 8 (const :tag "Everything" all) diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el index 20efc5e2b0a..04542cdff3d 100644 --- a/lisp/progmodes/python.el +++ b/lisp/progmodes/python.el @@ -485,7 +485,7 @@ The type returned can be `comment', `string' or `paren'." ((nth 1 ppss) 'paren)))) (defsubst python-syntax-comment-or-string-p (&optional ppss) - "Return non-nil if PPSS is inside 'comment or 'string." + "Return non-nil if PPSS is inside comment or string." (nth 8 (or ppss (syntax-ppss)))) (defsubst python-syntax-closing-paren-p () @@ -1842,7 +1842,7 @@ This command assumes point is not in a string or comment." (defun python-nav-if-name-main () "Move point at the beginning the __main__ block. -When \"if __name__ == '__main__':\" is found returns its +When \"if __name__ == \\='__main__\\=':\" is found returns its position, else returns nil." (interactive) (let ((point (point)) @@ -3051,7 +3051,7 @@ the python shell: (defun python-shell-send-region (start end &optional send-main msg) "Send the region delimited by START and END to inferior Python process. When optional argument SEND-MAIN is non-nil, allow execution of -code inside blocks delimited by \"if __name__== '__main__':\". +code inside blocks delimited by \"if __name__== \\='__main__\\=':\". When called interactively SEND-MAIN defaults to nil, unless it's called with prefix argument. When optional argument MSG is non-nil, forces display of a user-friendly message if there's no @@ -3068,7 +3068,7 @@ process running; defaults to t when called interactively." (defun python-shell-send-buffer (&optional send-main msg) "Send the entire buffer to inferior Python process. When optional argument SEND-MAIN is non-nil, allow execution of -code inside blocks delimited by \"if __name__== '__main__':\". +code inside blocks delimited by \"if __name__== \\='__main__\\=':\". When called interactively SEND-MAIN defaults to nil, unless it's called with prefix argument. When optional argument MSG is non-nil, forces display of a user-friendly message if there's no diff --git a/lisp/progmodes/sh-script.el b/lisp/progmodes/sh-script.el index baed27bb138..ac512f607aa 100644 --- a/lisp/progmodes/sh-script.el +++ b/lisp/progmodes/sh-script.el @@ -1450,7 +1450,7 @@ This is for the rc shell." (defun sh-mkword-regexpr (word) "Make a regexp which matches WORD as a word. This specifically excludes an occurrence of WORD followed by -punctuation characters like '-'." +punctuation characters like `-'." (concat word "\\([^-[:alnum:]_]\\|$\\)")) (defconst sh-re-done (sh-mkword-regexpr "done")) diff --git a/lisp/progmodes/simula.el b/lisp/progmodes/simula.el index bc0133805ee..d3ee9b5b4b2 100644 --- a/lisp/progmodes/simula.el +++ b/lisp/progmodes/simula.el @@ -344,22 +344,22 @@ Variables controlling indentation style: with respect to the previous line of the statement. `simula-label-offset' -4711 Offset of SIMULA label lines relative to usual indentation. - `simula-if-indent' '(0 . 0) + `simula-if-indent' (0 . 0) Extra indentation of THEN and ELSE with respect to the starting IF. Value is a cons cell, the car is extra THEN indentation and the cdr extra ELSE indentation. IF after ELSE is indented as the starting IF. - `simula-inspect-indent' '(0 . 0) + `simula-inspect-indent' (0 . 0) Extra indentation of WHEN and OTHERWISE with respect to the corresponding INSPECT. Value is a cons cell, the car is extra WHEN indentation and the cdr extra OTHERWISE indentation. `simula-electric-indent' nil If this variable is non-nil, `simula-indent-line' will check the previous line to see if it has to be reindented. - `simula-abbrev-keyword' 'upcase + `simula-abbrev-keyword' `upcase' Determine how SIMULA keywords will be expanded. Value is one of the symbols `upcase', `downcase', `capitalize', (as in) `abbrev-table', or nil if they should not be changed. - `simula-abbrev-stdproc' 'abbrev-table + `simula-abbrev-stdproc' `abbrev-table' Determine how standard SIMULA procedure and class names will be expanded. Value is one of the symbols `upcase', `downcase', `capitalize', (as in) `abbrev-table', or nil if they should not be changed. diff --git a/lisp/progmodes/sql.el b/lisp/progmodes/sql.el index abc99eec909..40596749de7 100644 --- a/lisp/progmodes/sql.el +++ b/lisp/progmodes/sql.el @@ -2987,7 +2987,7 @@ supported: :number t In order to ask the user for username, password and database, call the -function like this: (sql-get-login 'user 'password 'database)." +function like this: (sql-get-login \\='user \\='password \\='database)." (dolist (w what) (let ((plist (cdr-safe w))) (pcase (or (car-safe w) w) @@ -4891,7 +4891,7 @@ your might try undecided-dos as a coding system. If this doesn't help, Try to set `comint-output-filter-functions' like this: \(setq comint-output-filter-functions (append comint-output-filter-functions - '(comint-strip-ctrl-m))) + \\='(comint-strip-ctrl-m))) \(Type \\[describe-mode] in the SQL buffer for a list of commands.)" (interactive "P") diff --git a/lisp/progmodes/vera-mode.el b/lisp/progmodes/vera-mode.el index bce56a447f0..354002dd3b3 100644 --- a/lisp/progmodes/vera-mode.el +++ b/lisp/progmodes/vera-mode.el @@ -870,7 +870,7 @@ This function does not modify point or mark." (beginning-of-line))))))) (defmacro vera-prepare-search (&rest body) - "Execute BODY with a syntax table that includes '_'." + "Execute BODY with a syntax table that includes `_'." `(with-syntax-table vera-mode-ext-syntax-table ,@body)) ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; diff --git a/lisp/progmodes/verilog-mode.el b/lisp/progmodes/verilog-mode.el index 489094b2e4f..eae2f6cb8a6 100644 --- a/lisp/progmodes/verilog-mode.el +++ b/lisp/progmodes/verilog-mode.el @@ -750,7 +750,7 @@ Set this to \"logic\" for SystemVerilog code, or use `verilog-auto-logic'." (put 'verilog-auto-wire-type 'safe-local-variable `stringp) (defcustom verilog-auto-endcomments t - "Non-nil means insert a comment /* ... */ after 'end's. + "Non-nil means insert a comment /* ... */ after `end's. The name of the function or case will be set between the braces." :group 'verilog-mode-actions :type 'boolean) @@ -790,7 +790,7 @@ needed on every save. A value of `detect' will do \\[verilog-auto] automatically when it thinks necessary. A value of `ask' will query the user when it thinks updating is needed. -You should not rely on the 'ask or 'detect policies, they are safeguards +You should not rely on the `ask' or `detect' policies, they are safeguards only. They do not detect when AUTOINSTs need to be updated because a sub-module's port list has changed." :group 'verilog-mode-actions @@ -3717,12 +3717,12 @@ Variables controlling indentation/edit style: will be inserted. Setting this variable to zero results in every end acquiring a comment; the default avoids too many redundant comments in tight quarters. - `verilog-auto-lineup' (default 'declarations) + `verilog-auto-lineup' (default `declarations') List of contexts where auto lineup of code should be done. Variables controlling other actions: - `verilog-linter' (default surelint) + `verilog-linter' (default `surelint') Unix program to call to run the lint checker. This is the default command for \\[compile-command] and \\[verilog-auto-save-compile]. @@ -4073,7 +4073,7 @@ The upper left corner is defined by point. Indices begin with 0 and extend to the MAX - 1. If no prefix arg is given, the user is prompted for a value. The indices are surrounded by square brackets []. For example, the following code with the point -located after the first 'a' gives: +located after the first `a' gives: a = b a[ 0] = b a = b a[ 1] = b @@ -12899,7 +12899,7 @@ used on the right hand side of assignments. By default, AUTORESET will include the width of the signal in the autos, SystemVerilog designs may want to change this. To control this behavior, see `verilog-auto-reset-widths'. In some cases -AUTORESET must use a '0 assignment and it will print NOWIDTH; use +AUTORESET must use a \\='0 assignment and it will print NOWIDTH; use `verilog-auto-reset-widths' unbased to prevent this. AUTORESET ties signals to deasserted, which is presumed to be zero. diff --git a/lisp/progmodes/vhdl-mode.el b/lisp/progmodes/vhdl-mode.el index 9ee4ab520e1..09330d76dcd 100644 --- a/lisp/progmodes/vhdl-mode.el +++ b/lisp/progmodes/vhdl-mode.el @@ -585,7 +585,7 @@ option `vhdl-file-header'). The default directory must have an absolute path (use `M-TAB' for completion). All other paths can be absolute or relative to the default directory. All -paths must end with '/'. +paths must end with `/'. The design units found in the sources (files and directories) are shown in the hierarchy browser. Path and file name can contain wildcards `*' and `?' as @@ -945,7 +945,7 @@ If nil, only a list of actual parameters is entered." :group 'vhdl-template) (defcustom vhdl-sensitivity-list-all t - "Non-nil means use 'all' keyword in sensitivity list." + "Non-nil means use `all' keyword in sensitivity list." :version "25.1" :type 'boolean :group 'vhdl-template) @@ -1103,7 +1103,7 @@ Otherwise, falling edge triggers." (defcustom vhdl-clock-edge-condition 'standard "Syntax of the clock edge condition. - Standard: \"clk'event and clk = '1'\" + Standard: \"clk\\='event and clk = \\='1\\='\" Function: \"rising_edge(clk)\"" :type '(choice (const :tag "Standard" standard) (const :tag "Function" function)) @@ -2477,7 +2477,7 @@ current buffer if no project is defined." default-directory)) (defmacro vhdl-prepare-search-1 (&rest body) - "Enable case insensitive search and switch to syntax table that includes '_', + "Enable case insensitive search and switch to syntax table that includes `_', then execute BODY, and finally restore the old environment. Used for consistent searching." `(let ((case-fold-search t)) ; case insensitive search @@ -2486,7 +2486,7 @@ consistent searching." ,@body))) (defmacro vhdl-prepare-search-2 (&rest body) - "Enable case insensitive search, switch to syntax table that includes '_', + "Enable case insensitive search, switch to syntax table that includes `_', arrange to ignore `intangible' overlays, then execute BODY, and finally restore the old environment. Used for consistent searching." `(let ((case-fold-search t) ; case insensitive search @@ -2759,7 +2759,7 @@ elements > `vhdl-menu-max-size'." (defun vhdl-function-name (prefix string &optional postfix) "Generate a Lisp function name. -PREFIX, STRING and optional POSTFIX are concatenated by '-' and spaces in +PREFIX, STRING and optional POSTFIX are concatenated by `-' and spaces in STRING are replaced by `-' and substrings are converted to lower case." (let ((name prefix)) (while (string-match "\\(\\w+\\)\\s-*\\(.*\\)" string) @@ -8189,8 +8189,8 @@ options vhdl-upper-case-{keywords,types,attributes,enum-values}." (defun vhdl-fix-statement-region (beg end &optional arg) "Force statements in region on separate line except when on same line -with 'end' keyword (necessary for correct indentation). -Currently supported keywords: 'begin', 'if'." +with `end' keyword (necessary for correct indentation). +Currently supported keywords: `begin', `if'." (interactive "r\nP") (vhdl-prepare-search-2 (let (point) @@ -8236,7 +8236,7 @@ Currently supported keywords: 'begin', 'if'." (defun vhdl-fix-statement-buffer () "Force statements in buffer on separate line except when on same line -with 'end' keyword (necessary for correct indentation)." +with `end' keyword (necessary for correct indentation)." (interactive) (vhdl-fix-statement-region (point-min) (point-max))) @@ -10578,22 +10578,22 @@ specification, if not already there." (insert "-- pragma " directive)) (defun vhdl-template-directive-translate-on () - "Insert directive 'translate_on'." + "Insert directive `translate_on'." (interactive) (vhdl-template-directive "translate_on")) (defun vhdl-template-directive-translate-off () - "Insert directive 'translate_off'." + "Insert directive `translate_off'." (interactive) (vhdl-template-directive "translate_off")) (defun vhdl-template-directive-synthesis-on () - "Insert directive 'synthesis_on'." + "Insert directive `synthesis_on'." (interactive) (vhdl-template-directive "synthesis_on")) (defun vhdl-template-directive-synthesis-off () - "Insert directive 'synthesis_off'." + "Insert directive `synthesis_off'." (interactive) (vhdl-template-directive "synthesis_off")) @@ -13307,7 +13307,7 @@ File statistics: \"%s\"\n\ (defconst vhdl-font-lock-syntactic-keywords '(("\\('\\).\\('\\)" (1 (7 . ?\')) (2 (7 . ?\')))) - "Mark single quotes as having string quote syntax in 'c' instances.") + "Mark single quotes as having string quote syntax in `c' instances.") (defvar vhdl-font-lock-keywords nil "Regular expressions to highlight in VHDL Mode.") @@ -17760,7 +17760,7 @@ Release Notes for VHDL Mode 3.37 - Context declaration - Block comments - Directives - - 'all' keyword in sensitivity list + - `all' keyword in sensitivity list Release Notes for VHDL Mode 3.34 diff --git a/lisp/ps-bdf.el b/lisp/ps-bdf.el index 8fd0dbb3291..e45d0f4cf5f 100644 --- a/lisp/ps-bdf.el +++ b/lisp/ps-bdf.el @@ -44,7 +44,7 @@ (list (expand-file-name "fonts/bdf" installation-directory)) '("/usr/local/share/emacs/fonts/bdf")) "List of directories to search for `BDF' font files. -The default value is '(\"/usr/local/share/emacs/fonts/bdf\")." +The default value is (\"/usr/local/share/emacs/fonts/bdf\")." :type '(repeat :tag "BDF font directory list" (directory :tag "BDF font directory")) :group 'ps-print-miscellany) diff --git a/lisp/ps-print.el b/lisp/ps-print.el index e9294279c23..ff60926d48a 100644 --- a/lisp/ps-print.el +++ b/lisp/ps-print.el @@ -3232,7 +3232,7 @@ in the PostScript array HeaderLinesLeft. Strings are inserted unchanged into the array; those representing PostScript string literals should be delimited with PostScript string -delimiters '(' and ')'. +delimiters `(' and `)'. For symbols with bound functions, the function is called and should return a string to be inserted into the array. For symbols with bound values, the value @@ -3286,8 +3286,8 @@ The value should be a list of strings and symbols, each representing an entry in the PostScript array FooterLinesLeft. Strings are inserted unchanged into the array; those representing PostScript -string literals should be delimited with PostScript string delimiters '(' and -')'. +string literals should be delimited with PostScript string delimiters `(' and +`)'. For symbols with bound functions, the function is called and should return a string to be inserted into the array. For symbols with bound values, the value @@ -3601,7 +3601,7 @@ image in a file with that name." (defun ps-line-lengths () "Display the correspondence between a line length and a font size. Done using the current ps-print setup. -Try: pr -t file | awk '{printf \"%3d %s\n\", length($0), $0}' | sort -r | head" +Try: pr -t file | awk \\='{printf \"%3d %s\n\", length($0), $0}\\=' | sort -r | head" (interactive) (ps-line-lengths-internal)) @@ -4308,7 +4308,7 @@ which long lines wrap around." (defun ps-line-lengths-internal () "Display the correspondence between a line length and a font size. Done using the current ps-print setup. -Try: pr -t file | awk '{printf \"%3d %s\n\", length($0), $0}' | sort -r | head" +Try: pr -t file | awk \\='{printf \"%3d %s\n\", length($0), $0}\\=' | sort -r | head" (let* ((ps-font-size-internal (or ps-font-size-internal (ps-get-font-size 'ps-font-size))) diff --git a/lisp/ses.el b/lisp/ses.el index ec1359bbbcb..d15483f4783 100644 --- a/lisp/ses.el +++ b/lisp/ses.el @@ -336,7 +336,7 @@ default printer and then modify its output.") '(ses--col-widths -5 ses--col-printers -4 ses--default-printer -3 ses--header-row -2 ses--file-format 1 ses--numrows 2 ses--numcols 3 ses--numlocprn 4) - "Offsets from 'Global parameters' line to various parameter lines in the + "Offsets from \"Global parameters\" line to various parameter lines in the data area of a spreadsheet.") (defconst ses-paramfmt-plist @@ -348,7 +348,7 @@ data area of a spreadsheet.") ses--numrows " %S ;numrows" ses--numcols " %S ;numcols" ses--numlocprn " %S ;numlocprn") - "Formats of 'Global parameters' various parameters in the data + "Formats of \"Global parameters\" various parameters in the data area of a spreadsheet.") ;; @@ -361,8 +361,8 @@ area of a spreadsheet.") (defvar ses-relocate-return nil "Set by `ses-relocate-formula' and `ses-relocate-range', read by -`ses-relocate-all'. Set to 'delete if a cell-reference was deleted from a -formula--so the formula needs recalculation. Set to 'range if the size of a +`ses-relocate-all'. Set to `delete' if a cell-reference was deleted from a +formula--so the formula needs recalculation. Set to `range' if the size of a `ses-range' was changed--so both the formula's value and list of dependents need to be recalculated.") @@ -672,7 +672,7 @@ checking that it is a valid printer function." (add-to-list 'ses-read-printer-history (prin1-to-string printer)))) (defun ses-formula-record (formula) - "If FORMULA is of the form 'symbol, add it to the list of symbolic formulas + "If FORMULA is of the form \\='SYMBOL, add it to the list of symbolic formulas for this spreadsheet." (when (and (eq (car-safe formula) 'quote) (symbolp (cadr formula))) @@ -688,7 +688,7 @@ for this spreadsheet." (concat (ses-column-letter (1- (/ col 26))) units)))) (defun ses-create-cell-symbol (row col) - "Produce a symbol that names the cell (ROW,COL). (0,0) => 'A1." + "Produce a symbol that names the cell (ROW,COL). (0,0) => A1." (intern (concat (ses-column-letter col) (number-to-string (1+ row))))) (defun ses-decode-cell-symbol (str) @@ -1114,9 +1114,9 @@ region, or nil if cursor is not at a cell." (defun ses-check-curcell (&rest args) "Signal an error if `ses--curcell' is inappropriate. -The end marker is appropriate if some argument is 'end. -A range is appropriate if some argument is 'range. -A single cell is appropriate unless some argument is 'needrange." +The end marker is appropriate if some argument is `end'. +A range is appropriate if some argument is `range'. +A single cell is appropriate unless some argument is `needrange'." (if (eq ses--curcell t) ;; curcell recalculation was postponed, but user typed ahead. (ses-set-curcell)) @@ -1497,7 +1497,7 @@ If ROWINCR or COLINCR is negative, references to cells being deleted are removed. Example: (ses-relocate-formula \\='(+ A1 B2 D3) 0 1 0 -1) => (+ A1 C3) -Sets `ses-relocate-return' to 'delete if cell-references were removed." +Sets `ses-relocate-return' to `delete' if cell-references were removed." (let (rowcol result) (if (or (atom formula) (eq (car formula) 'quote)) (if (and (setq rowcol (ses-sym-rowcol formula)) @@ -1533,7 +1533,7 @@ Sets `ses-relocate-return' to 'delete if cell-references were removed." (nreverse result)))) (defun ses-relocate-range (range startrow startcol rowincr colincr) - "Relocate one RANGE, of the form '(ses-range min max). Cells starting + "Relocate one RANGE, of the form (SES-RANGE MIN MAX). Cells starting at (STARTROW,STARTCOL) are being shifted by (ROWINCR,COLINCR). Result is the new range, or nil if the entire range is deleted. If new rows are being added just beyond the end of a row range, or new columns just beyond a column range, @@ -2861,7 +2861,7 @@ SES attributes recording the contents of the cell as of the time of copying." (defun ses-copy-region-helper (line) "Converts one line (of a rectangle being extracted from a spreadsheet) to -external form by attaching to each print cell a 'ses attribute that records +external form by attaching to each print cell a `ses' attribute that records the corresponding data cell." (or (> (length line) 1) (error "Empty range")) @@ -2907,7 +2907,7 @@ We clear the killed cells instead of deleting them." (defun ses--advice-yank (yank-fun &optional arg &rest args) "In SES mode, the yanked text is inserted as cells. -If the text contains 'ses attributes (meaning it went to the kill-ring from a +If the text contains `ses' attributes (meaning it went to the kill-ring from a SES buffer), the formulas and print functions are restored for the cells. If the text contains tabs, this is an insertion of tab-separated formulas. Otherwise the text is inserted as the formula for the current cell. @@ -2919,7 +2919,7 @@ prefix to specify insertion without relocation, which is best when the formulas refer to cells outside the yanked text. When inserting formulas, the text is treated as a string constant if it doesn't -make sense as a sexp or would otherwise be considered a symbol. Use 'sym to +make sense as a sexp or would otherwise be considered a symbol. Use `sym' to explicitly insert a symbol, or use the C-u prefix to treat all unmarked words as symbols." (if (not (and (derived-mode-p 'ses-mode) @@ -2962,7 +2962,7 @@ previous insertion." (setq this-command 'yank)) (defun ses-yank-cells (text arg) - "If the TEXT has a proper set of 'ses attributes, insert the text as + "If the TEXT has a proper set of `ses' attributes, insert the text as cells, else return nil. The cells are reprinted--the supplied text is ignored because the column widths, default printer, etc. at yank time might be different from those at kill-time. ARG is a list to indicate that @@ -3558,7 +3558,7 @@ is read and how it is formatted. In the sequel we assume that cells A1, B1, A2 B2 have respective values 1 2 3 and 4. -Readout direction is specified by a `>v', '`>^', `v', `>^', `', `v<', `^>', `^<' flag. For historical reasons, in absence of such a flag, a default direction of `^<' is assumed. This way `(ses-range A1 B2 ^>)' will evaluate to `(1 3 2 4)', diff --git a/lisp/simple.el b/lisp/simple.el index deb5c888c92..dc19bd6e512 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -8269,7 +8269,7 @@ backward. If set to nil, both Delete and Backspace keys delete backward. -If set to 'maybe (which is the default), Emacs automatically +If set to `maybe' (which is the default), Emacs automatically selects a behavior. On window systems, the behavior depends on the keyboard used. If the keyboard has both a Backspace key and a Delete key, and both are mapped to their usual meanings, the diff --git a/lisp/speedbar.el b/lisp/speedbar.el index 17430587818..9d011e048a3 100644 --- a/lisp/speedbar.el +++ b/lisp/speedbar.el @@ -242,8 +242,8 @@ frame." (defcustom speedbar-query-confirmation-method 'all "Query control for file operations. -The 'all flag means to always query before file operations. -The 'none-but-delete flag means to not query before any file +The `all' flag means to always query before file operations. +The `none-but-delete' flag means to not query before any file operations, except before a file deletion." :group 'speedbar :type '(radio (const :tag "Always Query before some file operations." @@ -392,8 +392,8 @@ display is used instead." (defcustom speedbar-default-position 'left-right "Default position of the speedbar frame. -Possible values are 'left, 'right or 'left-right. -If value is 'left-right, the most suitable location is +Possible values are `left', `right' or `left-right'. +If value is `left-right', the most suitable location is determined automatically." :group 'speedbar :type '(radio (const :tag "Automatic" left-right) @@ -1989,7 +1989,7 @@ INDEX is not used, but is required by the caller." This is the button that expands or contracts a node (if applicable), and EXP-BUTTON-CHAR the character in it (+, -, ?, etc). EXP-BUTTON-FUNCTION is the function to call if it's clicked on. Button types are -'bracket, 'angle, 'curly, 'expandtag, 'statictag, t, or nil. +`bracket', `angle', `curly', `expandtag', `statictag', t, or nil. EXP-BUTTON-DATA is extra data attached to the text forming the expansion button. @@ -2061,7 +2061,7 @@ position to insert a new item, and that the new item will end with a CR." "Insert list of FILES starting at point, and indenting all files to LEVEL. Tag expandable items with a +, otherwise a ?. Don't highlight ? as we don't know how to manage them. The input parameter FILES is a cons -cell of the form ( 'DIRLIST . 'FILELIST )." +cell of the form (DIRLIST . FILELIST)." ;; Start inserting all the directories (let ((dirs (car files))) (while dirs @@ -2341,7 +2341,7 @@ Argument LST is the list of tags to trim." (append newlst trimlst)))) (defun speedbar-simple-group-tag-hierarchy (lst) - "Create a simple 'Tags' group with orphaned tags. + "Create a simple `Tags' group with orphaned tags. Argument LST is the list of tags to sort into groups." (let ((newlst nil) (sublst nil)) @@ -3469,7 +3469,7 @@ TOKEN will be the list, and INDENT is the current indentation level." ;; (defcustom speedbar-select-frame-method 'attached "Specify how to select a frame for displaying a file. -A value of 'attached means to use the attached frame (the frame +A value of `attached' means to use the attached frame (the frame that speedbar was started from.) A number such as 1 or -1 means to pass that number to `other-frame' while selecting a frame from speedbar." :group 'speedbar diff --git a/lisp/subr.el b/lisp/subr.el index ea926ae1475..420b212d545 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -3908,7 +3908,7 @@ If the feature is provided when evaluating code not associated with a file, FORM is evaluated immediately after the provide statement. Usually FILE is just a library name like \"font-lock\" or a feature name -like 'font-lock. +like `font-lock'. This function makes or adds to an entry on `after-load-alist'." (declare (compiler-macro diff --git a/lisp/tempo.el b/lisp/tempo.el index 93df15a8934..2fe76ab82d8 100644 --- a/lisp/tempo.el +++ b/lisp/tempo.el @@ -147,7 +147,7 @@ disappears at the next keypress; otherwise, it remains forever." "List of functions to run when inserting a string. Each function is called with a single arg, STRING and should return another string. This could be used for making all strings upcase by -setting it to '(upcase), for example.") +setting it to (upcase), for example.") (defvar tempo-tags nil "An association list with tags and corresponding templates.") diff --git a/lisp/term.el b/lisp/term.el index 41577c90301..033eef426ac 100644 --- a/lisp/term.el +++ b/lisp/term.el @@ -2140,7 +2140,7 @@ The prompt skip is done by skipping text matching the regular expression (defun term-read-noecho (prompt &optional stars) "Read a single line of text from user without echoing, and return it. Prompt with argument PROMPT, a string. Optional argument STARS causes -input to be echoed with '*' characters on the prompt line. Input ends with +input to be echoed with `*' characters on the prompt line. Input ends with RET, LFD, or ESC. DEL or C-h rubs out. C-u kills line. C-g aborts (if `inhibit-quit' is set because e.g. this function was called from a process filter and C-g is pressed, this function returns nil rather than a string). diff --git a/lisp/textmodes/bibtex.el b/lisp/textmodes/bibtex.el index df8066ee2fc..deb39d943a8 100644 --- a/lisp/textmodes/bibtex.el +++ b/lisp/textmodes/bibtex.el @@ -1503,7 +1503,7 @@ At most `bibtex-entry-kill-ring-max' items are kept here.") "The tail of `bibtex-entry-kill-ring' whose car is the last item yanked.") (defvar bibtex-last-kill-command nil - "Type of the last kill command (either 'field or 'entry).") + "Type of the last kill command (either `field' or `entry').") (defvar bibtex-strings (lazy-completion-table bibtex-strings @@ -2573,7 +2573,7 @@ Formats current entry according to variable `bibtex-entry-format'." (defun bibtex-field-re-init (regexp-alist type) "Calculate optimized value for bibtex-regexp-TYPE-opt. -This value is based on bibtex-regexp-TYPE-alist. TYPE is 'braces or 'strings. +This value is based on bibtex-regexp-TYPE-alist. TYPE is `braces' or `strings'. Return optimized value to be used by `bibtex-format-entry'." (setq regexp-alist (mapcar (lambda (e) diff --git a/lisp/textmodes/page-ext.el b/lisp/textmodes/page-ext.el index 99962c75897..c7a2f258f86 100644 --- a/lisp/textmodes/page-ext.el +++ b/lisp/textmodes/page-ext.el @@ -351,7 +351,7 @@ Else insert at exact location of point. Narrow to new page if `pages-directory-for-adding-page-narrowing-p' is non-nil. -Page begins with a '^L' as the default `page-delimiter'. +Page begins with a `^L' as the default `page-delimiter'. Use \\[set-page-delimiter] to change the page-delimiter. Point is left in the body of page." (interactive "sHeader line: ") diff --git a/lisp/textmodes/refbib.el b/lisp/textmodes/refbib.el index 424b6d0f6a1..e5b89a24a52 100644 --- a/lisp/textmodes/refbib.el +++ b/lisp/textmodes/refbib.el @@ -79,7 +79,7 @@ may be eliminated if is exactly the same as the car. Because titles are capitalized before matching, the abbreviation for the journal name should be listed as beginning with a capital letter, even if it really doesn't. - For example, a value of '((\"Aij\" \"{Artificial Intelligence}\") + For example, a value of ((\"Aij\" \"{Artificial Intelligence}\") \(\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string \"Artificial Intelligence\", but would replace Ijcai81 with the BibTeX macro \"ijcai7\"." @@ -97,7 +97,7 @@ abbreviation. The cadr may be eliminated if is exactly the same as the car. Because titles are capitalized before matching, the abbreviated title should be listed as beginning with a capital letter, even if it doesn't. - For example, a value of '((\"Aij\" \"{Artificial Intelligence}\") + For example, a value of ((\"Aij\" \"{Artificial Intelligence}\") \(\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string \"Artificial Intelligence\", but would replace Ijcai81 with the BibTeX macro \"ijcai7\"." @@ -115,7 +115,7 @@ The entry must match the given data exactly. should begin with a capital letter. For example, suppose the title \"Ijcai81\" is used for the proceedings of a conference, and its expansion is the BibTeX macro \"ijcai7\". Then -`r2b-proceedings-list' should be '((\"Ijcai81\") ...). If instead its +`r2b-proceedings-list' should be ((\"Ijcai81\") ...). If instead its expansion were \"Proceedings of the Seventh International Conference on Artificial Intelligence\", then you would NOT need to include Ijcai81 in `r2b-proceedings-list' (although it wouldn't cause an error)." diff --git a/lisp/textmodes/refer.el b/lisp/textmodes/refer.el index 22dc7dc9165..dfdda8a5742 100644 --- a/lisp/textmodes/refer.el +++ b/lisp/textmodes/refer.el @@ -77,13 +77,13 @@ (defcustom refer-bib-directory nil "Directory, or list of directories, to search for \\.bib files. -Can be set to 'bibinputs or 'texinputs, in which case the environment +Can be set to `bibinputs' or `texinputs', in which case the environment variable BIBINPUTS or TEXINPUTS, respectively, is used to obtain a -list of directories. Useful only if `refer-bib-files' is set to 'dir or +list of directories. Useful only if `refer-bib-files' is set to `dir' or a list of file names (without directory). A value of nil indicates the current working directory. -If `refer-bib-directory' is 'bibinputs or 'texinputs, it is setq'd to +If `refer-bib-directory' is `bibinputs' or `texinputs', it is setq'd to the appropriate list of directories when it is first used. Note that an empty directory is interpreted by BibTeX as indicating diff --git a/lisp/textmodes/reftex-vars.el b/lisp/textmodes/reftex-vars.el index 97c8af365e8..3f7a6f34dc6 100644 --- a/lisp/textmodes/reftex-vars.el +++ b/lisp/textmodes/reftex-vars.el @@ -335,7 +335,7 @@ more than `reftex-idle-time' seconds. Value t means, turn on immediately when RefTeX gets started. Then, recentering will work for any TOC window created during the session. -Value 'frame (the default) means, turn automatic recentering on only while the +Value `frame' (the default) means, turn automatic recentering on only while the dedicated TOC frame does exist, and do the recentering only in that frame. So when creating that frame (with `d' key in an ordinary TOC window), the automatic recentering is turned on. When the frame gets destroyed, automatic @@ -739,7 +739,7 @@ And here is the setup for RefTeX: \\end. Here we use \"linguex\" as this name. (setq reftex-label-alist - '((\"linguex\" ?x \"ex:\" \"~\\\\ref{%s}\" nil (\"Example\" \"Ex.\")))) + \\='((\"linguex\" ?x \"ex:\" \"~\\\\ref{%s}\" nil (\"Example\" \"Ex.\")))) 2. Write a function to detect the list macros and the determinators as well. @@ -762,7 +762,7 @@ And here is the setup for RefTeX: 3. Tell RefTeX to use this function - (setq reftex-special-environment-functions '(my-detect-linguex-list))" + (setq reftex-special-environment-functions \\='(my-detect-linguex-list))" :group 'reftex-defining-label-environments :type 'hook) @@ -1206,7 +1206,7 @@ strings. `reftex-cite-format' directly yourself or set it to the SYMBOL of one of the predefined styles. The predefined symbols are those which have an association in the constant `reftex-cite-format-builtin'. -E.g.: (setq reftex-cite-format 'natbib)" +E.g.: (setq reftex-cite-format \\='natbib)" :group 'reftex-citation-support :type `(choice diff --git a/lisp/textmodes/sgml-mode.el b/lisp/textmodes/sgml-mode.el index 55a1e6d26db..239112bca33 100644 --- a/lisp/textmodes/sgml-mode.el +++ b/lisp/textmodes/sgml-mode.el @@ -697,7 +697,7 @@ This only works for Latin-1 input." "Prompt for a tag and insert it, optionally with attributes. Completion and configuration are done according to `sgml-tag-alist'. If you like tags and attributes in uppercase, customize -`sgml-transformation-function' to 'upcase." +`sgml-transformation-function' to `upcase'." (funcall (or skeleton-transformation-function 'identity) (setq sgml-tag-last (completing-read diff --git a/lisp/textmodes/table.el b/lisp/textmodes/table.el index 151d64808af..97da43757da 100644 --- a/lisp/textmodes/table.el +++ b/lisp/textmodes/table.el @@ -2938,7 +2938,7 @@ WHERE is provided the cell and table at that location is reported." (defun table-generate-source (language &optional dest-buffer caption) "Generate source of the current table in the specified language. LANGUAGE is a symbol that specifies the language to describe the -structure of the table. It must be either 'html, 'latex or 'cals. +structure of the table. It must be either `html', `latex' or `cals'. The resulted source text is inserted into DEST-BUFFER and the buffer object is returned. When DEST-BUFFER is omitted or nil the default buffer specified in `table-dest-buffer-name' is used. In this case @@ -3561,7 +3561,7 @@ delimiter regular expressions. This parsing determines the number of columns and rows of the table automatically. If COL-DELIM-REGEXP and ROW-DELIM-REGEXP are omitted the result table has only one cell and the entire region contents is placed in that cell. Optional JUSTIFY -is one of 'left, 'center or 'right, which specifies the cell +is one of `left', `center' or `right', which specifies the cell justification. Optional MIN-CELL-WIDTH specifies the minimum cell width. Optional COLUMNS specify the number of columns when ROW-DELIM-REGEXP is not specified. diff --git a/lisp/textmodes/tex-mode.el b/lisp/textmodes/tex-mode.el index c9d347da02d..22bb8ca41db 100644 --- a/lisp/textmodes/tex-mode.el +++ b/lisp/textmodes/tex-mode.el @@ -188,7 +188,7 @@ If two printers are not enough of a choice, you can set the variable for example, (setq tex-alt-dvi-print-command - '(format \"lpr -P%s\" (read-string \"Use printer: \"))) + \\='(format \"lpr -P%s\" (read-string \"Use printer: \"))) would tell \\[tex-print] with a prefix argument to ask you which printer to use." diff --git a/lisp/textmodes/text-mode.el b/lisp/textmodes/text-mode.el index 1466556ab59..1e0a949ed05 100644 --- a/lisp/textmodes/text-mode.el +++ b/lisp/textmodes/text-mode.el @@ -39,7 +39,7 @@ (defvar text-mode-variant nil "Non-nil if this buffer's major mode is a variant of Text mode. -Use (derived-mode-p 'text-mode) instead.") +Use (derived-mode-p \\='text-mode) instead.") (defvar text-mode-syntax-table (let ((st (make-syntax-table))) diff --git a/lisp/time-stamp.el b/lisp/time-stamp.el index b6a73409f87..c148a57854f 100644 --- a/lisp/time-stamp.el +++ b/lisp/time-stamp.el @@ -677,7 +677,7 @@ otherwise the value of the function `system-name'." ;;; the rest of this file is for version 1 compatibility (defun time-stamp-fconcat (list sep) - "Similar to (mapconcat 'funcall LIST SEP) but LIST allows literals. + "Similar to (mapconcat \\='funcall LIST SEP) but LIST allows literals. If an element of LIST is a symbol, it is funcalled to get the string to use; the separator SEP is used between two strings obtained by funcalling a symbol. Otherwise the element itself is inserted; no separator is used diff --git a/lisp/url/url-auth.el b/lisp/url/url-auth.el index 87f67183b55..31c15329ac6 100644 --- a/lisp/url/url-auth.el +++ b/lisp/url/url-auth.el @@ -50,7 +50,7 @@ Must be a symbol pointing to another variable that will actually store the information. The value of this variable is an assoc list of assoc lists. The first assoc list is keyed by the server name. The cdr of -this is an assoc list based on the 'directory' specified by the URL we +this is an assoc list based on the \"directory\" specified by the URL we are looking up.") (defun url-basic-auth (url &optional prompt overwrite realm args) @@ -138,7 +138,7 @@ instead of the filename inheritance method." "Where usernames and passwords are stored. Its value is an assoc list of assoc lists. The first assoc list is keyed by the server name. The cdr of this is an assoc list based -on the 'directory' specified by the url we are looking up.") +on the \"directory\" specified by the url we are looking up.") (defun url-digest-auth-create-key (username password realm method uri) "Create a key for digest authentication method" diff --git a/lisp/url/url-http.el b/lisp/url/url-http.el index 7367a1eb3e9..a47d57d3c77 100644 --- a/lisp/url/url-http.el +++ b/lisp/url/url-http.el @@ -986,7 +986,7 @@ the callback to be triggered." (url-http-activate-callback))))) (defun url-http-chunked-encoding-after-change-function (st nd length) - "Function used when dealing with 'chunked' encoding. + "Function used when dealing with chunked encoding. Cannot give a sophisticated percentage, but we need a different function to look for the special 0-length chunk that signifies the end of the document." diff --git a/lisp/url/url-util.el b/lisp/url/url-util.el index e011b96ada2..7a186df474e 100644 --- a/lisp/url/url-util.el +++ b/lisp/url/url-util.el @@ -160,7 +160,7 @@ conversion. Replaces these characters as follows: ;;;###autoload (defun url-normalize-url (url) - "Return a 'normalized' version of URL. + "Return a \"normalized\" version of URL. Strips out default port numbers, etc." (let (type data retval) (setq data (url-generic-parse-url url) @@ -188,7 +188,7 @@ Will not do anything if `url-show-status' is nil." ;;;###autoload (defun url-get-normalized-date (&optional specified-time) - "Return a 'real' date string that most HTTP servers can understand." + "Return a date string that most HTTP servers can understand." (let ((system-time-locale "C")) (format-time-string "%a, %d %b %Y %T GMT" specified-time t))) diff --git a/lisp/userlock.el b/lisp/userlock.el index 781023c7449..52a3eb176b6 100644 --- a/lisp/userlock.el +++ b/lisp/userlock.el @@ -38,7 +38,7 @@ (defun ask-user-about-lock (file opponent) "Ask user what to do when he wants to edit FILE but it is locked by OPPONENT. This function has a choice of three things to do: - do (signal 'file-locked (list FILE OPPONENT)) + do (signal \\='file-locked (list FILE OPPONENT)) to refrain from editing the file return t (grab the lock on the file) return nil (edit the file even though it is locked). @@ -101,7 +101,7 @@ You can uit; don't modify this file.") (defun ask-user-about-supersession-threat (fn) "Ask a user who is about to modify an obsolete buffer what to do. This function has two choices: it can return, in which case the modification -of the buffer will proceed, or it can (signal 'file-supersession (file)), +of the buffer will proceed, or it can (signal \\='file-supersession (file)), in which case the proposed buffer modification will not be made. You can rewrite this to use any criterion you like to choose which one to do. diff --git a/lisp/vc/ediff-init.el b/lisp/vc/ediff-init.el index bf211599b9f..a1d405ac2a1 100644 --- a/lisp/vc/ediff-init.el +++ b/lisp/vc/ediff-init.el @@ -718,9 +718,9 @@ appropriate symbol: `rcs', `pcl-cvs', or `generic-sc' if you so desire." (defcustom ediff-coding-system-for-read 'raw-text "The coding system for read to use when running the diff program as a subprocess. In most cases, the default will do. However, under certain circumstances in -MS-Windows you might need to use something like 'raw-text-dos here. +MS-Windows you might need to use something like `raw-text-dos' here. So, if the output that your diff program sends to Emacs contains extra ^M's, -you might need to experiment here, if the default or 'raw-text-dos doesn't +you might need to experiment here, if the default or `raw-text-dos' doesn't work." :type 'symbol :group 'ediff) @@ -750,7 +750,7 @@ to temp files in buffer jobs and when Ediff needs to find fine differences." (defun ediff-check-version (op major minor &optional type-of-emacs) "Check the current version against MAJOR and MINOR version numbers. The comparison uses operator OP, which may be any of: =, >, >=, <, <=. -TYPE-OF-EMACS is either 'xemacs or 'emacs." +TYPE-OF-EMACS is either `emacs' or `xemacs'." (declare (obsolete version< "23.1")) (and (cond ((eq type-of-emacs 'xemacs) (featurep 'xemacs)) ((eq type-of-emacs 'emacs) (featurep 'emacs)) diff --git a/lisp/vc/ediff-wind.el b/lisp/vc/ediff-wind.el index e0887f03b62..8da752a1529 100644 --- a/lisp/vc/ediff-wind.el +++ b/lisp/vc/ediff-wind.el @@ -201,7 +201,7 @@ Used internally---not a user option.") (defcustom ediff-grab-mouse t "If t, Ediff will always grab the mouse and put it in the control frame. -If 'maybe, Ediff will do it sometimes, but not after operations that require +If `maybe', Ediff will do it sometimes, but not after operations that require relatively long time. If nil, the mouse will be entirely user's responsibility." :type 'boolean diff --git a/lisp/vc/log-edit.el b/lisp/vc/log-edit.el index 9857116e2d4..2bdd7a5be2b 100644 --- a/lisp/vc/log-edit.el +++ b/lisp/vc/log-edit.el @@ -97,7 +97,7 @@ (defcustom log-edit-confirm 'changed "If non-nil, `log-edit-done' will request confirmation. -If 'changed, only request confirmation if the list of files has +If `changed', only request confirmation if the list of files has changed since the beginning of the log-edit session." :group 'log-edit :type '(choice (const changed) (const t) (const nil))) @@ -115,7 +115,7 @@ Enforce it silently if t, query if non-nil and don't do anything if nil." (defcustom log-edit-setup-invert nil "Non-nil means `log-edit' should invert the meaning of its SETUP arg. -If SETUP is 'force, this variable has no effect." +If SETUP is `force', this variable has no effect." :group 'log-edit :type 'boolean) diff --git a/lisp/vc/pcvs.el b/lisp/vc/pcvs.el index 3fdee100d44..ba8425824f9 100644 --- a/lisp/vc/pcvs.el +++ b/lisp/vc/pcvs.el @@ -2209,7 +2209,7 @@ With prefix argument, prompt for cvs flags." ;; Byte compile files. (defun-cvs-mode cvs-mode-byte-compile-files () - "Run byte-compile-file on all selected files with '.el' extension." + "Run byte-compile-file on all selected files with `.el' extension." (interactive) (let ((marked (cvs-get-marked (cvs-ignore-marks-p "byte-compile")))) (dolist (fi marked) diff --git a/lisp/vc/smerge-mode.el b/lisp/vc/smerge-mode.el index 9f9224c226c..e9bfffd0354 100644 --- a/lisp/vc/smerge-mode.el +++ b/lisp/vc/smerge-mode.el @@ -735,17 +735,17 @@ major modes. Uses `smerge-resolve-function' to do the actual work." (smerge-auto-leave)))))) (defun smerge-diff-base-mine () - "Diff 'base' and 'mine' version in current conflict region." + "Diff `base' and `mine' version in current conflict region." (interactive) (smerge-diff 2 1)) (defun smerge-diff-base-other () - "Diff 'base' and 'other' version in current conflict region." + "Diff `base' and `other' version in current conflict region." (interactive) (smerge-diff 2 3)) (defun smerge-diff-mine-other () - "Diff 'mine' and 'other' version in current conflict region." + "Diff `mine' and `other' version in current conflict region." (interactive) (smerge-diff 1 3)) diff --git a/lisp/vc/vc-cvs.el b/lisp/vc/vc-cvs.el index 5f5807fb3c6..99a990b4417 100644 --- a/lisp/vc/vc-cvs.el +++ b/lisp/vc/vc-cvs.el @@ -161,7 +161,7 @@ Format is according to `format-time-string'. Only used if "Specify the mode-line display of sticky tags. Value t means default display, nil means no display at all. If the value is a function or macro, it is called with the sticky tag and -its' type as parameters, in that order. TYPE can have three different +its type as parameters, in that order. TYPE can have three different values: `symbolic-name' (TAG is a string), `revision-number' (TAG is a string) and `date' (TAG is a date as returned by `encode-time'). The return value of the function or macro will be displayed as a string. @@ -170,10 +170,10 @@ Here's an example that will display the formatted date for sticky dates and the word \"Sticky\" for sticky tag names and revisions. (lambda (tag type) - (cond ((eq type 'date) (format-time-string + (cond ((eq type \\='date) (format-time-string vc-cvs-sticky-date-format-string tag)) - ((eq type 'revision-number) \"Sticky\") - ((eq type 'symbolic-name) \"Sticky\"))) + ((eq type \\='revision-number) \"Sticky\") + ((eq type \\='symbolic-name) \"Sticky\"))) Here's an example that will abbreviate to the first character only, any text before the first occurrence of `-' for sticky symbolic tags. @@ -181,9 +181,9 @@ If the sticky tag is a revision number, the word \"Sticky\" is displayed. Date and time is displayed for sticky dates. (lambda (tag type) - (cond ((eq type 'date) (format-time-string \"%Y%m%d %H:%M\" tag)) - ((eq type 'revision-number) \"Sticky\") - ((eq type 'symbolic-name) + (cond ((eq type \\='date) (format-time-string \"%Y%m%d %H:%M\" tag)) + ((eq type \\='revision-number) \"Sticky\") + ((eq type \\='symbolic-name) (condition-case nil (progn (string-match \"\\\\([^-]*\\\\)\\\\(.*\\\\)\" tag) @@ -899,7 +899,7 @@ For an empty string, nil is returned (invalid CVS root)." (defun vc-cvs-parse-status (&optional full) "Parse output of \"cvs status\" command in the current buffer. Set file properties accordingly. Unless FULL is t, parse only -essential information. Note that this can never set the 'ignored +essential information. Note that this can never set the `ignored' state." (let (file status missing) (goto-char (point-min)) diff --git a/lisp/vc/vc-hooks.el b/lisp/vc/vc-hooks.el index 3e6d2a95051..dbe09d247b1 100644 --- a/lisp/vc/vc-hooks.el +++ b/lisp/vc/vc-hooks.el @@ -243,12 +243,12 @@ if that doesn't exist either, return nil." "Call for BACKEND the implementation of FUNCTION-NAME with the given ARGS. Calls - (apply 'vc-BACKEND-FUN ARGS) + (apply \\='vc-BACKEND-FUN ARGS) if vc-BACKEND-FUN exists (after trying to find it in vc-BACKEND.el) and else calls - (apply 'vc-default-FUN BACKEND ARGS) + (apply \\='vc-default-FUN BACKEND ARGS) It is usually called via the `vc-call' macro." (let ((f (assoc function-name (get backend 'vc-functions)))) diff --git a/lisp/vc/vc.el b/lisp/vc/vc.el index 178b5f0c0ce..0edbc94ecf6 100644 --- a/lisp/vc/vc.el +++ b/lisp/vc/vc.el @@ -2200,7 +2200,7 @@ Not all VC backends support short logs!") In the new log, leave point at WORKING-REVISION (if non-nil). LIMIT is the number of entries currently shown. Does nothing if IS-START-REVISION is non-nil, or if LIMIT is nil, -or if PL-RETURN is 'limit-unsupported." +or if PL-RETURN is `limit-unsupported'." (when (and limit (not (eq 'limit-unsupported pl-return)) (not is-start-revision)) (goto-char (point-max)) diff --git a/lisp/wid-edit.el b/lisp/wid-edit.el index 0d9157a5575..d0410aa6852 100644 --- a/lisp/wid-edit.el +++ b/lisp/wid-edit.el @@ -1267,7 +1267,7 @@ When not inside a field, signal an error." (defun widget-field-find (pos) "Return the field at POS. -Unlike (get-char-property POS 'field), this works with empty fields too." +Unlike (get-char-property POS \\='field), this works with empty fields too." (let ((fields widget-field-list) field found) (while fields diff --git a/lisp/windmove.el b/lisp/windmove.el index 1df74a2d271..52297ecf662 100644 --- a/lisp/windmove.el +++ b/lisp/windmove.el @@ -546,7 +546,7 @@ If no window is at the desired location, an error is signaled." (defun windmove-default-keybindings (&optional modifier) "Set up keybindings for `windmove'. Keybindings are of the form MODIFIER-{left,right,up,down}. -Default MODIFIER is 'shift." +Default MODIFIER is `shift'." (interactive) (unless modifier (setq modifier 'shift)) (global-set-key (vector (list modifier 'left)) 'windmove-left) diff --git a/lisp/window.el b/lisp/window.el index 295aa4f0dbf..67e39ecc9dd 100644 --- a/lisp/window.el +++ b/lisp/window.el @@ -3707,7 +3707,7 @@ and no others." (defun window-deletable-p (&optional window) "Return t if WINDOW can be safely deleted from its frame. WINDOW must be a valid window and defaults to the selected one. -Return 'frame if deleting WINDOW should also delete its frame." +Return `frame' if deleting WINDOW should also delete its frame." (setq window (window-normalize-window window)) (unless (or ignore-window-parameters @@ -6491,7 +6491,7 @@ action. Its form is described below. Optional argument FRAME, if non-nil, acts like an additional ALIST entry (reusable-frames . FRAME) to the action list of ACTION, specifying the frame(s) to search for a window that is already -displaying the buffer. See `display-buffer-reuse-window' +displaying the buffer. See `display-buffer-reuse-window'. If ACTION is non-nil, it should have the form (FUNCTION . ALIST), where FUNCTION is either a function or a list of functions, and @@ -6562,9 +6562,9 @@ Recognized alist entries include: of not displaying the buffer and FUNCTION can safely return a non-window value to suppress displaying. - `preserve-size' -- Value should be either '(t . nil)' to - preserve the width of the window, '(nil . t)' to preserve its - height or '(t . t)' to preserve both. + `preserve-size' -- Value should be either (t . nil) to + preserve the width of the window, (nil . t) to preserve its + height or (t . t) to preserve both. The ACTION argument to `display-buffer' can also have a non-nil and non-list value. This means to display the buffer in a window diff --git a/lisp/woman.el b/lisp/woman.el index 81319fa6a9f..dc65d1d9f47 100644 --- a/lisp/woman.el +++ b/lisp/woman.el @@ -738,7 +738,7 @@ the `woman' command to update and re-write the cache." (defcustom woman-dired-keys t "List of `dired' mode keys to define to run WoMan on current file. -E.g. '(\"w\" \"W\"), or any non-null atom to automatically define +E.g. (\"w\" \"W\"), or any non-null atom to automatically define \"w\" and \"W\" if they are unbound, or nil to do nothing. Default is t." :type '(choice (const :tag "None" nil) @@ -1102,7 +1102,7 @@ The ordinal numbers start from 0.") (defvar woman-if-conditions-true '(?n ?e ?o) "List of one-character built-in condition names that are true. Should include ?e, ?o (page even/odd) and either ?n (nroff) or ?t (troff). -Default is '(?n ?e ?o). Set via `woman-emulation'.") +Default is (?n ?e ?o). Set via `woman-emulation'.") ;;; Specialized utility functions: @@ -2218,7 +2218,7 @@ To be called on original buffer and any .so insertions." (defvar woman-emulate-tbl nil "True if WoMan should emulate the tbl preprocessor. This applies to text between .TE and .TS directives. -Currently set only from '\" t in the first line of the source file.") +Currently set only from \\='\\\" t in the first line of the source file.") (defun woman-decode-region (from _to) "Decode the region between FROM and TO in UN*X man-page source format." diff --git a/lisp/xml.el b/lisp/xml.el index f5a9a3f8f0b..7a853d98cc6 100644 --- a/lisp/xml.el +++ b/lisp/xml.el @@ -126,9 +126,9 @@ tag. For example, would be represented by - '(\"\" . \"foo\"). + (\"\" . \"foo\"). -If you'd just like a plain symbol instead, use 'symbol-qnames in +If you'd just like a plain symbol instead, use `symbol-qnames' in the PARSE-NS argument." (car node)) @@ -1010,12 +1010,12 @@ The first line is indented with the optional INDENT-STRING." (defun xml-escape-string (string) "Convert STRING into a string containing valid XML character data. -Replace occurrences of &<>'\" in STRING with their default XML -entity references (e.g. replace each & with &). +Replace occurrences of &<>\\='\" in STRING with their default XML +entity references (e.g., replace each & with &). XML character data must not contain & or < characters, nor the > character under some circumstances. The XML spec does not impose -restriction on \" or ', but we just substitute for these too +restriction on \" or \\=', but we just substitute for these too \(as is permitted by the spec)." (with-temp-buffer (insert string) diff --git a/src/dispnew.c b/src/dispnew.c index 64c84aec6f9..1d30eee2082 100644 --- a/src/dispnew.c +++ b/src/dispnew.c @@ -6206,10 +6206,10 @@ It is up to you to set this variable if your terminal can do that. */); doc: /* Name of the window system that Emacs uses for the first frame. The value is a symbol: nil for a termcap frame (a character-only terminal), - 'x' for an Emacs frame that is really an X window, - 'w32' for an Emacs frame that is a window on MS-Windows display, - 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display, - 'pc' for a direct-write MS-DOS frame. + `x' for an Emacs frame that is really an X window, + `w32' for an Emacs frame that is a window on MS-Windows display, + `ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display, + `pc' for a direct-write MS-DOS frame. Use of this variable as a boolean is deprecated. Instead, use `display-graphic-p' or any of the other `display-*-p' @@ -6219,10 +6219,10 @@ predicates which report frame's specific UI-related capabilities. */); doc: /* Name of window system through which the selected frame is displayed. The value is a symbol: nil for a termcap frame (a character-only terminal), - 'x' for an Emacs frame that is really an X window, - 'w32' for an Emacs frame that is a window on MS-Windows display, - 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display, - 'pc' for a direct-write MS-DOS frame. + `x' for an Emacs frame that is really an X window, + `w32' for an Emacs frame that is a window on MS-Windows display, + `ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display, + `pc' for a direct-write MS-DOS frame. Use of this variable as a boolean is deprecated. Instead, use `display-graphic-p' or any of the other `display-*-p' diff --git a/src/fns.c b/src/fns.c index efc319e721f..9931e80c970 100644 --- a/src/fns.c +++ b/src/fns.c @@ -338,7 +338,7 @@ This function obeys the conventions for collation order in your locale settings. For example, punctuation and whitespace characters might be considered less significant for sorting: -(sort '("11" "12" "1 1" "1 2" "1.1" "1.2") \\='string-collate-lessp) +(sort \\='("11" "12" "1 1" "1 2" "1.1" "1.2") \\='string-collate-lessp) => ("11" "1 1" "1.1" "12" "1 2" "1.2") The optional argument LOCALE, a string, overrides the setting of your diff --git a/src/frame.c b/src/frame.c index 78f8ff71be3..c388986e351 100644 --- a/src/frame.c +++ b/src/frame.c @@ -239,10 +239,10 @@ DEFUN ("framep", Fframep, Sframep, 1, 1, 0, doc: /* Return non-nil if OBJECT is a frame. Value is: t for a termcap frame (a character-only terminal), - 'x' for an Emacs frame that is really an X window, - 'w32' for an Emacs frame that is a window on MS-Windows display, - 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display, - 'pc' for a direct-write MS-DOS frame. + `x' for an Emacs frame that is really an X window, + `w32' for an Emacs frame that is a window on MS-Windows display, + `ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display, + `pc' for a direct-write MS-DOS frame. See also `frame-live-p'. */) (Lisp_Object object) { @@ -284,10 +284,10 @@ DEFUN ("window-system", Fwindow_system, Swindow_system, 0, 1, 0, doc: /* The name of the window system that FRAME is displaying through. The value is a symbol: nil for a termcap frame (a character-only terminal), - 'x' for an Emacs frame that is really an X window, - 'w32' for an Emacs frame that is a window on MS-Windows display, - 'ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display, - 'pc' for a direct-write MS-DOS frame. + `x' for an Emacs frame that is really an X window, + `w32' for an Emacs frame that is a window on MS-Windows display, + `ns' for an Emacs frame on a GNUstep or Macintosh Cocoa display, + `pc' for a direct-write MS-DOS frame. FRAME defaults to the currently selected frame. -- 2.11.4.GIT